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 * @throws MWException
769 * @return bool|string
771 public static function getCanonicalName( $name, $validate = 'valid' ) {
772 # Force usernames to capital
774 $name = $wgContLang->ucfirst( $name );
776 # Reject names containing '#'; these will be cleaned up
777 # with title normalisation, but then it's too late to
779 if( strpos( $name, '#' ) !== false )
782 # Clean up name according to title rules
783 $t = ( $validate === 'valid' ) ?
784 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
785 # Check for invalid titles
786 if( is_null( $t ) ) {
790 # Reject various classes of invalid names
792 $name = $wgAuth->getCanonicalName( $t->getText() );
794 switch ( $validate ) {
798 if ( !User
::isValidUserName( $name ) ) {
803 if ( !User
::isUsableName( $name ) ) {
808 if ( !User
::isCreatableName( $name ) ) {
813 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
819 * Count the number of edits of a user
821 * @param $uid Int User ID to check
822 * @return Int the user's edit count
824 * @deprecated since 1.21 in favour of User::getEditCount
826 public static function edits( $uid ) {
827 wfDeprecated( __METHOD__
, '1.21' );
828 $user = self
::newFromId( $uid );
829 return $user->getEditCount();
833 * Return a random password.
835 * @return String new random password
837 public static function randomPassword() {
838 global $wgMinimalPasswordLength;
839 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
840 $length = max( 10, $wgMinimalPasswordLength );
841 // Multiply by 1.25 to get the number of hex characters we need
842 $length = $length * 1.25;
843 // Generate random hex chars
844 $hex = MWCryptRand
::generateHex( $length );
845 // Convert from base 16 to base 32 to get a proper password like string
846 return wfBaseConvert( $hex, 16, 32 );
850 * Set cached properties to default.
852 * @note This no longer clears uncached lazy-initialised properties;
853 * the constructor does that instead.
855 * @param $name string
857 public function loadDefaults( $name = false ) {
858 wfProfileIn( __METHOD__
);
861 $this->mName
= $name;
862 $this->mRealName
= '';
863 $this->mPassword
= $this->mNewpassword
= '';
864 $this->mNewpassTime
= null;
866 $this->mOptionOverrides
= null;
867 $this->mOptionsLoaded
= false;
869 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
870 if( $loggedOut !== null ) {
871 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
873 $this->mTouched
= '1'; # Allow any pages to be cached
876 $this->mToken
= null; // Don't run cryptographic functions till we need a token
877 $this->mEmailAuthenticated
= null;
878 $this->mEmailToken
= '';
879 $this->mEmailTokenExpires
= null;
880 $this->mRegistration
= wfTimestamp( TS_MW
);
881 $this->mGroups
= array();
883 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
885 wfProfileOut( __METHOD__
);
889 * Return whether an item has been loaded.
891 * @param $item String: item to check. Current possibilities:
895 * @param $all String: 'all' to check if the whole object has been loaded
896 * or any other string to check if only the item is available (e.g.
900 public function isItemLoaded( $item, $all = 'all' ) {
901 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
902 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
906 * Set that an item has been loaded
908 * @param $item String
910 private function setItemLoaded( $item ) {
911 if ( is_array( $this->mLoadedItems
) ) {
912 $this->mLoadedItems
[$item] = true;
917 * Load user data from the session or login cookie.
918 * @return Bool True if the user is logged in, false otherwise.
920 private function loadFromSession() {
921 global $wgExternalAuthType, $wgAutocreatePolicy;
924 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
925 if ( $result !== null ) {
929 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
930 $extUser = ExternalUser
::newFromCookie();
932 # TODO: Automatically create the user here (or probably a bit
933 # lower down, in fact)
937 $request = $this->getRequest();
939 $cookieId = $request->getCookie( 'UserID' );
940 $sessId = $request->getSessionData( 'wsUserID' );
942 if ( $cookieId !== null ) {
943 $sId = intval( $cookieId );
944 if( $sessId !== null && $cookieId != $sessId ) {
945 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
946 cookie user ID ($sId) don't match!" );
949 $request->setSessionData( 'wsUserID', $sId );
950 } elseif ( $sessId !== null && $sessId != 0 ) {
956 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
957 $sName = $request->getSessionData( 'wsUserName' );
958 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
959 $sName = $request->getCookie( 'UserName' );
960 $request->setSessionData( 'wsUserName', $sName );
965 $proposedUser = User
::newFromId( $sId );
966 if ( !$proposedUser->isLoggedIn() ) {
971 global $wgBlockDisablesLogin;
972 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
973 # User blocked and we've disabled blocked user logins
977 if ( $request->getSessionData( 'wsToken' ) ) {
978 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
980 } elseif ( $request->getCookie( 'Token' ) ) {
981 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
984 # No session or persistent login cookie
988 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
989 $this->loadFromUserObject( $proposedUser );
990 $request->setSessionData( 'wsToken', $this->mToken
);
991 wfDebug( "User: logged in from $from\n" );
994 # Invalid credentials
995 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1001 * Load user and user_group data from the database.
1002 * $this->mId must be set, this is how the user is identified.
1004 * @return Bool True if the user exists, false if the user is anonymous
1006 public function loadFromDatabase() {
1008 $this->mId
= intval( $this->mId
);
1010 /** Anonymous user */
1012 $this->loadDefaults();
1016 $dbr = wfGetDB( DB_MASTER
);
1017 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1019 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1021 if ( $s !== false ) {
1022 # Initialise user table data
1023 $this->loadFromRow( $s );
1024 $this->mGroups
= null; // deferred
1025 $this->getEditCount(); // revalidation for nulls
1030 $this->loadDefaults();
1036 * Initialize this object from a row from the user table.
1038 * @param $row Array Row from the user table to load.
1040 public function loadFromRow( $row ) {
1043 $this->mGroups
= null; // deferred
1045 if ( isset( $row->user_name
) ) {
1046 $this->mName
= $row->user_name
;
1047 $this->mFrom
= 'name';
1048 $this->setItemLoaded( 'name' );
1053 if ( isset( $row->user_real_name
) ) {
1054 $this->mRealName
= $row->user_real_name
;
1055 $this->setItemLoaded( 'realname' );
1060 if ( isset( $row->user_id
) ) {
1061 $this->mId
= intval( $row->user_id
);
1062 $this->mFrom
= 'id';
1063 $this->setItemLoaded( 'id' );
1068 if ( isset( $row->user_editcount
) ) {
1069 $this->mEditCount
= $row->user_editcount
;
1074 if ( isset( $row->user_password
) ) {
1075 $this->mPassword
= $row->user_password
;
1076 $this->mNewpassword
= $row->user_newpassword
;
1077 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1078 $this->mEmail
= $row->user_email
;
1079 if ( isset( $row->user_options
) ) {
1080 $this->decodeOptions( $row->user_options
);
1082 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1083 $this->mToken
= $row->user_token
;
1084 if ( $this->mToken
== '' ) {
1085 $this->mToken
= null;
1087 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1088 $this->mEmailToken
= $row->user_email_token
;
1089 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1090 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1096 $this->mLoadedItems
= true;
1101 * Load the data for this user object from another user object.
1105 protected function loadFromUserObject( $user ) {
1107 $user->loadGroups();
1108 $user->loadOptions();
1109 foreach ( self
::$mCacheVars as $var ) {
1110 $this->$var = $user->$var;
1115 * Load the groups from the database if they aren't already loaded.
1117 private function loadGroups() {
1118 if ( is_null( $this->mGroups
) ) {
1119 $dbr = wfGetDB( DB_MASTER
);
1120 $res = $dbr->select( 'user_groups',
1121 array( 'ug_group' ),
1122 array( 'ug_user' => $this->mId
),
1124 $this->mGroups
= array();
1125 foreach ( $res as $row ) {
1126 $this->mGroups
[] = $row->ug_group
;
1132 * Add the user to the group if he/she meets given criteria.
1134 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1135 * possible to remove manually via Special:UserRights. In such case it
1136 * will not be re-added automatically. The user will also not lose the
1137 * group if they no longer meet the criteria.
1139 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1141 * @return array Array of groups the user has been promoted to.
1143 * @see $wgAutopromoteOnce
1145 public function addAutopromoteOnceGroups( $event ) {
1146 global $wgAutopromoteOnceLogInRC;
1148 $toPromote = array();
1149 if ( $this->getId() ) {
1150 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1151 if ( count( $toPromote ) ) {
1152 $oldGroups = $this->getGroups(); // previous groups
1153 foreach ( $toPromote as $group ) {
1154 $this->addGroup( $group );
1156 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1158 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1159 $log->addEntry( 'autopromote',
1160 $this->getUserPage(),
1162 // These group names are "list to texted"-ed in class LogPage.
1163 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1171 * Clear various cached data stored in this object. The cache of the user table
1172 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1174 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1175 * given source. May be "name", "id", "defaults", "session", or false for
1178 public function clearInstanceCache( $reloadFrom = false ) {
1179 $this->mNewtalk
= -1;
1180 $this->mDatePreference
= null;
1181 $this->mBlockedby
= -1; # Unset
1182 $this->mHash
= false;
1183 $this->mRights
= null;
1184 $this->mEffectiveGroups
= null;
1185 $this->mImplicitGroups
= null;
1186 $this->mOptions
= null;
1187 $this->mOptionsLoaded
= false;
1188 $this->mEditCount
= null;
1190 if ( $reloadFrom ) {
1191 $this->mLoadedItems
= array();
1192 $this->mFrom
= $reloadFrom;
1197 * Combine the language default options with any site-specific options
1198 * and add the default language variants.
1200 * @return Array of String options
1202 public static function getDefaultOptions() {
1203 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1205 $defOpt = $wgDefaultUserOptions;
1206 # default language setting
1207 $defOpt['variant'] = $wgContLang->getCode();
1208 $defOpt['language'] = $wgContLang->getCode();
1209 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1210 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1212 $defOpt['skin'] = $wgDefaultSkin;
1214 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1215 // but that breaks the parser tests because they rely on being able to change $wgContLang
1216 // mid-request and see that change reflected in the return value of this function.
1217 // Which is insane and would never happen during normal MW operation, but is also not
1218 // likely to get fixed unless and until we context-ify everything.
1219 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1220 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1226 * Get a given default option value.
1228 * @param $opt String Name of option to retrieve
1229 * @return String Default option value
1231 public static function getDefaultOption( $opt ) {
1232 $defOpts = self
::getDefaultOptions();
1233 if( isset( $defOpts[$opt] ) ) {
1234 return $defOpts[$opt];
1242 * Get blocking information
1243 * @param $bFromSlave Bool Whether to check the slave database first. To
1244 * improve performance, non-critical checks are done
1245 * against slaves. Check when actually saving should be
1246 * done against master.
1248 private function getBlockedStatus( $bFromSlave = true ) {
1249 global $wgProxyWhitelist, $wgUser;
1251 if ( -1 != $this->mBlockedby
) {
1255 wfProfileIn( __METHOD__
);
1256 wfDebug( __METHOD__
.": checking...\n" );
1258 // Initialize data...
1259 // Otherwise something ends up stomping on $this->mBlockedby when
1260 // things get lazy-loaded later, causing false positive block hits
1261 // due to -1 !== 0. Probably session-related... Nothing should be
1262 // overwriting mBlockedby, surely?
1265 # We only need to worry about passing the IP address to the Block generator if the
1266 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1267 # know which IP address they're actually coming from
1268 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1269 $ip = $this->getRequest()->getIP();
1275 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1278 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1279 && !in_array( $ip, $wgProxyWhitelist ) )
1282 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1284 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1285 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1286 $block->setTarget( $ip );
1287 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1289 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1290 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1291 $block->setTarget( $ip );
1295 if ( $block instanceof Block
) {
1296 wfDebug( __METHOD__
. ": Found block.\n" );
1297 $this->mBlock
= $block;
1298 $this->mBlockedby
= $block->getByName();
1299 $this->mBlockreason
= $block->mReason
;
1300 $this->mHideName
= $block->mHideName
;
1301 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1303 $this->mBlockedby
= '';
1304 $this->mHideName
= 0;
1305 $this->mAllowUsertalk
= false;
1309 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1311 wfProfileOut( __METHOD__
);
1315 * Whether the given IP is in a DNS blacklist.
1317 * @param $ip String IP to check
1318 * @param $checkWhitelist Bool: whether to check the whitelist first
1319 * @return Bool True if blacklisted.
1321 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1322 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1323 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1325 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1328 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1331 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1332 return $this->inDnsBlacklist( $ip, $urls );
1336 * Whether the given IP is in a given DNS blacklist.
1338 * @param $ip String IP to check
1339 * @param $bases String|Array of Strings: URL of the DNS blacklist
1340 * @return Bool True if blacklisted.
1342 public function inDnsBlacklist( $ip, $bases ) {
1343 wfProfileIn( __METHOD__
);
1346 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1347 if( IP
::isIPv4( $ip ) ) {
1348 # Reverse IP, bug 21255
1349 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1351 foreach( (array)$bases as $base ) {
1353 # If we have an access key, use that too (ProjectHoneypot, etc.)
1354 if( is_array( $base ) ) {
1355 if( count( $base ) >= 2 ) {
1356 # Access key is 1, base URL is 0
1357 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1359 $host = "$ipReversed.{$base[0]}";
1362 $host = "$ipReversed.$base";
1366 $ipList = gethostbynamel( $host );
1369 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1373 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1378 wfProfileOut( __METHOD__
);
1383 * Check if an IP address is in the local proxy list
1389 public static function isLocallyBlockedProxy( $ip ) {
1390 global $wgProxyList;
1392 if ( !$wgProxyList ) {
1395 wfProfileIn( __METHOD__
);
1397 if ( !is_array( $wgProxyList ) ) {
1398 # Load from the specified file
1399 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1402 if ( !is_array( $wgProxyList ) ) {
1404 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1406 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1407 # Old-style flipped proxy list
1412 wfProfileOut( __METHOD__
);
1417 * Is this user subject to rate limiting?
1419 * @return Bool True if rate limited
1421 public function isPingLimitable() {
1422 global $wgRateLimitsExcludedIPs;
1423 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1424 // No other good way currently to disable rate limits
1425 // for specific IPs. :P
1426 // But this is a crappy hack and should die.
1429 return !$this->isAllowed('noratelimit');
1433 * Primitive rate limits: enforce maximum actions per time period
1434 * to put a brake on flooding.
1436 * @note When using a shared cache like memcached, IP-address
1437 * last-hit counters will be shared across wikis.
1439 * @param $action String Action to enforce; 'edit' if unspecified
1440 * @return Bool True if a rate limiter was tripped
1442 public function pingLimiter( $action = 'edit' ) {
1443 # Call the 'PingLimiter' hook
1445 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1449 global $wgRateLimits;
1450 if( !isset( $wgRateLimits[$action] ) ) {
1454 # Some groups shouldn't trigger the ping limiter, ever
1455 if( !$this->isPingLimitable() )
1458 global $wgMemc, $wgRateLimitLog;
1459 wfProfileIn( __METHOD__
);
1461 $limits = $wgRateLimits[$action];
1463 $id = $this->getId();
1464 $ip = $this->getRequest()->getIP();
1467 if( isset( $limits['anon'] ) && $id == 0 ) {
1468 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1471 if( isset( $limits['user'] ) && $id != 0 ) {
1472 $userLimit = $limits['user'];
1474 if( $this->isNewbie() ) {
1475 if( isset( $limits['newbie'] ) && $id != 0 ) {
1476 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1478 if( isset( $limits['ip'] ) ) {
1479 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1482 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1483 $subnet = $matches[1];
1484 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1487 // Check for group-specific permissions
1488 // If more than one group applies, use the group with the highest limit
1489 foreach ( $this->getGroups() as $group ) {
1490 if ( isset( $limits[$group] ) ) {
1491 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1492 $userLimit = $limits[$group];
1496 // Set the user limit key
1497 if ( $userLimit !== false ) {
1498 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1499 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1503 foreach( $keys as $key => $limit ) {
1504 list( $max, $period ) = $limit;
1505 $summary = "(limit $max in {$period}s)";
1506 $count = $wgMemc->get( $key );
1509 if( $count >= $max ) {
1510 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1511 if( $wgRateLimitLog ) {
1512 wfSuppressWarnings();
1513 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1514 wfRestoreWarnings();
1518 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1521 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1522 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1524 $wgMemc->incr( $key );
1527 wfProfileOut( __METHOD__
);
1532 * Check if user is blocked
1534 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1535 * @return Bool True if blocked, false otherwise
1537 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1538 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1542 * Get the block affecting the user, or null if the user is not blocked
1544 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1545 * @return Block|null
1547 public function getBlock( $bFromSlave = true ){
1548 $this->getBlockedStatus( $bFromSlave );
1549 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1553 * Check if user is blocked from editing a particular article
1555 * @param $title Title to check
1556 * @param $bFromSlave Bool whether to check the slave database instead of the master
1559 function isBlockedFrom( $title, $bFromSlave = false ) {
1560 global $wgBlockAllowsUTEdit;
1561 wfProfileIn( __METHOD__
);
1563 $blocked = $this->isBlocked( $bFromSlave );
1564 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1565 # If a user's name is suppressed, they cannot make edits anywhere
1566 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1567 $title->getNamespace() == NS_USER_TALK
) {
1569 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1572 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1574 wfProfileOut( __METHOD__
);
1579 * If user is blocked, return the name of the user who placed the block
1580 * @return String name of blocker
1582 public function blockedBy() {
1583 $this->getBlockedStatus();
1584 return $this->mBlockedby
;
1588 * If user is blocked, return the specified reason for the block
1589 * @return String Blocking reason
1591 public function blockedFor() {
1592 $this->getBlockedStatus();
1593 return $this->mBlockreason
;
1597 * If user is blocked, return the ID for the block
1598 * @return Int Block ID
1600 public function getBlockId() {
1601 $this->getBlockedStatus();
1602 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1606 * Check if user is blocked on all wikis.
1607 * Do not use for actual edit permission checks!
1608 * This is intented for quick UI checks.
1610 * @param $ip String IP address, uses current client if none given
1611 * @return Bool True if blocked, false otherwise
1613 public function isBlockedGlobally( $ip = '' ) {
1614 if( $this->mBlockedGlobally
!== null ) {
1615 return $this->mBlockedGlobally
;
1617 // User is already an IP?
1618 if( IP
::isIPAddress( $this->getName() ) ) {
1619 $ip = $this->getName();
1621 $ip = $this->getRequest()->getIP();
1624 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1625 $this->mBlockedGlobally
= (bool)$blocked;
1626 return $this->mBlockedGlobally
;
1630 * Check if user account is locked
1632 * @return Bool True if locked, false otherwise
1634 public function isLocked() {
1635 if( $this->mLocked
!== null ) {
1636 return $this->mLocked
;
1639 $authUser = $wgAuth->getUserInstance( $this );
1640 $this->mLocked
= (bool)$authUser->isLocked();
1641 return $this->mLocked
;
1645 * Check if user account is hidden
1647 * @return Bool True if hidden, false otherwise
1649 public function isHidden() {
1650 if( $this->mHideName
!== null ) {
1651 return $this->mHideName
;
1653 $this->getBlockedStatus();
1654 if( !$this->mHideName
) {
1656 $authUser = $wgAuth->getUserInstance( $this );
1657 $this->mHideName
= (bool)$authUser->isHidden();
1659 return $this->mHideName
;
1663 * Get the user's ID.
1664 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1666 public function getId() {
1667 if( $this->mId
=== null && $this->mName
!== null
1668 && User
::isIP( $this->mName
) ) {
1669 // Special case, we know the user is anonymous
1671 } elseif( !$this->isItemLoaded( 'id' ) ) {
1672 // Don't load if this was initialized from an ID
1679 * Set the user and reload all fields according to a given ID
1680 * @param $v Int User ID to reload
1682 public function setId( $v ) {
1684 $this->clearInstanceCache( 'id' );
1688 * Get the user name, or the IP of an anonymous user
1689 * @return String User's name or IP address
1691 public function getName() {
1692 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1693 # Special case optimisation
1694 return $this->mName
;
1697 if ( $this->mName
=== false ) {
1699 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1701 return $this->mName
;
1706 * Set the user name.
1708 * This does not reload fields from the database according to the given
1709 * name. Rather, it is used to create a temporary "nonexistent user" for
1710 * later addition to the database. It can also be used to set the IP
1711 * address for an anonymous user to something other than the current
1714 * @note User::newFromName() has rougly the same function, when the named user
1716 * @param $str String New user name to set
1718 public function setName( $str ) {
1720 $this->mName
= $str;
1724 * Get the user's name escaped by underscores.
1725 * @return String Username escaped by underscores.
1727 public function getTitleKey() {
1728 return str_replace( ' ', '_', $this->getName() );
1732 * Check if the user has new messages.
1733 * @return Bool True if the user has new messages
1735 public function getNewtalk() {
1738 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1739 if( $this->mNewtalk
=== -1 ) {
1740 $this->mNewtalk
= false; # reset talk page status
1742 # Check memcached separately for anons, who have no
1743 # entire User object stored in there.
1745 global $wgDisableAnonTalk;
1746 if( $wgDisableAnonTalk ) {
1747 // Anon newtalk disabled by configuration.
1748 $this->mNewtalk
= false;
1751 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1752 $newtalk = $wgMemc->get( $key );
1753 if( strval( $newtalk ) !== '' ) {
1754 $this->mNewtalk
= (bool)$newtalk;
1756 // Since we are caching this, make sure it is up to date by getting it
1758 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1759 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1763 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1767 return (bool)$this->mNewtalk
;
1771 * Return the talk page(s) this user has new messages on.
1772 * @return Array of String page URLs
1774 public function getNewMessageLinks() {
1776 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1778 } elseif( !$this->getNewtalk() ) {
1781 $utp = $this->getTalkPage();
1782 $dbr = wfGetDB( DB_SLAVE
);
1783 // Get the "last viewed rev" timestamp from the oldest message notification
1784 $timestamp = $dbr->selectField( 'user_newtalk',
1785 'MIN(user_last_timestamp)',
1786 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1788 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1789 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1793 * Internal uncached check for new messages
1796 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1797 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1798 * @param $fromMaster Bool true to fetch from the master, false for a slave
1799 * @return Bool True if the user has new messages
1801 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1802 if ( $fromMaster ) {
1803 $db = wfGetDB( DB_MASTER
);
1805 $db = wfGetDB( DB_SLAVE
);
1807 $ok = $db->selectField( 'user_newtalk', $field,
1808 array( $field => $id ), __METHOD__
);
1809 return $ok !== false;
1813 * Add or update the new messages flag
1814 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1815 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1816 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1817 * @return Bool True if successful, false otherwise
1819 protected function updateNewtalk( $field, $id, $curRev = null ) {
1820 // Get timestamp of the talk page revision prior to the current one
1821 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1822 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1823 // Mark the user as having new messages since this revision
1824 $dbw = wfGetDB( DB_MASTER
);
1825 $dbw->insert( 'user_newtalk',
1826 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1829 if ( $dbw->affectedRows() ) {
1830 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1833 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1839 * Clear the new messages flag for the given user
1840 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1841 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1842 * @return Bool True if successful, false otherwise
1844 protected function deleteNewtalk( $field, $id ) {
1845 $dbw = wfGetDB( DB_MASTER
);
1846 $dbw->delete( 'user_newtalk',
1847 array( $field => $id ),
1849 if ( $dbw->affectedRows() ) {
1850 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1853 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1859 * Update the 'You have new messages!' status.
1860 * @param $val Bool Whether the user has new messages
1861 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1863 public function setNewtalk( $val, $curRev = null ) {
1864 if( wfReadOnly() ) {
1869 $this->mNewtalk
= $val;
1871 if( $this->isAnon() ) {
1873 $id = $this->getName();
1876 $id = $this->getId();
1881 $changed = $this->updateNewtalk( $field, $id, $curRev );
1883 $changed = $this->deleteNewtalk( $field, $id );
1886 if( $this->isAnon() ) {
1887 // Anons have a separate memcached space, since
1888 // user records aren't kept for them.
1889 $key = wfMemcKey( 'newtalk', 'ip', $id );
1890 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1893 $this->invalidateCache();
1898 * Generate a current or new-future timestamp to be stored in the
1899 * user_touched field when we update things.
1900 * @return String Timestamp in TS_MW format
1902 private static function newTouchedTimestamp() {
1903 global $wgClockSkewFudge;
1904 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1908 * Clear user data from memcached.
1909 * Use after applying fun updates to the database; caller's
1910 * responsibility to update user_touched if appropriate.
1912 * Called implicitly from invalidateCache() and saveSettings().
1914 private function clearSharedCache() {
1918 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1923 * Immediately touch the user data cache for this account.
1924 * Updates user_touched field, and removes account data from memcached
1925 * for reload on the next hit.
1927 public function invalidateCache() {
1928 if( wfReadOnly() ) {
1933 $this->mTouched
= self
::newTouchedTimestamp();
1935 $dbw = wfGetDB( DB_MASTER
);
1937 // Prevent contention slams by checking user_touched first
1938 $now = $dbw->timestamp( $this->mTouched
);
1939 $needsPurge = $dbw->selectField( 'user', '1',
1940 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1942 if ( $needsPurge ) {
1943 $dbw->update( 'user',
1944 array( 'user_touched' => $now ),
1945 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1950 $this->clearSharedCache();
1955 * Validate the cache for this account.
1956 * @param $timestamp String A timestamp in TS_MW format
1960 public function validateCache( $timestamp ) {
1962 return ( $timestamp >= $this->mTouched
);
1966 * Get the user touched timestamp
1967 * @return String timestamp
1969 public function getTouched() {
1971 return $this->mTouched
;
1975 * Set the password and reset the random token.
1976 * Calls through to authentication plugin if necessary;
1977 * will have no effect if the auth plugin refuses to
1978 * pass the change through or if the legal password
1981 * As a special case, setting the password to null
1982 * wipes it, so the account cannot be logged in until
1983 * a new password is set, for instance via e-mail.
1985 * @param $str String New password to set
1986 * @throws PasswordError on failure
1990 public function setPassword( $str ) {
1993 if( $str !== null ) {
1994 if( !$wgAuth->allowPasswordChange() ) {
1995 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
1998 if( !$this->isValidPassword( $str ) ) {
1999 global $wgMinimalPasswordLength;
2000 $valid = $this->getPasswordValidity( $str );
2001 if ( is_array( $valid ) ) {
2002 $message = array_shift( $valid );
2006 $params = array( $wgMinimalPasswordLength );
2008 throw new PasswordError( wfMessage( $message, $params )->text() );
2012 if( !$wgAuth->setPassword( $this, $str ) ) {
2013 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2016 $this->setInternalPassword( $str );
2022 * Set the password and reset the random token unconditionally.
2024 * @param $str String New password to set
2026 public function setInternalPassword( $str ) {
2030 if( $str === null ) {
2031 // Save an invalid hash...
2032 $this->mPassword
= '';
2034 $this->mPassword
= self
::crypt( $str );
2036 $this->mNewpassword
= '';
2037 $this->mNewpassTime
= null;
2041 * Get the user's current token.
2042 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2043 * @return String Token
2045 public function getToken( $forceCreation = true ) {
2047 if ( !$this->mToken
&& $forceCreation ) {
2050 return $this->mToken
;
2054 * Set the random token (used for persistent authentication)
2055 * Called from loadDefaults() among other places.
2057 * @param $token String|bool If specified, set the token to this value
2059 public function setToken( $token = false ) {
2062 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2064 $this->mToken
= $token;
2069 * Set the password for a password reminder or new account email
2071 * @param $str String New password to set
2072 * @param $throttle Bool If true, reset the throttle timestamp to the present
2074 public function setNewpassword( $str, $throttle = true ) {
2076 $this->mNewpassword
= self
::crypt( $str );
2078 $this->mNewpassTime
= wfTimestampNow();
2083 * Has password reminder email been sent within the last
2084 * $wgPasswordReminderResendTime hours?
2087 public function isPasswordReminderThrottled() {
2088 global $wgPasswordReminderResendTime;
2090 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2093 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2094 return time() < $expiry;
2098 * Get the user's e-mail address
2099 * @return String User's email address
2101 public function getEmail() {
2103 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2104 return $this->mEmail
;
2108 * Get the timestamp of the user's e-mail authentication
2109 * @return String TS_MW timestamp
2111 public function getEmailAuthenticationTimestamp() {
2113 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2114 return $this->mEmailAuthenticated
;
2118 * Set the user's e-mail address
2119 * @param $str String New e-mail address
2121 public function setEmail( $str ) {
2123 if( $str == $this->mEmail
) {
2126 $this->mEmail
= $str;
2127 $this->invalidateEmail();
2128 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2132 * Set the user's e-mail address and a confirmation mail if needed.
2135 * @param $str String New e-mail address
2138 public function setEmailWithConfirmation( $str ) {
2139 global $wgEnableEmail, $wgEmailAuthentication;
2141 if ( !$wgEnableEmail ) {
2142 return Status
::newFatal( 'emaildisabled' );
2145 $oldaddr = $this->getEmail();
2146 if ( $str === $oldaddr ) {
2147 return Status
::newGood( true );
2150 $this->setEmail( $str );
2152 if ( $str !== '' && $wgEmailAuthentication ) {
2153 # Send a confirmation request to the new address if needed
2154 $type = $oldaddr != '' ?
'changed' : 'set';
2155 $result = $this->sendConfirmationMail( $type );
2156 if ( $result->isGood() ) {
2157 # Say the the caller that a confirmation mail has been sent
2158 $result->value
= 'eauth';
2161 $result = Status
::newGood( true );
2168 * Get the user's real name
2169 * @return String User's real name
2171 public function getRealName() {
2172 if ( !$this->isItemLoaded( 'realname' ) ) {
2176 return $this->mRealName
;
2180 * Set the user's real name
2181 * @param $str String New real name
2183 public function setRealName( $str ) {
2185 $this->mRealName
= $str;
2189 * Get the user's current setting for a given option.
2191 * @param $oname String The option to check
2192 * @param $defaultOverride String A default value returned if the option does not exist
2193 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2194 * @return String User's current value for the option
2195 * @see getBoolOption()
2196 * @see getIntOption()
2198 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2199 global $wgHiddenPrefs;
2200 $this->loadOptions();
2202 if ( is_null( $this->mOptions
) ) {
2203 if($defaultOverride != '') {
2204 return $defaultOverride;
2206 $this->mOptions
= User
::getDefaultOptions();
2209 # We want 'disabled' preferences to always behave as the default value for
2210 # users, even if they have set the option explicitly in their settings (ie they
2211 # set it, and then it was disabled removing their ability to change it). But
2212 # we don't want to erase the preferences in the database in case the preference
2213 # is re-enabled again. So don't touch $mOptions, just override the returned value
2214 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2215 return self
::getDefaultOption( $oname );
2218 if ( array_key_exists( $oname, $this->mOptions
) ) {
2219 return $this->mOptions
[$oname];
2221 return $defaultOverride;
2226 * Get all user's options
2230 public function getOptions() {
2231 global $wgHiddenPrefs;
2232 $this->loadOptions();
2233 $options = $this->mOptions
;
2235 # We want 'disabled' preferences to always behave as the default value for
2236 # users, even if they have set the option explicitly in their settings (ie they
2237 # set it, and then it was disabled removing their ability to change it). But
2238 # we don't want to erase the preferences in the database in case the preference
2239 # is re-enabled again. So don't touch $mOptions, just override the returned value
2240 foreach( $wgHiddenPrefs as $pref ){
2241 $default = self
::getDefaultOption( $pref );
2242 if( $default !== null ){
2243 $options[$pref] = $default;
2251 * Get the user's current setting for a given option, as a boolean value.
2253 * @param $oname String The option to check
2254 * @return Bool User's current value for the option
2257 public function getBoolOption( $oname ) {
2258 return (bool)$this->getOption( $oname );
2262 * Get the user's current setting for a given option, as a boolean value.
2264 * @param $oname String The option to check
2265 * @param $defaultOverride Int A default value returned if the option does not exist
2266 * @return Int User's current value for the option
2269 public function getIntOption( $oname, $defaultOverride=0 ) {
2270 $val = $this->getOption( $oname );
2272 $val = $defaultOverride;
2274 return intval( $val );
2278 * Set the given option for a user.
2280 * @param $oname String The option to set
2281 * @param $val mixed New value to set
2283 public function setOption( $oname, $val ) {
2285 $this->loadOptions();
2287 // Explicitly NULL values should refer to defaults
2288 if( is_null( $val ) ) {
2289 $defaultOption = self
::getDefaultOption( $oname );
2290 if( !is_null( $defaultOption ) ) {
2291 $val = $defaultOption;
2295 $this->mOptions
[$oname] = $val;
2299 * Reset all options to the site defaults
2301 public function resetOptions() {
2304 $this->mOptions
= self
::getDefaultOptions();
2305 $this->mOptionsLoaded
= true;
2309 * Get the user's preferred date format.
2310 * @return String User's preferred date format
2312 public function getDatePreference() {
2313 // Important migration for old data rows
2314 if ( is_null( $this->mDatePreference
) ) {
2316 $value = $this->getOption( 'date' );
2317 $map = $wgLang->getDatePreferenceMigrationMap();
2318 if ( isset( $map[$value] ) ) {
2319 $value = $map[$value];
2321 $this->mDatePreference
= $value;
2323 return $this->mDatePreference
;
2327 * Get the user preferred stub threshold
2331 public function getStubThreshold() {
2332 global $wgMaxArticleSize; # Maximum article size, in Kb
2333 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2334 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2335 # If they have set an impossible value, disable the preference
2336 # so we can use the parser cache again.
2343 * Get the permissions this user has.
2344 * @return Array of String permission names
2346 public function getRights() {
2347 if ( is_null( $this->mRights
) ) {
2348 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2349 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2350 // Force reindexation of rights when a hook has unset one of them
2351 $this->mRights
= array_values( $this->mRights
);
2353 return $this->mRights
;
2357 * Get the list of explicit group memberships this user has.
2358 * The implicit * and user groups are not included.
2359 * @return Array of String internal group names
2361 public function getGroups() {
2363 $this->loadGroups();
2364 return $this->mGroups
;
2368 * Get the list of implicit group memberships this user has.
2369 * This includes all explicit groups, plus 'user' if logged in,
2370 * '*' for all accounts, and autopromoted groups
2371 * @param $recache Bool Whether to avoid the cache
2372 * @return Array of String internal group names
2374 public function getEffectiveGroups( $recache = false ) {
2375 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2376 wfProfileIn( __METHOD__
);
2377 $this->mEffectiveGroups
= array_unique( array_merge(
2378 $this->getGroups(), // explicit groups
2379 $this->getAutomaticGroups( $recache ) // implicit groups
2381 # Hook for additional groups
2382 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2383 wfProfileOut( __METHOD__
);
2385 return $this->mEffectiveGroups
;
2389 * Get the list of implicit group memberships this user has.
2390 * This includes 'user' if logged in, '*' for all accounts,
2391 * and autopromoted groups
2392 * @param $recache Bool Whether to avoid the cache
2393 * @return Array of String internal group names
2395 public function getAutomaticGroups( $recache = false ) {
2396 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2397 wfProfileIn( __METHOD__
);
2398 $this->mImplicitGroups
= array( '*' );
2399 if ( $this->getId() ) {
2400 $this->mImplicitGroups
[] = 'user';
2402 $this->mImplicitGroups
= array_unique( array_merge(
2403 $this->mImplicitGroups
,
2404 Autopromote
::getAutopromoteGroups( $this )
2408 # Assure data consistency with rights/groups,
2409 # as getEffectiveGroups() depends on this function
2410 $this->mEffectiveGroups
= null;
2412 wfProfileOut( __METHOD__
);
2414 return $this->mImplicitGroups
;
2418 * Returns the groups the user has belonged to.
2420 * The user may still belong to the returned groups. Compare with getGroups().
2422 * The function will not return groups the user had belonged to before MW 1.17
2424 * @return array Names of the groups the user has belonged to.
2426 public function getFormerGroups() {
2427 if( is_null( $this->mFormerGroups
) ) {
2428 $dbr = wfGetDB( DB_MASTER
);
2429 $res = $dbr->select( 'user_former_groups',
2430 array( 'ufg_group' ),
2431 array( 'ufg_user' => $this->mId
),
2433 $this->mFormerGroups
= array();
2434 foreach( $res as $row ) {
2435 $this->mFormerGroups
[] = $row->ufg_group
;
2438 return $this->mFormerGroups
;
2442 * Get the user's edit count.
2445 public function getEditCount() {
2446 if( $this->getId() ) {
2447 if ( !isset( $this->mEditCount
) ) {
2448 /* Populate the count, if it has not been populated yet */
2449 wfProfileIn( __METHOD__
);
2450 $dbr = wfGetDB( DB_SLAVE
);
2451 // check if the user_editcount field has been initialized
2452 $count = $dbr->selectField(
2453 'user', 'user_editcount',
2454 array( 'user_id' => $this->mId
),
2458 if( $count === null ) {
2459 // it has not been initialized. do so.
2460 $dbw = wfGetDB( DB_MASTER
);
2461 $count = $dbr->selectField(
2462 'revision', 'count(*)',
2463 array( 'rev_user' => $this->mId
),
2468 array( 'user_editcount' => $count ),
2469 array( 'user_id' => $this->mId
),
2473 wfProfileOut( __METHOD__
);
2474 $this->mEditCount
= $count;
2476 return $this->mEditCount
;
2484 * Add the user to the given group.
2485 * This takes immediate effect.
2486 * @param $group String Name of the group to add
2488 public function addGroup( $group ) {
2489 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2490 $dbw = wfGetDB( DB_MASTER
);
2491 if( $this->getId() ) {
2492 $dbw->insert( 'user_groups',
2494 'ug_user' => $this->getID(),
2495 'ug_group' => $group,
2498 array( 'IGNORE' ) );
2501 $this->loadGroups();
2502 $this->mGroups
[] = $group;
2503 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2505 $this->invalidateCache();
2509 * Remove the user from the given group.
2510 * This takes immediate effect.
2511 * @param $group String Name of the group to remove
2513 public function removeGroup( $group ) {
2515 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2516 $dbw = wfGetDB( DB_MASTER
);
2517 $dbw->delete( 'user_groups',
2519 'ug_user' => $this->getID(),
2520 'ug_group' => $group,
2522 // Remember that the user was in this group
2523 $dbw->insert( 'user_former_groups',
2525 'ufg_user' => $this->getID(),
2526 'ufg_group' => $group,
2529 array( 'IGNORE' ) );
2531 $this->loadGroups();
2532 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2533 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2535 $this->invalidateCache();
2539 * Get whether the user is logged in
2542 public function isLoggedIn() {
2543 return $this->getID() != 0;
2547 * Get whether the user is anonymous
2550 public function isAnon() {
2551 return !$this->isLoggedIn();
2555 * Check if user is allowed to access a feature / make an action
2557 * @internal param \String $varargs permissions to test
2558 * @return Boolean: True if user is allowed to perform *any* of the given actions
2562 public function isAllowedAny( /*...*/ ){
2563 $permissions = func_get_args();
2564 foreach( $permissions as $permission ){
2565 if( $this->isAllowed( $permission ) ){
2574 * @internal param $varargs string
2575 * @return bool True if the user is allowed to perform *all* of the given actions
2577 public function isAllowedAll( /*...*/ ){
2578 $permissions = func_get_args();
2579 foreach( $permissions as $permission ){
2580 if( !$this->isAllowed( $permission ) ){
2588 * Internal mechanics of testing a permission
2589 * @param $action String
2592 public function isAllowed( $action = '' ) {
2593 if ( $action === '' ) {
2594 return true; // In the spirit of DWIM
2596 # Patrolling may not be enabled
2597 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2598 global $wgUseRCPatrol, $wgUseNPPatrol;
2599 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2602 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2603 # by misconfiguration: 0 == 'foo'
2604 return in_array( $action, $this->getRights(), true );
2608 * Check whether to enable recent changes patrol features for this user
2609 * @return Boolean: True or false
2611 public function useRCPatrol() {
2612 global $wgUseRCPatrol;
2613 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2617 * Check whether to enable new pages patrol features for this user
2618 * @return Bool True or false
2620 public function useNPPatrol() {
2621 global $wgUseRCPatrol, $wgUseNPPatrol;
2622 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2626 * Get the WebRequest object to use with this object
2628 * @return WebRequest
2630 public function getRequest() {
2631 if ( $this->mRequest
) {
2632 return $this->mRequest
;
2640 * Get the current skin, loading it if required
2641 * @return Skin The current skin
2642 * @todo FIXME: Need to check the old failback system [AV]
2643 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2645 public function getSkin() {
2646 wfDeprecated( __METHOD__
, '1.18' );
2647 return RequestContext
::getMain()->getSkin();
2651 * Get a WatchedItem for this user and $title.
2653 * @param $title Title
2654 * @return WatchedItem
2656 public function getWatchedItem( $title ) {
2657 $key = $title->getNamespace() . ':' . $title->getDBkey();
2659 if ( isset( $this->mWatchedItems
[$key] ) ) {
2660 return $this->mWatchedItems
[$key];
2663 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2664 $this->mWatchedItems
= array();
2667 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2668 return $this->mWatchedItems
[$key];
2672 * Check the watched status of an article.
2673 * @param $title Title of the article to look at
2676 public function isWatched( $title ) {
2677 return $this->getWatchedItem( $title )->isWatched();
2682 * @param $title Title of the article to look at
2684 public function addWatch( $title ) {
2685 $this->getWatchedItem( $title )->addWatch();
2686 $this->invalidateCache();
2690 * Stop watching an article.
2691 * @param $title Title of the article to look at
2693 public function removeWatch( $title ) {
2694 $this->getWatchedItem( $title )->removeWatch();
2695 $this->invalidateCache();
2699 * Clear the user's notification timestamp for the given title.
2700 * If e-notif e-mails are on, they will receive notification mails on
2701 * the next change of the page if it's watched etc.
2702 * @param $title Title of the article to look at
2704 public function clearNotification( &$title ) {
2705 global $wgUseEnotif, $wgShowUpdatedMarker;
2707 # Do nothing if the database is locked to writes
2708 if( wfReadOnly() ) {
2712 if( $title->getNamespace() == NS_USER_TALK
&&
2713 $title->getText() == $this->getName() ) {
2714 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2716 $this->setNewtalk( false );
2719 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2723 if( $this->isAnon() ) {
2724 // Nothing else to do...
2728 // Only update the timestamp if the page is being watched.
2729 // The query to find out if it is watched is cached both in memcached and per-invocation,
2730 // and when it does have to be executed, it can be on a slave
2731 // If this is the user's newtalk page, we always update the timestamp
2733 if ( $title->getNamespace() == NS_USER_TALK
&&
2734 $title->getText() == $this->getName() )
2739 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2743 * Resets all of the given user's page-change notification timestamps.
2744 * If e-notif e-mails are on, they will receive notification mails on
2745 * the next change of any watched page.
2747 public function clearAllNotifications() {
2748 global $wgUseEnotif, $wgShowUpdatedMarker;
2749 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2750 $this->setNewtalk( false );
2753 $id = $this->getId();
2755 $dbw = wfGetDB( DB_MASTER
);
2756 $dbw->update( 'watchlist',
2758 'wl_notificationtimestamp' => null
2759 ), array( /* WHERE */
2763 # We also need to clear here the "you have new message" notification for the own user_talk page
2764 # This is cleared one page view later in Article::viewUpdates();
2769 * Set this user's options from an encoded string
2770 * @param $str String Encoded options to import
2772 * @deprecated in 1.19 due to removal of user_options from the user table
2774 private function decodeOptions( $str ) {
2775 wfDeprecated( __METHOD__
, '1.19' );
2779 $this->mOptionsLoaded
= true;
2780 $this->mOptionOverrides
= array();
2782 // If an option is not set in $str, use the default value
2783 $this->mOptions
= self
::getDefaultOptions();
2785 $a = explode( "\n", $str );
2786 foreach ( $a as $s ) {
2788 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2789 $this->mOptions
[$m[1]] = $m[2];
2790 $this->mOptionOverrides
[$m[1]] = $m[2];
2796 * Set a cookie on the user's client. Wrapper for
2797 * WebResponse::setCookie
2798 * @param $name String Name of the cookie to set
2799 * @param $value String Value to set
2800 * @param $exp Int Expiration time, as a UNIX time value;
2801 * if 0 or not specified, use the default $wgCookieExpiration
2802 * @param $secure Bool
2803 * true: Force setting the secure attribute when setting the cookie
2804 * false: Force NOT setting the secure attribute when setting the cookie
2805 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
2807 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
2808 $this->getRequest()->response()->setcookie( $name, $value, $exp, null, null, $secure );
2812 * Clear a cookie on the user's client
2813 * @param $name String Name of the cookie to clear
2815 protected function clearCookie( $name ) {
2816 $this->setCookie( $name, '', time() - 86400 );
2820 * Set the default cookies for this session on the user's client.
2822 * @param $request WebRequest object to use; $wgRequest will be used if null
2824 * @param $secure Whether to force secure/insecure cookies or use default
2826 public function setCookies( $request = null, $secure = null ) {
2827 if ( $request === null ) {
2828 $request = $this->getRequest();
2832 if ( 0 == $this->mId
) return;
2833 if ( !$this->mToken
) {
2834 // When token is empty or NULL generate a new one and then save it to the database
2835 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2836 // Simply by setting every cell in the user_token column to NULL and letting them be
2837 // regenerated as users log back into the wiki.
2839 $this->saveSettings();
2842 'wsUserID' => $this->mId
,
2843 'wsToken' => $this->mToken
,
2844 'wsUserName' => $this->getName()
2847 'UserID' => $this->mId
,
2848 'UserName' => $this->getName(),
2850 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2851 $cookies['Token'] = $this->mToken
;
2853 $cookies['Token'] = false;
2856 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2858 foreach ( $session as $name => $value ) {
2859 $request->setSessionData( $name, $value );
2861 foreach ( $cookies as $name => $value ) {
2862 if ( $value === false ) {
2863 $this->clearCookie( $name );
2865 $this->setCookie( $name, $value, 0, $secure );
2870 * If wpStickHTTPS was selected, also set an insecure cookie that
2871 * will cause the site to redirect the user to HTTPS, if they access
2872 * it over HTTP. Bug 29898.
2874 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
2875 $this->setCookie( 'forceHTTPS', 'true', time() +
2592000, false ); //30 days
2880 * Log this user out.
2882 public function logout() {
2883 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2889 * Clear the user's cookies and session, and reset the instance cache.
2892 public function doLogout() {
2893 $this->clearInstanceCache( 'defaults' );
2895 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2897 $this->clearCookie( 'UserID' );
2898 $this->clearCookie( 'Token' );
2899 $this->clearCookie( 'forceHTTPS' );
2901 # Remember when user logged out, to prevent seeing cached pages
2902 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2906 * Save this user's settings into the database.
2907 * @todo Only rarely do all these fields need to be set!
2909 public function saveSettings() {
2913 if ( wfReadOnly() ) { return; }
2914 if ( 0 == $this->mId
) { return; }
2916 $this->mTouched
= self
::newTouchedTimestamp();
2917 if ( !$wgAuth->allowSetLocalPassword() ) {
2918 $this->mPassword
= '';
2921 $dbw = wfGetDB( DB_MASTER
);
2922 $dbw->update( 'user',
2924 'user_name' => $this->mName
,
2925 'user_password' => $this->mPassword
,
2926 'user_newpassword' => $this->mNewpassword
,
2927 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2928 'user_real_name' => $this->mRealName
,
2929 'user_email' => $this->mEmail
,
2930 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2931 'user_touched' => $dbw->timestamp( $this->mTouched
),
2932 'user_token' => strval( $this->mToken
),
2933 'user_email_token' => $this->mEmailToken
,
2934 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2935 ), array( /* WHERE */
2936 'user_id' => $this->mId
2940 $this->saveOptions();
2942 wfRunHooks( 'UserSaveSettings', array( $this ) );
2943 $this->clearSharedCache();
2944 $this->getUserPage()->invalidateCache();
2948 * If only this user's username is known, and it exists, return the user ID.
2951 public function idForName() {
2952 $s = trim( $this->getName() );
2953 if ( $s === '' ) return 0;
2955 $dbr = wfGetDB( DB_SLAVE
);
2956 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2957 if ( $id === false ) {
2964 * Add a user to the database, return the user object
2966 * @param $name String Username to add
2967 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2968 * - password The user's password hash. Password logins will be disabled if this is omitted.
2969 * - newpassword Hash for a temporary password that has been mailed to the user
2970 * - email The user's email address
2971 * - email_authenticated The email authentication timestamp
2972 * - real_name The user's real name
2973 * - options An associative array of non-default options
2974 * - token Random authentication token. Do not set.
2975 * - registration Registration timestamp. Do not set.
2977 * @return User object, or null if the username already exists
2979 public static function createNew( $name, $params = array() ) {
2982 if ( isset( $params['options'] ) ) {
2983 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2984 unset( $params['options'] );
2986 $dbw = wfGetDB( DB_MASTER
);
2987 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2990 'user_id' => $seqVal,
2991 'user_name' => $name,
2992 'user_password' => $user->mPassword
,
2993 'user_newpassword' => $user->mNewpassword
,
2994 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2995 'user_email' => $user->mEmail
,
2996 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2997 'user_real_name' => $user->mRealName
,
2998 'user_token' => strval( $user->mToken
),
2999 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3000 'user_editcount' => 0,
3001 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3003 foreach ( $params as $name => $value ) {
3004 $fields["user_$name"] = $value;
3006 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3007 if ( $dbw->affectedRows() ) {
3008 $newUser = User
::newFromId( $dbw->insertId() );
3016 * Add this existing user object to the database. If the user already
3017 * exists, a fatal status object is returned, and the user object is
3018 * initialised with the data from the database.
3020 * Previously, this function generated a DB error due to a key conflict
3021 * if the user already existed. Many extension callers use this function
3022 * in code along the lines of:
3024 * $user = User::newFromName( $name );
3025 * if ( !$user->isLoggedIn() ) {
3026 * $user->addToDatabase();
3028 * // do something with $user...
3030 * However, this was vulnerable to a race condition (bug 16020). By
3031 * initialising the user object if the user exists, we aim to support this
3032 * calling sequence as far as possible.
3034 * Note that if the user exists, this function will acquire a write lock,
3035 * so it is still advisable to make the call conditional on isLoggedIn(),
3036 * and to commit the transaction after calling.
3040 public function addToDatabase() {
3043 $this->mTouched
= self
::newTouchedTimestamp();
3045 $dbw = wfGetDB( DB_MASTER
);
3046 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3047 $dbw->insert( 'user',
3049 'user_id' => $seqVal,
3050 'user_name' => $this->mName
,
3051 'user_password' => $this->mPassword
,
3052 'user_newpassword' => $this->mNewpassword
,
3053 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3054 'user_email' => $this->mEmail
,
3055 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3056 'user_real_name' => $this->mRealName
,
3057 'user_token' => strval( $this->mToken
),
3058 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3059 'user_editcount' => 0,
3060 'user_touched' => $dbw->timestamp( $this->mTouched
),
3064 if ( !$dbw->affectedRows() ) {
3065 $this->mId
= $dbw->selectField( 'user', 'user_id',
3066 array( 'user_name' => $this->mName
), __METHOD__
);
3069 if ( $this->loadFromDatabase() ) {
3074 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3075 "to insert a user row, but then it doesn't exist when we select it!" );
3077 return Status
::newFatal( 'userexists' );
3079 $this->mId
= $dbw->insertId();
3081 // Clear instance cache other than user table data, which is already accurate
3082 $this->clearInstanceCache();
3084 $this->saveOptions();
3085 return Status
::newGood();
3089 * If this user is logged-in and blocked,
3090 * block any IP address they've successfully logged in from.
3091 * @return bool A block was spread
3093 public function spreadAnyEditBlock() {
3094 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3095 return $this->spreadBlock();
3101 * If this (non-anonymous) user is blocked,
3102 * block the IP address they've successfully logged in from.
3103 * @return bool A block was spread
3105 protected function spreadBlock() {
3106 wfDebug( __METHOD__
. "()\n" );
3108 if ( $this->mId
== 0 ) {
3112 $userblock = Block
::newFromTarget( $this->getName() );
3113 if ( !$userblock ) {
3117 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3121 * Generate a string which will be different for any combination of
3122 * user options which would produce different parser output.
3123 * This will be used as part of the hash key for the parser cache,
3124 * so users with the same options can share the same cached data
3127 * Extensions which require it should install 'PageRenderingHash' hook,
3128 * which will give them a chance to modify this key based on their own
3131 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3132 * @return String Page rendering hash
3134 public function getPageRenderingHash() {
3135 wfDeprecated( __METHOD__
, '1.17' );
3137 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3139 return $this->mHash
;
3142 // stubthreshold is only included below for completeness,
3143 // since it disables the parser cache, its value will always
3144 // be 0 when this function is called by parsercache.
3146 $confstr = $this->getOption( 'math' );
3147 $confstr .= '!' . $this->getStubThreshold();
3148 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3149 $confstr .= '!' . $this->getDatePreference();
3151 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3152 $confstr .= '!' . $wgLang->getCode();
3153 $confstr .= '!' . $this->getOption( 'thumbsize' );
3154 // add in language specific options, if any
3155 $extra = $wgContLang->getExtraHashOptions();
3158 // Since the skin could be overloading link(), it should be
3159 // included here but in practice, none of our skins do that.
3161 $confstr .= $wgRenderHashAppend;
3163 // Give a chance for extensions to modify the hash, if they have
3164 // extra options or other effects on the parser cache.
3165 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3167 // Make it a valid memcached key fragment
3168 $confstr = str_replace( ' ', '_', $confstr );
3169 $this->mHash
= $confstr;
3174 * Get whether the user is explicitly blocked from account creation.
3175 * @return Bool|Block
3177 public function isBlockedFromCreateAccount() {
3178 $this->getBlockedStatus();
3179 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3180 return $this->mBlock
;
3183 # bug 13611: if the IP address the user is trying to create an account from is
3184 # blocked with createaccount disabled, prevent new account creation there even
3185 # when the user is logged in
3186 if( $this->mBlockedFromCreateAccount
=== false ){
3187 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3189 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3190 ?
$this->mBlockedFromCreateAccount
3195 * Get whether the user is blocked from using Special:Emailuser.
3198 public function isBlockedFromEmailuser() {
3199 $this->getBlockedStatus();
3200 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3204 * Get whether the user is allowed to create an account.
3207 function isAllowedToCreateAccount() {
3208 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3212 * Get this user's personal page title.
3214 * @return Title: User's personal page title
3216 public function getUserPage() {
3217 return Title
::makeTitle( NS_USER
, $this->getName() );
3221 * Get this user's talk page title.
3223 * @return Title: User's talk page title
3225 public function getTalkPage() {
3226 $title = $this->getUserPage();
3227 return $title->getTalkPage();
3231 * Determine whether the user is a newbie. Newbies are either
3232 * anonymous IPs, or the most recently created accounts.
3235 public function isNewbie() {
3236 return !$this->isAllowed( 'autoconfirmed' );
3240 * Check to see if the given clear-text password is one of the accepted passwords
3241 * @param $password String: user password.
3242 * @return Boolean: True if the given password is correct, otherwise False.
3244 public function checkPassword( $password ) {
3245 global $wgAuth, $wgLegacyEncoding;
3248 // Even though we stop people from creating passwords that
3249 // are shorter than this, doesn't mean people wont be able
3250 // to. Certain authentication plugins do NOT want to save
3251 // domain passwords in a mysql database, so we should
3252 // check this (in case $wgAuth->strict() is false).
3253 if( !$this->isValidPassword( $password ) ) {
3257 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3259 } elseif( $wgAuth->strict() ) {
3260 /* Auth plugin doesn't allow local authentication */
3262 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3263 /* Auth plugin doesn't allow local authentication for this user name */
3266 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3268 } elseif ( $wgLegacyEncoding ) {
3269 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3270 # Check for this with iconv
3271 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3272 if ( $cp1252Password != $password &&
3273 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3282 * Check if the given clear-text password matches the temporary password
3283 * sent by e-mail for password reset operations.
3285 * @param $plaintext string
3287 * @return Boolean: True if matches, false otherwise
3289 public function checkTemporaryPassword( $plaintext ) {
3290 global $wgNewPasswordExpiry;
3293 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3294 if ( is_null( $this->mNewpassTime
) ) {
3297 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3298 return ( time() < $expiry );
3305 * Alias for getEditToken.
3306 * @deprecated since 1.19, use getEditToken instead.
3308 * @param $salt String|Array of Strings Optional function-specific data for hashing
3309 * @param $request WebRequest object to use or null to use $wgRequest
3310 * @return String The new edit token
3312 public function editToken( $salt = '', $request = null ) {
3313 wfDeprecated( __METHOD__
, '1.19' );
3314 return $this->getEditToken( $salt, $request );
3318 * Initialize (if necessary) and return a session token value
3319 * which can be used in edit forms to show that the user's
3320 * login credentials aren't being hijacked with a foreign form
3325 * @param $salt String|Array of Strings Optional function-specific data for hashing
3326 * @param $request WebRequest object to use or null to use $wgRequest
3327 * @return String The new edit token
3329 public function getEditToken( $salt = '', $request = null ) {
3330 if ( $request == null ) {
3331 $request = $this->getRequest();
3334 if ( $this->isAnon() ) {
3335 return EDIT_TOKEN_SUFFIX
;
3337 $token = $request->getSessionData( 'wsEditToken' );
3338 if ( $token === null ) {
3339 $token = MWCryptRand
::generateHex( 32 );
3340 $request->setSessionData( 'wsEditToken', $token );
3342 if( is_array( $salt ) ) {
3343 $salt = implode( '|', $salt );
3345 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3350 * Generate a looking random token for various uses.
3352 * @param $salt String Optional salt value
3353 * @return String The new random token
3354 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3356 public static function generateToken( $salt = '' ) {
3357 return MWCryptRand
::generateHex( 32 );
3361 * Check given value against the token value stored in the session.
3362 * A match should confirm that the form was submitted from the
3363 * user's own login session, not a form submission from a third-party
3366 * @param $val String Input value to compare
3367 * @param $salt String Optional function-specific data for hashing
3368 * @param $request WebRequest object to use or null to use $wgRequest
3369 * @return Boolean: Whether the token matches
3371 public function matchEditToken( $val, $salt = '', $request = null ) {
3372 $sessionToken = $this->getEditToken( $salt, $request );
3373 if ( $val != $sessionToken ) {
3374 wfDebug( "User::matchEditToken: broken session data\n" );
3376 return $val == $sessionToken;
3380 * Check given value against the token value stored in the session,
3381 * ignoring the suffix.
3383 * @param $val String Input value to compare
3384 * @param $salt String Optional function-specific data for hashing
3385 * @param $request WebRequest object to use or null to use $wgRequest
3386 * @return Boolean: Whether the token matches
3388 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3389 $sessionToken = $this->getEditToken( $salt, $request );
3390 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3394 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3395 * mail to the user's given address.
3397 * @param $type String: message to send, either "created", "changed" or "set"
3398 * @return Status object
3400 public function sendConfirmationMail( $type = 'created' ) {
3402 $expiration = null; // gets passed-by-ref and defined in next line.
3403 $token = $this->confirmationToken( $expiration );
3404 $url = $this->confirmationTokenUrl( $token );
3405 $invalidateURL = $this->invalidationTokenUrl( $token );
3406 $this->saveSettings();
3408 if ( $type == 'created' ||
$type === false ) {
3409 $message = 'confirmemail_body';
3410 } elseif ( $type === true ) {
3411 $message = 'confirmemail_body_changed';
3413 $message = 'confirmemail_body_' . $type;
3416 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3417 wfMessage( $message,
3418 $this->getRequest()->getIP(),
3421 $wgLang->timeanddate( $expiration, false ),
3423 $wgLang->date( $expiration, false ),
3424 $wgLang->time( $expiration, false ) )->text() );
3428 * Send an e-mail to this user's account. Does not check for
3429 * confirmed status or validity.
3431 * @param $subject String Message subject
3432 * @param $body String Message body
3433 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3434 * @param $replyto String Reply-To address
3437 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3438 if( is_null( $from ) ) {
3439 global $wgPasswordSender, $wgPasswordSenderName;
3440 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3442 $sender = new MailAddress( $from );
3445 $to = new MailAddress( $this );
3446 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3450 * Generate, store, and return a new e-mail confirmation code.
3451 * A hash (unsalted, since it's used as a key) is stored.
3453 * @note Call saveSettings() after calling this function to commit
3454 * this change to the database.
3456 * @param &$expiration \mixed Accepts the expiration time
3457 * @return String New token
3459 private function confirmationToken( &$expiration ) {
3460 global $wgUserEmailConfirmationTokenExpiry;
3462 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3463 $expiration = wfTimestamp( TS_MW
, $expires );
3465 $token = MWCryptRand
::generateHex( 32 );
3466 $hash = md5( $token );
3467 $this->mEmailToken
= $hash;
3468 $this->mEmailTokenExpires
= $expiration;
3473 * Return a URL the user can use to confirm their email address.
3474 * @param $token String Accepts the email confirmation token
3475 * @return String New token URL
3477 private function confirmationTokenUrl( $token ) {
3478 return $this->getTokenUrl( 'ConfirmEmail', $token );
3482 * Return a URL the user can use to invalidate their email address.
3483 * @param $token String Accepts the email confirmation token
3484 * @return String New token URL
3486 private function invalidationTokenUrl( $token ) {
3487 return $this->getTokenUrl( 'InvalidateEmail', $token );
3491 * Internal function to format the e-mail validation/invalidation URLs.
3492 * This uses a quickie hack to use the
3493 * hardcoded English names of the Special: pages, for ASCII safety.
3495 * @note Since these URLs get dropped directly into emails, using the
3496 * short English names avoids insanely long URL-encoded links, which
3497 * also sometimes can get corrupted in some browsers/mailers
3498 * (bug 6957 with Gmail and Internet Explorer).
3500 * @param $page String Special page
3501 * @param $token String Token
3502 * @return String Formatted URL
3504 protected function getTokenUrl( $page, $token ) {
3505 // Hack to bypass localization of 'Special:'
3506 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3507 return $title->getCanonicalUrl();
3511 * Mark the e-mail address confirmed.
3513 * @note Call saveSettings() after calling this function to commit the change.
3517 public function confirmEmail() {
3518 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3519 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3524 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3525 * address if it was already confirmed.
3527 * @note Call saveSettings() after calling this function to commit the change.
3528 * @return bool Returns true
3530 function invalidateEmail() {
3532 $this->mEmailToken
= null;
3533 $this->mEmailTokenExpires
= null;
3534 $this->setEmailAuthenticationTimestamp( null );
3535 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3540 * Set the e-mail authentication timestamp.
3541 * @param $timestamp String TS_MW timestamp
3543 function setEmailAuthenticationTimestamp( $timestamp ) {
3545 $this->mEmailAuthenticated
= $timestamp;
3546 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3550 * Is this user allowed to send e-mails within limits of current
3551 * site configuration?
3554 public function canSendEmail() {
3555 global $wgEnableEmail, $wgEnableUserEmail;
3556 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3559 $canSend = $this->isEmailConfirmed();
3560 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3565 * Is this user allowed to receive e-mails within limits of current
3566 * site configuration?
3569 public function canReceiveEmail() {
3570 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3574 * Is this user's e-mail address valid-looking and confirmed within
3575 * limits of the current site configuration?
3577 * @note If $wgEmailAuthentication is on, this may require the user to have
3578 * confirmed their address by returning a code or using a password
3579 * sent to the address from the wiki.
3583 public function isEmailConfirmed() {
3584 global $wgEmailAuthentication;
3587 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3588 if( $this->isAnon() ) {
3591 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3594 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3604 * Check whether there is an outstanding request for e-mail confirmation.
3607 public function isEmailConfirmationPending() {
3608 global $wgEmailAuthentication;
3609 return $wgEmailAuthentication &&
3610 !$this->isEmailConfirmed() &&
3611 $this->mEmailToken
&&
3612 $this->mEmailTokenExpires
> wfTimestamp();
3616 * Get the timestamp of account creation.
3618 * @return String|Bool Timestamp of account creation, or false for
3619 * non-existent/anonymous user accounts.
3621 public function getRegistration() {
3622 if ( $this->isAnon() ) {
3626 return $this->mRegistration
;
3630 * Get the timestamp of the first edit
3632 * @return String|Bool Timestamp of first edit, or false for
3633 * non-existent/anonymous user accounts.
3635 public function getFirstEditTimestamp() {
3636 if( $this->getId() == 0 ) {
3637 return false; // anons
3639 $dbr = wfGetDB( DB_SLAVE
);
3640 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3641 array( 'rev_user' => $this->getId() ),
3643 array( 'ORDER BY' => 'rev_timestamp ASC' )
3646 return false; // no edits
3648 return wfTimestamp( TS_MW
, $time );
3652 * Get the permissions associated with a given list of groups
3654 * @param $groups Array of Strings List of internal group names
3655 * @return Array of Strings List of permission key names for given groups combined
3657 public static function getGroupPermissions( $groups ) {
3658 global $wgGroupPermissions, $wgRevokePermissions;
3660 // grant every granted permission first
3661 foreach( $groups as $group ) {
3662 if( isset( $wgGroupPermissions[$group] ) ) {
3663 $rights = array_merge( $rights,
3664 // array_filter removes empty items
3665 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3668 // now revoke the revoked permissions
3669 foreach( $groups as $group ) {
3670 if( isset( $wgRevokePermissions[$group] ) ) {
3671 $rights = array_diff( $rights,
3672 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3675 return array_unique( $rights );
3679 * Get all the groups who have a given permission
3681 * @param $role String Role to check
3682 * @return Array of Strings List of internal group names with the given permission
3684 public static function getGroupsWithPermission( $role ) {
3685 global $wgGroupPermissions;
3686 $allowedGroups = array();
3687 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
3688 if ( self
::groupHasPermission( $group, $role ) ) {
3689 $allowedGroups[] = $group;
3692 return $allowedGroups;
3696 * Check, if the given group has the given permission
3698 * @param $group String Group to check
3699 * @param $role String Role to check
3702 public static function groupHasPermission( $group, $role ) {
3703 global $wgGroupPermissions, $wgRevokePermissions;
3704 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
3705 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
3709 * Get the localized descriptive name for a group, if it exists
3711 * @param $group String Internal group name
3712 * @return String Localized descriptive group name
3714 public static function getGroupName( $group ) {
3715 $msg = wfMessage( "group-$group" );
3716 return $msg->isBlank() ?
$group : $msg->text();
3720 * Get the localized descriptive name for a member of a group, if it exists
3722 * @param $group String Internal group name
3723 * @param $username String Username for gender (since 1.19)
3724 * @return String Localized name for group member
3726 public static function getGroupMember( $group, $username = '#' ) {
3727 $msg = wfMessage( "group-$group-member", $username );
3728 return $msg->isBlank() ?
$group : $msg->text();
3732 * Return the set of defined explicit groups.
3733 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3734 * are not included, as they are defined automatically, not in the database.
3735 * @return Array of internal group names
3737 public static function getAllGroups() {
3738 global $wgGroupPermissions, $wgRevokePermissions;
3740 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3741 self
::getImplicitGroups()
3746 * Get a list of all available permissions.
3747 * @return Array of permission names
3749 public static function getAllRights() {
3750 if ( self
::$mAllRights === false ) {
3751 global $wgAvailableRights;
3752 if ( count( $wgAvailableRights ) ) {
3753 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3755 self
::$mAllRights = self
::$mCoreRights;
3757 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3759 return self
::$mAllRights;
3763 * Get a list of implicit groups
3764 * @return Array of Strings Array of internal group names
3766 public static function getImplicitGroups() {
3767 global $wgImplicitGroups;
3768 $groups = $wgImplicitGroups;
3769 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3774 * Get the title of a page describing a particular group
3776 * @param $group String Internal group name
3777 * @return Title|Bool Title of the page if it exists, false otherwise
3779 public static function getGroupPage( $group ) {
3780 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3781 if( $msg->exists() ) {
3782 $title = Title
::newFromText( $msg->text() );
3783 if( is_object( $title ) )
3790 * Create a link to the group in HTML, if available;
3791 * else return the group name.
3793 * @param $group String Internal name of the group
3794 * @param $text String The text of the link
3795 * @return String HTML link to the group
3797 public static function makeGroupLinkHTML( $group, $text = '' ) {
3799 $text = self
::getGroupName( $group );
3801 $title = self
::getGroupPage( $group );
3803 return Linker
::link( $title, htmlspecialchars( $text ) );
3810 * Create a link to the group in Wikitext, if available;
3811 * else return the group name.
3813 * @param $group String Internal name of the group
3814 * @param $text String The text of the link
3815 * @return String Wikilink to the group
3817 public static function makeGroupLinkWiki( $group, $text = '' ) {
3819 $text = self
::getGroupName( $group );
3821 $title = self
::getGroupPage( $group );
3823 $page = $title->getPrefixedText();
3824 return "[[$page|$text]]";
3831 * Returns an array of the groups that a particular group can add/remove.
3833 * @param $group String: the group to check for whether it can add/remove
3834 * @return Array array( 'add' => array( addablegroups ),
3835 * 'remove' => array( removablegroups ),
3836 * 'add-self' => array( addablegroups to self),
3837 * 'remove-self' => array( removable groups from self) )
3839 public static function changeableByGroup( $group ) {
3840 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3842 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3843 if( empty( $wgAddGroups[$group] ) ) {
3844 // Don't add anything to $groups
3845 } elseif( $wgAddGroups[$group] === true ) {
3846 // You get everything
3847 $groups['add'] = self
::getAllGroups();
3848 } elseif( is_array( $wgAddGroups[$group] ) ) {
3849 $groups['add'] = $wgAddGroups[$group];
3852 // Same thing for remove
3853 if( empty( $wgRemoveGroups[$group] ) ) {
3854 } elseif( $wgRemoveGroups[$group] === true ) {
3855 $groups['remove'] = self
::getAllGroups();
3856 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3857 $groups['remove'] = $wgRemoveGroups[$group];
3860 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3861 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3862 foreach( $wgGroupsAddToSelf as $key => $value ) {
3863 if( is_int( $key ) ) {
3864 $wgGroupsAddToSelf['user'][] = $value;
3869 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3870 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3871 if( is_int( $key ) ) {
3872 $wgGroupsRemoveFromSelf['user'][] = $value;
3877 // Now figure out what groups the user can add to him/herself
3878 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3879 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3880 // No idea WHY this would be used, but it's there
3881 $groups['add-self'] = User
::getAllGroups();
3882 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3883 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3886 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3887 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3888 $groups['remove-self'] = User
::getAllGroups();
3889 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3890 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3897 * Returns an array of groups that this user can add and remove
3898 * @return Array array( 'add' => array( addablegroups ),
3899 * 'remove' => array( removablegroups ),
3900 * 'add-self' => array( addablegroups to self),
3901 * 'remove-self' => array( removable groups from self) )
3903 public function changeableGroups() {
3904 if( $this->isAllowed( 'userrights' ) ) {
3905 // This group gives the right to modify everything (reverse-
3906 // compatibility with old "userrights lets you change
3908 // Using array_merge to make the groups reindexed
3909 $all = array_merge( User
::getAllGroups() );
3913 'add-self' => array(),
3914 'remove-self' => array()
3918 // Okay, it's not so simple, we will have to go through the arrays
3921 'remove' => array(),
3922 'add-self' => array(),
3923 'remove-self' => array()
3925 $addergroups = $this->getEffectiveGroups();
3927 foreach( $addergroups as $addergroup ) {
3928 $groups = array_merge_recursive(
3929 $groups, $this->changeableByGroup( $addergroup )
3931 $groups['add'] = array_unique( $groups['add'] );
3932 $groups['remove'] = array_unique( $groups['remove'] );
3933 $groups['add-self'] = array_unique( $groups['add-self'] );
3934 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3940 * Increment the user's edit-count field.
3941 * Will have no effect for anonymous users.
3943 public function incEditCount() {
3944 if( !$this->isAnon() ) {
3945 $dbw = wfGetDB( DB_MASTER
);
3946 $dbw->update( 'user',
3947 array( 'user_editcount=user_editcount+1' ),
3948 array( 'user_id' => $this->getId() ),
3951 // Lazy initialization check...
3952 if( $dbw->affectedRows() == 0 ) {
3953 // Pull from a slave to be less cruel to servers
3954 // Accuracy isn't the point anyway here
3955 $dbr = wfGetDB( DB_SLAVE
);
3956 $count = $dbr->selectField( 'revision',
3958 array( 'rev_user' => $this->getId() ),
3961 // Now here's a goddamn hack...
3962 if( $dbr !== $dbw ) {
3963 // If we actually have a slave server, the count is
3964 // at least one behind because the current transaction
3965 // has not been committed and replicated.
3968 // But if DB_SLAVE is selecting the master, then the
3969 // count we just read includes the revision that was
3970 // just added in the working transaction.
3973 $dbw->update( 'user',
3974 array( 'user_editcount' => $count ),
3975 array( 'user_id' => $this->getId() ),
3979 // edit count in user cache too
3980 $this->invalidateCache();
3984 * Get the description of a given right
3986 * @param $right String Right to query
3987 * @return String Localized description of the right
3989 public static function getRightDescription( $right ) {
3990 $key = "right-$right";
3991 $msg = wfMessage( $key );
3992 return $msg->isBlank() ?
$right : $msg->text();
3996 * Make an old-style password hash
3998 * @param $password String Plain-text password
3999 * @param $userId String User ID
4000 * @return String Password hash
4002 public static function oldCrypt( $password, $userId ) {
4003 global $wgPasswordSalt;
4004 if ( $wgPasswordSalt ) {
4005 return md5( $userId . '-' . md5( $password ) );
4007 return md5( $password );
4012 * Make a new-style password hash
4014 * @param $password String Plain-text password
4015 * @param bool|string $salt Optional salt, may be random or the user ID.
4017 * If unspecified or false, will generate one automatically
4018 * @return String Password hash
4020 public static function crypt( $password, $salt = false ) {
4021 global $wgPasswordSalt;
4024 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
4028 if( $wgPasswordSalt ) {
4029 if ( $salt === false ) {
4030 $salt = MWCryptRand
::generateHex( 8 );
4032 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
4034 return ':A:' . md5( $password );
4039 * Compare a password hash with a plain-text password. Requires the user
4040 * ID if there's a chance that the hash is an old-style hash.
4042 * @param $hash String Password hash
4043 * @param $password String Plain-text password to compare
4044 * @param $userId String|bool User ID for old-style password salt
4048 public static function comparePasswords( $hash, $password, $userId = false ) {
4049 $type = substr( $hash, 0, 3 );
4052 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4056 if ( $type == ':A:' ) {
4058 return md5( $password ) === substr( $hash, 3 );
4059 } elseif ( $type == ':B:' ) {
4061 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4062 return md5( $salt.'-'.md5( $password ) ) === $realHash;
4065 return self
::oldCrypt( $password, $userId ) === $hash;
4070 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
4072 * @param $byEmail Boolean: account made by email?
4073 * @param $reason String: user supplied reason
4075 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4077 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
4078 global $wgUser, $wgContLang, $wgNewUserLog;
4079 if( empty( $wgNewUserLog ) ) {
4080 return true; // disabled
4083 if( $this->getName() == $wgUser->getName() ) {
4086 $action = 'create2';
4088 if ( $reason === '' ) {
4089 $reason = wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text();
4091 $reason = $wgContLang->commaList( array(
4092 $reason, wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text() ) );
4096 $log = new LogPage( 'newusers' );
4097 return (int)$log->addEntry(
4099 $this->getUserPage(),
4101 array( $this->getId() )
4106 * Add an autocreate newuser log entry for this user
4107 * Used by things like CentralAuth and perhaps other authplugins.
4111 public function addNewUserLogEntryAutoCreate() {
4112 global $wgNewUserLog;
4113 if( !$wgNewUserLog ) {
4114 return true; // disabled
4116 $log = new LogPage( 'newusers', false );
4117 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4124 protected function loadOptions() {
4129 if ( $this->mOptionsLoaded
) {
4133 $this->mOptions
= self
::getDefaultOptions();
4135 if ( !$this->getId() ) {
4136 // For unlogged-in users, load language/variant options from request.
4137 // There's no need to do it for logged-in users: they can set preferences,
4138 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4139 // so don't override user's choice (especially when the user chooses site default).
4140 $variant = $wgContLang->getDefaultVariant();
4141 $this->mOptions
['variant'] = $variant;
4142 $this->mOptions
['language'] = $variant;
4143 $this->mOptionsLoaded
= true;
4147 // Maybe load from the object
4148 if ( !is_null( $this->mOptionOverrides
) ) {
4149 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4150 foreach( $this->mOptionOverrides
as $key => $value ) {
4151 $this->mOptions
[$key] = $value;
4154 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4155 // Load from database
4156 $dbr = wfGetDB( DB_SLAVE
);
4158 $res = $dbr->select(
4160 array( 'up_property', 'up_value' ),
4161 array( 'up_user' => $this->getId() ),
4165 $this->mOptionOverrides
= array();
4166 foreach ( $res as $row ) {
4167 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4168 $this->mOptions
[$row->up_property
] = $row->up_value
;
4172 $this->mOptionsLoaded
= true;
4174 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4180 protected function saveOptions() {
4181 global $wgAllowPrefChange;
4183 $this->loadOptions();
4185 // Not using getOptions(), to keep hidden preferences in database
4186 $saveOptions = $this->mOptions
;
4188 // Allow hooks to abort, for instance to save to a global profile.
4189 // Reset options to default state before saving.
4190 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4194 $extuser = ExternalUser
::newFromUser( $this );
4195 $userId = $this->getId();
4196 $insert_rows = array();
4197 foreach( $saveOptions as $key => $value ) {
4198 # Don't bother storing default values
4199 $defaultOption = self
::getDefaultOption( $key );
4200 if ( ( is_null( $defaultOption ) &&
4201 !( $value === false ||
is_null( $value ) ) ) ||
4202 $value != $defaultOption ) {
4203 $insert_rows[] = array(
4204 'up_user' => $userId,
4205 'up_property' => $key,
4206 'up_value' => $value,
4209 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4210 switch ( $wgAllowPrefChange[$key] ) {
4216 $extuser->setPref( $key, $value );
4221 $dbw = wfGetDB( DB_MASTER
);
4222 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4223 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4227 * Provide an array of HTML5 attributes to put on an input element
4228 * intended for the user to enter a new password. This may include
4229 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4231 * Do *not* use this when asking the user to enter his current password!
4232 * Regardless of configuration, users may have invalid passwords for whatever
4233 * reason (e.g., they were set before requirements were tightened up).
4234 * Only use it when asking for a new password, like on account creation or
4237 * Obviously, you still need to do server-side checking.
4239 * NOTE: A combination of bugs in various browsers means that this function
4240 * actually just returns array() unconditionally at the moment. May as
4241 * well keep it around for when the browser bugs get fixed, though.
4243 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4245 * @return array Array of HTML attributes suitable for feeding to
4246 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4247 * That will potentially output invalid XHTML 1.0 Transitional, and will
4248 * get confused by the boolean attribute syntax used.)
4250 public static function passwordChangeInputAttribs() {
4251 global $wgMinimalPasswordLength;
4253 if ( $wgMinimalPasswordLength == 0 ) {
4257 # Note that the pattern requirement will always be satisfied if the
4258 # input is empty, so we need required in all cases.
4260 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4261 # if e-mail confirmation is being used. Since HTML5 input validation
4262 # is b0rked anyway in some browsers, just return nothing. When it's
4263 # re-enabled, fix this code to not output required for e-mail
4265 #$ret = array( 'required' );
4268 # We can't actually do this right now, because Opera 9.6 will print out
4269 # the entered password visibly in its error message! When other
4270 # browsers add support for this attribute, or Opera fixes its support,
4271 # we can add support with a version check to avoid doing this on Opera
4272 # versions where it will be a problem. Reported to Opera as
4273 # DSK-262266, but they don't have a public bug tracker for us to follow.
4275 if ( $wgMinimalPasswordLength > 1 ) {
4276 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4277 $ret['title'] = wfMessage( 'passwordtooshort' )
4278 ->numParams( $wgMinimalPasswordLength )->text();
4286 * Return the list of user fields that should be selected to create
4287 * a new user object.
4290 public static function selectFields() {
4297 'user_newpass_time',
4301 'user_email_authenticated',
4303 'user_email_token_expires',
4304 'user_registration',