3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Int Number of characters in user_token field.
27 define( 'USER_TOKEN_LENGTH', 32 );
30 * Int Serialized record version.
33 define( 'MW_USER_VERSION', 8 );
36 * String Some punctuation to prevent editing from broken text-mangling proxies.
39 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
42 * Thrown by User::setPassword() on error.
45 class PasswordError
extends MWException
{
50 * The User object encapsulates all of the user-specific settings (user_id,
51 * name, rights, password, email address, options, last login time). Client
52 * classes use the getXXX() functions to access these fields. These functions
53 * do all the work of determining whether the user is logged in,
54 * whether the requested option can be satisfied from cookies or
55 * whether a database query is needed. Most of the settings needed
56 * for rendering normal pages are set in the cookie to minimize use
61 * Global constants made accessible as class constants so that autoloader
64 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
65 const MW_USER_VERSION
= MW_USER_VERSION
;
66 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
69 * Maximum items in $mWatchedItems
71 const MAX_WATCHED_ITEMS_CACHE
= 100;
74 * Array of Strings List of member variables which are saved to the
75 * shared cache (memcached). Any operation which changes the
76 * corresponding database fields must call a cache-clearing function.
79 static $mCacheVars = array(
90 'mEmailAuthenticated',
97 // user_properties table
102 * Array of Strings Core rights.
103 * Each of these should have a corresponding message of the form
107 static $mCoreRights = array(
127 'editusercssjs', #deprecated
139 'move-rootuserpages',
143 'override-export-depth',
166 'userrights-interwiki',
170 * String Cached results of getAllRights()
172 static $mAllRights = false;
174 /** @name Cache variables */
176 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
177 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
178 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
179 $mGroups, $mOptionOverrides;
183 * Bool Whether the cache variables have been loaded.
189 * Array with already loaded items or true if all items have been loaded.
191 private $mLoadedItems = array();
195 * String Initialization data source if mLoadedItems!==true. May be one of:
196 * - 'defaults' anonymous user initialised from class defaults
197 * - 'name' initialise from mName
198 * - 'id' initialise from mId
199 * - 'session' log in from cookies or session if possible
201 * Use the User::newFrom*() family of functions to set this.
206 * Lazy-initialized variables, invalidated with clearInstanceCache
208 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
209 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
210 $mLocked, $mHideName, $mOptions;
230 private $mBlockedFromCreateAccount = false;
235 private $mWatchedItems = array();
237 static $idCacheByName = array();
240 * Lightweight constructor for an anonymous user.
241 * Use the User::newFrom* factory functions for other kinds of users.
245 * @see newFromConfirmationCode()
246 * @see newFromSession()
249 function __construct() {
250 $this->clearInstanceCache( 'defaults' );
256 function __toString(){
257 return $this->getName();
261 * Load the user table data for this object from the source given by mFrom.
263 public function load() {
264 if ( $this->mLoadedItems
=== true ) {
267 wfProfileIn( __METHOD__
);
269 # Set it now to avoid infinite recursion in accessors
270 $this->mLoadedItems
= true;
272 switch ( $this->mFrom
) {
274 $this->loadDefaults();
277 $this->mId
= self
::idFromName( $this->mName
);
279 # Nonexistent user placeholder object
280 $this->loadDefaults( $this->mName
);
289 if( !$this->loadFromSession() ) {
290 // Loading from session failed. Load defaults.
291 $this->loadDefaults();
293 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
296 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
298 wfProfileOut( __METHOD__
);
302 * Load user table data, given mId has already been set.
303 * @return Bool false if the ID does not exist, true otherwise
305 public function loadFromId() {
307 if ( $this->mId
== 0 ) {
308 $this->loadDefaults();
313 $key = wfMemcKey( 'user', 'id', $this->mId
);
314 $data = $wgMemc->get( $key );
315 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
316 # Object is expired, load from DB
321 wfDebug( "User: cache miss for user {$this->mId}\n" );
323 if ( !$this->loadFromDatabase() ) {
324 # Can't load from ID, user is anonymous
327 $this->saveToCache();
329 wfDebug( "User: got user {$this->mId} from cache\n" );
331 foreach ( self
::$mCacheVars as $name ) {
332 $this->$name = $data[$name];
339 * Save user data to the shared cache
341 public function saveToCache() {
344 $this->loadOptions();
345 if ( $this->isAnon() ) {
346 // Anonymous users are uncached
350 foreach ( self
::$mCacheVars as $name ) {
351 $data[$name] = $this->$name;
353 $data['mVersion'] = MW_USER_VERSION
;
354 $key = wfMemcKey( 'user', 'id', $this->mId
);
356 $wgMemc->set( $key, $data );
359 /** @name newFrom*() static factory methods */
363 * Static factory method for creation from username.
365 * This is slightly less efficient than newFromId(), so use newFromId() if
366 * you have both an ID and a name handy.
368 * @param $name String Username, validated by Title::newFromText()
369 * @param $validate String|Bool Validate username. Takes the same parameters as
370 * User::getCanonicalName(), except that true is accepted as an alias
371 * for 'valid', for BC.
373 * @return User object, or false if the username is invalid
374 * (e.g. if it contains illegal characters or is an IP address). If the
375 * username is not present in the database, the result will be a user object
376 * with a name, zero user ID and default settings.
378 public static function newFromName( $name, $validate = 'valid' ) {
379 if ( $validate === true ) {
382 $name = self
::getCanonicalName( $name, $validate );
383 if ( $name === false ) {
386 # Create unloaded user object
390 $u->setItemLoaded( 'name' );
396 * Static factory method for creation from a given user ID.
398 * @param $id Int Valid user ID
399 * @return User The corresponding User object
401 public static function newFromId( $id ) {
405 $u->setItemLoaded( 'id' );
410 * Factory method to fetch whichever user has a given email confirmation code.
411 * This code is generated when an account is created or its e-mail address
414 * If the code is invalid or has expired, returns NULL.
416 * @param $code String Confirmation code
417 * @return User object, or null
419 public static function newFromConfirmationCode( $code ) {
420 $dbr = wfGetDB( DB_SLAVE
);
421 $id = $dbr->selectField( 'user', 'user_id', array(
422 'user_email_token' => md5( $code ),
423 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
425 if( $id !== false ) {
426 return User
::newFromId( $id );
433 * Create a new user object using data from session or cookies. If the
434 * login credentials are invalid, the result is an anonymous user.
436 * @param $request WebRequest object to use; $wgRequest will be used if
438 * @return User object
440 public static function newFromSession( WebRequest
$request = null ) {
442 $user->mFrom
= 'session';
443 $user->mRequest
= $request;
448 * Create a new user object from a user row.
449 * The row should have the following fields from the user table in it:
450 * - either user_name or user_id to load further data if needed (or both)
452 * - all other fields (email, password, etc.)
453 * It is useless to provide the remaining fields if either user_id,
454 * user_name and user_real_name are not provided because the whole row
455 * will be loaded once more from the database when accessing them.
457 * @param $row Array A row from the user table
460 public static function newFromRow( $row ) {
462 $user->loadFromRow( $row );
469 * Get the username corresponding to a given user ID
470 * @param $id Int User ID
471 * @return String|bool The corresponding username
473 public static function whoIs( $id ) {
474 return UserCache
::singleton()->getProp( $id, 'name' );
478 * Get the real name of a user given their user ID
480 * @param $id Int User ID
481 * @return String|bool The corresponding user's real name
483 public static function whoIsReal( $id ) {
484 return UserCache
::singleton()->getProp( $id, 'real_name' );
488 * Get database id given a user name
489 * @param $name String Username
490 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
492 public static function idFromName( $name ) {
493 $nt = Title
::makeTitleSafe( NS_USER
, $name );
494 if( is_null( $nt ) ) {
499 if ( isset( self
::$idCacheByName[$name] ) ) {
500 return self
::$idCacheByName[$name];
503 $dbr = wfGetDB( DB_SLAVE
);
504 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
506 if ( $s === false ) {
509 $result = $s->user_id
;
512 self
::$idCacheByName[$name] = $result;
514 if ( count( self
::$idCacheByName ) > 1000 ) {
515 self
::$idCacheByName = array();
522 * Reset the cache used in idFromName(). For use in tests.
524 public static function resetIdByNameCache() {
525 self
::$idCacheByName = array();
529 * Does the string match an anonymous IPv4 address?
531 * This function exists for username validation, in order to reject
532 * usernames which are similar in form to IP addresses. Strings such
533 * as 300.300.300.300 will return true because it looks like an IP
534 * address, despite not being strictly valid.
536 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
537 * address because the usemod software would "cloak" anonymous IP
538 * addresses like this, if we allowed accounts like this to be created
539 * new users could get the old edits of these anonymous users.
541 * @param $name String to match
544 public static function isIP( $name ) {
545 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
549 * Is the input a valid username?
551 * Checks if the input is a valid username, we don't want an empty string,
552 * an IP address, anything that containins slashes (would mess up subpages),
553 * is longer than the maximum allowed username size or doesn't begin with
556 * @param $name String to match
559 public static function isValidUserName( $name ) {
560 global $wgContLang, $wgMaxNameChars;
563 || User
::isIP( $name )
564 ||
strpos( $name, '/' ) !== false
565 ||
strlen( $name ) > $wgMaxNameChars
566 ||
$name != $wgContLang->ucfirst( $name ) ) {
567 wfDebugLog( 'username', __METHOD__
.
568 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
573 // Ensure that the name can't be misresolved as a different title,
574 // such as with extra namespace keys at the start.
575 $parsed = Title
::newFromText( $name );
576 if( is_null( $parsed )
577 ||
$parsed->getNamespace()
578 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
579 wfDebugLog( 'username', __METHOD__
.
580 ": '$name' invalid due to ambiguous prefixes" );
584 // Check an additional blacklist of troublemaker characters.
585 // Should these be merged into the title char list?
586 $unicodeBlacklist = '/[' .
587 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
588 '\x{00a0}' . # non-breaking space
589 '\x{2000}-\x{200f}' . # various whitespace
590 '\x{2028}-\x{202f}' . # breaks and control chars
591 '\x{3000}' . # ideographic space
592 '\x{e000}-\x{f8ff}' . # private use
594 if( preg_match( $unicodeBlacklist, $name ) ) {
595 wfDebugLog( 'username', __METHOD__
.
596 ": '$name' invalid due to blacklisted characters" );
604 * Usernames which fail to pass this function will be blocked
605 * from user login and new account registrations, but may be used
606 * internally by batch processes.
608 * If an account already exists in this form, login will be blocked
609 * by a failure to pass this function.
611 * @param $name String to match
614 public static function isUsableName( $name ) {
615 global $wgReservedUsernames;
616 // Must be a valid username, obviously ;)
617 if ( !self
::isValidUserName( $name ) ) {
621 static $reservedUsernames = false;
622 if ( !$reservedUsernames ) {
623 $reservedUsernames = $wgReservedUsernames;
624 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
627 // Certain names may be reserved for batch processes.
628 foreach ( $reservedUsernames as $reserved ) {
629 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
630 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
632 if ( $reserved == $name ) {
640 * Usernames which fail to pass this function will be blocked
641 * from new account registrations, but may be used internally
642 * either by batch processes or by user accounts which have
643 * already been created.
645 * Additional blacklisting may be added here rather than in
646 * isValidUserName() to avoid disrupting existing accounts.
648 * @param $name String to match
651 public static function isCreatableName( $name ) {
652 global $wgInvalidUsernameCharacters;
654 // Ensure that the username isn't longer than 235 bytes, so that
655 // (at least for the builtin skins) user javascript and css files
656 // will work. (bug 23080)
657 if( strlen( $name ) > 235 ) {
658 wfDebugLog( 'username', __METHOD__
.
659 ": '$name' invalid due to length" );
663 // Preg yells if you try to give it an empty string
664 if( $wgInvalidUsernameCharacters !== '' ) {
665 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
666 wfDebugLog( 'username', __METHOD__
.
667 ": '$name' invalid due to wgInvalidUsernameCharacters" );
672 return self
::isUsableName( $name );
676 * Is the input a valid password for this user?
678 * @param $password String Desired password
681 public function isValidPassword( $password ) {
682 //simple boolean wrapper for getPasswordValidity
683 return $this->getPasswordValidity( $password ) === true;
687 * Given unvalidated password input, return error message on failure.
689 * @param $password String Desired password
690 * @return mixed: true on success, string or array of error message on failure
692 public function getPasswordValidity( $password ) {
693 global $wgMinimalPasswordLength, $wgContLang;
695 static $blockedLogins = array(
696 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
697 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
700 $result = false; //init $result to false for the internal checks
702 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
705 if ( $result === false ) {
706 if( strlen( $password ) < $wgMinimalPasswordLength ) {
707 return 'passwordtooshort';
708 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
709 return 'password-name-match';
710 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
711 return 'password-login-forbidden';
713 //it seems weird returning true here, but this is because of the
714 //initialization of $result to false above. If the hook is never run or it
715 //doesn't modify $result, then we will likely get down into this if with
719 } elseif( $result === true ) {
722 return $result; //the isValidPassword hook set a string $result and returned true
727 * Does a string look like an e-mail address?
729 * This validates an email address using an HTML5 specification found at:
730 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
731 * Which as of 2011-01-24 says:
733 * A valid e-mail address is a string that matches the ABNF production
734 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
735 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
738 * This function is an implementation of the specification as requested in
741 * Client-side forms will use the same standard validation rules via JS or
742 * HTML 5 validation; additional restrictions can be enforced server-side
743 * by extensions via the 'isValidEmailAddr' hook.
745 * Note that this validation doesn't 100% match RFC 2822, but is believed
746 * to be liberal enough for wide use. Some invalid addresses will still
747 * pass validation here.
749 * @param $addr String E-mail address
751 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
753 public static function isValidEmailAddr( $addr ) {
754 wfDeprecated( __METHOD__
, '1.18' );
755 return Sanitizer
::validateEmail( $addr );
759 * Given unvalidated user input, return a canonical username, or false if
760 * the username is invalid.
761 * @param $name String User input
762 * @param $validate String|Bool type of validation to use:
763 * - false No validation
764 * - 'valid' Valid for batch processes
765 * - 'usable' Valid for batch processes and login
766 * - 'creatable' Valid for batch processes, login and account creation
768 * @return bool|string
770 public static function getCanonicalName( $name, $validate = 'valid' ) {
771 # Force usernames to capital
773 $name = $wgContLang->ucfirst( $name );
775 # Reject names containing '#'; these will be cleaned up
776 # with title normalisation, but then it's too late to
778 if( strpos( $name, '#' ) !== false )
781 # Clean up name according to title rules
782 $t = ( $validate === 'valid' ) ?
783 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
784 # Check for invalid titles
785 if( is_null( $t ) ) {
789 # Reject various classes of invalid names
791 $name = $wgAuth->getCanonicalName( $t->getText() );
793 switch ( $validate ) {
797 if ( !User
::isValidUserName( $name ) ) {
802 if ( !User
::isUsableName( $name ) ) {
807 if ( !User
::isCreatableName( $name ) ) {
812 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
818 * Count the number of edits of a user
820 * @param $uid Int User ID to check
821 * @return Int the user's edit count
823 * @deprecated since 1.21 in favour of User::getEditCount
825 public static function edits( $uid ) {
826 wfDeprecated( __METHOD__
, '1.21' );
827 $user = self
::newFromId( $uid );
828 return $user->getEditCount();
832 * Return a random password.
834 * @return String new random password
836 public static function randomPassword() {
837 global $wgMinimalPasswordLength;
838 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
839 $length = max( 10, $wgMinimalPasswordLength );
840 // Multiply by 1.25 to get the number of hex characters we need
841 $length = $length * 1.25;
842 // Generate random hex chars
843 $hex = MWCryptRand
::generateHex( $length );
844 // Convert from base 16 to base 32 to get a proper password like string
845 return wfBaseConvert( $hex, 16, 32 );
849 * Set cached properties to default.
851 * @note This no longer clears uncached lazy-initialised properties;
852 * the constructor does that instead.
854 * @param $name string
856 public function loadDefaults( $name = false ) {
857 wfProfileIn( __METHOD__
);
860 $this->mName
= $name;
861 $this->mRealName
= '';
862 $this->mPassword
= $this->mNewpassword
= '';
863 $this->mNewpassTime
= null;
865 $this->mOptionOverrides
= null;
866 $this->mOptionsLoaded
= false;
868 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
869 if( $loggedOut !== null ) {
870 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
872 $this->mTouched
= '0'; # Allow any pages to be cached
875 $this->mToken
= null; // Don't run cryptographic functions till we need a token
876 $this->mEmailAuthenticated
= null;
877 $this->mEmailToken
= '';
878 $this->mEmailTokenExpires
= null;
879 $this->mRegistration
= wfTimestamp( TS_MW
);
880 $this->mGroups
= array();
882 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
884 wfProfileOut( __METHOD__
);
888 * Return whether an item has been loaded.
890 * @param $item String: item to check. Current possibilities:
894 * @param $all String: 'all' to check if the whole object has been loaded
895 * or any other string to check if only the item is available (e.g.
899 public function isItemLoaded( $item, $all = 'all' ) {
900 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
901 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
905 * Set that an item has been loaded
907 * @param $item String
909 private function setItemLoaded( $item ) {
910 if ( is_array( $this->mLoadedItems
) ) {
911 $this->mLoadedItems
[$item] = true;
916 * Load user data from the session or login cookie.
917 * @return Bool True if the user is logged in, false otherwise.
919 private function loadFromSession() {
920 global $wgExternalAuthType, $wgAutocreatePolicy;
923 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
924 if ( $result !== null ) {
928 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
929 $extUser = ExternalUser
::newFromCookie();
931 # TODO: Automatically create the user here (or probably a bit
932 # lower down, in fact)
936 $request = $this->getRequest();
938 $cookieId = $request->getCookie( 'UserID' );
939 $sessId = $request->getSessionData( 'wsUserID' );
941 if ( $cookieId !== null ) {
942 $sId = intval( $cookieId );
943 if( $sessId !== null && $cookieId != $sessId ) {
944 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
945 cookie user ID ($sId) don't match!" );
948 $request->setSessionData( 'wsUserID', $sId );
949 } elseif ( $sessId !== null && $sessId != 0 ) {
955 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
956 $sName = $request->getSessionData( 'wsUserName' );
957 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
958 $sName = $request->getCookie( 'UserName' );
959 $request->setSessionData( 'wsUserName', $sName );
964 $proposedUser = User
::newFromId( $sId );
965 if ( !$proposedUser->isLoggedIn() ) {
970 global $wgBlockDisablesLogin;
971 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
972 # User blocked and we've disabled blocked user logins
976 if ( $request->getSessionData( 'wsToken' ) ) {
977 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
979 } elseif ( $request->getCookie( 'Token' ) ) {
980 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
983 # No session or persistent login cookie
987 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
988 $this->loadFromUserObject( $proposedUser );
989 $request->setSessionData( 'wsToken', $this->mToken
);
990 wfDebug( "User: logged in from $from\n" );
993 # Invalid credentials
994 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1000 * Load user and user_group data from the database.
1001 * $this->mId must be set, this is how the user is identified.
1003 * @return Bool True if the user exists, false if the user is anonymous
1005 public function loadFromDatabase() {
1007 $this->mId
= intval( $this->mId
);
1009 /** Anonymous user */
1011 $this->loadDefaults();
1015 $dbr = wfGetDB( DB_MASTER
);
1016 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1018 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1020 if ( $s !== false ) {
1021 # Initialise user table data
1022 $this->loadFromRow( $s );
1023 $this->mGroups
= null; // deferred
1024 $this->getEditCount(); // revalidation for nulls
1029 $this->loadDefaults();
1035 * Initialize this object from a row from the user table.
1037 * @param $row Array Row from the user table to load.
1039 public function loadFromRow( $row ) {
1042 $this->mGroups
= null; // deferred
1044 if ( isset( $row->user_name
) ) {
1045 $this->mName
= $row->user_name
;
1046 $this->mFrom
= 'name';
1047 $this->setItemLoaded( 'name' );
1052 if ( isset( $row->user_real_name
) ) {
1053 $this->mRealName
= $row->user_real_name
;
1054 $this->setItemLoaded( 'realname' );
1059 if ( isset( $row->user_id
) ) {
1060 $this->mId
= intval( $row->user_id
);
1061 $this->mFrom
= 'id';
1062 $this->setItemLoaded( 'id' );
1067 if ( isset( $row->user_editcount
) ) {
1068 $this->mEditCount
= $row->user_editcount
;
1073 if ( isset( $row->user_password
) ) {
1074 $this->mPassword
= $row->user_password
;
1075 $this->mNewpassword
= $row->user_newpassword
;
1076 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1077 $this->mEmail
= $row->user_email
;
1078 if ( isset( $row->user_options
) ) {
1079 $this->decodeOptions( $row->user_options
);
1081 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1082 $this->mToken
= $row->user_token
;
1083 if ( $this->mToken
== '' ) {
1084 $this->mToken
= null;
1086 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1087 $this->mEmailToken
= $row->user_email_token
;
1088 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1089 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1095 $this->mLoadedItems
= true;
1100 * Load the data for this user object from another user object.
1104 protected function loadFromUserObject( $user ) {
1106 $user->loadGroups();
1107 $user->loadOptions();
1108 foreach ( self
::$mCacheVars as $var ) {
1109 $this->$var = $user->$var;
1114 * Load the groups from the database if they aren't already loaded.
1116 private function loadGroups() {
1117 if ( is_null( $this->mGroups
) ) {
1118 $dbr = wfGetDB( DB_MASTER
);
1119 $res = $dbr->select( 'user_groups',
1120 array( 'ug_group' ),
1121 array( 'ug_user' => $this->mId
),
1123 $this->mGroups
= array();
1124 foreach ( $res as $row ) {
1125 $this->mGroups
[] = $row->ug_group
;
1131 * Add the user to the group if he/she meets given criteria.
1133 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1134 * possible to remove manually via Special:UserRights. In such case it
1135 * will not be re-added automatically. The user will also not lose the
1136 * group if they no longer meet the criteria.
1138 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1140 * @return array Array of groups the user has been promoted to.
1142 * @see $wgAutopromoteOnce
1144 public function addAutopromoteOnceGroups( $event ) {
1145 global $wgAutopromoteOnceLogInRC;
1147 $toPromote = array();
1148 if ( $this->getId() ) {
1149 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1150 if ( count( $toPromote ) ) {
1151 $oldGroups = $this->getGroups(); // previous groups
1152 foreach ( $toPromote as $group ) {
1153 $this->addGroup( $group );
1155 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1157 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1158 $log->addEntry( 'autopromote',
1159 $this->getUserPage(),
1161 // These group names are "list to texted"-ed in class LogPage.
1162 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1170 * Clear various cached data stored in this object.
1171 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1172 * given source. May be "name", "id", "defaults", "session", or false for
1175 public function clearInstanceCache( $reloadFrom = false ) {
1176 $this->mNewtalk
= -1;
1177 $this->mDatePreference
= null;
1178 $this->mBlockedby
= -1; # Unset
1179 $this->mHash
= false;
1180 $this->mRights
= null;
1181 $this->mEffectiveGroups
= null;
1182 $this->mImplicitGroups
= null;
1183 $this->mOptions
= null;
1185 if ( $reloadFrom ) {
1186 $this->mLoadedItems
= array();
1187 $this->mFrom
= $reloadFrom;
1192 * Combine the language default options with any site-specific options
1193 * and add the default language variants.
1195 * @return Array of String options
1197 public static function getDefaultOptions() {
1198 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1200 $defOpt = $wgDefaultUserOptions;
1201 # default language setting
1202 $variant = $wgContLang->getDefaultVariant();
1203 $defOpt['variant'] = $variant;
1204 $defOpt['language'] = $variant;
1205 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1206 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1208 $defOpt['skin'] = $wgDefaultSkin;
1210 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1211 // but that breaks the parser tests because they rely on being able to change $wgContLang
1212 // mid-request and see that change reflected in the return value of this function.
1213 // Which is insane and would never happen during normal MW operation, but is also not
1214 // likely to get fixed unless and until we context-ify everything.
1215 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1216 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1222 * Get a given default option value.
1224 * @param $opt String Name of option to retrieve
1225 * @return String Default option value
1227 public static function getDefaultOption( $opt ) {
1228 $defOpts = self
::getDefaultOptions();
1229 if( isset( $defOpts[$opt] ) ) {
1230 return $defOpts[$opt];
1238 * Get blocking information
1239 * @param $bFromSlave Bool Whether to check the slave database first. To
1240 * improve performance, non-critical checks are done
1241 * against slaves. Check when actually saving should be
1242 * done against master.
1244 private function getBlockedStatus( $bFromSlave = true ) {
1245 global $wgProxyWhitelist, $wgUser;
1247 if ( -1 != $this->mBlockedby
) {
1251 wfProfileIn( __METHOD__
);
1252 wfDebug( __METHOD__
.": checking...\n" );
1254 // Initialize data...
1255 // Otherwise something ends up stomping on $this->mBlockedby when
1256 // things get lazy-loaded later, causing false positive block hits
1257 // due to -1 !== 0. Probably session-related... Nothing should be
1258 // overwriting mBlockedby, surely?
1261 # We only need to worry about passing the IP address to the Block generator if the
1262 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1263 # know which IP address they're actually coming from
1264 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1265 $ip = $this->getRequest()->getIP();
1271 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1274 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1275 && !in_array( $ip, $wgProxyWhitelist ) )
1278 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1280 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1281 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1282 $block->setTarget( $ip );
1283 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1285 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1286 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1287 $block->setTarget( $ip );
1291 if ( $block instanceof Block
) {
1292 wfDebug( __METHOD__
. ": Found block.\n" );
1293 $this->mBlock
= $block;
1294 $this->mBlockedby
= $block->getByName();
1295 $this->mBlockreason
= $block->mReason
;
1296 $this->mHideName
= $block->mHideName
;
1297 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1299 $this->mBlockedby
= '';
1300 $this->mHideName
= 0;
1301 $this->mAllowUsertalk
= false;
1305 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1307 wfProfileOut( __METHOD__
);
1311 * Whether the given IP is in a DNS blacklist.
1313 * @param $ip String IP to check
1314 * @param $checkWhitelist Bool: whether to check the whitelist first
1315 * @return Bool True if blacklisted.
1317 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1318 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1319 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1321 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1324 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1327 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1328 return $this->inDnsBlacklist( $ip, $urls );
1332 * Whether the given IP is in a given DNS blacklist.
1334 * @param $ip String IP to check
1335 * @param $bases String|Array of Strings: URL of the DNS blacklist
1336 * @return Bool True if blacklisted.
1338 public function inDnsBlacklist( $ip, $bases ) {
1339 wfProfileIn( __METHOD__
);
1342 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1343 if( IP
::isIPv4( $ip ) ) {
1344 # Reverse IP, bug 21255
1345 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1347 foreach( (array)$bases as $base ) {
1349 # If we have an access key, use that too (ProjectHoneypot, etc.)
1350 if( is_array( $base ) ) {
1351 if( count( $base ) >= 2 ) {
1352 # Access key is 1, base URL is 0
1353 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1355 $host = "$ipReversed.{$base[0]}";
1358 $host = "$ipReversed.$base";
1362 $ipList = gethostbynamel( $host );
1365 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1369 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1374 wfProfileOut( __METHOD__
);
1379 * Check if an IP address is in the local proxy list
1385 public static function isLocallyBlockedProxy( $ip ) {
1386 global $wgProxyList;
1388 if ( !$wgProxyList ) {
1391 wfProfileIn( __METHOD__
);
1393 if ( !is_array( $wgProxyList ) ) {
1394 # Load from the specified file
1395 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1398 if ( !is_array( $wgProxyList ) ) {
1400 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1402 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1403 # Old-style flipped proxy list
1408 wfProfileOut( __METHOD__
);
1413 * Is this user subject to rate limiting?
1415 * @return Bool True if rate limited
1417 public function isPingLimitable() {
1418 global $wgRateLimitsExcludedIPs;
1419 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1420 // No other good way currently to disable rate limits
1421 // for specific IPs. :P
1422 // But this is a crappy hack and should die.
1425 return !$this->isAllowed('noratelimit');
1429 * Primitive rate limits: enforce maximum actions per time period
1430 * to put a brake on flooding.
1432 * @note When using a shared cache like memcached, IP-address
1433 * last-hit counters will be shared across wikis.
1435 * @param $action String Action to enforce; 'edit' if unspecified
1436 * @return Bool True if a rate limiter was tripped
1438 public function pingLimiter( $action = 'edit' ) {
1439 # Call the 'PingLimiter' hook
1441 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1445 global $wgRateLimits;
1446 if( !isset( $wgRateLimits[$action] ) ) {
1450 # Some groups shouldn't trigger the ping limiter, ever
1451 if( !$this->isPingLimitable() )
1454 global $wgMemc, $wgRateLimitLog;
1455 wfProfileIn( __METHOD__
);
1457 $limits = $wgRateLimits[$action];
1459 $id = $this->getId();
1460 $ip = $this->getRequest()->getIP();
1463 if( isset( $limits['anon'] ) && $id == 0 ) {
1464 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1467 if( isset( $limits['user'] ) && $id != 0 ) {
1468 $userLimit = $limits['user'];
1470 if( $this->isNewbie() ) {
1471 if( isset( $limits['newbie'] ) && $id != 0 ) {
1472 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1474 if( isset( $limits['ip'] ) ) {
1475 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1478 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1479 $subnet = $matches[1];
1480 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1483 // Check for group-specific permissions
1484 // If more than one group applies, use the group with the highest limit
1485 foreach ( $this->getGroups() as $group ) {
1486 if ( isset( $limits[$group] ) ) {
1487 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1488 $userLimit = $limits[$group];
1492 // Set the user limit key
1493 if ( $userLimit !== false ) {
1494 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1495 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1499 foreach( $keys as $key => $limit ) {
1500 list( $max, $period ) = $limit;
1501 $summary = "(limit $max in {$period}s)";
1502 $count = $wgMemc->get( $key );
1505 if( $count >= $max ) {
1506 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1507 if( $wgRateLimitLog ) {
1508 wfSuppressWarnings();
1509 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1510 wfRestoreWarnings();
1514 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1517 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1518 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1520 $wgMemc->incr( $key );
1523 wfProfileOut( __METHOD__
);
1528 * Check if user is blocked
1530 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1531 * @return Bool True if blocked, false otherwise
1533 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1534 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1538 * Get the block affecting the user, or null if the user is not blocked
1540 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1541 * @return Block|null
1543 public function getBlock( $bFromSlave = true ){
1544 $this->getBlockedStatus( $bFromSlave );
1545 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1549 * Check if user is blocked from editing a particular article
1551 * @param $title Title to check
1552 * @param $bFromSlave Bool whether to check the slave database instead of the master
1555 function isBlockedFrom( $title, $bFromSlave = false ) {
1556 global $wgBlockAllowsUTEdit;
1557 wfProfileIn( __METHOD__
);
1559 $blocked = $this->isBlocked( $bFromSlave );
1560 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1561 # If a user's name is suppressed, they cannot make edits anywhere
1562 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1563 $title->getNamespace() == NS_USER_TALK
) {
1565 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1568 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1570 wfProfileOut( __METHOD__
);
1575 * If user is blocked, return the name of the user who placed the block
1576 * @return String name of blocker
1578 public function blockedBy() {
1579 $this->getBlockedStatus();
1580 return $this->mBlockedby
;
1584 * If user is blocked, return the specified reason for the block
1585 * @return String Blocking reason
1587 public function blockedFor() {
1588 $this->getBlockedStatus();
1589 return $this->mBlockreason
;
1593 * If user is blocked, return the ID for the block
1594 * @return Int Block ID
1596 public function getBlockId() {
1597 $this->getBlockedStatus();
1598 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1602 * Check if user is blocked on all wikis.
1603 * Do not use for actual edit permission checks!
1604 * This is intented for quick UI checks.
1606 * @param $ip String IP address, uses current client if none given
1607 * @return Bool True if blocked, false otherwise
1609 public function isBlockedGlobally( $ip = '' ) {
1610 if( $this->mBlockedGlobally
!== null ) {
1611 return $this->mBlockedGlobally
;
1613 // User is already an IP?
1614 if( IP
::isIPAddress( $this->getName() ) ) {
1615 $ip = $this->getName();
1617 $ip = $this->getRequest()->getIP();
1620 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1621 $this->mBlockedGlobally
= (bool)$blocked;
1622 return $this->mBlockedGlobally
;
1626 * Check if user account is locked
1628 * @return Bool True if locked, false otherwise
1630 public function isLocked() {
1631 if( $this->mLocked
!== null ) {
1632 return $this->mLocked
;
1635 $authUser = $wgAuth->getUserInstance( $this );
1636 $this->mLocked
= (bool)$authUser->isLocked();
1637 return $this->mLocked
;
1641 * Check if user account is hidden
1643 * @return Bool True if hidden, false otherwise
1645 public function isHidden() {
1646 if( $this->mHideName
!== null ) {
1647 return $this->mHideName
;
1649 $this->getBlockedStatus();
1650 if( !$this->mHideName
) {
1652 $authUser = $wgAuth->getUserInstance( $this );
1653 $this->mHideName
= (bool)$authUser->isHidden();
1655 return $this->mHideName
;
1659 * Get the user's ID.
1660 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1662 public function getId() {
1663 if( $this->mId
=== null && $this->mName
!== null
1664 && User
::isIP( $this->mName
) ) {
1665 // Special case, we know the user is anonymous
1667 } elseif( !$this->isItemLoaded( 'id' ) ) {
1668 // Don't load if this was initialized from an ID
1675 * Set the user and reload all fields according to a given ID
1676 * @param $v Int User ID to reload
1678 public function setId( $v ) {
1680 $this->clearInstanceCache( 'id' );
1684 * Get the user name, or the IP of an anonymous user
1685 * @return String User's name or IP address
1687 public function getName() {
1688 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1689 # Special case optimisation
1690 return $this->mName
;
1693 if ( $this->mName
=== false ) {
1695 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1697 return $this->mName
;
1702 * Set the user name.
1704 * This does not reload fields from the database according to the given
1705 * name. Rather, it is used to create a temporary "nonexistent user" for
1706 * later addition to the database. It can also be used to set the IP
1707 * address for an anonymous user to something other than the current
1710 * @note User::newFromName() has rougly the same function, when the named user
1712 * @param $str String New user name to set
1714 public function setName( $str ) {
1716 $this->mName
= $str;
1720 * Get the user's name escaped by underscores.
1721 * @return String Username escaped by underscores.
1723 public function getTitleKey() {
1724 return str_replace( ' ', '_', $this->getName() );
1728 * Check if the user has new messages.
1729 * @return Bool True if the user has new messages
1731 public function getNewtalk() {
1734 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1735 if( $this->mNewtalk
=== -1 ) {
1736 $this->mNewtalk
= false; # reset talk page status
1738 # Check memcached separately for anons, who have no
1739 # entire User object stored in there.
1741 global $wgDisableAnonTalk;
1742 if( $wgDisableAnonTalk ) {
1743 // Anon newtalk disabled by configuration.
1744 $this->mNewtalk
= false;
1747 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1748 $newtalk = $wgMemc->get( $key );
1749 if( strval( $newtalk ) !== '' ) {
1750 $this->mNewtalk
= (bool)$newtalk;
1752 // Since we are caching this, make sure it is up to date by getting it
1754 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1755 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1759 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1763 return (bool)$this->mNewtalk
;
1767 * Return the talk page(s) this user has new messages on.
1768 * @return Array of String page URLs
1770 public function getNewMessageLinks() {
1772 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1774 } elseif( !$this->getNewtalk() ) {
1777 $utp = $this->getTalkPage();
1778 $dbr = wfGetDB( DB_SLAVE
);
1779 // Get the "last viewed rev" timestamp from the oldest message notification
1780 $timestamp = $dbr->selectField( 'user_newtalk',
1781 'MIN(user_last_timestamp)',
1782 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1784 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1785 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1789 * Internal uncached check for new messages
1792 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1793 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1794 * @param $fromMaster Bool true to fetch from the master, false for a slave
1795 * @return Bool True if the user has new messages
1797 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1798 if ( $fromMaster ) {
1799 $db = wfGetDB( DB_MASTER
);
1801 $db = wfGetDB( DB_SLAVE
);
1803 $ok = $db->selectField( 'user_newtalk', $field,
1804 array( $field => $id ), __METHOD__
);
1805 return $ok !== false;
1809 * Add or update the new messages flag
1810 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1811 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1812 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1813 * @return Bool True if successful, false otherwise
1815 protected function updateNewtalk( $field, $id, $curRev = null ) {
1816 // Get timestamp of the talk page revision prior to the current one
1817 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1818 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1819 // Mark the user as having new messages since this revision
1820 $dbw = wfGetDB( DB_MASTER
);
1821 $dbw->insert( 'user_newtalk',
1822 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1825 if ( $dbw->affectedRows() ) {
1826 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1829 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1835 * Clear the new messages flag for the given user
1836 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1837 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1838 * @return Bool True if successful, false otherwise
1840 protected function deleteNewtalk( $field, $id ) {
1841 $dbw = wfGetDB( DB_MASTER
);
1842 $dbw->delete( 'user_newtalk',
1843 array( $field => $id ),
1845 if ( $dbw->affectedRows() ) {
1846 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1849 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1855 * Update the 'You have new messages!' status.
1856 * @param $val Bool Whether the user has new messages
1857 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1859 public function setNewtalk( $val, $curRev = null ) {
1860 if( wfReadOnly() ) {
1865 $this->mNewtalk
= $val;
1867 if( $this->isAnon() ) {
1869 $id = $this->getName();
1872 $id = $this->getId();
1877 $changed = $this->updateNewtalk( $field, $id, $curRev );
1879 $changed = $this->deleteNewtalk( $field, $id );
1882 if( $this->isAnon() ) {
1883 // Anons have a separate memcached space, since
1884 // user records aren't kept for them.
1885 $key = wfMemcKey( 'newtalk', 'ip', $id );
1886 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1889 $this->invalidateCache();
1894 * Generate a current or new-future timestamp to be stored in the
1895 * user_touched field when we update things.
1896 * @return String Timestamp in TS_MW format
1898 private static function newTouchedTimestamp() {
1899 global $wgClockSkewFudge;
1900 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1904 * Clear user data from memcached.
1905 * Use after applying fun updates to the database; caller's
1906 * responsibility to update user_touched if appropriate.
1908 * Called implicitly from invalidateCache() and saveSettings().
1910 private function clearSharedCache() {
1914 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1919 * Immediately touch the user data cache for this account.
1920 * Updates user_touched field, and removes account data from memcached
1921 * for reload on the next hit.
1923 public function invalidateCache() {
1924 if( wfReadOnly() ) {
1929 $this->mTouched
= self
::newTouchedTimestamp();
1931 $dbw = wfGetDB( DB_MASTER
);
1933 // Prevent contention slams by checking user_touched first
1934 $now = $dbw->timestamp( $this->mTouched
);
1935 $needsPurge = $dbw->selectField( 'user', '1',
1936 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1938 if ( $needsPurge ) {
1939 $dbw->update( 'user',
1940 array( 'user_touched' => $now ),
1941 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1946 $this->clearSharedCache();
1951 * Validate the cache for this account.
1952 * @param $timestamp String A timestamp in TS_MW format
1956 public function validateCache( $timestamp ) {
1958 return ( $timestamp >= $this->mTouched
);
1962 * Get the user touched timestamp
1963 * @return String timestamp
1965 public function getTouched() {
1967 return $this->mTouched
;
1971 * Set the password and reset the random token.
1972 * Calls through to authentication plugin if necessary;
1973 * will have no effect if the auth plugin refuses to
1974 * pass the change through or if the legal password
1977 * As a special case, setting the password to null
1978 * wipes it, so the account cannot be logged in until
1979 * a new password is set, for instance via e-mail.
1981 * @param $str String New password to set
1982 * @throws PasswordError on failure
1986 public function setPassword( $str ) {
1989 if( $str !== null ) {
1990 if( !$wgAuth->allowPasswordChange() ) {
1991 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
1994 if( !$this->isValidPassword( $str ) ) {
1995 global $wgMinimalPasswordLength;
1996 $valid = $this->getPasswordValidity( $str );
1997 if ( is_array( $valid ) ) {
1998 $message = array_shift( $valid );
2002 $params = array( $wgMinimalPasswordLength );
2004 throw new PasswordError( wfMessage( $message, $params )->text() );
2008 if( !$wgAuth->setPassword( $this, $str ) ) {
2009 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2012 $this->setInternalPassword( $str );
2018 * Set the password and reset the random token unconditionally.
2020 * @param $str String New password to set
2022 public function setInternalPassword( $str ) {
2026 if( $str === null ) {
2027 // Save an invalid hash...
2028 $this->mPassword
= '';
2030 $this->mPassword
= self
::crypt( $str );
2032 $this->mNewpassword
= '';
2033 $this->mNewpassTime
= null;
2037 * Get the user's current token.
2038 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2039 * @return String Token
2041 public function getToken( $forceCreation = true ) {
2043 if ( !$this->mToken
&& $forceCreation ) {
2046 return $this->mToken
;
2050 * Set the random token (used for persistent authentication)
2051 * Called from loadDefaults() among other places.
2053 * @param $token String|bool If specified, set the token to this value
2055 public function setToken( $token = false ) {
2058 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2060 $this->mToken
= $token;
2065 * Set the password for a password reminder or new account email
2067 * @param $str String New password to set
2068 * @param $throttle Bool If true, reset the throttle timestamp to the present
2070 public function setNewpassword( $str, $throttle = true ) {
2072 $this->mNewpassword
= self
::crypt( $str );
2074 $this->mNewpassTime
= wfTimestampNow();
2079 * Has password reminder email been sent within the last
2080 * $wgPasswordReminderResendTime hours?
2083 public function isPasswordReminderThrottled() {
2084 global $wgPasswordReminderResendTime;
2086 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2089 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2090 return time() < $expiry;
2094 * Get the user's e-mail address
2095 * @return String User's email address
2097 public function getEmail() {
2099 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2100 return $this->mEmail
;
2104 * Get the timestamp of the user's e-mail authentication
2105 * @return String TS_MW timestamp
2107 public function getEmailAuthenticationTimestamp() {
2109 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2110 return $this->mEmailAuthenticated
;
2114 * Set the user's e-mail address
2115 * @param $str String New e-mail address
2117 public function setEmail( $str ) {
2119 if( $str == $this->mEmail
) {
2122 $this->mEmail
= $str;
2123 $this->invalidateEmail();
2124 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2128 * Set the user's e-mail address and a confirmation mail if needed.
2131 * @param $str String New e-mail address
2134 public function setEmailWithConfirmation( $str ) {
2135 global $wgEnableEmail, $wgEmailAuthentication;
2137 if ( !$wgEnableEmail ) {
2138 return Status
::newFatal( 'emaildisabled' );
2141 $oldaddr = $this->getEmail();
2142 if ( $str === $oldaddr ) {
2143 return Status
::newGood( true );
2146 $this->setEmail( $str );
2148 if ( $str !== '' && $wgEmailAuthentication ) {
2149 # Send a confirmation request to the new address if needed
2150 $type = $oldaddr != '' ?
'changed' : 'set';
2151 $result = $this->sendConfirmationMail( $type );
2152 if ( $result->isGood() ) {
2153 # Say the the caller that a confirmation mail has been sent
2154 $result->value
= 'eauth';
2157 $result = Status
::newGood( true );
2164 * Get the user's real name
2165 * @return String User's real name
2167 public function getRealName() {
2168 if ( !$this->isItemLoaded( 'realname' ) ) {
2172 return $this->mRealName
;
2176 * Set the user's real name
2177 * @param $str String New real name
2179 public function setRealName( $str ) {
2181 $this->mRealName
= $str;
2185 * Get the user's current setting for a given option.
2187 * @param $oname String The option to check
2188 * @param $defaultOverride String A default value returned if the option does not exist
2189 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2190 * @return String User's current value for the option
2191 * @see getBoolOption()
2192 * @see getIntOption()
2194 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2195 global $wgHiddenPrefs;
2196 $this->loadOptions();
2198 if ( is_null( $this->mOptions
) ) {
2199 if($defaultOverride != '') {
2200 return $defaultOverride;
2202 $this->mOptions
= User
::getDefaultOptions();
2205 # We want 'disabled' preferences to always behave as the default value for
2206 # users, even if they have set the option explicitly in their settings (ie they
2207 # set it, and then it was disabled removing their ability to change it). But
2208 # we don't want to erase the preferences in the database in case the preference
2209 # is re-enabled again. So don't touch $mOptions, just override the returned value
2210 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2211 return self
::getDefaultOption( $oname );
2214 if ( array_key_exists( $oname, $this->mOptions
) ) {
2215 return $this->mOptions
[$oname];
2217 return $defaultOverride;
2222 * Get all user's options
2226 public function getOptions() {
2227 global $wgHiddenPrefs;
2228 $this->loadOptions();
2229 $options = $this->mOptions
;
2231 # We want 'disabled' preferences to always behave as the default value for
2232 # users, even if they have set the option explicitly in their settings (ie they
2233 # set it, and then it was disabled removing their ability to change it). But
2234 # we don't want to erase the preferences in the database in case the preference
2235 # is re-enabled again. So don't touch $mOptions, just override the returned value
2236 foreach( $wgHiddenPrefs as $pref ){
2237 $default = self
::getDefaultOption( $pref );
2238 if( $default !== null ){
2239 $options[$pref] = $default;
2247 * Get the user's current setting for a given option, as a boolean value.
2249 * @param $oname String The option to check
2250 * @return Bool User's current value for the option
2253 public function getBoolOption( $oname ) {
2254 return (bool)$this->getOption( $oname );
2258 * Get the user's current setting for a given option, as a boolean value.
2260 * @param $oname String The option to check
2261 * @param $defaultOverride Int A default value returned if the option does not exist
2262 * @return Int User's current value for the option
2265 public function getIntOption( $oname, $defaultOverride=0 ) {
2266 $val = $this->getOption( $oname );
2268 $val = $defaultOverride;
2270 return intval( $val );
2274 * Set the given option for a user.
2276 * @param $oname String The option to set
2277 * @param $val mixed New value to set
2279 public function setOption( $oname, $val ) {
2281 $this->loadOptions();
2283 // Explicitly NULL values should refer to defaults
2284 if( is_null( $val ) ) {
2285 $defaultOption = self
::getDefaultOption( $oname );
2286 if( !is_null( $defaultOption ) ) {
2287 $val = $defaultOption;
2291 $this->mOptions
[$oname] = $val;
2295 * Reset all options to the site defaults
2297 public function resetOptions() {
2300 $this->mOptions
= self
::getDefaultOptions();
2301 $this->mOptionsLoaded
= true;
2305 * Get the user's preferred date format.
2306 * @return String User's preferred date format
2308 public function getDatePreference() {
2309 // Important migration for old data rows
2310 if ( is_null( $this->mDatePreference
) ) {
2312 $value = $this->getOption( 'date' );
2313 $map = $wgLang->getDatePreferenceMigrationMap();
2314 if ( isset( $map[$value] ) ) {
2315 $value = $map[$value];
2317 $this->mDatePreference
= $value;
2319 return $this->mDatePreference
;
2323 * Get the user preferred stub threshold
2327 public function getStubThreshold() {
2328 global $wgMaxArticleSize; # Maximum article size, in Kb
2329 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2330 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2331 # If they have set an impossible value, disable the preference
2332 # so we can use the parser cache again.
2339 * Get the permissions this user has.
2340 * @return Array of String permission names
2342 public function getRights() {
2343 if ( is_null( $this->mRights
) ) {
2344 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2345 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2346 // Force reindexation of rights when a hook has unset one of them
2347 $this->mRights
= array_values( $this->mRights
);
2349 return $this->mRights
;
2353 * Get the list of explicit group memberships this user has.
2354 * The implicit * and user groups are not included.
2355 * @return Array of String internal group names
2357 public function getGroups() {
2359 $this->loadGroups();
2360 return $this->mGroups
;
2364 * Get the list of implicit group memberships this user has.
2365 * This includes all explicit groups, plus 'user' if logged in,
2366 * '*' for all accounts, and autopromoted groups
2367 * @param $recache Bool Whether to avoid the cache
2368 * @return Array of String internal group names
2370 public function getEffectiveGroups( $recache = false ) {
2371 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2372 wfProfileIn( __METHOD__
);
2373 $this->mEffectiveGroups
= array_unique( array_merge(
2374 $this->getGroups(), // explicit groups
2375 $this->getAutomaticGroups( $recache ) // implicit groups
2377 # Hook for additional groups
2378 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2379 wfProfileOut( __METHOD__
);
2381 return $this->mEffectiveGroups
;
2385 * Get the list of implicit group memberships this user has.
2386 * This includes 'user' if logged in, '*' for all accounts,
2387 * and autopromoted groups
2388 * @param $recache Bool Whether to avoid the cache
2389 * @return Array of String internal group names
2391 public function getAutomaticGroups( $recache = false ) {
2392 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2393 wfProfileIn( __METHOD__
);
2394 $this->mImplicitGroups
= array( '*' );
2395 if ( $this->getId() ) {
2396 $this->mImplicitGroups
[] = 'user';
2398 $this->mImplicitGroups
= array_unique( array_merge(
2399 $this->mImplicitGroups
,
2400 Autopromote
::getAutopromoteGroups( $this )
2404 # Assure data consistency with rights/groups,
2405 # as getEffectiveGroups() depends on this function
2406 $this->mEffectiveGroups
= null;
2408 wfProfileOut( __METHOD__
);
2410 return $this->mImplicitGroups
;
2414 * Returns the groups the user has belonged to.
2416 * The user may still belong to the returned groups. Compare with getGroups().
2418 * The function will not return groups the user had belonged to before MW 1.17
2420 * @return array Names of the groups the user has belonged to.
2422 public function getFormerGroups() {
2423 if( is_null( $this->mFormerGroups
) ) {
2424 $dbr = wfGetDB( DB_MASTER
);
2425 $res = $dbr->select( 'user_former_groups',
2426 array( 'ufg_group' ),
2427 array( 'ufg_user' => $this->mId
),
2429 $this->mFormerGroups
= array();
2430 foreach( $res as $row ) {
2431 $this->mFormerGroups
[] = $row->ufg_group
;
2434 return $this->mFormerGroups
;
2438 * Get the user's edit count.
2441 public function getEditCount() {
2442 if( $this->getId() ) {
2443 if ( !isset( $this->mEditCount
) ) {
2444 /* Populate the count, if it has not been populated yet */
2445 wfProfileIn( __METHOD__
);
2446 $dbr = wfGetDB( DB_SLAVE
);
2447 // check if the user_editcount field has been initialized
2448 $count = $dbr->selectField(
2449 'user', 'user_editcount',
2450 array( 'user_id' => $this->mId
),
2454 if( $count === null ) {
2455 // it has not been initialized. do so.
2456 $dbw = wfGetDB( DB_MASTER
);
2457 $count = $dbr->selectField(
2458 'revision', 'count(*)',
2459 array( 'rev_user' => $this->mId
),
2464 array( 'user_editcount' => $count ),
2465 array( 'user_id' => $this->mId
),
2469 wfProfileOut( __METHOD__
);
2470 $this->mEditCount
= $count;
2472 return $this->mEditCount
;
2480 * Add the user to the given group.
2481 * This takes immediate effect.
2482 * @param $group String Name of the group to add
2484 public function addGroup( $group ) {
2485 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2486 $dbw = wfGetDB( DB_MASTER
);
2487 if( $this->getId() ) {
2488 $dbw->insert( 'user_groups',
2490 'ug_user' => $this->getID(),
2491 'ug_group' => $group,
2494 array( 'IGNORE' ) );
2497 $this->loadGroups();
2498 $this->mGroups
[] = $group;
2499 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2501 $this->invalidateCache();
2505 * Remove the user from the given group.
2506 * This takes immediate effect.
2507 * @param $group String Name of the group to remove
2509 public function removeGroup( $group ) {
2511 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2512 $dbw = wfGetDB( DB_MASTER
);
2513 $dbw->delete( 'user_groups',
2515 'ug_user' => $this->getID(),
2516 'ug_group' => $group,
2518 // Remember that the user was in this group
2519 $dbw->insert( 'user_former_groups',
2521 'ufg_user' => $this->getID(),
2522 'ufg_group' => $group,
2525 array( 'IGNORE' ) );
2527 $this->loadGroups();
2528 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2529 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2531 $this->invalidateCache();
2535 * Get whether the user is logged in
2538 public function isLoggedIn() {
2539 return $this->getID() != 0;
2543 * Get whether the user is anonymous
2546 public function isAnon() {
2547 return !$this->isLoggedIn();
2551 * Check if user is allowed to access a feature / make an action
2553 * @internal param \String $varargs permissions to test
2554 * @return Boolean: True if user is allowed to perform *any* of the given actions
2558 public function isAllowedAny( /*...*/ ){
2559 $permissions = func_get_args();
2560 foreach( $permissions as $permission ){
2561 if( $this->isAllowed( $permission ) ){
2570 * @internal param $varargs string
2571 * @return bool True if the user is allowed to perform *all* of the given actions
2573 public function isAllowedAll( /*...*/ ){
2574 $permissions = func_get_args();
2575 foreach( $permissions as $permission ){
2576 if( !$this->isAllowed( $permission ) ){
2584 * Internal mechanics of testing a permission
2585 * @param $action String
2588 public function isAllowed( $action = '' ) {
2589 if ( $action === '' ) {
2590 return true; // In the spirit of DWIM
2592 # Patrolling may not be enabled
2593 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2594 global $wgUseRCPatrol, $wgUseNPPatrol;
2595 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2598 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2599 # by misconfiguration: 0 == 'foo'
2600 return in_array( $action, $this->getRights(), true );
2604 * Check whether to enable recent changes patrol features for this user
2605 * @return Boolean: True or false
2607 public function useRCPatrol() {
2608 global $wgUseRCPatrol;
2609 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2613 * Check whether to enable new pages patrol features for this user
2614 * @return Bool True or false
2616 public function useNPPatrol() {
2617 global $wgUseRCPatrol, $wgUseNPPatrol;
2618 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2622 * Get the WebRequest object to use with this object
2624 * @return WebRequest
2626 public function getRequest() {
2627 if ( $this->mRequest
) {
2628 return $this->mRequest
;
2636 * Get the current skin, loading it if required
2637 * @return Skin The current skin
2638 * @todo FIXME: Need to check the old failback system [AV]
2639 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2641 public function getSkin() {
2642 wfDeprecated( __METHOD__
, '1.18' );
2643 return RequestContext
::getMain()->getSkin();
2647 * Get a WatchedItem for this user and $title.
2649 * @param $title Title
2650 * @return WatchedItem
2652 public function getWatchedItem( $title ) {
2653 $key = $title->getNamespace() . ':' . $title->getDBkey();
2655 if ( isset( $this->mWatchedItems
[$key] ) ) {
2656 return $this->mWatchedItems
[$key];
2659 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2660 $this->mWatchedItems
= array();
2663 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2664 return $this->mWatchedItems
[$key];
2668 * Check the watched status of an article.
2669 * @param $title Title of the article to look at
2672 public function isWatched( $title ) {
2673 return $this->getWatchedItem( $title )->isWatched();
2678 * @param $title Title of the article to look at
2680 public function addWatch( $title ) {
2681 $this->getWatchedItem( $title )->addWatch();
2682 $this->invalidateCache();
2686 * Stop watching an article.
2687 * @param $title Title of the article to look at
2689 public function removeWatch( $title ) {
2690 $this->getWatchedItem( $title )->removeWatch();
2691 $this->invalidateCache();
2695 * Clear the user's notification timestamp for the given title.
2696 * If e-notif e-mails are on, they will receive notification mails on
2697 * the next change of the page if it's watched etc.
2698 * @param $title Title of the article to look at
2700 public function clearNotification( &$title ) {
2701 global $wgUseEnotif, $wgShowUpdatedMarker;
2703 # Do nothing if the database is locked to writes
2704 if( wfReadOnly() ) {
2708 if( $title->getNamespace() == NS_USER_TALK
&&
2709 $title->getText() == $this->getName() ) {
2710 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2712 $this->setNewtalk( false );
2715 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2719 if( $this->isAnon() ) {
2720 // Nothing else to do...
2724 // Only update the timestamp if the page is being watched.
2725 // The query to find out if it is watched is cached both in memcached and per-invocation,
2726 // and when it does have to be executed, it can be on a slave
2727 // If this is the user's newtalk page, we always update the timestamp
2729 if ( $title->getNamespace() == NS_USER_TALK
&&
2730 $title->getText() == $this->getName() )
2735 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2739 * Resets all of the given user's page-change notification timestamps.
2740 * If e-notif e-mails are on, they will receive notification mails on
2741 * the next change of any watched page.
2743 public function clearAllNotifications() {
2744 global $wgUseEnotif, $wgShowUpdatedMarker;
2745 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2746 $this->setNewtalk( false );
2749 $id = $this->getId();
2751 $dbw = wfGetDB( DB_MASTER
);
2752 $dbw->update( 'watchlist',
2754 'wl_notificationtimestamp' => null
2755 ), array( /* WHERE */
2759 # We also need to clear here the "you have new message" notification for the own user_talk page
2760 # This is cleared one page view later in Article::viewUpdates();
2765 * Set this user's options from an encoded string
2766 * @param $str String Encoded options to import
2768 * @deprecated in 1.19 due to removal of user_options from the user table
2770 private function decodeOptions( $str ) {
2771 wfDeprecated( __METHOD__
, '1.19' );
2775 $this->mOptionsLoaded
= true;
2776 $this->mOptionOverrides
= array();
2778 // If an option is not set in $str, use the default value
2779 $this->mOptions
= self
::getDefaultOptions();
2781 $a = explode( "\n", $str );
2782 foreach ( $a as $s ) {
2784 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2785 $this->mOptions
[$m[1]] = $m[2];
2786 $this->mOptionOverrides
[$m[1]] = $m[2];
2792 * Set a cookie on the user's client. Wrapper for
2793 * WebResponse::setCookie
2794 * @param $name String Name of the cookie to set
2795 * @param $value String Value to set
2796 * @param $exp Int Expiration time, as a UNIX time value;
2797 * if 0 or not specified, use the default $wgCookieExpiration
2798 * @param $secure Bool
2799 * true: Force setting the secure attribute when setting the cookie
2800 * false: Force NOT setting the secure attribute when setting the cookie
2801 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
2803 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
2804 $this->getRequest()->response()->setcookie( $name, $value, $exp, null, null, $secure );
2808 * Clear a cookie on the user's client
2809 * @param $name String Name of the cookie to clear
2811 protected function clearCookie( $name ) {
2812 $this->setCookie( $name, '', time() - 86400 );
2816 * Set the default cookies for this session on the user's client.
2818 * @param $request WebRequest object to use; $wgRequest will be used if null
2820 * @param $secure Whether to force secure/insecure cookies or use default
2822 public function setCookies( $request = null, $secure = null ) {
2823 if ( $request === null ) {
2824 $request = $this->getRequest();
2828 if ( 0 == $this->mId
) return;
2829 if ( !$this->mToken
) {
2830 // When token is empty or NULL generate a new one and then save it to the database
2831 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2832 // Simply by setting every cell in the user_token column to NULL and letting them be
2833 // regenerated as users log back into the wiki.
2835 $this->saveSettings();
2838 'wsUserID' => $this->mId
,
2839 'wsToken' => $this->mToken
,
2840 'wsUserName' => $this->getName()
2843 'UserID' => $this->mId
,
2844 'UserName' => $this->getName(),
2846 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2847 $cookies['Token'] = $this->mToken
;
2849 $cookies['Token'] = false;
2852 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2854 foreach ( $session as $name => $value ) {
2855 $request->setSessionData( $name, $value );
2857 foreach ( $cookies as $name => $value ) {
2858 if ( $value === false ) {
2859 $this->clearCookie( $name );
2861 $this->setCookie( $name, $value, 0, $secure );
2866 * If wpStickHTTPS was selected, also set an insecure cookie that
2867 * will cause the site to redirect the user to HTTPS, if they access
2868 * it over HTTP. Bug 29898.
2870 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
2871 $this->setCookie( 'forceHTTPS', 'true', time() +
2592000, false ); //30 days
2876 * Log this user out.
2878 public function logout() {
2879 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2885 * Clear the user's cookies and session, and reset the instance cache.
2888 public function doLogout() {
2889 $this->clearInstanceCache( 'defaults' );
2891 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2893 $this->clearCookie( 'UserID' );
2894 $this->clearCookie( 'Token' );
2895 $this->clearCookie( 'forceHTTPS' );
2897 # Remember when user logged out, to prevent seeing cached pages
2898 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2902 * Save this user's settings into the database.
2903 * @todo Only rarely do all these fields need to be set!
2905 public function saveSettings() {
2909 if ( wfReadOnly() ) { return; }
2910 if ( 0 == $this->mId
) { return; }
2912 $this->mTouched
= self
::newTouchedTimestamp();
2913 if ( !$wgAuth->allowSetLocalPassword() ) {
2914 $this->mPassword
= '';
2917 $dbw = wfGetDB( DB_MASTER
);
2918 $dbw->update( 'user',
2920 'user_name' => $this->mName
,
2921 'user_password' => $this->mPassword
,
2922 'user_newpassword' => $this->mNewpassword
,
2923 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2924 'user_real_name' => $this->mRealName
,
2925 'user_email' => $this->mEmail
,
2926 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2927 'user_touched' => $dbw->timestamp( $this->mTouched
),
2928 'user_token' => strval( $this->mToken
),
2929 'user_email_token' => $this->mEmailToken
,
2930 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2931 ), array( /* WHERE */
2932 'user_id' => $this->mId
2936 $this->saveOptions();
2938 wfRunHooks( 'UserSaveSettings', array( $this ) );
2939 $this->clearSharedCache();
2940 $this->getUserPage()->invalidateCache();
2944 * If only this user's username is known, and it exists, return the user ID.
2947 public function idForName() {
2948 $s = trim( $this->getName() );
2949 if ( $s === '' ) return 0;
2951 $dbr = wfGetDB( DB_SLAVE
);
2952 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2953 if ( $id === false ) {
2960 * Add a user to the database, return the user object
2962 * @param $name String Username to add
2963 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2964 * - password The user's password hash. Password logins will be disabled if this is omitted.
2965 * - newpassword Hash for a temporary password that has been mailed to the user
2966 * - email The user's email address
2967 * - email_authenticated The email authentication timestamp
2968 * - real_name The user's real name
2969 * - options An associative array of non-default options
2970 * - token Random authentication token. Do not set.
2971 * - registration Registration timestamp. Do not set.
2973 * @return User object, or null if the username already exists
2975 public static function createNew( $name, $params = array() ) {
2978 if ( isset( $params['options'] ) ) {
2979 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2980 unset( $params['options'] );
2982 $dbw = wfGetDB( DB_MASTER
);
2983 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2986 'user_id' => $seqVal,
2987 'user_name' => $name,
2988 'user_password' => $user->mPassword
,
2989 'user_newpassword' => $user->mNewpassword
,
2990 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2991 'user_email' => $user->mEmail
,
2992 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2993 'user_real_name' => $user->mRealName
,
2994 'user_token' => strval( $user->mToken
),
2995 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2996 'user_editcount' => 0,
2997 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
2999 foreach ( $params as $name => $value ) {
3000 $fields["user_$name"] = $value;
3002 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3003 if ( $dbw->affectedRows() ) {
3004 $newUser = User
::newFromId( $dbw->insertId() );
3012 * Add this existing user object to the database
3014 public function addToDatabase() {
3017 $this->mTouched
= self
::newTouchedTimestamp();
3019 $dbw = wfGetDB( DB_MASTER
);
3020 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3021 $dbw->insert( 'user',
3023 'user_id' => $seqVal,
3024 'user_name' => $this->mName
,
3025 'user_password' => $this->mPassword
,
3026 'user_newpassword' => $this->mNewpassword
,
3027 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3028 'user_email' => $this->mEmail
,
3029 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3030 'user_real_name' => $this->mRealName
,
3031 'user_token' => strval( $this->mToken
),
3032 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3033 'user_editcount' => 0,
3034 'user_touched' => $dbw->timestamp( $this->mTouched
),
3037 $this->mId
= $dbw->insertId();
3039 // Clear instance cache other than user table data, which is already accurate
3040 $this->clearInstanceCache();
3042 $this->saveOptions();
3046 * If this user is logged-in and blocked,
3047 * block any IP address they've successfully logged in from.
3048 * @return bool A block was spread
3050 public function spreadAnyEditBlock() {
3051 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3052 return $this->spreadBlock();
3058 * If this (non-anonymous) user is blocked,
3059 * block the IP address they've successfully logged in from.
3060 * @return bool A block was spread
3062 protected function spreadBlock() {
3063 wfDebug( __METHOD__
. "()\n" );
3065 if ( $this->mId
== 0 ) {
3069 $userblock = Block
::newFromTarget( $this->getName() );
3070 if ( !$userblock ) {
3074 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3078 * Generate a string which will be different for any combination of
3079 * user options which would produce different parser output.
3080 * This will be used as part of the hash key for the parser cache,
3081 * so users with the same options can share the same cached data
3084 * Extensions which require it should install 'PageRenderingHash' hook,
3085 * which will give them a chance to modify this key based on their own
3088 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3089 * @return String Page rendering hash
3091 public function getPageRenderingHash() {
3092 wfDeprecated( __METHOD__
, '1.17' );
3094 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3096 return $this->mHash
;
3099 // stubthreshold is only included below for completeness,
3100 // since it disables the parser cache, its value will always
3101 // be 0 when this function is called by parsercache.
3103 $confstr = $this->getOption( 'math' );
3104 $confstr .= '!' . $this->getStubThreshold();
3105 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3106 $confstr .= '!' . $this->getDatePreference();
3108 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3109 $confstr .= '!' . $wgLang->getCode();
3110 $confstr .= '!' . $this->getOption( 'thumbsize' );
3111 // add in language specific options, if any
3112 $extra = $wgContLang->getExtraHashOptions();
3115 // Since the skin could be overloading link(), it should be
3116 // included here but in practice, none of our skins do that.
3118 $confstr .= $wgRenderHashAppend;
3120 // Give a chance for extensions to modify the hash, if they have
3121 // extra options or other effects on the parser cache.
3122 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3124 // Make it a valid memcached key fragment
3125 $confstr = str_replace( ' ', '_', $confstr );
3126 $this->mHash
= $confstr;
3131 * Get whether the user is explicitly blocked from account creation.
3132 * @return Bool|Block
3134 public function isBlockedFromCreateAccount() {
3135 $this->getBlockedStatus();
3136 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3137 return $this->mBlock
;
3140 # bug 13611: if the IP address the user is trying to create an account from is
3141 # blocked with createaccount disabled, prevent new account creation there even
3142 # when the user is logged in
3143 if( $this->mBlockedFromCreateAccount
=== false ){
3144 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3146 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3147 ?
$this->mBlockedFromCreateAccount
3152 * Get whether the user is blocked from using Special:Emailuser.
3155 public function isBlockedFromEmailuser() {
3156 $this->getBlockedStatus();
3157 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3161 * Get whether the user is allowed to create an account.
3164 function isAllowedToCreateAccount() {
3165 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3169 * Get this user's personal page title.
3171 * @return Title: User's personal page title
3173 public function getUserPage() {
3174 return Title
::makeTitle( NS_USER
, $this->getName() );
3178 * Get this user's talk page title.
3180 * @return Title: User's talk page title
3182 public function getTalkPage() {
3183 $title = $this->getUserPage();
3184 return $title->getTalkPage();
3188 * Determine whether the user is a newbie. Newbies are either
3189 * anonymous IPs, or the most recently created accounts.
3192 public function isNewbie() {
3193 return !$this->isAllowed( 'autoconfirmed' );
3197 * Check to see if the given clear-text password is one of the accepted passwords
3198 * @param $password String: user password.
3199 * @return Boolean: True if the given password is correct, otherwise False.
3201 public function checkPassword( $password ) {
3202 global $wgAuth, $wgLegacyEncoding;
3205 // Even though we stop people from creating passwords that
3206 // are shorter than this, doesn't mean people wont be able
3207 // to. Certain authentication plugins do NOT want to save
3208 // domain passwords in a mysql database, so we should
3209 // check this (in case $wgAuth->strict() is false).
3210 if( !$this->isValidPassword( $password ) ) {
3214 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3216 } elseif( $wgAuth->strict() ) {
3217 /* Auth plugin doesn't allow local authentication */
3219 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3220 /* Auth plugin doesn't allow local authentication for this user name */
3223 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3225 } elseif ( $wgLegacyEncoding ) {
3226 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3227 # Check for this with iconv
3228 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3229 if ( $cp1252Password != $password &&
3230 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3239 * Check if the given clear-text password matches the temporary password
3240 * sent by e-mail for password reset operations.
3242 * @param $plaintext string
3244 * @return Boolean: True if matches, false otherwise
3246 public function checkTemporaryPassword( $plaintext ) {
3247 global $wgNewPasswordExpiry;
3250 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3251 if ( is_null( $this->mNewpassTime
) ) {
3254 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3255 return ( time() < $expiry );
3262 * Alias for getEditToken.
3263 * @deprecated since 1.19, use getEditToken instead.
3265 * @param $salt String|Array of Strings Optional function-specific data for hashing
3266 * @param $request WebRequest object to use or null to use $wgRequest
3267 * @return String The new edit token
3269 public function editToken( $salt = '', $request = null ) {
3270 wfDeprecated( __METHOD__
, '1.19' );
3271 return $this->getEditToken( $salt, $request );
3275 * Initialize (if necessary) and return a session token value
3276 * which can be used in edit forms to show that the user's
3277 * login credentials aren't being hijacked with a foreign form
3282 * @param $salt String|Array of Strings Optional function-specific data for hashing
3283 * @param $request WebRequest object to use or null to use $wgRequest
3284 * @return String The new edit token
3286 public function getEditToken( $salt = '', $request = null ) {
3287 if ( $request == null ) {
3288 $request = $this->getRequest();
3291 if ( $this->isAnon() ) {
3292 return EDIT_TOKEN_SUFFIX
;
3294 $token = $request->getSessionData( 'wsEditToken' );
3295 if ( $token === null ) {
3296 $token = MWCryptRand
::generateHex( 32 );
3297 $request->setSessionData( 'wsEditToken', $token );
3299 if( is_array( $salt ) ) {
3300 $salt = implode( '|', $salt );
3302 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3307 * Generate a looking random token for various uses.
3309 * @param $salt String Optional salt value
3310 * @return String The new random token
3311 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3313 public static function generateToken( $salt = '' ) {
3314 return MWCryptRand
::generateHex( 32 );
3318 * Check given value against the token value stored in the session.
3319 * A match should confirm that the form was submitted from the
3320 * user's own login session, not a form submission from a third-party
3323 * @param $val String Input value to compare
3324 * @param $salt String Optional function-specific data for hashing
3325 * @param $request WebRequest object to use or null to use $wgRequest
3326 * @return Boolean: Whether the token matches
3328 public function matchEditToken( $val, $salt = '', $request = null ) {
3329 $sessionToken = $this->getEditToken( $salt, $request );
3330 if ( $val != $sessionToken ) {
3331 wfDebug( "User::matchEditToken: broken session data\n" );
3333 return $val == $sessionToken;
3337 * Check given value against the token value stored in the session,
3338 * ignoring the suffix.
3340 * @param $val String Input value to compare
3341 * @param $salt String Optional function-specific data for hashing
3342 * @param $request WebRequest object to use or null to use $wgRequest
3343 * @return Boolean: Whether the token matches
3345 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3346 $sessionToken = $this->getEditToken( $salt, $request );
3347 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3351 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3352 * mail to the user's given address.
3354 * @param $type String: message to send, either "created", "changed" or "set"
3355 * @return Status object
3357 public function sendConfirmationMail( $type = 'created' ) {
3359 $expiration = null; // gets passed-by-ref and defined in next line.
3360 $token = $this->confirmationToken( $expiration );
3361 $url = $this->confirmationTokenUrl( $token );
3362 $invalidateURL = $this->invalidationTokenUrl( $token );
3363 $this->saveSettings();
3365 if ( $type == 'created' ||
$type === false ) {
3366 $message = 'confirmemail_body';
3367 } elseif ( $type === true ) {
3368 $message = 'confirmemail_body_changed';
3370 $message = 'confirmemail_body_' . $type;
3373 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3374 wfMessage( $message,
3375 $this->getRequest()->getIP(),
3378 $wgLang->timeanddate( $expiration, false ),
3380 $wgLang->date( $expiration, false ),
3381 $wgLang->time( $expiration, false ) )->text() );
3385 * Send an e-mail to this user's account. Does not check for
3386 * confirmed status or validity.
3388 * @param $subject String Message subject
3389 * @param $body String Message body
3390 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3391 * @param $replyto String Reply-To address
3394 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3395 if( is_null( $from ) ) {
3396 global $wgPasswordSender, $wgPasswordSenderName;
3397 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3399 $sender = new MailAddress( $from );
3402 $to = new MailAddress( $this );
3403 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3407 * Generate, store, and return a new e-mail confirmation code.
3408 * A hash (unsalted, since it's used as a key) is stored.
3410 * @note Call saveSettings() after calling this function to commit
3411 * this change to the database.
3413 * @param &$expiration \mixed Accepts the expiration time
3414 * @return String New token
3416 private function confirmationToken( &$expiration ) {
3417 global $wgUserEmailConfirmationTokenExpiry;
3419 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3420 $expiration = wfTimestamp( TS_MW
, $expires );
3422 $token = MWCryptRand
::generateHex( 32 );
3423 $hash = md5( $token );
3424 $this->mEmailToken
= $hash;
3425 $this->mEmailTokenExpires
= $expiration;
3430 * Return a URL the user can use to confirm their email address.
3431 * @param $token String Accepts the email confirmation token
3432 * @return String New token URL
3434 private function confirmationTokenUrl( $token ) {
3435 return $this->getTokenUrl( 'ConfirmEmail', $token );
3439 * Return a URL the user can use to invalidate their email address.
3440 * @param $token String Accepts the email confirmation token
3441 * @return String New token URL
3443 private function invalidationTokenUrl( $token ) {
3444 return $this->getTokenUrl( 'InvalidateEmail', $token );
3448 * Internal function to format the e-mail validation/invalidation URLs.
3449 * This uses a quickie hack to use the
3450 * hardcoded English names of the Special: pages, for ASCII safety.
3452 * @note Since these URLs get dropped directly into emails, using the
3453 * short English names avoids insanely long URL-encoded links, which
3454 * also sometimes can get corrupted in some browsers/mailers
3455 * (bug 6957 with Gmail and Internet Explorer).
3457 * @param $page String Special page
3458 * @param $token String Token
3459 * @return String Formatted URL
3461 protected function getTokenUrl( $page, $token ) {
3462 // Hack to bypass localization of 'Special:'
3463 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3464 return $title->getCanonicalUrl();
3468 * Mark the e-mail address confirmed.
3470 * @note Call saveSettings() after calling this function to commit the change.
3474 public function confirmEmail() {
3475 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3476 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3481 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3482 * address if it was already confirmed.
3484 * @note Call saveSettings() after calling this function to commit the change.
3485 * @return bool Returns true
3487 function invalidateEmail() {
3489 $this->mEmailToken
= null;
3490 $this->mEmailTokenExpires
= null;
3491 $this->setEmailAuthenticationTimestamp( null );
3492 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3497 * Set the e-mail authentication timestamp.
3498 * @param $timestamp String TS_MW timestamp
3500 function setEmailAuthenticationTimestamp( $timestamp ) {
3502 $this->mEmailAuthenticated
= $timestamp;
3503 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3507 * Is this user allowed to send e-mails within limits of current
3508 * site configuration?
3511 public function canSendEmail() {
3512 global $wgEnableEmail, $wgEnableUserEmail;
3513 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3516 $canSend = $this->isEmailConfirmed();
3517 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3522 * Is this user allowed to receive e-mails within limits of current
3523 * site configuration?
3526 public function canReceiveEmail() {
3527 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3531 * Is this user's e-mail address valid-looking and confirmed within
3532 * limits of the current site configuration?
3534 * @note If $wgEmailAuthentication is on, this may require the user to have
3535 * confirmed their address by returning a code or using a password
3536 * sent to the address from the wiki.
3540 public function isEmailConfirmed() {
3541 global $wgEmailAuthentication;
3544 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3545 if( $this->isAnon() ) {
3548 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3551 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3561 * Check whether there is an outstanding request for e-mail confirmation.
3564 public function isEmailConfirmationPending() {
3565 global $wgEmailAuthentication;
3566 return $wgEmailAuthentication &&
3567 !$this->isEmailConfirmed() &&
3568 $this->mEmailToken
&&
3569 $this->mEmailTokenExpires
> wfTimestamp();
3573 * Get the timestamp of account creation.
3575 * @return String|Bool Timestamp of account creation, or false for
3576 * non-existent/anonymous user accounts.
3578 public function getRegistration() {
3579 if ( $this->isAnon() ) {
3583 return $this->mRegistration
;
3587 * Get the timestamp of the first edit
3589 * @return String|Bool Timestamp of first edit, or false for
3590 * non-existent/anonymous user accounts.
3592 public function getFirstEditTimestamp() {
3593 if( $this->getId() == 0 ) {
3594 return false; // anons
3596 $dbr = wfGetDB( DB_SLAVE
);
3597 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3598 array( 'rev_user' => $this->getId() ),
3600 array( 'ORDER BY' => 'rev_timestamp ASC' )
3603 return false; // no edits
3605 return wfTimestamp( TS_MW
, $time );
3609 * Get the permissions associated with a given list of groups
3611 * @param $groups Array of Strings List of internal group names
3612 * @return Array of Strings List of permission key names for given groups combined
3614 public static function getGroupPermissions( $groups ) {
3615 global $wgGroupPermissions, $wgRevokePermissions;
3617 // grant every granted permission first
3618 foreach( $groups as $group ) {
3619 if( isset( $wgGroupPermissions[$group] ) ) {
3620 $rights = array_merge( $rights,
3621 // array_filter removes empty items
3622 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3625 // now revoke the revoked permissions
3626 foreach( $groups as $group ) {
3627 if( isset( $wgRevokePermissions[$group] ) ) {
3628 $rights = array_diff( $rights,
3629 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3632 return array_unique( $rights );
3636 * Get all the groups who have a given permission
3638 * @param $role String Role to check
3639 * @return Array of Strings List of internal group names with the given permission
3641 public static function getGroupsWithPermission( $role ) {
3642 global $wgGroupPermissions;
3643 $allowedGroups = array();
3644 foreach ( $wgGroupPermissions as $group => $rights ) {
3645 if ( isset( $rights[$role] ) && $rights[$role] ) {
3646 $allowedGroups[] = $group;
3649 return $allowedGroups;
3653 * Get the localized descriptive name for a group, if it exists
3655 * @param $group String Internal group name
3656 * @return String Localized descriptive group name
3658 public static function getGroupName( $group ) {
3659 $msg = wfMessage( "group-$group" );
3660 return $msg->isBlank() ?
$group : $msg->text();
3664 * Get the localized descriptive name for a member of a group, if it exists
3666 * @param $group String Internal group name
3667 * @param $username String Username for gender (since 1.19)
3668 * @return String Localized name for group member
3670 public static function getGroupMember( $group, $username = '#' ) {
3671 $msg = wfMessage( "group-$group-member", $username );
3672 return $msg->isBlank() ?
$group : $msg->text();
3676 * Return the set of defined explicit groups.
3677 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3678 * are not included, as they are defined automatically, not in the database.
3679 * @return Array of internal group names
3681 public static function getAllGroups() {
3682 global $wgGroupPermissions, $wgRevokePermissions;
3684 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3685 self
::getImplicitGroups()
3690 * Get a list of all available permissions.
3691 * @return Array of permission names
3693 public static function getAllRights() {
3694 if ( self
::$mAllRights === false ) {
3695 global $wgAvailableRights;
3696 if ( count( $wgAvailableRights ) ) {
3697 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3699 self
::$mAllRights = self
::$mCoreRights;
3701 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3703 return self
::$mAllRights;
3707 * Get a list of implicit groups
3708 * @return Array of Strings Array of internal group names
3710 public static function getImplicitGroups() {
3711 global $wgImplicitGroups;
3712 $groups = $wgImplicitGroups;
3713 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3718 * Get the title of a page describing a particular group
3720 * @param $group String Internal group name
3721 * @return Title|Bool Title of the page if it exists, false otherwise
3723 public static function getGroupPage( $group ) {
3724 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3725 if( $msg->exists() ) {
3726 $title = Title
::newFromText( $msg->text() );
3727 if( is_object( $title ) )
3734 * Create a link to the group in HTML, if available;
3735 * else return the group name.
3737 * @param $group String Internal name of the group
3738 * @param $text String The text of the link
3739 * @return String HTML link to the group
3741 public static function makeGroupLinkHTML( $group, $text = '' ) {
3743 $text = self
::getGroupName( $group );
3745 $title = self
::getGroupPage( $group );
3747 return Linker
::link( $title, htmlspecialchars( $text ) );
3754 * Create a link to the group in Wikitext, if available;
3755 * else return the group name.
3757 * @param $group String Internal name of the group
3758 * @param $text String The text of the link
3759 * @return String Wikilink to the group
3761 public static function makeGroupLinkWiki( $group, $text = '' ) {
3763 $text = self
::getGroupName( $group );
3765 $title = self
::getGroupPage( $group );
3767 $page = $title->getPrefixedText();
3768 return "[[$page|$text]]";
3775 * Returns an array of the groups that a particular group can add/remove.
3777 * @param $group String: the group to check for whether it can add/remove
3778 * @return Array array( 'add' => array( addablegroups ),
3779 * 'remove' => array( removablegroups ),
3780 * 'add-self' => array( addablegroups to self),
3781 * 'remove-self' => array( removable groups from self) )
3783 public static function changeableByGroup( $group ) {
3784 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3786 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3787 if( empty( $wgAddGroups[$group] ) ) {
3788 // Don't add anything to $groups
3789 } elseif( $wgAddGroups[$group] === true ) {
3790 // You get everything
3791 $groups['add'] = self
::getAllGroups();
3792 } elseif( is_array( $wgAddGroups[$group] ) ) {
3793 $groups['add'] = $wgAddGroups[$group];
3796 // Same thing for remove
3797 if( empty( $wgRemoveGroups[$group] ) ) {
3798 } elseif( $wgRemoveGroups[$group] === true ) {
3799 $groups['remove'] = self
::getAllGroups();
3800 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3801 $groups['remove'] = $wgRemoveGroups[$group];
3804 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3805 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3806 foreach( $wgGroupsAddToSelf as $key => $value ) {
3807 if( is_int( $key ) ) {
3808 $wgGroupsAddToSelf['user'][] = $value;
3813 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3814 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3815 if( is_int( $key ) ) {
3816 $wgGroupsRemoveFromSelf['user'][] = $value;
3821 // Now figure out what groups the user can add to him/herself
3822 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3823 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3824 // No idea WHY this would be used, but it's there
3825 $groups['add-self'] = User
::getAllGroups();
3826 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3827 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3830 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3831 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3832 $groups['remove-self'] = User
::getAllGroups();
3833 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3834 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3841 * Returns an array of groups that this user can add and remove
3842 * @return Array array( 'add' => array( addablegroups ),
3843 * 'remove' => array( removablegroups ),
3844 * 'add-self' => array( addablegroups to self),
3845 * 'remove-self' => array( removable groups from self) )
3847 public function changeableGroups() {
3848 if( $this->isAllowed( 'userrights' ) ) {
3849 // This group gives the right to modify everything (reverse-
3850 // compatibility with old "userrights lets you change
3852 // Using array_merge to make the groups reindexed
3853 $all = array_merge( User
::getAllGroups() );
3857 'add-self' => array(),
3858 'remove-self' => array()
3862 // Okay, it's not so simple, we will have to go through the arrays
3865 'remove' => array(),
3866 'add-self' => array(),
3867 'remove-self' => array()
3869 $addergroups = $this->getEffectiveGroups();
3871 foreach( $addergroups as $addergroup ) {
3872 $groups = array_merge_recursive(
3873 $groups, $this->changeableByGroup( $addergroup )
3875 $groups['add'] = array_unique( $groups['add'] );
3876 $groups['remove'] = array_unique( $groups['remove'] );
3877 $groups['add-self'] = array_unique( $groups['add-self'] );
3878 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3884 * Increment the user's edit-count field.
3885 * Will have no effect for anonymous users.
3887 public function incEditCount() {
3888 if( !$this->isAnon() ) {
3889 $dbw = wfGetDB( DB_MASTER
);
3890 $dbw->update( 'user',
3891 array( 'user_editcount=user_editcount+1' ),
3892 array( 'user_id' => $this->getId() ),
3895 // Lazy initialization check...
3896 if( $dbw->affectedRows() == 0 ) {
3897 // Pull from a slave to be less cruel to servers
3898 // Accuracy isn't the point anyway here
3899 $dbr = wfGetDB( DB_SLAVE
);
3900 $count = $dbr->selectField( 'revision',
3902 array( 'rev_user' => $this->getId() ),
3905 // Now here's a goddamn hack...
3906 if( $dbr !== $dbw ) {
3907 // If we actually have a slave server, the count is
3908 // at least one behind because the current transaction
3909 // has not been committed and replicated.
3912 // But if DB_SLAVE is selecting the master, then the
3913 // count we just read includes the revision that was
3914 // just added in the working transaction.
3917 $dbw->update( 'user',
3918 array( 'user_editcount' => $count ),
3919 array( 'user_id' => $this->getId() ),
3923 // edit count in user cache too
3924 $this->invalidateCache();
3928 * Get the description of a given right
3930 * @param $right String Right to query
3931 * @return String Localized description of the right
3933 public static function getRightDescription( $right ) {
3934 $key = "right-$right";
3935 $msg = wfMessage( $key );
3936 return $msg->isBlank() ?
$right : $msg->text();
3940 * Make an old-style password hash
3942 * @param $password String Plain-text password
3943 * @param $userId String User ID
3944 * @return String Password hash
3946 public static function oldCrypt( $password, $userId ) {
3947 global $wgPasswordSalt;
3948 if ( $wgPasswordSalt ) {
3949 return md5( $userId . '-' . md5( $password ) );
3951 return md5( $password );
3956 * Make a new-style password hash
3958 * @param $password String Plain-text password
3959 * @param bool|string $salt Optional salt, may be random or the user ID.
3961 * If unspecified or false, will generate one automatically
3962 * @return String Password hash
3964 public static function crypt( $password, $salt = false ) {
3965 global $wgPasswordSalt;
3968 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3972 if( $wgPasswordSalt ) {
3973 if ( $salt === false ) {
3974 $salt = MWCryptRand
::generateHex( 8 );
3976 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3978 return ':A:' . md5( $password );
3983 * Compare a password hash with a plain-text password. Requires the user
3984 * ID if there's a chance that the hash is an old-style hash.
3986 * @param $hash String Password hash
3987 * @param $password String Plain-text password to compare
3988 * @param $userId String|bool User ID for old-style password salt
3992 public static function comparePasswords( $hash, $password, $userId = false ) {
3993 $type = substr( $hash, 0, 3 );
3996 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4000 if ( $type == ':A:' ) {
4002 return md5( $password ) === substr( $hash, 3 );
4003 } elseif ( $type == ':B:' ) {
4005 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4006 return md5( $salt.'-'.md5( $password ) ) === $realHash;
4009 return self
::oldCrypt( $password, $userId ) === $hash;
4014 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
4016 * @param $byEmail Boolean: account made by email?
4017 * @param $reason String: user supplied reason
4019 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4021 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
4022 global $wgUser, $wgContLang, $wgNewUserLog;
4023 if( empty( $wgNewUserLog ) ) {
4024 return true; // disabled
4027 if( $this->getName() == $wgUser->getName() ) {
4030 $action = 'create2';
4032 if ( $reason === '' ) {
4033 $reason = wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text();
4035 $reason = $wgContLang->commaList( array(
4036 $reason, wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text() ) );
4040 $log = new LogPage( 'newusers' );
4041 return (int)$log->addEntry(
4043 $this->getUserPage(),
4045 array( $this->getId() )
4050 * Add an autocreate newuser log entry for this user
4051 * Used by things like CentralAuth and perhaps other authplugins.
4055 public function addNewUserLogEntryAutoCreate() {
4056 global $wgNewUserLog;
4057 if( !$wgNewUserLog ) {
4058 return true; // disabled
4060 $log = new LogPage( 'newusers', false );
4061 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4068 protected function loadOptions() {
4070 if ( $this->mOptionsLoaded ||
!$this->getId() )
4073 $this->mOptions
= self
::getDefaultOptions();
4075 // Maybe load from the object
4076 if ( !is_null( $this->mOptionOverrides
) ) {
4077 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4078 foreach( $this->mOptionOverrides
as $key => $value ) {
4079 $this->mOptions
[$key] = $value;
4082 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4083 // Load from database
4084 $dbr = wfGetDB( DB_SLAVE
);
4086 $res = $dbr->select(
4088 array( 'up_property', 'up_value' ),
4089 array( 'up_user' => $this->getId() ),
4093 $this->mOptionOverrides
= array();
4094 foreach ( $res as $row ) {
4095 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4096 $this->mOptions
[$row->up_property
] = $row->up_value
;
4100 $this->mOptionsLoaded
= true;
4102 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4108 protected function saveOptions() {
4109 global $wgAllowPrefChange;
4111 $this->loadOptions();
4113 // Not using getOptions(), to keep hidden preferences in database
4114 $saveOptions = $this->mOptions
;
4116 // Allow hooks to abort, for instance to save to a global profile.
4117 // Reset options to default state before saving.
4118 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4122 $extuser = ExternalUser
::newFromUser( $this );
4123 $userId = $this->getId();
4124 $insert_rows = array();
4125 foreach( $saveOptions as $key => $value ) {
4126 # Don't bother storing default values
4127 $defaultOption = self
::getDefaultOption( $key );
4128 if ( ( is_null( $defaultOption ) &&
4129 !( $value === false ||
is_null( $value ) ) ) ||
4130 $value != $defaultOption ) {
4131 $insert_rows[] = array(
4132 'up_user' => $userId,
4133 'up_property' => $key,
4134 'up_value' => $value,
4137 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4138 switch ( $wgAllowPrefChange[$key] ) {
4144 $extuser->setPref( $key, $value );
4149 $dbw = wfGetDB( DB_MASTER
);
4150 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4151 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4155 * Provide an array of HTML5 attributes to put on an input element
4156 * intended for the user to enter a new password. This may include
4157 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4159 * Do *not* use this when asking the user to enter his current password!
4160 * Regardless of configuration, users may have invalid passwords for whatever
4161 * reason (e.g., they were set before requirements were tightened up).
4162 * Only use it when asking for a new password, like on account creation or
4165 * Obviously, you still need to do server-side checking.
4167 * NOTE: A combination of bugs in various browsers means that this function
4168 * actually just returns array() unconditionally at the moment. May as
4169 * well keep it around for when the browser bugs get fixed, though.
4171 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4173 * @return array Array of HTML attributes suitable for feeding to
4174 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4175 * That will potentially output invalid XHTML 1.0 Transitional, and will
4176 * get confused by the boolean attribute syntax used.)
4178 public static function passwordChangeInputAttribs() {
4179 global $wgMinimalPasswordLength;
4181 if ( $wgMinimalPasswordLength == 0 ) {
4185 # Note that the pattern requirement will always be satisfied if the
4186 # input is empty, so we need required in all cases.
4188 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4189 # if e-mail confirmation is being used. Since HTML5 input validation
4190 # is b0rked anyway in some browsers, just return nothing. When it's
4191 # re-enabled, fix this code to not output required for e-mail
4193 #$ret = array( 'required' );
4196 # We can't actually do this right now, because Opera 9.6 will print out
4197 # the entered password visibly in its error message! When other
4198 # browsers add support for this attribute, or Opera fixes its support,
4199 # we can add support with a version check to avoid doing this on Opera
4200 # versions where it will be a problem. Reported to Opera as
4201 # DSK-262266, but they don't have a public bug tracker for us to follow.
4203 if ( $wgMinimalPasswordLength > 1 ) {
4204 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4205 $ret['title'] = wfMessage( 'passwordtooshort' )
4206 ->numParams( $wgMinimalPasswordLength )->text();
4214 * Return the list of user fields that should be selected to create
4215 * a new user object.
4218 public static function selectFields() {
4225 'user_newpass_time',
4229 'user_email_authenticated',
4231 'user_email_token_expires',
4232 'user_registration',