3 * Implements the User class for the %MediaWiki software.
8 * Int Number of characters in user_token field.
11 define( 'USER_TOKEN_LENGTH', 32 );
14 * Int Serialized record version.
17 define( 'MW_USER_VERSION', 8 );
20 * String Some punctuation to prevent editing from broken text-mangling proxies.
23 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
26 * Thrown by User::setPassword() on error.
29 class PasswordError
extends MWException
{
34 * The User object encapsulates all of the user-specific settings (user_id,
35 * name, rights, password, email address, options, last login time). Client
36 * classes use the getXXX() functions to access these fields. These functions
37 * do all the work of determining whether the user is logged in,
38 * whether the requested option can be satisfied from cookies or
39 * whether a database query is needed. Most of the settings needed
40 * for rendering normal pages are set in the cookie to minimize use
45 * Global constants made accessible as class constants so that autoloader
48 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
49 const MW_USER_VERSION
= MW_USER_VERSION
;
50 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
53 * Array of Strings List of member variables which are saved to the
54 * shared cache (memcached). Any operation which changes the
55 * corresponding database fields must call a cache-clearing function.
58 static $mCacheVars = array(
69 'mEmailAuthenticated',
76 // user_properties table
81 * Array of Strings Core rights.
82 * Each of these should have a corresponding message of the form
86 static $mCoreRights = array(
105 'editusercssjs', #deprecated
117 'move-rootuserpages',
121 'override-export-depth',
142 'userrights-interwiki',
146 * String Cached results of getAllRights()
148 static $mAllRights = false;
150 /** @name Cache variables */
152 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
153 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
154 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
158 * Bool Whether the cache variables have been loaded.
160 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
163 * String Initialization data source if mDataLoaded==false. May be one of:
164 * - 'defaults' anonymous user initialised from class defaults
165 * - 'name' initialise from mName
166 * - 'id' initialise from mId
167 * - 'session' log in from cookies or session if possible
169 * Use the User::newFrom*() family of functions to set this.
174 * Lazy-initialized variables, invalidated with clearInstanceCache
176 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
177 $mBlockreason, $mEffectiveGroups, $mBlockedGlobally,
178 $mLocked, $mHideName, $mOptions;
190 static $idCacheByName = array();
193 * Lightweight constructor for an anonymous user.
194 * Use the User::newFrom* factory functions for other kinds of users.
198 * @see newFromConfirmationCode()
199 * @see newFromSession()
202 function __construct() {
203 $this->clearInstanceCache( 'defaults' );
207 * Load the user table data for this object from the source given by mFrom.
210 if ( $this->mDataLoaded
) {
213 wfProfileIn( __METHOD__
);
215 # Set it now to avoid infinite recursion in accessors
216 $this->mDataLoaded
= true;
218 switch ( $this->mFrom
) {
220 $this->loadDefaults();
223 $this->mId
= self
::idFromName( $this->mName
);
225 # Nonexistent user placeholder object
226 $this->loadDefaults( $this->mName
);
235 $this->loadFromSession();
236 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
239 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
241 wfProfileOut( __METHOD__
);
245 * Load user table data, given mId has already been set.
246 * @return Bool false if the ID does not exist, true otherwise
249 function loadFromId() {
251 if ( $this->mId
== 0 ) {
252 $this->loadDefaults();
257 $key = wfMemcKey( 'user', 'id', $this->mId
);
258 $data = $wgMemc->get( $key );
259 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
260 # Object is expired, load from DB
265 wfDebug( "User: cache miss for user {$this->mId}\n" );
267 if ( !$this->loadFromDatabase() ) {
268 # Can't load from ID, user is anonymous
271 $this->saveToCache();
273 wfDebug( "User: got user {$this->mId} from cache\n" );
275 foreach ( self
::$mCacheVars as $name ) {
276 $this->$name = $data[$name];
283 * Save user data to the shared cache
285 function saveToCache() {
288 $this->loadOptions();
289 if ( $this->isAnon() ) {
290 // Anonymous users are uncached
294 foreach ( self
::$mCacheVars as $name ) {
295 $data[$name] = $this->$name;
297 $data['mVersion'] = MW_USER_VERSION
;
298 $key = wfMemcKey( 'user', 'id', $this->mId
);
300 $wgMemc->set( $key, $data );
304 /** @name newFrom*() static factory methods */
308 * Static factory method for creation from username.
310 * This is slightly less efficient than newFromId(), so use newFromId() if
311 * you have both an ID and a name handy.
313 * @param $name String Username, validated by Title::newFromText()
314 * @param $validate String|Bool Validate username. Takes the same parameters as
315 * User::getCanonicalName(), except that true is accepted as an alias
316 * for 'valid', for BC.
318 * @return User object, or false if the username is invalid
319 * (e.g. if it contains illegal characters or is an IP address). If the
320 * username is not present in the database, the result will be a user object
321 * with a name, zero user ID and default settings.
323 static function newFromName( $name, $validate = 'valid' ) {
324 if ( $validate === true ) {
327 $name = self
::getCanonicalName( $name, $validate );
328 if ( $name === false ) {
331 # Create unloaded user object
340 * Static factory method for creation from a given user ID.
342 * @param $id Int Valid user ID
343 * @return User The corresponding User object
345 static function newFromId( $id ) {
353 * Factory method to fetch whichever user has a given email confirmation code.
354 * This code is generated when an account is created or its e-mail address
357 * If the code is invalid or has expired, returns NULL.
359 * @param $code String Confirmation code
362 static function newFromConfirmationCode( $code ) {
363 $dbr = wfGetDB( DB_SLAVE
);
364 $id = $dbr->selectField( 'user', 'user_id', array(
365 'user_email_token' => md5( $code ),
366 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
368 if( $id !== false ) {
369 return User
::newFromId( $id );
376 * Create a new user object using data from session or cookies. If the
377 * login credentials are invalid, the result is an anonymous user.
381 static function newFromSession() {
383 $user->mFrom
= 'session';
388 * Create a new user object from a user row.
389 * The row should have all fields from the user table in it.
390 * @param $row Array A row from the user table
393 static function newFromRow( $row ) {
395 $user->loadFromRow( $row );
403 * Get the username corresponding to a given user ID
404 * @param $id Int User ID
405 * @return String The corresponding username
407 static function whoIs( $id ) {
408 $dbr = wfGetDB( DB_SLAVE
);
409 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
413 * Get the real name of a user given their user ID
415 * @param $id Int User ID
416 * @return String The corresponding user's real name
418 static function whoIsReal( $id ) {
419 $dbr = wfGetDB( DB_SLAVE
);
420 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
424 * Get database id given a user name
425 * @param $name String Username
426 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
428 static function idFromName( $name ) {
429 $nt = Title
::makeTitleSafe( NS_USER
, $name );
430 if( is_null( $nt ) ) {
435 if ( isset( self
::$idCacheByName[$name] ) ) {
436 return self
::$idCacheByName[$name];
439 $dbr = wfGetDB( DB_SLAVE
);
440 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
442 if ( $s === false ) {
445 $result = $s->user_id
;
448 self
::$idCacheByName[$name] = $result;
450 if ( count( self
::$idCacheByName ) > 1000 ) {
451 self
::$idCacheByName = array();
458 * Reset the cache used in idFromName(). For use in tests.
460 public static function resetIdByNameCache() {
461 self
::$idCacheByName = array();
465 * Does the string match an anonymous IPv4 address?
467 * This function exists for username validation, in order to reject
468 * usernames which are similar in form to IP addresses. Strings such
469 * as 300.300.300.300 will return true because it looks like an IP
470 * address, despite not being strictly valid.
472 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
473 * address because the usemod software would "cloak" anonymous IP
474 * addresses like this, if we allowed accounts like this to be created
475 * new users could get the old edits of these anonymous users.
477 * @param $name String to match
480 static function isIP( $name ) {
481 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
485 * Is the input a valid username?
487 * Checks if the input is a valid username, we don't want an empty string,
488 * an IP address, anything that containins slashes (would mess up subpages),
489 * is longer than the maximum allowed username size or doesn't begin with
492 * @param $name String to match
495 static function isValidUserName( $name ) {
496 global $wgContLang, $wgMaxNameChars;
499 || User
::isIP( $name )
500 ||
strpos( $name, '/' ) !== false
501 ||
strlen( $name ) > $wgMaxNameChars
502 ||
$name != $wgContLang->ucfirst( $name ) ) {
503 wfDebugLog( 'username', __METHOD__
.
504 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
508 // Ensure that the name can't be misresolved as a different title,
509 // such as with extra namespace keys at the start.
510 $parsed = Title
::newFromText( $name );
511 if( is_null( $parsed )
512 ||
$parsed->getNamespace()
513 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
514 wfDebugLog( 'username', __METHOD__
.
515 ": '$name' invalid due to ambiguous prefixes" );
519 // Check an additional blacklist of troublemaker characters.
520 // Should these be merged into the title char list?
521 $unicodeBlacklist = '/[' .
522 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
523 '\x{00a0}' . # non-breaking space
524 '\x{2000}-\x{200f}' . # various whitespace
525 '\x{2028}-\x{202f}' . # breaks and control chars
526 '\x{3000}' . # ideographic space
527 '\x{e000}-\x{f8ff}' . # private use
529 if( preg_match( $unicodeBlacklist, $name ) ) {
530 wfDebugLog( 'username', __METHOD__
.
531 ": '$name' invalid due to blacklisted characters" );
539 * Usernames which fail to pass this function will be blocked
540 * from user login and new account registrations, but may be used
541 * internally by batch processes.
543 * If an account already exists in this form, login will be blocked
544 * by a failure to pass this function.
546 * @param $name String to match
549 static function isUsableName( $name ) {
550 global $wgReservedUsernames;
551 // Must be a valid username, obviously ;)
552 if ( !self
::isValidUserName( $name ) ) {
556 static $reservedUsernames = false;
557 if ( !$reservedUsernames ) {
558 $reservedUsernames = $wgReservedUsernames;
559 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
562 // Certain names may be reserved for batch processes.
563 foreach ( $reservedUsernames as $reserved ) {
564 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
565 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
567 if ( $reserved == $name ) {
575 * Usernames which fail to pass this function will be blocked
576 * from new account registrations, but may be used internally
577 * either by batch processes or by user accounts which have
578 * already been created.
580 * Additional blacklisting may be added here rather than in
581 * isValidUserName() to avoid disrupting existing accounts.
583 * @param $name String to match
586 static function isCreatableName( $name ) {
587 global $wgInvalidUsernameCharacters;
589 // Ensure that the username isn't longer than 235 bytes, so that
590 // (at least for the builtin skins) user javascript and css files
591 // will work. (bug 23080)
592 if( strlen( $name ) > 235 ) {
593 wfDebugLog( 'username', __METHOD__
.
594 ": '$name' invalid due to length" );
598 // Preg yells if you try to give it an empty string
599 if( $wgInvalidUsernameCharacters !== '' ) {
600 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
601 wfDebugLog( 'username', __METHOD__
.
602 ": '$name' invalid due to wgInvalidUsernameCharacters" );
607 return self
::isUsableName( $name );
611 * Is the input a valid password for this user?
613 * @param $password String Desired password
616 function isValidPassword( $password ) {
617 //simple boolean wrapper for getPasswordValidity
618 return $this->getPasswordValidity( $password ) === true;
622 * Given unvalidated password input, return error message on failure.
624 * @param $password String Desired password
625 * @return mixed: true on success, string or array of error message on failure
627 function getPasswordValidity( $password ) {
628 global $wgMinimalPasswordLength, $wgContLang;
630 static $blockedLogins = array(
631 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
632 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
635 $result = false; //init $result to false for the internal checks
637 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
640 if ( $result === false ) {
641 if( strlen( $password ) < $wgMinimalPasswordLength ) {
642 return 'passwordtooshort';
643 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
644 return 'password-name-match';
645 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
646 return 'password-login-forbidden';
648 //it seems weird returning true here, but this is because of the
649 //initialization of $result to false above. If the hook is never run or it
650 //doesn't modify $result, then we will likely get down into this if with
654 } elseif( $result === true ) {
657 return $result; //the isValidPassword hook set a string $result and returned true
662 * Does a string look like an e-mail address?
664 * This validates an email address using an HTML5 specification found at:
665 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
666 * Which as of 2011-01-24 says:
668 * A valid e-mail address is a string that matches the ABNF production
669 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
670 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
673 * This function is an implementation of the specification as requested in
676 * Client-side forms will use the same standard validation rules via JS or
677 * HTML 5 validation; additional restrictions can be enforced server-side
678 * by extensions via the 'isValidEmailAddr' hook.
680 * Note that this validation doesn't 100% match RFC 2822, but is believed
681 * to be liberal enough for wide use. Some invalid addresses will still
682 * pass validation here.
684 * @param $addr String E-mail address
687 public static function isValidEmailAddr( $addr ) {
689 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
693 // Please note strings below are enclosed in brackets [], this make the
694 // hyphen "-" a range indicator. Hence it is double backslashed below.
696 $rfc5322_atext = "a-z0-9!#$%&'*+\\-\/=?^_`{|}~" ;
697 $rfc1034_ldh_str = "a-z0-9\\-" ;
699 $HTML5_email_regexp = "/
701 [$rfc5322_atext\\.]+ # user part which is liberal :p
703 [$rfc1034_ldh_str]+ # First domain part
704 (\\.[$rfc1034_ldh_str]+)* # Following part prefixed with a dot
706 /ix" ; // case Insensitive, eXtended
708 return (bool) preg_match( $HTML5_email_regexp, $addr );
712 * Given unvalidated user input, return a canonical username, or false if
713 * the username is invalid.
714 * @param $name String User input
715 * @param $validate String|Bool type of validation to use:
716 * - false No validation
717 * - 'valid' Valid for batch processes
718 * - 'usable' Valid for batch processes and login
719 * - 'creatable' Valid for batch processes, login and account creation
721 static function getCanonicalName( $name, $validate = 'valid' ) {
722 # Force usernames to capital
724 $name = $wgContLang->ucfirst( $name );
726 # Reject names containing '#'; these will be cleaned up
727 # with title normalisation, but then it's too late to
729 if( strpos( $name, '#' ) !== false )
732 # Clean up name according to title rules
733 $t = ( $validate === 'valid' ) ?
734 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
735 # Check for invalid titles
736 if( is_null( $t ) ) {
740 # Reject various classes of invalid names
742 $name = $wgAuth->getCanonicalName( $t->getText() );
744 switch ( $validate ) {
748 if ( !User
::isValidUserName( $name ) ) {
753 if ( !User
::isUsableName( $name ) ) {
758 if ( !User
::isCreatableName( $name ) ) {
763 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
769 * Count the number of edits of a user
770 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
772 * @param $uid Int User ID to check
773 * @return Int the user's edit count
775 static function edits( $uid ) {
776 wfProfileIn( __METHOD__
);
777 $dbr = wfGetDB( DB_SLAVE
);
778 // check if the user_editcount field has been initialized
779 $field = $dbr->selectField(
780 'user', 'user_editcount',
781 array( 'user_id' => $uid ),
785 if( $field === null ) { // it has not been initialized. do so.
786 $dbw = wfGetDB( DB_MASTER
);
787 $count = $dbr->selectField(
788 'revision', 'count(*)',
789 array( 'rev_user' => $uid ),
794 array( 'user_editcount' => $count ),
795 array( 'user_id' => $uid ),
801 wfProfileOut( __METHOD__
);
806 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
807 * @todo hash random numbers to improve security, like generateToken()
809 * @return String new random password
811 static function randomPassword() {
812 global $wgMinimalPasswordLength;
813 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
814 $l = strlen( $pwchars ) - 1;
816 $pwlength = max( 7, $wgMinimalPasswordLength );
817 $digit = mt_rand( 0, $pwlength - 1 );
819 for ( $i = 0; $i < $pwlength; $i++
) {
820 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
826 * Set cached properties to default.
828 * @note This no longer clears uncached lazy-initialised properties;
829 * the constructor does that instead.
832 function loadDefaults( $name = false ) {
833 wfProfileIn( __METHOD__
);
838 $this->mName
= $name;
839 $this->mRealName
= '';
840 $this->mPassword
= $this->mNewpassword
= '';
841 $this->mNewpassTime
= null;
843 $this->mOptionOverrides
= null;
844 $this->mOptionsLoaded
= false;
846 if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) {
847 $this->mTouched
= wfTimestamp( TS_MW
, $wgRequest->getCookie( 'LoggedOut' ) );
849 $this->mTouched
= '0'; # Allow any pages to be cached
852 $this->setToken(); # Random
853 $this->mEmailAuthenticated
= null;
854 $this->mEmailToken
= '';
855 $this->mEmailTokenExpires
= null;
856 $this->mRegistration
= wfTimestamp( TS_MW
);
857 $this->mGroups
= array();
859 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
861 wfProfileOut( __METHOD__
);
865 * Load user data from the session or login cookie. If there are no valid
866 * credentials, initialises the user as an anonymous user.
867 * @return Bool True if the user is logged in, false otherwise.
869 private function loadFromSession() {
870 global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy;
873 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
874 if ( $result !== null ) {
878 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
879 $extUser = ExternalUser
::newFromCookie();
881 # TODO: Automatically create the user here (or probably a bit
882 # lower down, in fact)
886 $cookieId = $wgRequest->getCookie( 'UserID' );
887 $sessId = $wgRequest->getSessionData( 'wsUserID' );
889 if ( $cookieId !== null ) {
890 $sId = intval( $cookieId );
891 if( $sessId !== null && $cookieId != $sessId ) {
892 $this->loadDefaults(); // Possible collision!
893 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
894 cookie user ID ($sId) don't match!" );
897 $wgRequest->setSessionData( 'wsUserID', $sId );
898 } else if ( $sessId !== null && $sessId != 0 ) {
901 $this->loadDefaults();
905 if ( $wgRequest->getSessionData( 'wsUserName' ) !== null ) {
906 $sName = $wgRequest->getSessionData( 'wsUserName' );
907 } else if ( $wgRequest->getCookie( 'UserName' ) !== null ) {
908 $sName = $wgRequest->getCookie( 'UserName' );
909 $wgRequest->setSessionData( 'wsUserName', $sName );
911 $this->loadDefaults();
916 if ( !$this->loadFromId() ) {
917 # Not a valid ID, loadFromId has switched the object to anon for us
921 global $wgBlockDisablesLogin;
922 if( $wgBlockDisablesLogin && $this->isBlocked() ) {
923 # User blocked and we've disabled blocked user logins
924 $this->loadDefaults();
928 if ( $wgRequest->getSessionData( 'wsToken' ) !== null ) {
929 $passwordCorrect = $this->mToken
== $wgRequest->getSessionData( 'wsToken' );
931 } else if ( $wgRequest->getCookie( 'Token' ) !== null ) {
932 $passwordCorrect = $this->mToken
== $wgRequest->getCookie( 'Token' );
935 # No session or persistent login cookie
936 $this->loadDefaults();
940 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
941 $wgRequest->setSessionData( 'wsToken', $this->mToken
);
942 wfDebug( "User: logged in from $from\n" );
945 # Invalid credentials
946 wfDebug( "User: can't log in from $from, invalid credentials\n" );
947 $this->loadDefaults();
953 * Load user and user_group data from the database.
954 * $this::mId must be set, this is how the user is identified.
956 * @return Bool True if the user exists, false if the user is anonymous
959 function loadFromDatabase() {
961 $this->mId
= intval( $this->mId
);
963 /** Anonymous user */
965 $this->loadDefaults();
969 $dbr = wfGetDB( DB_MASTER
);
970 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
972 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
974 if ( $s !== false ) {
975 # Initialise user table data
976 $this->loadFromRow( $s );
977 $this->mGroups
= null; // deferred
978 $this->getEditCount(); // revalidation for nulls
983 $this->loadDefaults();
989 * Initialize this object from a row from the user table.
991 * @param $row Array Row from the user table to load.
993 function loadFromRow( $row ) {
994 $this->mDataLoaded
= true;
996 if ( isset( $row->user_id
) ) {
997 $this->mId
= intval( $row->user_id
);
999 $this->mName
= $row->user_name
;
1000 $this->mRealName
= $row->user_real_name
;
1001 $this->mPassword
= $row->user_password
;
1002 $this->mNewpassword
= $row->user_newpassword
;
1003 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1004 $this->mEmail
= $row->user_email
;
1005 $this->decodeOptions( $row->user_options
);
1006 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
1007 $this->mToken
= $row->user_token
;
1008 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1009 $this->mEmailToken
= $row->user_email_token
;
1010 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1011 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1012 $this->mEditCount
= $row->user_editcount
;
1016 * Load the groups from the database if they aren't already loaded.
1019 function loadGroups() {
1020 if ( is_null( $this->mGroups
) ) {
1021 $dbr = wfGetDB( DB_MASTER
);
1022 $res = $dbr->select( 'user_groups',
1023 array( 'ug_group' ),
1024 array( 'ug_user' => $this->mId
),
1026 $this->mGroups
= array();
1027 foreach ( $res as $row ) {
1028 $this->mGroups
[] = $row->ug_group
;
1034 * Clear various cached data stored in this object.
1035 * @param $reloadFrom String Reload user and user_groups table data from a
1036 * given source. May be "name", "id", "defaults", "session", or false for
1039 function clearInstanceCache( $reloadFrom = false ) {
1040 $this->mNewtalk
= -1;
1041 $this->mDatePreference
= null;
1042 $this->mBlockedby
= -1; # Unset
1043 $this->mHash
= false;
1044 $this->mSkin
= null;
1045 $this->mRights
= null;
1046 $this->mEffectiveGroups
= null;
1047 $this->mOptions
= null;
1049 if ( $reloadFrom ) {
1050 $this->mDataLoaded
= false;
1051 $this->mFrom
= $reloadFrom;
1056 * Combine the language default options with any site-specific options
1057 * and add the default language variants.
1059 * @return Array of String options
1061 static function getDefaultOptions() {
1062 global $wgNamespacesToBeSearchedDefault;
1064 * Site defaults will override the global/language defaults
1066 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1067 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1070 * default language setting
1072 $variant = $wgContLang->getDefaultVariant();
1073 $defOpt['variant'] = $variant;
1074 $defOpt['language'] = $variant;
1075 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1076 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1078 $defOpt['skin'] = $wgDefaultSkin;
1084 * Get a given default option value.
1086 * @param $opt String Name of option to retrieve
1087 * @return String Default option value
1089 public static function getDefaultOption( $opt ) {
1090 $defOpts = self
::getDefaultOptions();
1091 if( isset( $defOpts[$opt] ) ) {
1092 return $defOpts[$opt];
1100 * Get blocking information
1102 * @param $bFromSlave Bool Whether to check the slave database first. To
1103 * improve performance, non-critical checks are done
1104 * against slaves. Check when actually saving should be
1105 * done against master.
1107 function getBlockedStatus( $bFromSlave = true ) {
1108 global $wgProxyWhitelist, $wgUser;
1110 if ( -1 != $this->mBlockedby
) {
1114 wfProfileIn( __METHOD__
);
1115 wfDebug( __METHOD__
.": checking...\n" );
1117 // Initialize data...
1118 // Otherwise something ends up stomping on $this->mBlockedby when
1119 // things get lazy-loaded later, causing false positive block hits
1120 // due to -1 !== 0. Probably session-related... Nothing should be
1121 // overwriting mBlockedby, surely?
1124 $this->mBlockedby
= 0;
1125 $this->mHideName
= 0;
1126 $this->mAllowUsertalk
= 0;
1128 # Check if we are looking at an IP or a logged-in user
1129 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1130 # Exempt from all types of IP-block
1132 } elseif ( $this->isIP( $this->getName() ) ) {
1133 $ip = $this->getName();
1135 # Check if we are looking at the current user
1136 # If we don't, and the user is logged in, we don't know about
1137 # his IP / autoblock status, so ignore autoblock of current user's IP
1138 if ( $this->getID() != $wgUser->getID() ) {
1141 # Get IP of current user
1147 $this->mBlock
= new Block();
1148 $this->mBlock
->fromMaster( !$bFromSlave );
1149 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1150 wfDebug( __METHOD__
. ": Found block.\n" );
1151 $this->mBlockedby
= $this->mBlock
->mBy
;
1152 if( $this->mBlockedby
== 0 )
1153 $this->mBlockedby
= $this->mBlock
->mByName
;
1154 $this->mBlockreason
= $this->mBlock
->mReason
;
1155 $this->mHideName
= $this->mBlock
->mHideName
;
1156 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1157 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1158 $this->spreadBlock();
1161 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1162 // apply to users. Note that the existence of $this->mBlock is not used to
1163 // check for edit blocks, $this->mBlockedby is instead.
1167 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1169 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1170 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1171 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1175 if ( !$this->mBlockedby
&& !$this->getID() ) {
1176 if ( $this->isDnsBlacklisted( $ip ) ) {
1177 $this->mBlockedby
= wfMsg( 'sorbs' );
1178 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1184 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1186 wfProfileOut( __METHOD__
);
1190 * Whether the given IP is in a DNS blacklist.
1192 * @param $ip String IP to check
1193 * @param $checkWhitelist Bool: whether to check the whitelist first
1194 * @return Bool True if blacklisted.
1196 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1197 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1198 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1200 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1203 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1206 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1207 return $this->inDnsBlacklist( $ip, $urls );
1211 * Whether the given IP is in a given DNS blacklist.
1213 * @param $ip String IP to check
1214 * @param $bases String|Array of Strings: URL of the DNS blacklist
1215 * @return Bool True if blacklisted.
1217 function inDnsBlacklist( $ip, $bases ) {
1218 wfProfileIn( __METHOD__
);
1221 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1222 if( IP
::isIPv4( $ip ) ) {
1223 # Reverse IP, bug 21255
1224 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1226 foreach( (array)$bases as $base ) {
1228 $host = "$ipReversed.$base";
1231 $ipList = gethostbynamel( $host );
1234 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1238 wfDebug( "Requested $host, not found in $base.\n" );
1243 wfProfileOut( __METHOD__
);
1248 * Is this user subject to rate limiting?
1250 * @return Bool True if rate limited
1252 public function isPingLimitable() {
1253 global $wgRateLimitsExcludedGroups;
1254 global $wgRateLimitsExcludedIPs;
1255 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1256 // Deprecated, but kept for backwards-compatibility config
1259 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1260 // No other good way currently to disable rate limits
1261 // for specific IPs. :P
1262 // But this is a crappy hack and should die.
1265 return !$this->isAllowed('noratelimit');
1269 * Primitive rate limits: enforce maximum actions per time period
1270 * to put a brake on flooding.
1272 * @note When using a shared cache like memcached, IP-address
1273 * last-hit counters will be shared across wikis.
1275 * @param $action String Action to enforce; 'edit' if unspecified
1276 * @return Bool True if a rate limiter was tripped
1278 function pingLimiter( $action = 'edit' ) {
1279 # Call the 'PingLimiter' hook
1281 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1285 global $wgRateLimits;
1286 if( !isset( $wgRateLimits[$action] ) ) {
1290 # Some groups shouldn't trigger the ping limiter, ever
1291 if( !$this->isPingLimitable() )
1294 global $wgMemc, $wgRateLimitLog;
1295 wfProfileIn( __METHOD__
);
1297 $limits = $wgRateLimits[$action];
1299 $id = $this->getId();
1303 if( isset( $limits['anon'] ) && $id == 0 ) {
1304 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1307 if( isset( $limits['user'] ) && $id != 0 ) {
1308 $userLimit = $limits['user'];
1310 if( $this->isNewbie() ) {
1311 if( isset( $limits['newbie'] ) && $id != 0 ) {
1312 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1314 if( isset( $limits['ip'] ) ) {
1315 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1318 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1319 $subnet = $matches[1];
1320 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1323 // Check for group-specific permissions
1324 // If more than one group applies, use the group with the highest limit
1325 foreach ( $this->getGroups() as $group ) {
1326 if ( isset( $limits[$group] ) ) {
1327 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1328 $userLimit = $limits[$group];
1332 // Set the user limit key
1333 if ( $userLimit !== false ) {
1334 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1335 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1339 foreach( $keys as $key => $limit ) {
1340 list( $max, $period ) = $limit;
1341 $summary = "(limit $max in {$period}s)";
1342 $count = $wgMemc->get( $key );
1345 if( $count > $max ) {
1346 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1347 if( $wgRateLimitLog ) {
1348 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1352 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1355 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1356 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1358 $wgMemc->incr( $key );
1361 wfProfileOut( __METHOD__
);
1366 * Check if user is blocked
1368 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1369 * @return Bool True if blocked, false otherwise
1371 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1372 $this->getBlockedStatus( $bFromSlave );
1373 return $this->mBlockedby
!== 0;
1377 * Check if user is blocked from editing a particular article
1379 * @param $title Title to check
1380 * @param $bFromSlave Bool whether to check the slave database instead of the master
1383 function isBlockedFrom( $title, $bFromSlave = false ) {
1384 global $wgBlockAllowsUTEdit;
1385 wfProfileIn( __METHOD__
);
1387 $blocked = $this->isBlocked( $bFromSlave );
1388 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1389 # If a user's name is suppressed, they cannot make edits anywhere
1390 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1391 $title->getNamespace() == NS_USER_TALK
) {
1393 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1396 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1398 wfProfileOut( __METHOD__
);
1403 * If user is blocked, return the name of the user who placed the block
1404 * @return String name of blocker
1406 function blockedBy() {
1407 $this->getBlockedStatus();
1408 return $this->mBlockedby
;
1412 * If user is blocked, return the specified reason for the block
1413 * @return String Blocking reason
1415 function blockedFor() {
1416 $this->getBlockedStatus();
1417 return $this->mBlockreason
;
1421 * If user is blocked, return the ID for the block
1422 * @return Int Block ID
1424 function getBlockId() {
1425 $this->getBlockedStatus();
1426 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1430 * Check if user is blocked on all wikis.
1431 * Do not use for actual edit permission checks!
1432 * This is intented for quick UI checks.
1434 * @param $ip String IP address, uses current client if none given
1435 * @return Bool True if blocked, false otherwise
1437 function isBlockedGlobally( $ip = '' ) {
1438 if( $this->mBlockedGlobally
!== null ) {
1439 return $this->mBlockedGlobally
;
1441 // User is already an IP?
1442 if( IP
::isIPAddress( $this->getName() ) ) {
1443 $ip = $this->getName();
1448 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1449 $this->mBlockedGlobally
= (bool)$blocked;
1450 return $this->mBlockedGlobally
;
1454 * Check if user account is locked
1456 * @return Bool True if locked, false otherwise
1458 function isLocked() {
1459 if( $this->mLocked
!== null ) {
1460 return $this->mLocked
;
1463 $authUser = $wgAuth->getUserInstance( $this );
1464 $this->mLocked
= (bool)$authUser->isLocked();
1465 return $this->mLocked
;
1469 * Check if user account is hidden
1471 * @return Bool True if hidden, false otherwise
1473 function isHidden() {
1474 if( $this->mHideName
!== null ) {
1475 return $this->mHideName
;
1477 $this->getBlockedStatus();
1478 if( !$this->mHideName
) {
1480 $authUser = $wgAuth->getUserInstance( $this );
1481 $this->mHideName
= (bool)$authUser->isHidden();
1483 return $this->mHideName
;
1487 * Get the user's ID.
1488 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1491 if( $this->mId
=== null and $this->mName
!== null
1492 and User
::isIP( $this->mName
) ) {
1493 // Special case, we know the user is anonymous
1495 } elseif( $this->mId
=== null ) {
1496 // Don't load if this was initialized from an ID
1503 * Set the user and reload all fields according to a given ID
1504 * @param $v Int User ID to reload
1506 function setId( $v ) {
1508 $this->clearInstanceCache( 'id' );
1512 * Get the user name, or the IP of an anonymous user
1513 * @return String User's name or IP address
1515 function getName() {
1516 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1517 # Special case optimisation
1518 return $this->mName
;
1521 if ( $this->mName
=== false ) {
1523 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1525 return $this->mName
;
1530 * Set the user name.
1532 * This does not reload fields from the database according to the given
1533 * name. Rather, it is used to create a temporary "nonexistent user" for
1534 * later addition to the database. It can also be used to set the IP
1535 * address for an anonymous user to something other than the current
1538 * @note User::newFromName() has rougly the same function, when the named user
1540 * @param $str String New user name to set
1542 function setName( $str ) {
1544 $this->mName
= $str;
1548 * Get the user's name escaped by underscores.
1549 * @return String Username escaped by underscores.
1551 function getTitleKey() {
1552 return str_replace( ' ', '_', $this->getName() );
1556 * Check if the user has new messages.
1557 * @return Bool True if the user has new messages
1559 function getNewtalk() {
1562 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1563 if( $this->mNewtalk
=== -1 ) {
1564 $this->mNewtalk
= false; # reset talk page status
1566 # Check memcached separately for anons, who have no
1567 # entire User object stored in there.
1570 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1571 $newtalk = $wgMemc->get( $key );
1572 if( strval( $newtalk ) !== '' ) {
1573 $this->mNewtalk
= (bool)$newtalk;
1575 // Since we are caching this, make sure it is up to date by getting it
1577 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1578 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1581 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1585 return (bool)$this->mNewtalk
;
1589 * Return the talk page(s) this user has new messages on.
1590 * @return Array of String page URLs
1592 function getNewMessageLinks() {
1594 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1597 if( !$this->getNewtalk() )
1599 $up = $this->getUserPage();
1600 $utp = $up->getTalkPage();
1601 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1605 * Internal uncached check for new messages
1608 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1609 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1610 * @param $fromMaster Bool true to fetch from the master, false for a slave
1611 * @return Bool True if the user has new messages
1614 function checkNewtalk( $field, $id, $fromMaster = false ) {
1615 if ( $fromMaster ) {
1616 $db = wfGetDB( DB_MASTER
);
1618 $db = wfGetDB( DB_SLAVE
);
1620 $ok = $db->selectField( 'user_newtalk', $field,
1621 array( $field => $id ), __METHOD__
);
1622 return $ok !== false;
1626 * Add or update the new messages flag
1627 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1628 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1629 * @return Bool True if successful, false otherwise
1632 function updateNewtalk( $field, $id ) {
1633 $dbw = wfGetDB( DB_MASTER
);
1634 $dbw->insert( 'user_newtalk',
1635 array( $field => $id ),
1638 if ( $dbw->affectedRows() ) {
1639 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1642 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1648 * Clear the new messages flag for the given user
1649 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1650 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1651 * @return Bool True if successful, false otherwise
1654 function deleteNewtalk( $field, $id ) {
1655 $dbw = wfGetDB( DB_MASTER
);
1656 $dbw->delete( 'user_newtalk',
1657 array( $field => $id ),
1659 if ( $dbw->affectedRows() ) {
1660 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1663 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1669 * Update the 'You have new messages!' status.
1670 * @param $val Bool Whether the user has new messages
1672 function setNewtalk( $val ) {
1673 if( wfReadOnly() ) {
1678 $this->mNewtalk
= $val;
1680 if( $this->isAnon() ) {
1682 $id = $this->getName();
1685 $id = $this->getId();
1690 $changed = $this->updateNewtalk( $field, $id );
1692 $changed = $this->deleteNewtalk( $field, $id );
1695 if( $this->isAnon() ) {
1696 // Anons have a separate memcached space, since
1697 // user records aren't kept for them.
1698 $key = wfMemcKey( 'newtalk', 'ip', $id );
1699 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1702 $this->invalidateCache();
1707 * Generate a current or new-future timestamp to be stored in the
1708 * user_touched field when we update things.
1709 * @return String Timestamp in TS_MW format
1711 private static function newTouchedTimestamp() {
1712 global $wgClockSkewFudge;
1713 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1717 * Clear user data from memcached.
1718 * Use after applying fun updates to the database; caller's
1719 * responsibility to update user_touched if appropriate.
1721 * Called implicitly from invalidateCache() and saveSettings().
1723 private function clearSharedCache() {
1727 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1732 * Immediately touch the user data cache for this account.
1733 * Updates user_touched field, and removes account data from memcached
1734 * for reload on the next hit.
1736 function invalidateCache() {
1737 if( wfReadOnly() ) {
1742 $this->mTouched
= self
::newTouchedTimestamp();
1744 $dbw = wfGetDB( DB_MASTER
);
1745 $dbw->update( 'user',
1746 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1747 array( 'user_id' => $this->mId
),
1750 $this->clearSharedCache();
1755 * Validate the cache for this account.
1756 * @param $timestamp String A timestamp in TS_MW format
1758 function validateCache( $timestamp ) {
1760 return ( $timestamp >= $this->mTouched
);
1764 * Get the user touched timestamp
1765 * @return String timestamp
1767 function getTouched() {
1769 return $this->mTouched
;
1773 * Set the password and reset the random token.
1774 * Calls through to authentication plugin if necessary;
1775 * will have no effect if the auth plugin refuses to
1776 * pass the change through or if the legal password
1779 * As a special case, setting the password to null
1780 * wipes it, so the account cannot be logged in until
1781 * a new password is set, for instance via e-mail.
1783 * @param $str String New password to set
1784 * @throws PasswordError on failure
1786 function setPassword( $str ) {
1789 if( $str !== null ) {
1790 if( !$wgAuth->allowPasswordChange() ) {
1791 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1794 if( !$this->isValidPassword( $str ) ) {
1795 global $wgMinimalPasswordLength;
1796 $valid = $this->getPasswordValidity( $str );
1797 if ( is_array( $valid ) ) {
1798 $message = array_shift( $valid );
1802 $params = array( $wgMinimalPasswordLength );
1804 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
1808 if( !$wgAuth->setPassword( $this, $str ) ) {
1809 throw new PasswordError( wfMsg( 'externaldberror' ) );
1812 $this->setInternalPassword( $str );
1818 * Set the password and reset the random token unconditionally.
1820 * @param $str String New password to set
1822 function setInternalPassword( $str ) {
1826 if( $str === null ) {
1827 // Save an invalid hash...
1828 $this->mPassword
= '';
1830 $this->mPassword
= self
::crypt( $str );
1832 $this->mNewpassword
= '';
1833 $this->mNewpassTime
= null;
1837 * Get the user's current token.
1838 * @return String Token
1840 function getToken() {
1842 return $this->mToken
;
1846 * Set the random token (used for persistent authentication)
1847 * Called from loadDefaults() among other places.
1849 * @param $token String If specified, set the token to this value
1852 function setToken( $token = false ) {
1853 global $wgSecretKey, $wgProxyKey;
1856 if ( $wgSecretKey ) {
1857 $key = $wgSecretKey;
1858 } elseif ( $wgProxyKey ) {
1863 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1865 $this->mToken
= $token;
1870 * Set the cookie password
1872 * @param $str String New cookie password
1875 function setCookiePassword( $str ) {
1877 $this->mCookiePassword
= md5( $str );
1881 * Set the password for a password reminder or new account email
1883 * @param $str String New password to set
1884 * @param $throttle Bool If true, reset the throttle timestamp to the present
1886 function setNewpassword( $str, $throttle = true ) {
1888 $this->mNewpassword
= self
::crypt( $str );
1890 $this->mNewpassTime
= wfTimestampNow();
1895 * Has password reminder email been sent within the last
1896 * $wgPasswordReminderResendTime hours?
1899 function isPasswordReminderThrottled() {
1900 global $wgPasswordReminderResendTime;
1902 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1905 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1906 return time() < $expiry;
1910 * Get the user's e-mail address
1911 * @return String User's email address
1913 function getEmail() {
1915 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1916 return $this->mEmail
;
1920 * Get the timestamp of the user's e-mail authentication
1921 * @return String TS_MW timestamp
1923 function getEmailAuthenticationTimestamp() {
1925 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1926 return $this->mEmailAuthenticated
;
1930 * Set the user's e-mail address
1931 * @param $str String New e-mail address
1933 function setEmail( $str ) {
1935 $this->mEmail
= $str;
1936 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1940 * Get the user's real name
1941 * @return String User's real name
1943 function getRealName() {
1945 return $this->mRealName
;
1949 * Set the user's real name
1950 * @param $str String New real name
1952 function setRealName( $str ) {
1954 $this->mRealName
= $str;
1958 * Get the user's current setting for a given option.
1960 * @param $oname String The option to check
1961 * @param $defaultOverride String A default value returned if the option does not exist
1962 * @return String User's current value for the option
1963 * @see getBoolOption()
1964 * @see getIntOption()
1966 function getOption( $oname, $defaultOverride = null ) {
1967 $this->loadOptions();
1969 if ( is_null( $this->mOptions
) ) {
1970 if($defaultOverride != '') {
1971 return $defaultOverride;
1973 $this->mOptions
= User
::getDefaultOptions();
1976 if ( array_key_exists( $oname, $this->mOptions
) ) {
1977 return $this->mOptions
[$oname];
1979 return $defaultOverride;
1984 * Get all user's options
1988 public function getOptions() {
1989 $this->loadOptions();
1990 return $this->mOptions
;
1994 * Get the user's current setting for a given option, as a boolean value.
1996 * @param $oname String The option to check
1997 * @return Bool User's current value for the option
2000 function getBoolOption( $oname ) {
2001 return (bool)$this->getOption( $oname );
2006 * Get the user's current setting for a given option, as a boolean value.
2008 * @param $oname String The option to check
2009 * @param $defaultOverride Int A default value returned if the option does not exist
2010 * @return Int User's current value for the option
2013 function getIntOption( $oname, $defaultOverride=0 ) {
2014 $val = $this->getOption( $oname );
2016 $val = $defaultOverride;
2018 return intval( $val );
2022 * Set the given option for a user.
2024 * @param $oname String The option to set
2025 * @param $val mixed New value to set
2027 function setOption( $oname, $val ) {
2029 $this->loadOptions();
2031 if ( $oname == 'skin' ) {
2032 # Clear cached skin, so the new one displays immediately in Special:Preferences
2033 $this->mSkin
= null;
2036 // Explicitly NULL values should refer to defaults
2037 global $wgDefaultUserOptions;
2038 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2039 $val = $wgDefaultUserOptions[$oname];
2042 $this->mOptions
[$oname] = $val;
2046 * Reset all options to the site defaults
2048 function resetOptions() {
2049 $this->mOptions
= self
::getDefaultOptions();
2053 * Get the user's preferred date format.
2054 * @return String User's preferred date format
2056 function getDatePreference() {
2057 // Important migration for old data rows
2058 if ( is_null( $this->mDatePreference
) ) {
2060 $value = $this->getOption( 'date' );
2061 $map = $wgLang->getDatePreferenceMigrationMap();
2062 if ( isset( $map[$value] ) ) {
2063 $value = $map[$value];
2065 $this->mDatePreference
= $value;
2067 return $this->mDatePreference
;
2071 * Get the user preferred stub threshold
2073 function getStubThreshold() {
2074 global $wgMaxArticleSize; # Maximum article size, in Kb
2075 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2076 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2077 # If they have set an impossible value, disable the preference
2078 # so we can use the parser cache again.
2085 * Get the permissions this user has.
2086 * @return Array of String permission names
2088 function getRights() {
2089 if ( is_null( $this->mRights
) ) {
2090 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2091 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2092 // Force reindexation of rights when a hook has unset one of them
2093 $this->mRights
= array_values( $this->mRights
);
2095 return $this->mRights
;
2099 * Get the list of explicit group memberships this user has.
2100 * The implicit * and user groups are not included.
2101 * @return Array of String internal group names
2103 function getGroups() {
2105 return $this->mGroups
;
2109 * Get the list of implicit group memberships this user has.
2110 * This includes all explicit groups, plus 'user' if logged in,
2111 * '*' for all accounts, and autopromoted groups
2112 * @param $recache Bool Whether to avoid the cache
2113 * @return Array of String internal group names
2115 function getEffectiveGroups( $recache = false ) {
2116 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2117 wfProfileIn( __METHOD__
);
2118 $this->mEffectiveGroups
= $this->getGroups();
2119 $this->mEffectiveGroups
[] = '*';
2120 if( $this->getId() ) {
2121 $this->mEffectiveGroups
[] = 'user';
2123 $this->mEffectiveGroups
= array_unique( array_merge(
2124 $this->mEffectiveGroups
,
2125 Autopromote
::getAutopromoteGroups( $this )
2128 # Hook for additional groups
2129 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2131 wfProfileOut( __METHOD__
);
2133 return $this->mEffectiveGroups
;
2137 * Get the user's edit count.
2140 function getEditCount() {
2141 if( $this->getId() ) {
2142 if ( !isset( $this->mEditCount
) ) {
2143 /* Populate the count, if it has not been populated yet */
2144 $this->mEditCount
= User
::edits( $this->mId
);
2146 return $this->mEditCount
;
2154 * Add the user to the given group.
2155 * This takes immediate effect.
2156 * @param $group String Name of the group to add
2158 function addGroup( $group ) {
2159 $dbw = wfGetDB( DB_MASTER
);
2160 if( $this->getId() ) {
2161 $dbw->insert( 'user_groups',
2163 'ug_user' => $this->getID(),
2164 'ug_group' => $group,
2167 array( 'IGNORE' ) );
2170 $this->loadGroups();
2171 $this->mGroups
[] = $group;
2172 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2174 $this->invalidateCache();
2178 * Remove the user from the given group.
2179 * This takes immediate effect.
2180 * @param $group String Name of the group to remove
2182 function removeGroup( $group ) {
2184 $dbw = wfGetDB( DB_MASTER
);
2185 $dbw->delete( 'user_groups',
2187 'ug_user' => $this->getID(),
2188 'ug_group' => $group,
2191 $this->loadGroups();
2192 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2193 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2195 $this->invalidateCache();
2199 * Get whether the user is logged in
2202 function isLoggedIn() {
2203 return $this->getID() != 0;
2207 * Get whether the user is anonymous
2211 return !$this->isLoggedIn();
2215 * Check if user is allowed to access a feature / make an action
2216 * @param $action String action to be checked
2217 * @return Boolean: True if action is allowed, else false
2219 function isAllowed( $action = '' ) {
2220 if ( $action === '' ) {
2221 return true; // In the spirit of DWIM
2223 # Patrolling may not be enabled
2224 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2225 global $wgUseRCPatrol, $wgUseNPPatrol;
2226 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2229 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2230 # by misconfiguration: 0 == 'foo'
2231 return in_array( $action, $this->getRights(), true );
2235 * Check whether to enable recent changes patrol features for this user
2236 * @return Boolean: True or false
2238 public function useRCPatrol() {
2239 global $wgUseRCPatrol;
2240 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2244 * Check whether to enable new pages patrol features for this user
2245 * @return Bool True or false
2247 public function useNPPatrol() {
2248 global $wgUseRCPatrol, $wgUseNPPatrol;
2249 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2253 * Get the current skin, loading it if required, and setting a title
2254 * @param $t Title: the title to use in the skin
2255 * @return Skin The current skin
2256 * @todo: FIXME : need to check the old failback system [AV]
2258 function getSkin( $t = null ) {
2259 if( !$this->mSkin
) {
2261 $this->mSkin
= $this->createSkinObject();
2262 $this->mSkin
->setTitle( $wgOut->getTitle() );
2264 if ( $t && ( !$this->mSkin
->getTitle() ||
!$t->equals( $this->mSkin
->getTitle() ) ) ) {
2265 $skin = $this->createSkinObject();
2266 $skin->setTitle( $t );
2269 return $this->mSkin
;
2273 // Creates a Skin object, for getSkin()
2274 private function createSkinObject() {
2275 wfProfileIn( __METHOD__
);
2277 global $wgHiddenPrefs;
2278 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2281 $userSkin = $this->getOption( 'skin' );
2282 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2284 # if we're not allowing users to override, then use the default
2285 global $wgDefaultSkin;
2286 $userSkin = $wgDefaultSkin;
2289 $skin = Skin
::newFromKey( $userSkin );
2290 wfProfileOut( __METHOD__
);
2296 * Check the watched status of an article.
2297 * @param $title Title of the article to look at
2300 function isWatched( $title ) {
2301 $wl = WatchedItem
::fromUserTitle( $this, $title );
2302 return $wl->isWatched();
2307 * @param $title Title of the article to look at
2309 function addWatch( $title ) {
2310 $wl = WatchedItem
::fromUserTitle( $this, $title );
2312 $this->invalidateCache();
2316 * Stop watching an article.
2317 * @param $title Title of the article to look at
2319 function removeWatch( $title ) {
2320 $wl = WatchedItem
::fromUserTitle( $this, $title );
2322 $this->invalidateCache();
2326 * Clear the user's notification timestamp for the given title.
2327 * If e-notif e-mails are on, they will receive notification mails on
2328 * the next change of the page if it's watched etc.
2329 * @param $title Title of the article to look at
2331 function clearNotification( &$title ) {
2332 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2334 # Do nothing if the database is locked to writes
2335 if( wfReadOnly() ) {
2339 if( $title->getNamespace() == NS_USER_TALK
&&
2340 $title->getText() == $this->getName() ) {
2341 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2343 $this->setNewtalk( false );
2346 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2350 if( $this->isAnon() ) {
2351 // Nothing else to do...
2355 // Only update the timestamp if the page is being watched.
2356 // The query to find out if it is watched is cached both in memcached and per-invocation,
2357 // and when it does have to be executed, it can be on a slave
2358 // If this is the user's newtalk page, we always update the timestamp
2359 if( $title->getNamespace() == NS_USER_TALK
&&
2360 $title->getText() == $wgUser->getName() )
2363 } elseif ( $this->getId() == $wgUser->getId() ) {
2364 $watched = $title->userIsWatching();
2369 // If the page is watched by the user (or may be watched), update the timestamp on any
2370 // any matching rows
2372 $dbw = wfGetDB( DB_MASTER
);
2373 $dbw->update( 'watchlist',
2375 'wl_notificationtimestamp' => null
2376 ), array( /* WHERE */
2377 'wl_title' => $title->getDBkey(),
2378 'wl_namespace' => $title->getNamespace(),
2379 'wl_user' => $this->getID()
2386 * Resets all of the given user's page-change notification timestamps.
2387 * If e-notif e-mails are on, they will receive notification mails on
2388 * the next change of any watched page.
2390 * @param $currentUser Int User ID
2392 function clearAllNotifications( $currentUser ) {
2393 global $wgUseEnotif, $wgShowUpdatedMarker;
2394 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2395 $this->setNewtalk( false );
2398 if( $currentUser != 0 ) {
2399 $dbw = wfGetDB( DB_MASTER
);
2400 $dbw->update( 'watchlist',
2402 'wl_notificationtimestamp' => null
2403 ), array( /* WHERE */
2404 'wl_user' => $currentUser
2407 # We also need to clear here the "you have new message" notification for the own user_talk page
2408 # This is cleared one page view later in Article::viewUpdates();
2413 * Set this user's options from an encoded string
2414 * @param $str String Encoded options to import
2417 function decodeOptions( $str ) {
2421 $this->mOptionsLoaded
= true;
2422 $this->mOptionOverrides
= array();
2424 // If an option is not set in $str, use the default value
2425 $this->mOptions
= self
::getDefaultOptions();
2427 $a = explode( "\n", $str );
2428 foreach ( $a as $s ) {
2430 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2431 $this->mOptions
[$m[1]] = $m[2];
2432 $this->mOptionOverrides
[$m[1]] = $m[2];
2438 * Set a cookie on the user's client. Wrapper for
2439 * WebResponse::setCookie
2440 * @param $name String Name of the cookie to set
2441 * @param $value String Value to set
2442 * @param $exp Int Expiration time, as a UNIX time value;
2443 * if 0 or not specified, use the default $wgCookieExpiration
2445 protected function setCookie( $name, $value, $exp = 0 ) {
2447 $wgRequest->response()->setcookie( $name, $value, $exp );
2451 * Clear a cookie on the user's client
2452 * @param $name String Name of the cookie to clear
2454 protected function clearCookie( $name ) {
2455 $this->setCookie( $name, '', time() - 86400 );
2459 * Set the default cookies for this session on the user's client.
2461 function setCookies() {
2465 if ( 0 == $this->mId
) return;
2467 'wsUserID' => $this->mId
,
2468 'wsToken' => $this->mToken
,
2469 'wsUserName' => $this->getName()
2472 'UserID' => $this->mId
,
2473 'UserName' => $this->getName(),
2475 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2476 $cookies['Token'] = $this->mToken
;
2478 $cookies['Token'] = false;
2481 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2483 foreach ( $session as $name => $value ) {
2484 $wgRequest->setSessionData( $name, $value );
2486 foreach ( $cookies as $name => $value ) {
2487 if ( $value === false ) {
2488 $this->clearCookie( $name );
2490 $this->setCookie( $name, $value );
2496 * Log this user out.
2499 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2505 * Clear the user's cookies and session, and reset the instance cache.
2509 function doLogout() {
2512 $this->clearInstanceCache( 'defaults' );
2514 $wgRequest->setSessionData( 'wsUserID', 0 );
2516 $this->clearCookie( 'UserID' );
2517 $this->clearCookie( 'Token' );
2519 # Remember when user logged out, to prevent seeing cached pages
2520 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2524 * Save this user's settings into the database.
2525 * @todo Only rarely do all these fields need to be set!
2527 function saveSettings() {
2529 if ( wfReadOnly() ) { return; }
2530 if ( 0 == $this->mId
) { return; }
2532 $this->mTouched
= self
::newTouchedTimestamp();
2534 $dbw = wfGetDB( DB_MASTER
);
2535 $dbw->update( 'user',
2537 'user_name' => $this->mName
,
2538 'user_password' => $this->mPassword
,
2539 'user_newpassword' => $this->mNewpassword
,
2540 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2541 'user_real_name' => $this->mRealName
,
2542 'user_email' => $this->mEmail
,
2543 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2544 'user_options' => '',
2545 'user_touched' => $dbw->timestamp( $this->mTouched
),
2546 'user_token' => $this->mToken
,
2547 'user_email_token' => $this->mEmailToken
,
2548 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2549 ), array( /* WHERE */
2550 'user_id' => $this->mId
2554 $this->saveOptions();
2556 wfRunHooks( 'UserSaveSettings', array( $this ) );
2557 $this->clearSharedCache();
2558 $this->getUserPage()->invalidateCache();
2562 * If only this user's username is known, and it exists, return the user ID.
2565 function idForName() {
2566 $s = trim( $this->getName() );
2567 if ( $s === '' ) return 0;
2569 $dbr = wfGetDB( DB_SLAVE
);
2570 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2571 if ( $id === false ) {
2578 * Add a user to the database, return the user object
2580 * @param $name String Username to add
2581 * @param $params Array of Strings Non-default parameters to save to the database:
2582 * - password The user's password. Password logins will be disabled if this is omitted.
2583 * - newpassword A temporary password mailed to the user
2584 * - email The user's email address
2585 * - email_authenticated The email authentication timestamp
2586 * - real_name The user's real name
2587 * - options An associative array of non-default options
2588 * - token Random authentication token. Do not set.
2589 * - registration Registration timestamp. Do not set.
2591 * @return User object, or null if the username already exists
2593 static function createNew( $name, $params = array() ) {
2596 if ( isset( $params['options'] ) ) {
2597 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2598 unset( $params['options'] );
2600 $dbw = wfGetDB( DB_MASTER
);
2601 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2604 'user_id' => $seqVal,
2605 'user_name' => $name,
2606 'user_password' => $user->mPassword
,
2607 'user_newpassword' => $user->mNewpassword
,
2608 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2609 'user_email' => $user->mEmail
,
2610 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2611 'user_real_name' => $user->mRealName
,
2612 'user_options' => '',
2613 'user_token' => $user->mToken
,
2614 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2615 'user_editcount' => 0,
2617 foreach ( $params as $name => $value ) {
2618 $fields["user_$name"] = $value;
2620 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2621 if ( $dbw->affectedRows() ) {
2622 $newUser = User
::newFromId( $dbw->insertId() );
2630 * Add this existing user object to the database
2632 function addToDatabase() {
2634 $dbw = wfGetDB( DB_MASTER
);
2635 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2636 $dbw->insert( 'user',
2638 'user_id' => $seqVal,
2639 'user_name' => $this->mName
,
2640 'user_password' => $this->mPassword
,
2641 'user_newpassword' => $this->mNewpassword
,
2642 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2643 'user_email' => $this->mEmail
,
2644 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2645 'user_real_name' => $this->mRealName
,
2646 'user_options' => '',
2647 'user_token' => $this->mToken
,
2648 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2649 'user_editcount' => 0,
2652 $this->mId
= $dbw->insertId();
2654 // Clear instance cache other than user table data, which is already accurate
2655 $this->clearInstanceCache();
2657 $this->saveOptions();
2661 * If this (non-anonymous) user is blocked, block any IP address
2662 * they've successfully logged in from.
2664 function spreadBlock() {
2665 wfDebug( __METHOD__
. "()\n" );
2667 if ( $this->mId
== 0 ) {
2671 $userblock = Block
::newFromDB( '', $this->mId
);
2672 if ( !$userblock ) {
2676 $userblock->doAutoblock( wfGetIP() );
2680 * Generate a string which will be different for any combination of
2681 * user options which would produce different parser output.
2682 * This will be used as part of the hash key for the parser cache,
2683 * so users with the same options can share the same cached data
2686 * Extensions which require it should install 'PageRenderingHash' hook,
2687 * which will give them a chance to modify this key based on their own
2690 * @deprecated @since 1.17 use the ParserOptions object to get the relevant options
2691 * @return String Page rendering hash
2693 function getPageRenderingHash() {
2694 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2696 return $this->mHash
;
2698 wfDeprecated( __METHOD__
);
2700 // stubthreshold is only included below for completeness,
2701 // since it disables the parser cache, its value will always
2702 // be 0 when this function is called by parsercache.
2704 $confstr = $this->getOption( 'math' );
2705 $confstr .= '!' . $this->getStubThreshold();
2706 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2707 $confstr .= '!' . $this->getDatePreference();
2709 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2710 $confstr .= '!' . $wgLang->getCode();
2711 $confstr .= '!' . $this->getOption( 'thumbsize' );
2712 // add in language specific options, if any
2713 $extra = $wgContLang->getExtraHashOptions();
2716 // Since the skin could be overloading link(), it should be
2717 // included here but in practice, none of our skins do that.
2719 $confstr .= $wgRenderHashAppend;
2721 // Give a chance for extensions to modify the hash, if they have
2722 // extra options or other effects on the parser cache.
2723 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2725 // Make it a valid memcached key fragment
2726 $confstr = str_replace( ' ', '_', $confstr );
2727 $this->mHash
= $confstr;
2732 * Get whether the user is explicitly blocked from account creation.
2735 function isBlockedFromCreateAccount() {
2736 $this->getBlockedStatus();
2737 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2741 * Get whether the user is blocked from using Special:Emailuser.
2744 function isBlockedFromEmailuser() {
2745 $this->getBlockedStatus();
2746 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2750 * Get whether the user is allowed to create an account.
2753 function isAllowedToCreateAccount() {
2754 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2758 * Get this user's personal page title.
2760 * @return Title: User's personal page title
2762 function getUserPage() {
2763 return Title
::makeTitle( NS_USER
, $this->getName() );
2767 * Get this user's talk page title.
2769 * @return Title: User's talk page title
2771 function getTalkPage() {
2772 $title = $this->getUserPage();
2773 return $title->getTalkPage();
2777 * Get the maximum valid user ID.
2778 * @return Integer: User ID
2781 function getMaxID() {
2782 static $res; // cache
2784 if ( isset( $res ) ) {
2787 $dbr = wfGetDB( DB_SLAVE
);
2788 return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__
);
2793 * Determine whether the user is a newbie. Newbies are either
2794 * anonymous IPs, or the most recently created accounts.
2797 function isNewbie() {
2798 return !$this->isAllowed( 'autoconfirmed' );
2802 * Check to see if the given clear-text password is one of the accepted passwords
2803 * @param $password String: user password.
2804 * @return Boolean: True if the given password is correct, otherwise False.
2806 function checkPassword( $password ) {
2807 global $wgAuth, $wgLegacyEncoding;
2810 // Even though we stop people from creating passwords that
2811 // are shorter than this, doesn't mean people wont be able
2812 // to. Certain authentication plugins do NOT want to save
2813 // domain passwords in a mysql database, so we should
2814 // check this (in case $wgAuth->strict() is false).
2815 if( !$this->isValidPassword( $password ) ) {
2819 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2821 } elseif( $wgAuth->strict() ) {
2822 /* Auth plugin doesn't allow local authentication */
2824 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2825 /* Auth plugin doesn't allow local authentication for this user name */
2828 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2830 } elseif ( $wgLegacyEncoding ) {
2831 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2832 # Check for this with iconv
2833 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2834 if ( $cp1252Password != $password &&
2835 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
2844 * Check if the given clear-text password matches the temporary password
2845 * sent by e-mail for password reset operations.
2846 * @return Boolean: True if matches, false otherwise
2848 function checkTemporaryPassword( $plaintext ) {
2849 global $wgNewPasswordExpiry;
2850 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2851 if ( is_null( $this->mNewpassTime
) ) {
2854 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2855 return ( time() < $expiry );
2862 * Initialize (if necessary) and return a session token value
2863 * which can be used in edit forms to show that the user's
2864 * login credentials aren't being hijacked with a foreign form
2867 * @param $salt String|Array of Strings Optional function-specific data for hashing
2868 * @param $request WebRequest object to use or null to use $wgRequest
2869 * @return String The new edit token
2871 function editToken( $salt = '', $request = null ) {
2872 if ( $request == null ) {
2874 $request = $wgRequest;
2877 if ( $this->isAnon() ) {
2878 return EDIT_TOKEN_SUFFIX
;
2880 $token = $request->getSessionData( 'wsEditToken' );
2881 if ( $token === null ) {
2882 $token = self
::generateToken();
2883 $request->setSessionData( 'wsEditToken', $token );
2885 if( is_array( $salt ) ) {
2886 $salt = implode( '|', $salt );
2888 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2893 * Generate a looking random token for various uses.
2895 * @param $salt String Optional salt value
2896 * @return String The new random token
2898 public static function generateToken( $salt = '' ) {
2899 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2900 return md5( $token . $salt );
2904 * Check given value against the token value stored in the session.
2905 * A match should confirm that the form was submitted from the
2906 * user's own login session, not a form submission from a third-party
2909 * @param $val String Input value to compare
2910 * @param $salt String Optional function-specific data for hashing
2911 * @param $request WebRequest object to use or null to use $wgRequest
2912 * @return Boolean: Whether the token matches
2914 function matchEditToken( $val, $salt = '', $request = null ) {
2915 $sessionToken = $this->editToken( $salt, $request );
2916 if ( $val != $sessionToken ) {
2917 wfDebug( "User::matchEditToken: broken session data\n" );
2919 return $val == $sessionToken;
2923 * Check given value against the token value stored in the session,
2924 * ignoring the suffix.
2926 * @param $val String Input value to compare
2927 * @param $salt String Optional function-specific data for hashing
2928 * @param $request WebRequest object to use or null to use $wgRequest
2929 * @return Boolean: Whether the token matches
2931 function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
2932 $sessionToken = $this->editToken( $salt, $request );
2933 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2937 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2938 * mail to the user's given address.
2940 * @param $type String: message to send, either "created", "changed" or "set"
2941 * @return Status object
2943 function sendConfirmationMail( $type = 'created' ) {
2945 $expiration = null; // gets passed-by-ref and defined in next line.
2946 $token = $this->confirmationToken( $expiration );
2947 $url = $this->confirmationTokenUrl( $token );
2948 $invalidateURL = $this->invalidationTokenUrl( $token );
2949 $this->saveSettings();
2951 if ( $type == 'created' ||
$type === false ) {
2952 $message = 'confirmemail_body';
2953 } elseif ( $type === true ) {
2954 $message = 'confirmemail_body_changed';
2956 $message = 'confirmemail_body_' . $type;
2959 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2964 $wgLang->timeanddate( $expiration, false ),
2966 $wgLang->date( $expiration, false ),
2967 $wgLang->time( $expiration, false ) ) );
2971 * Send an e-mail to this user's account. Does not check for
2972 * confirmed status or validity.
2974 * @param $subject String Message subject
2975 * @param $body String Message body
2976 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
2977 * @param $replyto String Reply-To address
2980 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2981 if( is_null( $from ) ) {
2982 global $wgPasswordSender, $wgPasswordSenderName;
2983 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
2985 $sender = new MailAddress( $from );
2988 $to = new MailAddress( $this );
2989 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2993 * Generate, store, and return a new e-mail confirmation code.
2994 * A hash (unsalted, since it's used as a key) is stored.
2996 * @note Call saveSettings() after calling this function to commit
2997 * this change to the database.
2999 * @param[out] &$expiration \mixed Accepts the expiration time
3000 * @return String New token
3003 function confirmationToken( &$expiration ) {
3004 global $wgUserEmailConfirmationTokenExpiry;
3006 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3007 $expiration = wfTimestamp( TS_MW
, $expires );
3008 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
3009 $hash = md5( $token );
3011 $this->mEmailToken
= $hash;
3012 $this->mEmailTokenExpires
= $expiration;
3017 * Return a URL the user can use to confirm their email address.
3018 * @param $token String Accepts the email confirmation token
3019 * @return String New token URL
3022 function confirmationTokenUrl( $token ) {
3023 return $this->getTokenUrl( 'ConfirmEmail', $token );
3027 * Return a URL the user can use to invalidate their email address.
3028 * @param $token String Accepts the email confirmation token
3029 * @return String New token URL
3032 function invalidationTokenUrl( $token ) {
3033 return $this->getTokenUrl( 'Invalidateemail', $token );
3037 * Internal function to format the e-mail validation/invalidation URLs.
3038 * This uses $wgArticlePath directly as a quickie hack to use the
3039 * hardcoded English names of the Special: pages, for ASCII safety.
3041 * @note Since these URLs get dropped directly into emails, using the
3042 * short English names avoids insanely long URL-encoded links, which
3043 * also sometimes can get corrupted in some browsers/mailers
3044 * (bug 6957 with Gmail and Internet Explorer).
3046 * @param $page String Special page
3047 * @param $token String Token
3048 * @return String Formatted URL
3050 protected function getTokenUrl( $page, $token ) {
3051 global $wgArticlePath;
3055 "Special:$page/$token",
3060 * Mark the e-mail address confirmed.
3062 * @note Call saveSettings() after calling this function to commit the change.
3064 function confirmEmail() {
3065 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3066 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3071 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3072 * address if it was already confirmed.
3074 * @note Call saveSettings() after calling this function to commit the change.
3076 function invalidateEmail() {
3078 $this->mEmailToken
= null;
3079 $this->mEmailTokenExpires
= null;
3080 $this->setEmailAuthenticationTimestamp( null );
3081 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3086 * Set the e-mail authentication timestamp.
3087 * @param $timestamp String TS_MW timestamp
3089 function setEmailAuthenticationTimestamp( $timestamp ) {
3091 $this->mEmailAuthenticated
= $timestamp;
3092 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3096 * Is this user allowed to send e-mails within limits of current
3097 * site configuration?
3100 function canSendEmail() {
3101 global $wgEnableEmail, $wgEnableUserEmail;
3102 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3105 $canSend = $this->isEmailConfirmed();
3106 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3111 * Is this user allowed to receive e-mails within limits of current
3112 * site configuration?
3115 function canReceiveEmail() {
3116 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3120 * Is this user's e-mail address valid-looking and confirmed within
3121 * limits of the current site configuration?
3123 * @note If $wgEmailAuthentication is on, this may require the user to have
3124 * confirmed their address by returning a code or using a password
3125 * sent to the address from the wiki.
3129 function isEmailConfirmed() {
3130 global $wgEmailAuthentication;
3133 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3134 if( $this->isAnon() )
3136 if( !self
::isValidEmailAddr( $this->mEmail
) )
3138 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3147 * Check whether there is an outstanding request for e-mail confirmation.
3150 function isEmailConfirmationPending() {
3151 global $wgEmailAuthentication;
3152 return $wgEmailAuthentication &&
3153 !$this->isEmailConfirmed() &&
3154 $this->mEmailToken
&&
3155 $this->mEmailTokenExpires
> wfTimestamp();
3159 * Get the timestamp of account creation.
3161 * @return String|Bool Timestamp of account creation, or false for
3162 * non-existent/anonymous user accounts.
3164 public function getRegistration() {
3165 return $this->getId() > 0
3166 ?
$this->mRegistration
3171 * Get the timestamp of the first edit
3173 * @return String|Bool Timestamp of first edit, or false for
3174 * non-existent/anonymous user accounts.
3176 public function getFirstEditTimestamp() {
3177 if( $this->getId() == 0 ) {
3178 return false; // anons
3180 $dbr = wfGetDB( DB_SLAVE
);
3181 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3182 array( 'rev_user' => $this->getId() ),
3184 array( 'ORDER BY' => 'rev_timestamp ASC' )
3187 return false; // no edits
3189 return wfTimestamp( TS_MW
, $time );
3193 * Get the permissions associated with a given list of groups
3195 * @param $groups Array of Strings List of internal group names
3196 * @return Array of Strings List of permission key names for given groups combined
3198 static function getGroupPermissions( $groups ) {
3199 global $wgGroupPermissions, $wgRevokePermissions;
3201 // grant every granted permission first
3202 foreach( $groups as $group ) {
3203 if( isset( $wgGroupPermissions[$group] ) ) {
3204 $rights = array_merge( $rights,
3205 // array_filter removes empty items
3206 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3209 // now revoke the revoked permissions
3210 foreach( $groups as $group ) {
3211 if( isset( $wgRevokePermissions[$group] ) ) {
3212 $rights = array_diff( $rights,
3213 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3216 return array_unique( $rights );
3220 * Get all the groups who have a given permission
3222 * @param $role String Role to check
3223 * @return Array of Strings List of internal group names with the given permission
3225 static function getGroupsWithPermission( $role ) {
3226 global $wgGroupPermissions;
3227 $allowedGroups = array();
3228 foreach ( $wgGroupPermissions as $group => $rights ) {
3229 if ( isset( $rights[$role] ) && $rights[$role] ) {
3230 $allowedGroups[] = $group;
3233 return $allowedGroups;
3237 * Get the localized descriptive name for a group, if it exists
3239 * @param $group String Internal group name
3240 * @return String Localized descriptive group name
3242 static function getGroupName( $group ) {
3243 $msg = wfMessage( "group-$group" );
3244 return $msg->isBlank() ?
$group : $msg->text();
3248 * Get the localized descriptive name for a member of a group, if it exists
3250 * @param $group String Internal group name
3251 * @return String Localized name for group member
3253 static function getGroupMember( $group ) {
3254 $msg = wfMessage( "group-$group-member" );
3255 return $msg->isBlank() ?
$group : $msg->text();
3259 * Return the set of defined explicit groups.
3260 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3261 * are not included, as they are defined automatically, not in the database.
3262 * @return Array of internal group names
3264 static function getAllGroups() {
3265 global $wgGroupPermissions, $wgRevokePermissions;
3267 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3268 self
::getImplicitGroups()
3273 * Get a list of all available permissions.
3274 * @return Array of permission names
3276 static function getAllRights() {
3277 if ( self
::$mAllRights === false ) {
3278 global $wgAvailableRights;
3279 if ( count( $wgAvailableRights ) ) {
3280 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3282 self
::$mAllRights = self
::$mCoreRights;
3284 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3286 return self
::$mAllRights;
3290 * Get a list of implicit groups
3291 * @return Array of Strings Array of internal group names
3293 public static function getImplicitGroups() {
3294 global $wgImplicitGroups;
3295 $groups = $wgImplicitGroups;
3296 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3301 * Get the title of a page describing a particular group
3303 * @param $group String Internal group name
3304 * @return Title|Bool Title of the page if it exists, false otherwise
3306 static function getGroupPage( $group ) {
3307 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3308 if( $msg->exists() ) {
3309 $title = Title
::newFromText( $msg->text() );
3310 if( is_object( $title ) )
3317 * Create a link to the group in HTML, if available;
3318 * else return the group name.
3320 * @param $group String Internal name of the group
3321 * @param $text String The text of the link
3322 * @return String HTML link to the group
3324 static function makeGroupLinkHTML( $group, $text = '' ) {
3326 $text = self
::getGroupName( $group );
3328 $title = self
::getGroupPage( $group );
3331 $sk = $wgUser->getSkin();
3332 return $sk->link( $title, htmlspecialchars( $text ) );
3339 * Create a link to the group in Wikitext, if available;
3340 * else return the group name.
3342 * @param $group String Internal name of the group
3343 * @param $text String The text of the link
3344 * @return String Wikilink to the group
3346 static function makeGroupLinkWiki( $group, $text = '' ) {
3348 $text = self
::getGroupName( $group );
3350 $title = self
::getGroupPage( $group );
3352 $page = $title->getPrefixedText();
3353 return "[[$page|$text]]";
3360 * Returns an array of the groups that a particular group can add/remove.
3362 * @param $group String: the group to check for whether it can add/remove
3363 * @return Array array( 'add' => array( addablegroups ),
3364 * 'remove' => array( removablegroups ),
3365 * 'add-self' => array( addablegroups to self),
3366 * 'remove-self' => array( removable groups from self) )
3368 static function changeableByGroup( $group ) {
3369 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3371 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3372 if( empty( $wgAddGroups[$group] ) ) {
3373 // Don't add anything to $groups
3374 } elseif( $wgAddGroups[$group] === true ) {
3375 // You get everything
3376 $groups['add'] = self
::getAllGroups();
3377 } elseif( is_array( $wgAddGroups[$group] ) ) {
3378 $groups['add'] = $wgAddGroups[$group];
3381 // Same thing for remove
3382 if( empty( $wgRemoveGroups[$group] ) ) {
3383 } elseif( $wgRemoveGroups[$group] === true ) {
3384 $groups['remove'] = self
::getAllGroups();
3385 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3386 $groups['remove'] = $wgRemoveGroups[$group];
3389 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3390 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3391 foreach( $wgGroupsAddToSelf as $key => $value ) {
3392 if( is_int( $key ) ) {
3393 $wgGroupsAddToSelf['user'][] = $value;
3398 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3399 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3400 if( is_int( $key ) ) {
3401 $wgGroupsRemoveFromSelf['user'][] = $value;
3406 // Now figure out what groups the user can add to him/herself
3407 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3408 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3409 // No idea WHY this would be used, but it's there
3410 $groups['add-self'] = User
::getAllGroups();
3411 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3412 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3415 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3416 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3417 $groups['remove-self'] = User
::getAllGroups();
3418 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3419 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3426 * Returns an array of groups that this user can add and remove
3427 * @return Array array( 'add' => array( addablegroups ),
3428 * 'remove' => array( removablegroups ),
3429 * 'add-self' => array( addablegroups to self),
3430 * 'remove-self' => array( removable groups from self) )
3432 function changeableGroups() {
3433 if( $this->isAllowed( 'userrights' ) ) {
3434 // This group gives the right to modify everything (reverse-
3435 // compatibility with old "userrights lets you change
3437 // Using array_merge to make the groups reindexed
3438 $all = array_merge( User
::getAllGroups() );
3442 'add-self' => array(),
3443 'remove-self' => array()
3447 // Okay, it's not so simple, we will have to go through the arrays
3450 'remove' => array(),
3451 'add-self' => array(),
3452 'remove-self' => array()
3454 $addergroups = $this->getEffectiveGroups();
3456 foreach( $addergroups as $addergroup ) {
3457 $groups = array_merge_recursive(
3458 $groups, $this->changeableByGroup( $addergroup )
3460 $groups['add'] = array_unique( $groups['add'] );
3461 $groups['remove'] = array_unique( $groups['remove'] );
3462 $groups['add-self'] = array_unique( $groups['add-self'] );
3463 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3469 * Increment the user's edit-count field.
3470 * Will have no effect for anonymous users.
3472 function incEditCount() {
3473 if( !$this->isAnon() ) {
3474 $dbw = wfGetDB( DB_MASTER
);
3475 $dbw->update( 'user',
3476 array( 'user_editcount=user_editcount+1' ),
3477 array( 'user_id' => $this->getId() ),
3480 // Lazy initialization check...
3481 if( $dbw->affectedRows() == 0 ) {
3482 // Pull from a slave to be less cruel to servers
3483 // Accuracy isn't the point anyway here
3484 $dbr = wfGetDB( DB_SLAVE
);
3485 $count = $dbr->selectField( 'revision',
3487 array( 'rev_user' => $this->getId() ),
3490 // Now here's a goddamn hack...
3491 if( $dbr !== $dbw ) {
3492 // If we actually have a slave server, the count is
3493 // at least one behind because the current transaction
3494 // has not been committed and replicated.
3497 // But if DB_SLAVE is selecting the master, then the
3498 // count we just read includes the revision that was
3499 // just added in the working transaction.
3502 $dbw->update( 'user',
3503 array( 'user_editcount' => $count ),
3504 array( 'user_id' => $this->getId() ),
3508 // edit count in user cache too
3509 $this->invalidateCache();
3513 * Get the description of a given right
3515 * @param $right String Right to query
3516 * @return String Localized description of the right
3518 static function getRightDescription( $right ) {
3519 $key = "right-$right";
3520 $name = wfMsg( $key );
3521 return $name == '' ||
wfEmptyMsg( $key )
3527 * Make an old-style password hash
3529 * @param $password String Plain-text password
3530 * @param $userId String User ID
3531 * @return String Password hash
3533 static function oldCrypt( $password, $userId ) {
3534 global $wgPasswordSalt;
3535 if ( $wgPasswordSalt ) {
3536 return md5( $userId . '-' . md5( $password ) );
3538 return md5( $password );
3543 * Make a new-style password hash
3545 * @param $password String Plain-text password
3546 * @param $salt String Optional salt, may be random or the user ID.
3547 * If unspecified or false, will generate one automatically
3548 * @return String Password hash
3550 static function crypt( $password, $salt = false ) {
3551 global $wgPasswordSalt;
3554 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3558 if( $wgPasswordSalt ) {
3559 if ( $salt === false ) {
3560 $salt = substr( wfGenerateToken(), 0, 8 );
3562 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3564 return ':A:' . md5( $password );
3569 * Compare a password hash with a plain-text password. Requires the user
3570 * ID if there's a chance that the hash is an old-style hash.
3572 * @param $hash String Password hash
3573 * @param $password String Plain-text password to compare
3574 * @param $userId String User ID for old-style password salt
3577 static function comparePasswords( $hash, $password, $userId = false ) {
3578 $type = substr( $hash, 0, 3 );
3581 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3585 if ( $type == ':A:' ) {
3587 return md5( $password ) === substr( $hash, 3 );
3588 } elseif ( $type == ':B:' ) {
3590 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3591 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3594 return self
::oldCrypt( $password, $userId ) === $hash;
3599 * Add a newuser log entry for this user
3601 * @param $byEmail Boolean: account made by email?
3602 * @param $reason String: user supplied reason
3604 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3605 global $wgUser, $wgContLang, $wgNewUserLog;
3606 if( empty( $wgNewUserLog ) ) {
3607 return true; // disabled
3610 if( $this->getName() == $wgUser->getName() ) {
3613 $action = 'create2';
3615 if ( $reason === '' ) {
3616 $reason = wfMsgForContent( 'newuserlog-byemail' );
3618 $reason = $wgContLang->commaList( array(
3619 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3623 $log = new LogPage( 'newusers' );
3626 $this->getUserPage(),
3628 array( $this->getId() )
3634 * Add an autocreate newuser log entry for this user
3635 * Used by things like CentralAuth and perhaps other authplugins.
3637 public function addNewUserLogEntryAutoCreate() {
3638 global $wgNewUserLog, $wgLogAutocreatedAccounts;
3639 if( !$wgNewUserLog ||
!$wgLogAutocreatedAccounts ) {
3640 return true; // disabled
3642 $log = new LogPage( 'newusers', false );
3643 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3647 protected function loadOptions() {
3649 if ( $this->mOptionsLoaded ||
!$this->getId() )
3652 $this->mOptions
= self
::getDefaultOptions();
3654 // Maybe load from the object
3655 if ( !is_null( $this->mOptionOverrides
) ) {
3656 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3657 foreach( $this->mOptionOverrides
as $key => $value ) {
3658 $this->mOptions
[$key] = $value;
3661 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
3662 // Load from database
3663 $dbr = wfGetDB( DB_SLAVE
);
3665 $res = $dbr->select(
3668 array( 'up_user' => $this->getId() ),
3672 foreach ( $res as $row ) {
3673 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3674 $this->mOptions
[$row->up_property
] = $row->up_value
;
3678 $this->mOptionsLoaded
= true;
3680 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3683 protected function saveOptions() {
3684 global $wgAllowPrefChange;
3686 $extuser = ExternalUser
::newFromUser( $this );
3688 $this->loadOptions();
3689 $dbw = wfGetDB( DB_MASTER
);
3691 $insert_rows = array();
3693 $saveOptions = $this->mOptions
;
3695 // Allow hooks to abort, for instance to save to a global profile.
3696 // Reset options to default state before saving.
3697 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3700 foreach( $saveOptions as $key => $value ) {
3701 # Don't bother storing default values
3702 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3703 !( $value === false ||
is_null($value) ) ) ||
3704 $value != self
::getDefaultOption( $key ) ) {
3705 $insert_rows[] = array(
3706 'up_user' => $this->getId(),
3707 'up_property' => $key,
3708 'up_value' => $value,
3711 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3712 switch ( $wgAllowPrefChange[$key] ) {
3718 $extuser->setPref( $key, $value );
3724 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3725 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3730 * Provide an array of HTML5 attributes to put on an input element
3731 * intended for the user to enter a new password. This may include
3732 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3734 * Do *not* use this when asking the user to enter his current password!
3735 * Regardless of configuration, users may have invalid passwords for whatever
3736 * reason (e.g., they were set before requirements were tightened up).
3737 * Only use it when asking for a new password, like on account creation or
3740 * Obviously, you still need to do server-side checking.
3742 * NOTE: A combination of bugs in various browsers means that this function
3743 * actually just returns array() unconditionally at the moment. May as
3744 * well keep it around for when the browser bugs get fixed, though.
3746 * FIXME : This does not belong here; put it in Html or Linker or somewhere
3748 * @return array Array of HTML attributes suitable for feeding to
3749 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3750 * That will potentially output invalid XHTML 1.0 Transitional, and will
3751 * get confused by the boolean attribute syntax used.)
3753 public static function passwordChangeInputAttribs() {
3754 global $wgMinimalPasswordLength;
3756 if ( $wgMinimalPasswordLength == 0 ) {
3760 # Note that the pattern requirement will always be satisfied if the
3761 # input is empty, so we need required in all cases.
3763 # FIXME (bug 23769): This needs to not claim the password is required
3764 # if e-mail confirmation is being used. Since HTML5 input validation
3765 # is b0rked anyway in some browsers, just return nothing. When it's
3766 # re-enabled, fix this code to not output required for e-mail
3768 #$ret = array( 'required' );
3771 # We can't actually do this right now, because Opera 9.6 will print out
3772 # the entered password visibly in its error message! When other
3773 # browsers add support for this attribute, or Opera fixes its support,
3774 # we can add support with a version check to avoid doing this on Opera
3775 # versions where it will be a problem. Reported to Opera as
3776 # DSK-262266, but they don't have a public bug tracker for us to follow.
3778 if ( $wgMinimalPasswordLength > 1 ) {
3779 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3780 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3781 $wgMinimalPasswordLength );