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 * String Some punctuation to prevent editing from broken text-mangling proxies.
27 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
30 * The User object encapsulates all of the user-specific settings (user_id,
31 * name, rights, password, email address, options, last login time). Client
32 * classes use the getXXX() functions to access these fields. These functions
33 * do all the work of determining whether the user is logged in,
34 * whether the requested option can be satisfied from cookies or
35 * whether a database query is needed. Most of the settings needed
36 * for rendering normal pages are set in the cookie to minimize use
39 class User
implements IDBAccessObject
{
41 * @const int Number of characters in user_token field.
43 const TOKEN_LENGTH
= 32;
46 * Global constant made accessible as class constants so that autoloader
49 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
52 * @const int Serialized record version.
57 * Maximum items in $mWatchedItems
59 const MAX_WATCHED_ITEMS_CACHE
= 100;
62 * @var PasswordFactory Lazily loaded factory object for passwords
64 private static $mPasswordFactory = null;
67 * Array of Strings List of member variables which are saved to the
68 * shared cache (memcached). Any operation which changes the
69 * corresponding database fields must call a cache-clearing function.
72 protected static $mCacheVars = array(
80 'mEmailAuthenticated',
87 // user_properties table
92 * Array of Strings Core rights.
93 * Each of these should have a corresponding message of the form
97 protected static $mCoreRights = array(
123 'editusercssjs', #deprecated
135 'move-categorypages',
136 'move-rootuserpages',
140 'override-export-depth',
164 'userrights-interwiki',
172 * String Cached results of getAllRights()
174 protected static $mAllRights = false;
176 /** @name Cache variables */
185 * @todo Make this actually private
191 * @todo Make this actually private
194 public $mNewpassword;
196 public $mNewpassTime;
204 public $mEmailAuthenticated;
206 protected $mEmailToken;
208 protected $mEmailTokenExpires;
210 protected $mRegistration;
212 protected $mEditCount;
216 protected $mOptionOverrides;
218 protected $mPasswordExpires;
222 * Bool Whether the cache variables have been loaded.
225 public $mOptionsLoaded;
228 * Array with already loaded items or true if all items have been loaded.
230 protected $mLoadedItems = array();
234 * String Initialization data source if mLoadedItems!==true. May be one of:
235 * - 'defaults' anonymous user initialised from class defaults
236 * - 'name' initialise from mName
237 * - 'id' initialise from mId
238 * - 'session' log in from cookies or session if possible
240 * Use the User::newFrom*() family of functions to set this.
245 * Lazy-initialized variables, invalidated with clearInstanceCache
249 protected $mDatePreference;
257 protected $mBlockreason;
259 protected $mEffectiveGroups;
261 protected $mImplicitGroups;
263 protected $mFormerGroups;
265 protected $mBlockedGlobally;
282 protected $mAllowUsertalk;
285 private $mBlockedFromCreateAccount = false;
288 private $mWatchedItems = array();
290 public static $idCacheByName = array();
293 * Lightweight constructor for an anonymous user.
294 * Use the User::newFrom* factory functions for other kinds of users.
298 * @see newFromConfirmationCode()
299 * @see newFromSession()
302 public function __construct() {
303 $this->clearInstanceCache( 'defaults' );
309 public function __toString() {
310 return $this->getName();
314 * Load the user table data for this object from the source given by mFrom.
316 public function load() {
317 if ( $this->mLoadedItems
=== true ) {
320 wfProfileIn( __METHOD__
);
322 // Set it now to avoid infinite recursion in accessors
323 $this->mLoadedItems
= true;
325 switch ( $this->mFrom
) {
327 $this->loadDefaults();
330 $this->mId
= self
::idFromName( $this->mName
);
332 // Nonexistent user placeholder object
333 $this->loadDefaults( $this->mName
);
342 if ( !$this->loadFromSession() ) {
343 // Loading from session failed. Load defaults.
344 $this->loadDefaults();
346 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
349 wfProfileOut( __METHOD__
);
350 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
352 wfProfileOut( __METHOD__
);
356 * Load user table data, given mId has already been set.
357 * @return bool False if the ID does not exist, true otherwise
359 public function loadFromId() {
360 if ( $this->mId
== 0 ) {
361 $this->loadDefaults();
366 $cache = $this->loadFromCache();
368 wfDebug( "User: cache miss for user {$this->mId}\n" );
370 if ( !$this->loadFromDatabase() ) {
371 // Can't load from ID, user is anonymous
374 $this->saveToCache();
377 $this->mLoadedItems
= true;
383 * Load user data from shared cache, given mId has already been set.
385 * @return bool false if the ID does not exist or data is invalid, true otherwise
388 public function loadFromCache() {
391 if ( $this->mId
== 0 ) {
392 $this->loadDefaults();
396 $key = wfMemcKey( 'user', 'id', $this->mId
);
397 $data = $wgMemc->get( $key );
398 if ( !is_array( $data ) ||
$data['mVersion'] < self
::VERSION
) {
403 wfDebug( "User: got user {$this->mId} from cache\n" );
405 // Restore from cache
406 foreach ( self
::$mCacheVars as $name ) {
407 $this->$name = $data[$name];
414 * Save user data to the shared cache
416 public function saveToCache() {
419 $this->loadOptions();
420 if ( $this->isAnon() ) {
421 // Anonymous users are uncached
425 foreach ( self
::$mCacheVars as $name ) {
426 $data[$name] = $this->$name;
428 $data['mVersion'] = self
::VERSION
;
429 $key = wfMemcKey( 'user', 'id', $this->mId
);
431 $wgMemc->set( $key, $data );
434 /** @name newFrom*() static factory methods */
438 * Static factory method for creation from username.
440 * This is slightly less efficient than newFromId(), so use newFromId() if
441 * you have both an ID and a name handy.
443 * @param string $name Username, validated by Title::newFromText()
444 * @param string|bool $validate Validate username. Takes the same parameters as
445 * User::getCanonicalName(), except that true is accepted as an alias
446 * for 'valid', for BC.
448 * @return User|bool User object, or false if the username is invalid
449 * (e.g. if it contains illegal characters or is an IP address). If the
450 * username is not present in the database, the result will be a user object
451 * with a name, zero user ID and default settings.
453 public static function newFromName( $name, $validate = 'valid' ) {
454 if ( $validate === true ) {
457 $name = self
::getCanonicalName( $name, $validate );
458 if ( $name === false ) {
461 // Create unloaded user object
465 $u->setItemLoaded( 'name' );
471 * Static factory method for creation from a given user ID.
473 * @param int $id Valid user ID
474 * @return User The corresponding User object
476 public static function newFromId( $id ) {
480 $u->setItemLoaded( 'id' );
485 * Factory method to fetch whichever user has a given email confirmation code.
486 * This code is generated when an account is created or its e-mail address
489 * If the code is invalid or has expired, returns NULL.
491 * @param string $code Confirmation code
494 public static function newFromConfirmationCode( $code ) {
495 $dbr = wfGetDB( DB_SLAVE
);
496 $id = $dbr->selectField( 'user', 'user_id', array(
497 'user_email_token' => md5( $code ),
498 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
500 if ( $id !== false ) {
501 return User
::newFromId( $id );
508 * Create a new user object using data from session or cookies. If the
509 * login credentials are invalid, the result is an anonymous user.
511 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
514 public static function newFromSession( WebRequest
$request = null ) {
516 $user->mFrom
= 'session';
517 $user->mRequest
= $request;
522 * Create a new user object from a user row.
523 * The row should have the following fields from the user table in it:
524 * - either user_name or user_id to load further data if needed (or both)
526 * - all other fields (email, password, etc.)
527 * It is useless to provide the remaining fields if either user_id,
528 * user_name and user_real_name are not provided because the whole row
529 * will be loaded once more from the database when accessing them.
531 * @param stdClass $row A row from the user table
532 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
535 public static function newFromRow( $row, $data = null ) {
537 $user->loadFromRow( $row, $data );
544 * Get the username corresponding to a given user ID
545 * @param int $id User ID
546 * @return string|bool The corresponding username
548 public static function whoIs( $id ) {
549 return UserCache
::singleton()->getProp( $id, 'name' );
553 * Get the real name of a user given their user ID
555 * @param int $id User ID
556 * @return string|bool The corresponding user's real name
558 public static function whoIsReal( $id ) {
559 return UserCache
::singleton()->getProp( $id, 'real_name' );
563 * Get database id given a user name
564 * @param string $name Username
565 * @return int|null The corresponding user's ID, or null if user is nonexistent
567 public static function idFromName( $name ) {
568 $nt = Title
::makeTitleSafe( NS_USER
, $name );
569 if ( is_null( $nt ) ) {
574 if ( isset( self
::$idCacheByName[$name] ) ) {
575 return self
::$idCacheByName[$name];
578 $dbr = wfGetDB( DB_SLAVE
);
579 $s = $dbr->selectRow(
582 array( 'user_name' => $nt->getText() ),
586 if ( $s === false ) {
589 $result = $s->user_id
;
592 self
::$idCacheByName[$name] = $result;
594 if ( count( self
::$idCacheByName ) > 1000 ) {
595 self
::$idCacheByName = array();
602 * Reset the cache used in idFromName(). For use in tests.
604 public static function resetIdByNameCache() {
605 self
::$idCacheByName = array();
609 * Does the string match an anonymous IPv4 address?
611 * This function exists for username validation, in order to reject
612 * usernames which are similar in form to IP addresses. Strings such
613 * as 300.300.300.300 will return true because it looks like an IP
614 * address, despite not being strictly valid.
616 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
617 * address because the usemod software would "cloak" anonymous IP
618 * addresses like this, if we allowed accounts like this to be created
619 * new users could get the old edits of these anonymous users.
621 * @param string $name Name to match
624 public static function isIP( $name ) {
625 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
626 || IP
::isIPv6( $name );
630 * Is the input a valid username?
632 * Checks if the input is a valid username, we don't want an empty string,
633 * an IP address, anything that contains slashes (would mess up subpages),
634 * is longer than the maximum allowed username size or doesn't begin with
637 * @param string $name Name to match
640 public static function isValidUserName( $name ) {
641 global $wgContLang, $wgMaxNameChars;
644 || User
::isIP( $name )
645 ||
strpos( $name, '/' ) !== false
646 ||
strlen( $name ) > $wgMaxNameChars
647 ||
$name != $wgContLang->ucfirst( $name ) ) {
648 wfDebugLog( 'username', __METHOD__
.
649 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
653 // Ensure that the name can't be misresolved as a different title,
654 // such as with extra namespace keys at the start.
655 $parsed = Title
::newFromText( $name );
656 if ( is_null( $parsed )
657 ||
$parsed->getNamespace()
658 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
659 wfDebugLog( 'username', __METHOD__
.
660 ": '$name' invalid due to ambiguous prefixes" );
664 // Check an additional blacklist of troublemaker characters.
665 // Should these be merged into the title char list?
666 $unicodeBlacklist = '/[' .
667 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
668 '\x{00a0}' . # non-breaking space
669 '\x{2000}-\x{200f}' . # various whitespace
670 '\x{2028}-\x{202f}' . # breaks and control chars
671 '\x{3000}' . # ideographic space
672 '\x{e000}-\x{f8ff}' . # private use
674 if ( preg_match( $unicodeBlacklist, $name ) ) {
675 wfDebugLog( 'username', __METHOD__
.
676 ": '$name' invalid due to blacklisted characters" );
684 * Usernames which fail to pass this function will be blocked
685 * from user login and new account registrations, but may be used
686 * internally by batch processes.
688 * If an account already exists in this form, login will be blocked
689 * by a failure to pass this function.
691 * @param string $name Name to match
694 public static function isUsableName( $name ) {
695 global $wgReservedUsernames;
696 // Must be a valid username, obviously ;)
697 if ( !self
::isValidUserName( $name ) ) {
701 static $reservedUsernames = false;
702 if ( !$reservedUsernames ) {
703 $reservedUsernames = $wgReservedUsernames;
704 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
707 // Certain names may be reserved for batch processes.
708 foreach ( $reservedUsernames as $reserved ) {
709 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
710 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
712 if ( $reserved == $name ) {
720 * Usernames which fail to pass this function will be blocked
721 * from new account registrations, but may be used internally
722 * either by batch processes or by user accounts which have
723 * already been created.
725 * Additional blacklisting may be added here rather than in
726 * isValidUserName() to avoid disrupting existing accounts.
728 * @param string $name String to match
731 public static function isCreatableName( $name ) {
732 global $wgInvalidUsernameCharacters;
734 // Ensure that the username isn't longer than 235 bytes, so that
735 // (at least for the builtin skins) user javascript and css files
736 // will work. (bug 23080)
737 if ( strlen( $name ) > 235 ) {
738 wfDebugLog( 'username', __METHOD__
.
739 ": '$name' invalid due to length" );
743 // Preg yells if you try to give it an empty string
744 if ( $wgInvalidUsernameCharacters !== '' ) {
745 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
746 wfDebugLog( 'username', __METHOD__
.
747 ": '$name' invalid due to wgInvalidUsernameCharacters" );
752 return self
::isUsableName( $name );
756 * Is the input a valid password for this user?
758 * @param string $password Desired password
761 public function isValidPassword( $password ) {
762 //simple boolean wrapper for getPasswordValidity
763 return $this->getPasswordValidity( $password ) === true;
768 * Given unvalidated password input, return error message on failure.
770 * @param string $password Desired password
771 * @return bool|string|array True on success, string or array of error message on failure
773 public function getPasswordValidity( $password ) {
774 $result = $this->checkPasswordValidity( $password );
775 if ( $result->isGood() ) {
779 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
780 $messages[] = $error['message'];
782 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
783 $messages[] = $warning['message'];
785 if ( count( $messages ) === 1 ) {
793 * Check if this is a valid password for this user. Status will be good if
794 * the password is valid, or have an array of error messages if not.
796 * @param string $password Desired password
800 public function checkPasswordValidity( $password ) {
801 global $wgMinimalPasswordLength, $wgContLang;
803 static $blockedLogins = array(
804 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
805 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
808 $status = Status
::newGood();
810 $result = false; //init $result to false for the internal checks
812 if ( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) ) {
813 $status->error( $result );
817 if ( $result === false ) {
818 if ( strlen( $password ) < $wgMinimalPasswordLength ) {
819 $status->error( 'passwordtooshort', $wgMinimalPasswordLength );
821 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
822 $status->error( 'password-name-match' );
824 } elseif ( isset( $blockedLogins[$this->getName()] )
825 && $password == $blockedLogins[$this->getName()]
827 $status->error( 'password-login-forbidden' );
830 //it seems weird returning a Good status here, but this is because of the
831 //initialization of $result to false above. If the hook is never run or it
832 //doesn't modify $result, then we will likely get down into this if with
836 } elseif ( $result === true ) {
839 $status->error( $result );
840 return $status; //the isValidPassword hook set a string $result and returned true
845 * Expire a user's password
847 * @param int $ts Optional timestamp to convert, default 0 for the current time
849 public function expirePassword( $ts = 0 ) {
850 $this->loadPasswords();
851 $timestamp = wfTimestamp( TS_MW
, $ts );
852 $this->mPasswordExpires
= $timestamp;
853 $this->saveSettings();
857 * Clear the password expiration for a user
859 * @param bool $load Ensure user object is loaded first
861 public function resetPasswordExpiration( $load = true ) {
862 global $wgPasswordExpirationDays;
867 if ( $wgPasswordExpirationDays ) {
868 $newExpire = wfTimestamp(
870 time() +
( $wgPasswordExpirationDays * 24 * 3600 )
873 // Give extensions a chance to force an expiration
874 wfRunHooks( 'ResetPasswordExpiration', array( $this, &$newExpire ) );
875 $this->mPasswordExpires
= $newExpire;
879 * Check if the user's password is expired.
880 * TODO: Put this and password length into a PasswordPolicy object
882 * @return string|bool The expiration type, or false if not expired
883 * hard: A password change is required to login
884 * soft: Allow login, but encourage password change
885 * false: Password is not expired
887 public function getPasswordExpired() {
888 global $wgPasswordExpireGrace;
890 $now = wfTimestamp();
891 $expiration = $this->getPasswordExpireDate();
892 $expUnix = wfTimestamp( TS_UNIX
, $expiration );
893 if ( $expiration !== null && $expUnix < $now ) {
894 $expired = ( $expUnix +
$wgPasswordExpireGrace < $now ) ?
'hard' : 'soft';
900 * Get this user's password expiration date. Since this may be using
901 * the cached User object, we assume that whatever mechanism is setting
902 * the expiration date is also expiring the User cache.
904 * @return string|bool The datestamp of the expiration, or null if not set
906 public function getPasswordExpireDate() {
908 return $this->mPasswordExpires
;
912 * Given unvalidated user input, return a canonical username, or false if
913 * the username is invalid.
914 * @param string $name User input
915 * @param string|bool $validate Type of validation to use:
916 * - false No validation
917 * - 'valid' Valid for batch processes
918 * - 'usable' Valid for batch processes and login
919 * - 'creatable' Valid for batch processes, login and account creation
921 * @throws MWException
922 * @return bool|string
924 public static function getCanonicalName( $name, $validate = 'valid' ) {
925 // Force usernames to capital
927 $name = $wgContLang->ucfirst( $name );
929 # Reject names containing '#'; these will be cleaned up
930 # with title normalisation, but then it's too late to
932 if ( strpos( $name, '#' ) !== false ) {
936 // Clean up name according to title rules,
937 // but only when validation is requested (bug 12654)
938 $t = ( $validate !== false ) ?
939 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
940 // Check for invalid titles
941 if ( is_null( $t ) ) {
945 // Reject various classes of invalid names
947 $name = $wgAuth->getCanonicalName( $t->getText() );
949 switch ( $validate ) {
953 if ( !User
::isValidUserName( $name ) ) {
958 if ( !User
::isUsableName( $name ) ) {
963 if ( !User
::isCreatableName( $name ) ) {
968 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
974 * Count the number of edits of a user
976 * @param int $uid User ID to check
977 * @return int The user's edit count
979 * @deprecated since 1.21 in favour of User::getEditCount
981 public static function edits( $uid ) {
982 wfDeprecated( __METHOD__
, '1.21' );
983 $user = self
::newFromId( $uid );
984 return $user->getEditCount();
988 * Return a random password.
990 * @return string New random password
992 public static function randomPassword() {
993 global $wgMinimalPasswordLength;
994 // Decide the final password length based on our min password length,
995 // stopping at a minimum of 10 chars.
996 $length = max( 10, $wgMinimalPasswordLength );
997 // Multiply by 1.25 to get the number of hex characters we need
998 $length = $length * 1.25;
999 // Generate random hex chars
1000 $hex = MWCryptRand
::generateHex( $length );
1001 // Convert from base 16 to base 32 to get a proper password like string
1002 return wfBaseConvert( $hex, 16, 32 );
1006 * Set cached properties to default.
1008 * @note This no longer clears uncached lazy-initialised properties;
1009 * the constructor does that instead.
1011 * @param string|bool $name
1013 public function loadDefaults( $name = false ) {
1014 wfProfileIn( __METHOD__
);
1016 $passwordFactory = self
::getPasswordFactory();
1019 $this->mName
= $name;
1020 $this->mRealName
= '';
1021 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1022 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1023 $this->mNewpassTime
= null;
1025 $this->mOptionOverrides
= null;
1026 $this->mOptionsLoaded
= false;
1028 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
1029 if ( $loggedOut !== null ) {
1030 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1032 $this->mTouched
= '1'; # Allow any pages to be cached
1035 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1036 $this->mEmailAuthenticated
= null;
1037 $this->mEmailToken
= '';
1038 $this->mEmailTokenExpires
= null;
1039 $this->mPasswordExpires
= null;
1040 $this->resetPasswordExpiration( false );
1041 $this->mRegistration
= wfTimestamp( TS_MW
);
1042 $this->mGroups
= array();
1044 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
1046 wfProfileOut( __METHOD__
);
1050 * Return whether an item has been loaded.
1052 * @param string $item Item to check. Current possibilities:
1056 * @param string $all 'all' to check if the whole object has been loaded
1057 * or any other string to check if only the item is available (e.g.
1061 public function isItemLoaded( $item, $all = 'all' ) {
1062 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1063 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1067 * Set that an item has been loaded
1069 * @param string $item
1071 protected function setItemLoaded( $item ) {
1072 if ( is_array( $this->mLoadedItems
) ) {
1073 $this->mLoadedItems
[$item] = true;
1078 * Load user data from the session or login cookie.
1079 * @return bool True if the user is logged in, false otherwise.
1081 private function loadFromSession() {
1083 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
1084 if ( $result !== null ) {
1088 $request = $this->getRequest();
1090 $cookieId = $request->getCookie( 'UserID' );
1091 $sessId = $request->getSessionData( 'wsUserID' );
1093 if ( $cookieId !== null ) {
1094 $sId = intval( $cookieId );
1095 if ( $sessId !== null && $cookieId != $sessId ) {
1096 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
1097 cookie user ID ($sId) don't match!" );
1100 $request->setSessionData( 'wsUserID', $sId );
1101 } elseif ( $sessId !== null && $sessId != 0 ) {
1107 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
1108 $sName = $request->getSessionData( 'wsUserName' );
1109 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
1110 $sName = $request->getCookie( 'UserName' );
1111 $request->setSessionData( 'wsUserName', $sName );
1116 $proposedUser = User
::newFromId( $sId );
1117 if ( !$proposedUser->isLoggedIn() ) {
1122 global $wgBlockDisablesLogin;
1123 if ( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
1124 // User blocked and we've disabled blocked user logins
1128 if ( $request->getSessionData( 'wsToken' ) ) {
1130 ( $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ) );
1132 } elseif ( $request->getCookie( 'Token' ) ) {
1133 # Get the token from DB/cache and clean it up to remove garbage padding.
1134 # This deals with historical problems with bugs and the default column value.
1135 $token = rtrim( $proposedUser->getToken( false ) ); // correct token
1136 // Make comparison in constant time (bug 61346)
1137 $passwordCorrect = strlen( $token )
1138 && hash_equals( $token, $request->getCookie( 'Token' ) );
1141 // No session or persistent login cookie
1145 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1146 $this->loadFromUserObject( $proposedUser );
1147 $request->setSessionData( 'wsToken', $this->mToken
);
1148 wfDebug( "User: logged in from $from\n" );
1151 // Invalid credentials
1152 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1158 * Load user and user_group data from the database.
1159 * $this->mId must be set, this is how the user is identified.
1161 * @param int $flags Supports User::READ_LOCKING
1162 * @return bool True if the user exists, false if the user is anonymous
1164 public function loadFromDatabase( $flags = 0 ) {
1166 $this->mId
= intval( $this->mId
);
1169 if ( !$this->mId
) {
1170 $this->loadDefaults();
1174 $dbr = wfGetDB( DB_MASTER
);
1175 $s = $dbr->selectRow(
1177 self
::selectFields(),
1178 array( 'user_id' => $this->mId
),
1180 ( $flags & self
::READ_LOCKING
== self
::READ_LOCKING
)
1181 ?
array( 'LOCK IN SHARE MODE' )
1185 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1187 if ( $s !== false ) {
1188 // Initialise user table data
1189 $this->loadFromRow( $s );
1190 $this->mGroups
= null; // deferred
1191 $this->getEditCount(); // revalidation for nulls
1196 $this->loadDefaults();
1202 * Initialize this object from a row from the user table.
1204 * @param stdClass $row Row from the user table to load.
1205 * @param array $data Further user data to load into the object
1207 * user_groups Array with groups out of the user_groups table
1208 * user_properties Array with properties out of the user_properties table
1210 public function loadFromRow( $row, $data = null ) {
1212 $passwordFactory = self
::getPasswordFactory();
1214 $this->mGroups
= null; // deferred
1216 if ( isset( $row->user_name
) ) {
1217 $this->mName
= $row->user_name
;
1218 $this->mFrom
= 'name';
1219 $this->setItemLoaded( 'name' );
1224 if ( isset( $row->user_real_name
) ) {
1225 $this->mRealName
= $row->user_real_name
;
1226 $this->setItemLoaded( 'realname' );
1231 if ( isset( $row->user_id
) ) {
1232 $this->mId
= intval( $row->user_id
);
1233 $this->mFrom
= 'id';
1234 $this->setItemLoaded( 'id' );
1239 if ( isset( $row->user_editcount
) ) {
1240 $this->mEditCount
= $row->user_editcount
;
1245 if ( isset( $row->user_password
) ) {
1246 // Check for *really* old password hashes that don't even have a type
1247 // The old hash format was just an md5 hex hash, with no type information
1248 if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password
) ) {
1249 $row->user_password
= ":A:{$this->mId}:{$row->user_password}";
1253 $this->mPassword
= $passwordFactory->newFromCiphertext( $row->user_password
);
1254 } catch ( PasswordError
$e ) {
1255 wfDebug( 'Invalid password hash found in database.' );
1256 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1260 $this->mNewpassword
= $passwordFactory->newFromCiphertext( $row->user_newpassword
);
1261 } catch ( PasswordError
$e ) {
1262 wfDebug( 'Invalid password hash found in database.' );
1263 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1266 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1267 $this->mPasswordExpires
= wfTimestampOrNull( TS_MW
, $row->user_password_expires
);
1270 if ( isset( $row->user_email
) ) {
1271 $this->mEmail
= $row->user_email
;
1272 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1273 $this->mToken
= $row->user_token
;
1274 if ( $this->mToken
== '' ) {
1275 $this->mToken
= null;
1277 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1278 $this->mEmailToken
= $row->user_email_token
;
1279 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1280 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1286 $this->mLoadedItems
= true;
1289 if ( is_array( $data ) ) {
1290 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1291 $this->mGroups
= $data['user_groups'];
1293 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1294 $this->loadOptions( $data['user_properties'] );
1300 * Load the data for this user object from another user object.
1304 protected function loadFromUserObject( $user ) {
1306 $user->loadGroups();
1307 $user->loadOptions();
1308 foreach ( self
::$mCacheVars as $var ) {
1309 $this->$var = $user->$var;
1314 * Load the groups from the database if they aren't already loaded.
1316 private function loadGroups() {
1317 if ( is_null( $this->mGroups
) ) {
1318 $dbr = wfGetDB( DB_MASTER
);
1319 $res = $dbr->select( 'user_groups',
1320 array( 'ug_group' ),
1321 array( 'ug_user' => $this->mId
),
1323 $this->mGroups
= array();
1324 foreach ( $res as $row ) {
1325 $this->mGroups
[] = $row->ug_group
;
1331 * Load the user's password hashes from the database
1333 * This is usually called in a scenario where the actual User object was
1334 * loaded from the cache, and then password comparison needs to be performed.
1335 * Password hashes are not stored in memcached.
1339 private function loadPasswords() {
1340 if ( $this->getId() !== 0 && ( $this->mPassword
=== null ||
$this->mNewpassword
=== null ) ) {
1341 $this->loadFromRow( wfGetDB( DB_MASTER
)->selectRow(
1343 array( 'user_password', 'user_newpassword', 'user_newpass_time', 'user_password_expires' ),
1344 array( 'user_id' => $this->getId() ),
1351 * Add the user to the group if he/she meets given criteria.
1353 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1354 * possible to remove manually via Special:UserRights. In such case it
1355 * will not be re-added automatically. The user will also not lose the
1356 * group if they no longer meet the criteria.
1358 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1360 * @return array Array of groups the user has been promoted to.
1362 * @see $wgAutopromoteOnce
1364 public function addAutopromoteOnceGroups( $event ) {
1365 global $wgAutopromoteOnceLogInRC, $wgAuth;
1367 $toPromote = array();
1368 if ( $this->getId() ) {
1369 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1370 if ( count( $toPromote ) ) {
1371 $oldGroups = $this->getGroups(); // previous groups
1373 foreach ( $toPromote as $group ) {
1374 $this->addGroup( $group );
1376 // update groups in external authentication database
1377 $wgAuth->updateExternalDBGroups( $this, $toPromote );
1379 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1381 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1382 $logEntry->setPerformer( $this );
1383 $logEntry->setTarget( $this->getUserPage() );
1384 $logEntry->setParameters( array(
1385 '4::oldgroups' => $oldGroups,
1386 '5::newgroups' => $newGroups,
1388 $logid = $logEntry->insert();
1389 if ( $wgAutopromoteOnceLogInRC ) {
1390 $logEntry->publish( $logid );
1398 * Clear various cached data stored in this object. The cache of the user table
1399 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1401 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1402 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1404 public function clearInstanceCache( $reloadFrom = false ) {
1405 $this->mNewtalk
= -1;
1406 $this->mDatePreference
= null;
1407 $this->mBlockedby
= -1; # Unset
1408 $this->mHash
= false;
1409 $this->mRights
= null;
1410 $this->mEffectiveGroups
= null;
1411 $this->mImplicitGroups
= null;
1412 $this->mGroups
= null;
1413 $this->mOptions
= null;
1414 $this->mOptionsLoaded
= false;
1415 $this->mEditCount
= null;
1417 if ( $reloadFrom ) {
1418 $this->mLoadedItems
= array();
1419 $this->mFrom
= $reloadFrom;
1424 * Combine the language default options with any site-specific options
1425 * and add the default language variants.
1427 * @return array Array of String options
1429 public static function getDefaultOptions() {
1430 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1432 static $defOpt = null;
1433 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1434 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1435 // mid-request and see that change reflected in the return value of this function.
1436 // Which is insane and would never happen during normal MW operation
1440 $defOpt = $wgDefaultUserOptions;
1441 // Default language setting
1442 $defOpt['language'] = $wgContLang->getCode();
1443 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1444 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1446 foreach ( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1447 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1449 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1451 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1457 * Get a given default option value.
1459 * @param string $opt Name of option to retrieve
1460 * @return string Default option value
1462 public static function getDefaultOption( $opt ) {
1463 $defOpts = self
::getDefaultOptions();
1464 if ( isset( $defOpts[$opt] ) ) {
1465 return $defOpts[$opt];
1472 * Get blocking information
1473 * @param bool $bFromSlave Whether to check the slave database first.
1474 * To improve performance, non-critical checks are done against slaves.
1475 * Check when actually saving should be done against master.
1477 private function getBlockedStatus( $bFromSlave = true ) {
1478 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1480 if ( -1 != $this->mBlockedby
) {
1484 wfProfileIn( __METHOD__
);
1485 wfDebug( __METHOD__
. ": checking...\n" );
1487 // Initialize data...
1488 // Otherwise something ends up stomping on $this->mBlockedby when
1489 // things get lazy-loaded later, causing false positive block hits
1490 // due to -1 !== 0. Probably session-related... Nothing should be
1491 // overwriting mBlockedby, surely?
1494 # We only need to worry about passing the IP address to the Block generator if the
1495 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1496 # know which IP address they're actually coming from
1497 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1498 $ip = $this->getRequest()->getIP();
1504 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1507 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1508 && !in_array( $ip, $wgProxyWhitelist )
1511 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1513 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1514 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1515 $block->setTarget( $ip );
1516 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1518 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1519 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1520 $block->setTarget( $ip );
1524 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1525 if ( !$block instanceof Block
1526 && $wgApplyIpBlocksToXff
1528 && !$this->isAllowed( 'proxyunbannable' )
1529 && !in_array( $ip, $wgProxyWhitelist )
1531 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1532 $xff = array_map( 'trim', explode( ',', $xff ) );
1533 $xff = array_diff( $xff, array( $ip ) );
1534 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1535 $block = Block
::chooseBlock( $xffblocks, $xff );
1536 if ( $block instanceof Block
) {
1537 # Mangle the reason to alert the user that the block
1538 # originated from matching the X-Forwarded-For header.
1539 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1543 if ( $block instanceof Block
) {
1544 wfDebug( __METHOD__
. ": Found block.\n" );
1545 $this->mBlock
= $block;
1546 $this->mBlockedby
= $block->getByName();
1547 $this->mBlockreason
= $block->mReason
;
1548 $this->mHideName
= $block->mHideName
;
1549 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1551 $this->mBlockedby
= '';
1552 $this->mHideName
= 0;
1553 $this->mAllowUsertalk
= false;
1557 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1559 wfProfileOut( __METHOD__
);
1563 * Whether the given IP is in a DNS blacklist.
1565 * @param string $ip IP to check
1566 * @param bool $checkWhitelist Whether to check the whitelist first
1567 * @return bool True if blacklisted.
1569 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1570 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1572 if ( !$wgEnableDnsBlacklist ) {
1576 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1580 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1584 * Whether the given IP is in a given DNS blacklist.
1586 * @param string $ip IP to check
1587 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1588 * @return bool True if blacklisted.
1590 public function inDnsBlacklist( $ip, $bases ) {
1591 wfProfileIn( __METHOD__
);
1594 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1595 if ( IP
::isIPv4( $ip ) ) {
1596 // Reverse IP, bug 21255
1597 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1599 foreach ( (array)$bases as $base ) {
1601 // If we have an access key, use that too (ProjectHoneypot, etc.)
1602 if ( is_array( $base ) ) {
1603 if ( count( $base ) >= 2 ) {
1604 // Access key is 1, base URL is 0
1605 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1607 $host = "$ipReversed.{$base[0]}";
1610 $host = "$ipReversed.$base";
1614 $ipList = gethostbynamel( $host );
1617 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!" );
1621 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base." );
1626 wfProfileOut( __METHOD__
);
1631 * Check if an IP address is in the local proxy list
1637 public static function isLocallyBlockedProxy( $ip ) {
1638 global $wgProxyList;
1640 if ( !$wgProxyList ) {
1643 wfProfileIn( __METHOD__
);
1645 if ( !is_array( $wgProxyList ) ) {
1646 // Load from the specified file
1647 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1650 if ( !is_array( $wgProxyList ) ) {
1652 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1654 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1655 // Old-style flipped proxy list
1660 wfProfileOut( __METHOD__
);
1665 * Is this user subject to rate limiting?
1667 * @return bool True if rate limited
1669 public function isPingLimitable() {
1670 global $wgRateLimitsExcludedIPs;
1671 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1672 // No other good way currently to disable rate limits
1673 // for specific IPs. :P
1674 // But this is a crappy hack and should die.
1677 return !$this->isAllowed( 'noratelimit' );
1681 * Primitive rate limits: enforce maximum actions per time period
1682 * to put a brake on flooding.
1684 * The method generates both a generic profiling point and a per action one
1685 * (suffix being "-$action".
1687 * @note When using a shared cache like memcached, IP-address
1688 * last-hit counters will be shared across wikis.
1690 * @param string $action Action to enforce; 'edit' if unspecified
1691 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1692 * @return bool True if a rate limiter was tripped
1694 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1695 // Call the 'PingLimiter' hook
1697 if ( !wfRunHooks( 'PingLimiter', array( &$this, $action, &$result, $incrBy ) ) ) {
1701 global $wgRateLimits;
1702 if ( !isset( $wgRateLimits[$action] ) ) {
1706 // Some groups shouldn't trigger the ping limiter, ever
1707 if ( !$this->isPingLimitable() ) {
1712 wfProfileIn( __METHOD__
);
1713 wfProfileIn( __METHOD__
. '-' . $action );
1715 $limits = $wgRateLimits[$action];
1717 $id = $this->getId();
1720 if ( isset( $limits['anon'] ) && $id == 0 ) {
1721 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1724 if ( isset( $limits['user'] ) && $id != 0 ) {
1725 $userLimit = $limits['user'];
1727 if ( $this->isNewbie() ) {
1728 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1729 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1731 if ( isset( $limits['ip'] ) ) {
1732 $ip = $this->getRequest()->getIP();
1733 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1735 if ( isset( $limits['subnet'] ) ) {
1736 $ip = $this->getRequest()->getIP();
1739 if ( IP
::isIPv6( $ip ) ) {
1740 $parts = IP
::parseRange( "$ip/64" );
1741 $subnet = $parts[0];
1742 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1744 $subnet = $matches[1];
1746 if ( $subnet !== false ) {
1747 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1751 // Check for group-specific permissions
1752 // If more than one group applies, use the group with the highest limit
1753 foreach ( $this->getGroups() as $group ) {
1754 if ( isset( $limits[$group] ) ) {
1755 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1756 $userLimit = $limits[$group];
1760 // Set the user limit key
1761 if ( $userLimit !== false ) {
1762 list( $max, $period ) = $userLimit;
1763 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1764 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1768 foreach ( $keys as $key => $limit ) {
1769 list( $max, $period ) = $limit;
1770 $summary = "(limit $max in {$period}s)";
1771 $count = $wgMemc->get( $key );
1774 if ( $count >= $max ) {
1775 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1776 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1779 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1782 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1783 if ( $incrBy > 0 ) {
1784 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1787 if ( $incrBy > 0 ) {
1788 $wgMemc->incr( $key, $incrBy );
1792 wfProfileOut( __METHOD__
. '-' . $action );
1793 wfProfileOut( __METHOD__
);
1798 * Check if user is blocked
1800 * @param bool $bFromSlave Whether to check the slave database instead of
1801 * the master. Hacked from false due to horrible probs on site.
1802 * @return bool True if blocked, false otherwise
1804 public function isBlocked( $bFromSlave = true ) {
1805 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1809 * Get the block affecting the user, or null if the user is not blocked
1811 * @param bool $bFromSlave Whether to check the slave database instead of the master
1812 * @return Block|null
1814 public function getBlock( $bFromSlave = true ) {
1815 $this->getBlockedStatus( $bFromSlave );
1816 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1820 * Check if user is blocked from editing a particular article
1822 * @param Title $title Title to check
1823 * @param bool $bFromSlave Whether to check the slave database instead of the master
1826 public function isBlockedFrom( $title, $bFromSlave = false ) {
1827 global $wgBlockAllowsUTEdit;
1828 wfProfileIn( __METHOD__
);
1830 $blocked = $this->isBlocked( $bFromSlave );
1831 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1832 // If a user's name is suppressed, they cannot make edits anywhere
1833 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1834 && $title->getNamespace() == NS_USER_TALK
) {
1836 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1839 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1841 wfProfileOut( __METHOD__
);
1846 * If user is blocked, return the name of the user who placed the block
1847 * @return string Name of blocker
1849 public function blockedBy() {
1850 $this->getBlockedStatus();
1851 return $this->mBlockedby
;
1855 * If user is blocked, return the specified reason for the block
1856 * @return string Blocking reason
1858 public function blockedFor() {
1859 $this->getBlockedStatus();
1860 return $this->mBlockreason
;
1864 * If user is blocked, return the ID for the block
1865 * @return int Block ID
1867 public function getBlockId() {
1868 $this->getBlockedStatus();
1869 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1873 * Check if user is blocked on all wikis.
1874 * Do not use for actual edit permission checks!
1875 * This is intended for quick UI checks.
1877 * @param string $ip IP address, uses current client if none given
1878 * @return bool True if blocked, false otherwise
1880 public function isBlockedGlobally( $ip = '' ) {
1881 if ( $this->mBlockedGlobally
!== null ) {
1882 return $this->mBlockedGlobally
;
1884 // User is already an IP?
1885 if ( IP
::isIPAddress( $this->getName() ) ) {
1886 $ip = $this->getName();
1888 $ip = $this->getRequest()->getIP();
1891 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1892 $this->mBlockedGlobally
= (bool)$blocked;
1893 return $this->mBlockedGlobally
;
1897 * Check if user account is locked
1899 * @return bool True if locked, false otherwise
1901 public function isLocked() {
1902 if ( $this->mLocked
!== null ) {
1903 return $this->mLocked
;
1906 $authUser = $wgAuth->getUserInstance( $this );
1907 $this->mLocked
= (bool)$authUser->isLocked();
1908 return $this->mLocked
;
1912 * Check if user account is hidden
1914 * @return bool True if hidden, false otherwise
1916 public function isHidden() {
1917 if ( $this->mHideName
!== null ) {
1918 return $this->mHideName
;
1920 $this->getBlockedStatus();
1921 if ( !$this->mHideName
) {
1923 $authUser = $wgAuth->getUserInstance( $this );
1924 $this->mHideName
= (bool)$authUser->isHidden();
1926 return $this->mHideName
;
1930 * Get the user's ID.
1931 * @return int The user's ID; 0 if the user is anonymous or nonexistent
1933 public function getId() {
1934 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
1935 // Special case, we know the user is anonymous
1937 } elseif ( !$this->isItemLoaded( 'id' ) ) {
1938 // Don't load if this was initialized from an ID
1945 * Set the user and reload all fields according to a given ID
1946 * @param int $v User ID to reload
1948 public function setId( $v ) {
1950 $this->clearInstanceCache( 'id' );
1954 * Get the user name, or the IP of an anonymous user
1955 * @return string User's name or IP address
1957 public function getName() {
1958 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1959 // Special case optimisation
1960 return $this->mName
;
1963 if ( $this->mName
=== false ) {
1965 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1967 return $this->mName
;
1972 * Set the user name.
1974 * This does not reload fields from the database according to the given
1975 * name. Rather, it is used to create a temporary "nonexistent user" for
1976 * later addition to the database. It can also be used to set the IP
1977 * address for an anonymous user to something other than the current
1980 * @note User::newFromName() has roughly the same function, when the named user
1982 * @param string $str New user name to set
1984 public function setName( $str ) {
1986 $this->mName
= $str;
1990 * Get the user's name escaped by underscores.
1991 * @return string Username escaped by underscores.
1993 public function getTitleKey() {
1994 return str_replace( ' ', '_', $this->getName() );
1998 * Check if the user has new messages.
1999 * @return bool True if the user has new messages
2001 public function getNewtalk() {
2004 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2005 if ( $this->mNewtalk
=== -1 ) {
2006 $this->mNewtalk
= false; # reset talk page status
2008 // Check memcached separately for anons, who have no
2009 // entire User object stored in there.
2010 if ( !$this->mId
) {
2011 global $wgDisableAnonTalk;
2012 if ( $wgDisableAnonTalk ) {
2013 // Anon newtalk disabled by configuration.
2014 $this->mNewtalk
= false;
2017 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
2018 $newtalk = $wgMemc->get( $key );
2019 if ( strval( $newtalk ) !== '' ) {
2020 $this->mNewtalk
= (bool)$newtalk;
2022 // Since we are caching this, make sure it is up to date by getting it
2024 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
2025 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
2029 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2033 return (bool)$this->mNewtalk
;
2037 * Return the data needed to construct links for new talk page message
2038 * alerts. If there are new messages, this will return an associative array
2039 * with the following data:
2040 * wiki: The database name of the wiki
2041 * link: Root-relative link to the user's talk page
2042 * rev: The last talk page revision that the user has seen or null. This
2043 * is useful for building diff links.
2044 * If there are no new messages, it returns an empty array.
2045 * @note This function was designed to accomodate multiple talk pages, but
2046 * currently only returns a single link and revision.
2049 public function getNewMessageLinks() {
2051 if ( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
2053 } elseif ( !$this->getNewtalk() ) {
2056 $utp = $this->getTalkPage();
2057 $dbr = wfGetDB( DB_SLAVE
);
2058 // Get the "last viewed rev" timestamp from the oldest message notification
2059 $timestamp = $dbr->selectField( 'user_newtalk',
2060 'MIN(user_last_timestamp)',
2061 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
2063 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2064 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
2068 * Get the revision ID for the last talk page revision viewed by the talk
2070 * @return int|null Revision ID or null
2072 public function getNewMessageRevisionId() {
2073 $newMessageRevisionId = null;
2074 $newMessageLinks = $this->getNewMessageLinks();
2075 if ( $newMessageLinks ) {
2076 // Note: getNewMessageLinks() never returns more than a single link
2077 // and it is always for the same wiki, but we double-check here in
2078 // case that changes some time in the future.
2079 if ( count( $newMessageLinks ) === 1
2080 && $newMessageLinks[0]['wiki'] === wfWikiID()
2081 && $newMessageLinks[0]['rev']
2083 $newMessageRevision = $newMessageLinks[0]['rev'];
2084 $newMessageRevisionId = $newMessageRevision->getId();
2087 return $newMessageRevisionId;
2091 * Internal uncached check for new messages
2094 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2095 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2096 * @param bool $fromMaster True to fetch from the master, false for a slave
2097 * @return bool True if the user has new messages
2099 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
2100 if ( $fromMaster ) {
2101 $db = wfGetDB( DB_MASTER
);
2103 $db = wfGetDB( DB_SLAVE
);
2105 $ok = $db->selectField( 'user_newtalk', $field,
2106 array( $field => $id ), __METHOD__
);
2107 return $ok !== false;
2111 * Add or update the new messages flag
2112 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2113 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2114 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2115 * @return bool True if successful, false otherwise
2117 protected function updateNewtalk( $field, $id, $curRev = null ) {
2118 // Get timestamp of the talk page revision prior to the current one
2119 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2120 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2121 // Mark the user as having new messages since this revision
2122 $dbw = wfGetDB( DB_MASTER
);
2123 $dbw->insert( 'user_newtalk',
2124 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
2127 if ( $dbw->affectedRows() ) {
2128 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2131 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2137 * Clear the new messages flag for the given user
2138 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2139 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2140 * @return bool True if successful, false otherwise
2142 protected function deleteNewtalk( $field, $id ) {
2143 $dbw = wfGetDB( DB_MASTER
);
2144 $dbw->delete( 'user_newtalk',
2145 array( $field => $id ),
2147 if ( $dbw->affectedRows() ) {
2148 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2151 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2157 * Update the 'You have new messages!' status.
2158 * @param bool $val Whether the user has new messages
2159 * @param Revision $curRev New, as yet unseen revision of the user talk
2160 * page. Ignored if null or !$val.
2162 public function setNewtalk( $val, $curRev = null ) {
2163 if ( wfReadOnly() ) {
2168 $this->mNewtalk
= $val;
2170 if ( $this->isAnon() ) {
2172 $id = $this->getName();
2175 $id = $this->getId();
2180 $changed = $this->updateNewtalk( $field, $id, $curRev );
2182 $changed = $this->deleteNewtalk( $field, $id );
2185 if ( $this->isAnon() ) {
2186 // Anons have a separate memcached space, since
2187 // user records aren't kept for them.
2188 $key = wfMemcKey( 'newtalk', 'ip', $id );
2189 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
2192 $this->invalidateCache();
2197 * Generate a current or new-future timestamp to be stored in the
2198 * user_touched field when we update things.
2199 * @return string Timestamp in TS_MW format
2201 private static function newTouchedTimestamp() {
2202 global $wgClockSkewFudge;
2203 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2207 * Clear user data from memcached.
2208 * Use after applying fun updates to the database; caller's
2209 * responsibility to update user_touched if appropriate.
2211 * Called implicitly from invalidateCache() and saveSettings().
2213 public function clearSharedCache() {
2217 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
2222 * Immediately touch the user data cache for this account.
2223 * Updates user_touched field, and removes account data from memcached
2224 * for reload on the next hit.
2226 public function invalidateCache() {
2227 if ( wfReadOnly() ) {
2232 $this->mTouched
= self
::newTouchedTimestamp();
2234 $dbw = wfGetDB( DB_MASTER
);
2235 $userid = $this->mId
;
2236 $touched = $this->mTouched
;
2237 $method = __METHOD__
;
2238 $dbw->onTransactionIdle( function () use ( $dbw, $userid, $touched, $method ) {
2239 // Prevent contention slams by checking user_touched first
2240 $encTouched = $dbw->addQuotes( $dbw->timestamp( $touched ) );
2241 $needsPurge = $dbw->selectField( 'user', '1',
2242 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ) );
2243 if ( $needsPurge ) {
2244 $dbw->update( 'user',
2245 array( 'user_touched' => $dbw->timestamp( $touched ) ),
2246 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ),
2251 $this->clearSharedCache();
2256 * Validate the cache for this account.
2257 * @param string $timestamp A timestamp in TS_MW format
2260 public function validateCache( $timestamp ) {
2262 return ( $timestamp >= $this->mTouched
);
2266 * Get the user touched timestamp
2267 * @return string Timestamp
2269 public function getTouched() {
2271 return $this->mTouched
;
2278 public function getPassword() {
2279 $this->loadPasswords();
2281 return $this->mPassword
;
2288 public function getTemporaryPassword() {
2289 $this->loadPasswords();
2291 return $this->mNewpassword
;
2295 * Set the password and reset the random token.
2296 * Calls through to authentication plugin if necessary;
2297 * will have no effect if the auth plugin refuses to
2298 * pass the change through or if the legal password
2301 * As a special case, setting the password to null
2302 * wipes it, so the account cannot be logged in until
2303 * a new password is set, for instance via e-mail.
2305 * @param string $str New password to set
2306 * @throws PasswordError On failure
2310 public function setPassword( $str ) {
2313 $this->loadPasswords();
2315 if ( $str !== null ) {
2316 if ( !$wgAuth->allowPasswordChange() ) {
2317 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2320 if ( !$this->isValidPassword( $str ) ) {
2321 global $wgMinimalPasswordLength;
2322 $valid = $this->getPasswordValidity( $str );
2323 if ( is_array( $valid ) ) {
2324 $message = array_shift( $valid );
2328 $params = array( $wgMinimalPasswordLength );
2330 throw new PasswordError( wfMessage( $message, $params )->text() );
2334 if ( !$wgAuth->setPassword( $this, $str ) ) {
2335 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2338 $this->setInternalPassword( $str );
2344 * Set the password and reset the random token unconditionally.
2346 * @param string|null $str New password to set or null to set an invalid
2347 * password hash meaning that the user will not be able to log in
2348 * through the web interface.
2350 public function setInternalPassword( $str ) {
2353 $passwordFactory = self
::getPasswordFactory();
2354 if ( $str === null ) {
2355 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
2357 $this->mPassword
= $passwordFactory->newFromPlaintext( $str );
2360 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
2361 $this->mNewpassTime
= null;
2365 * Get the user's current token.
2366 * @param bool $forceCreation Force the generation of a new token if the
2367 * user doesn't have one (default=true for backwards compatibility).
2368 * @return string Token
2370 public function getToken( $forceCreation = true ) {
2372 if ( !$this->mToken
&& $forceCreation ) {
2375 return $this->mToken
;
2379 * Set the random token (used for persistent authentication)
2380 * Called from loadDefaults() among other places.
2382 * @param string|bool $token If specified, set the token to this value
2384 public function setToken( $token = false ) {
2387 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2389 $this->mToken
= $token;
2394 * Set the password for a password reminder or new account email
2396 * @param string $str New password to set or null to set an invalid
2397 * password hash meaning that the user will not be able to use it
2398 * @param bool $throttle If true, reset the throttle timestamp to the present
2400 public function setNewpassword( $str, $throttle = true ) {
2401 $this->loadPasswords();
2403 if ( $str === null ) {
2404 $this->mNewpassword
= '';
2405 $this->mNewpassTime
= null;
2407 $this->mNewpassword
= self
::getPasswordFactory()->newFromPlaintext( $str );
2409 $this->mNewpassTime
= wfTimestampNow();
2415 * Has password reminder email been sent within the last
2416 * $wgPasswordReminderResendTime hours?
2419 public function isPasswordReminderThrottled() {
2420 global $wgPasswordReminderResendTime;
2422 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2425 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2426 return time() < $expiry;
2430 * Get the user's e-mail address
2431 * @return string User's email address
2433 public function getEmail() {
2435 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2436 return $this->mEmail
;
2440 * Get the timestamp of the user's e-mail authentication
2441 * @return string TS_MW timestamp
2443 public function getEmailAuthenticationTimestamp() {
2445 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2446 return $this->mEmailAuthenticated
;
2450 * Set the user's e-mail address
2451 * @param string $str New e-mail address
2453 public function setEmail( $str ) {
2455 if ( $str == $this->mEmail
) {
2458 $this->invalidateEmail();
2459 $this->mEmail
= $str;
2460 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2464 * Set the user's e-mail address and a confirmation mail if needed.
2467 * @param string $str New e-mail address
2470 public function setEmailWithConfirmation( $str ) {
2471 global $wgEnableEmail, $wgEmailAuthentication;
2473 if ( !$wgEnableEmail ) {
2474 return Status
::newFatal( 'emaildisabled' );
2477 $oldaddr = $this->getEmail();
2478 if ( $str === $oldaddr ) {
2479 return Status
::newGood( true );
2482 $this->setEmail( $str );
2484 if ( $str !== '' && $wgEmailAuthentication ) {
2485 // Send a confirmation request to the new address if needed
2486 $type = $oldaddr != '' ?
'changed' : 'set';
2487 $result = $this->sendConfirmationMail( $type );
2488 if ( $result->isGood() ) {
2489 // Say the the caller that a confirmation mail has been sent
2490 $result->value
= 'eauth';
2493 $result = Status
::newGood( true );
2500 * Get the user's real name
2501 * @return string User's real name
2503 public function getRealName() {
2504 if ( !$this->isItemLoaded( 'realname' ) ) {
2508 return $this->mRealName
;
2512 * Set the user's real name
2513 * @param string $str New real name
2515 public function setRealName( $str ) {
2517 $this->mRealName
= $str;
2521 * Get the user's current setting for a given option.
2523 * @param string $oname The option to check
2524 * @param string $defaultOverride A default value returned if the option does not exist
2525 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2526 * @return string User's current value for the option
2527 * @see getBoolOption()
2528 * @see getIntOption()
2530 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2531 global $wgHiddenPrefs;
2532 $this->loadOptions();
2534 # We want 'disabled' preferences to always behave as the default value for
2535 # users, even if they have set the option explicitly in their settings (ie they
2536 # set it, and then it was disabled removing their ability to change it). But
2537 # we don't want to erase the preferences in the database in case the preference
2538 # is re-enabled again. So don't touch $mOptions, just override the returned value
2539 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2540 return self
::getDefaultOption( $oname );
2543 if ( array_key_exists( $oname, $this->mOptions
) ) {
2544 return $this->mOptions
[$oname];
2546 return $defaultOverride;
2551 * Get all user's options
2555 public function getOptions() {
2556 global $wgHiddenPrefs;
2557 $this->loadOptions();
2558 $options = $this->mOptions
;
2560 # We want 'disabled' preferences to always behave as the default value for
2561 # users, even if they have set the option explicitly in their settings (ie they
2562 # set it, and then it was disabled removing their ability to change it). But
2563 # we don't want to erase the preferences in the database in case the preference
2564 # is re-enabled again. So don't touch $mOptions, just override the returned value
2565 foreach ( $wgHiddenPrefs as $pref ) {
2566 $default = self
::getDefaultOption( $pref );
2567 if ( $default !== null ) {
2568 $options[$pref] = $default;
2576 * Get the user's current setting for a given option, as a boolean value.
2578 * @param string $oname The option to check
2579 * @return bool User's current value for the option
2582 public function getBoolOption( $oname ) {
2583 return (bool)$this->getOption( $oname );
2587 * Get the user's current setting for a given option, as an integer value.
2589 * @param string $oname The option to check
2590 * @param int $defaultOverride A default value returned if the option does not exist
2591 * @return int User's current value for the option
2594 public function getIntOption( $oname, $defaultOverride = 0 ) {
2595 $val = $this->getOption( $oname );
2597 $val = $defaultOverride;
2599 return intval( $val );
2603 * Set the given option for a user.
2605 * You need to call saveSettings() to actually write to the database.
2607 * @param string $oname The option to set
2608 * @param mixed $val New value to set
2610 public function setOption( $oname, $val ) {
2611 $this->loadOptions();
2613 // Explicitly NULL values should refer to defaults
2614 if ( is_null( $val ) ) {
2615 $val = self
::getDefaultOption( $oname );
2618 $this->mOptions
[$oname] = $val;
2622 * Get a token stored in the preferences (like the watchlist one),
2623 * resetting it if it's empty (and saving changes).
2625 * @param string $oname The option name to retrieve the token from
2626 * @return string|bool User's current value for the option, or false if this option is disabled.
2627 * @see resetTokenFromOption()
2630 public function getTokenFromOption( $oname ) {
2631 global $wgHiddenPrefs;
2632 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2636 $token = $this->getOption( $oname );
2638 $token = $this->resetTokenFromOption( $oname );
2639 $this->saveSettings();
2645 * Reset a token stored in the preferences (like the watchlist one).
2646 * *Does not* save user's preferences (similarly to setOption()).
2648 * @param string $oname The option name to reset the token in
2649 * @return string|bool New token value, or false if this option is disabled.
2650 * @see getTokenFromOption()
2653 public function resetTokenFromOption( $oname ) {
2654 global $wgHiddenPrefs;
2655 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2659 $token = MWCryptRand
::generateHex( 40 );
2660 $this->setOption( $oname, $token );
2665 * Return a list of the types of user options currently returned by
2666 * User::getOptionKinds().
2668 * Currently, the option kinds are:
2669 * - 'registered' - preferences which are registered in core MediaWiki or
2670 * by extensions using the UserGetDefaultOptions hook.
2671 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2672 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2673 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2674 * be used by user scripts.
2675 * - 'special' - "preferences" that are not accessible via User::getOptions
2676 * or User::setOptions.
2677 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2678 * These are usually legacy options, removed in newer versions.
2680 * The API (and possibly others) use this function to determine the possible
2681 * option types for validation purposes, so make sure to update this when a
2682 * new option kind is added.
2684 * @see User::getOptionKinds
2685 * @return array Option kinds
2687 public static function listOptionKinds() {
2690 'registered-multiselect',
2691 'registered-checkmatrix',
2699 * Return an associative array mapping preferences keys to the kind of a preference they're
2700 * used for. Different kinds are handled differently when setting or reading preferences.
2702 * See User::listOptionKinds for the list of valid option types that can be provided.
2704 * @see User::listOptionKinds
2705 * @param IContextSource $context
2706 * @param array $options Assoc. array with options keys to check as keys.
2707 * Defaults to $this->mOptions.
2708 * @return array The key => kind mapping data
2710 public function getOptionKinds( IContextSource
$context, $options = null ) {
2711 $this->loadOptions();
2712 if ( $options === null ) {
2713 $options = $this->mOptions
;
2716 $prefs = Preferences
::getPreferences( $this, $context );
2719 // Pull out the "special" options, so they don't get converted as
2720 // multiselect or checkmatrix.
2721 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2722 foreach ( $specialOptions as $name => $value ) {
2723 unset( $prefs[$name] );
2726 // Multiselect and checkmatrix options are stored in the database with
2727 // one key per option, each having a boolean value. Extract those keys.
2728 $multiselectOptions = array();
2729 foreach ( $prefs as $name => $info ) {
2730 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2731 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2732 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2733 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2735 foreach ( $opts as $value ) {
2736 $multiselectOptions["$prefix$value"] = true;
2739 unset( $prefs[$name] );
2742 $checkmatrixOptions = array();
2743 foreach ( $prefs as $name => $info ) {
2744 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2745 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2746 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2747 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2748 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2750 foreach ( $columns as $column ) {
2751 foreach ( $rows as $row ) {
2752 $checkmatrixOptions["$prefix$column-$row"] = true;
2756 unset( $prefs[$name] );
2760 // $value is ignored
2761 foreach ( $options as $key => $value ) {
2762 if ( isset( $prefs[$key] ) ) {
2763 $mapping[$key] = 'registered';
2764 } elseif ( isset( $multiselectOptions[$key] ) ) {
2765 $mapping[$key] = 'registered-multiselect';
2766 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2767 $mapping[$key] = 'registered-checkmatrix';
2768 } elseif ( isset( $specialOptions[$key] ) ) {
2769 $mapping[$key] = 'special';
2770 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2771 $mapping[$key] = 'userjs';
2773 $mapping[$key] = 'unused';
2781 * Reset certain (or all) options to the site defaults
2783 * The optional parameter determines which kinds of preferences will be reset.
2784 * Supported values are everything that can be reported by getOptionKinds()
2785 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2787 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
2788 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2789 * for backwards-compatibility.
2790 * @param IContextSource|null $context Context source used when $resetKinds
2791 * does not contain 'all', passed to getOptionKinds().
2792 * Defaults to RequestContext::getMain() when null.
2794 public function resetOptions(
2795 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2796 IContextSource
$context = null
2799 $defaultOptions = self
::getDefaultOptions();
2801 if ( !is_array( $resetKinds ) ) {
2802 $resetKinds = array( $resetKinds );
2805 if ( in_array( 'all', $resetKinds ) ) {
2806 $newOptions = $defaultOptions;
2808 if ( $context === null ) {
2809 $context = RequestContext
::getMain();
2812 $optionKinds = $this->getOptionKinds( $context );
2813 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
2814 $newOptions = array();
2816 // Use default values for the options that should be deleted, and
2817 // copy old values for the ones that shouldn't.
2818 foreach ( $this->mOptions
as $key => $value ) {
2819 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2820 if ( array_key_exists( $key, $defaultOptions ) ) {
2821 $newOptions[$key] = $defaultOptions[$key];
2824 $newOptions[$key] = $value;
2829 wfRunHooks( 'UserResetAllOptions', array( $this, &$newOptions, $this->mOptions
, $resetKinds ) );
2831 $this->mOptions
= $newOptions;
2832 $this->mOptionsLoaded
= true;
2836 * Get the user's preferred date format.
2837 * @return string User's preferred date format
2839 public function getDatePreference() {
2840 // Important migration for old data rows
2841 if ( is_null( $this->mDatePreference
) ) {
2843 $value = $this->getOption( 'date' );
2844 $map = $wgLang->getDatePreferenceMigrationMap();
2845 if ( isset( $map[$value] ) ) {
2846 $value = $map[$value];
2848 $this->mDatePreference
= $value;
2850 return $this->mDatePreference
;
2854 * Determine based on the wiki configuration and the user's options,
2855 * whether this user must be over HTTPS no matter what.
2859 public function requiresHTTPS() {
2860 global $wgSecureLogin;
2861 if ( !$wgSecureLogin ) {
2864 $https = $this->getBoolOption( 'prefershttps' );
2865 wfRunHooks( 'UserRequiresHTTPS', array( $this, &$https ) );
2867 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
2874 * Get the user preferred stub threshold
2878 public function getStubThreshold() {
2879 global $wgMaxArticleSize; # Maximum article size, in Kb
2880 $threshold = $this->getIntOption( 'stubthreshold' );
2881 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2882 // If they have set an impossible value, disable the preference
2883 // so we can use the parser cache again.
2890 * Get the permissions this user has.
2891 * @return array Array of String permission names
2893 public function getRights() {
2894 if ( is_null( $this->mRights
) ) {
2895 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2896 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2897 // Force reindexation of rights when a hook has unset one of them
2898 $this->mRights
= array_values( array_unique( $this->mRights
) );
2900 return $this->mRights
;
2904 * Get the list of explicit group memberships this user has.
2905 * The implicit * and user groups are not included.
2906 * @return array Array of String internal group names
2908 public function getGroups() {
2910 $this->loadGroups();
2911 return $this->mGroups
;
2915 * Get the list of implicit group memberships this user has.
2916 * This includes all explicit groups, plus 'user' if logged in,
2917 * '*' for all accounts, and autopromoted groups
2918 * @param bool $recache Whether to avoid the cache
2919 * @return array Array of String internal group names
2921 public function getEffectiveGroups( $recache = false ) {
2922 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2923 wfProfileIn( __METHOD__
);
2924 $this->mEffectiveGroups
= array_unique( array_merge(
2925 $this->getGroups(), // explicit groups
2926 $this->getAutomaticGroups( $recache ) // implicit groups
2928 // Hook for additional groups
2929 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2930 // Force reindexation of groups when a hook has unset one of them
2931 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
2932 wfProfileOut( __METHOD__
);
2934 return $this->mEffectiveGroups
;
2938 * Get the list of implicit group memberships this user has.
2939 * This includes 'user' if logged in, '*' for all accounts,
2940 * and autopromoted groups
2941 * @param bool $recache Whether to avoid the cache
2942 * @return array Array of String internal group names
2944 public function getAutomaticGroups( $recache = false ) {
2945 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2946 wfProfileIn( __METHOD__
);
2947 $this->mImplicitGroups
= array( '*' );
2948 if ( $this->getId() ) {
2949 $this->mImplicitGroups
[] = 'user';
2951 $this->mImplicitGroups
= array_unique( array_merge(
2952 $this->mImplicitGroups
,
2953 Autopromote
::getAutopromoteGroups( $this )
2957 // Assure data consistency with rights/groups,
2958 // as getEffectiveGroups() depends on this function
2959 $this->mEffectiveGroups
= null;
2961 wfProfileOut( __METHOD__
);
2963 return $this->mImplicitGroups
;
2967 * Returns the groups the user has belonged to.
2969 * The user may still belong to the returned groups. Compare with getGroups().
2971 * The function will not return groups the user had belonged to before MW 1.17
2973 * @return array Names of the groups the user has belonged to.
2975 public function getFormerGroups() {
2976 if ( is_null( $this->mFormerGroups
) ) {
2977 $dbr = wfGetDB( DB_MASTER
);
2978 $res = $dbr->select( 'user_former_groups',
2979 array( 'ufg_group' ),
2980 array( 'ufg_user' => $this->mId
),
2982 $this->mFormerGroups
= array();
2983 foreach ( $res as $row ) {
2984 $this->mFormerGroups
[] = $row->ufg_group
;
2987 return $this->mFormerGroups
;
2991 * Get the user's edit count.
2992 * @return int|null Null for anonymous users
2994 public function getEditCount() {
2995 if ( !$this->getId() ) {
2999 if ( $this->mEditCount
=== null ) {
3000 /* Populate the count, if it has not been populated yet */
3001 wfProfileIn( __METHOD__
);
3002 $dbr = wfGetDB( DB_SLAVE
);
3003 // check if the user_editcount field has been initialized
3004 $count = $dbr->selectField(
3005 'user', 'user_editcount',
3006 array( 'user_id' => $this->mId
),
3010 if ( $count === null ) {
3011 // it has not been initialized. do so.
3012 $count = $this->initEditCount();
3014 $this->mEditCount
= $count;
3015 wfProfileOut( __METHOD__
);
3017 return (int)$this->mEditCount
;
3021 * Add the user to the given group.
3022 * This takes immediate effect.
3023 * @param string $group Name of the group to add
3025 public function addGroup( $group ) {
3026 if ( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
3027 $dbw = wfGetDB( DB_MASTER
);
3028 if ( $this->getId() ) {
3029 $dbw->insert( 'user_groups',
3031 'ug_user' => $this->getID(),
3032 'ug_group' => $group,
3035 array( 'IGNORE' ) );
3038 $this->loadGroups();
3039 $this->mGroups
[] = $group;
3040 // In case loadGroups was not called before, we now have the right twice.
3041 // Get rid of the duplicate.
3042 $this->mGroups
= array_unique( $this->mGroups
);
3044 // Refresh the groups caches, and clear the rights cache so it will be
3045 // refreshed on the next call to $this->getRights().
3046 $this->getEffectiveGroups( true );
3047 $this->mRights
= null;
3049 $this->invalidateCache();
3053 * Remove the user from the given group.
3054 * This takes immediate effect.
3055 * @param string $group Name of the group to remove
3057 public function removeGroup( $group ) {
3059 if ( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
3060 $dbw = wfGetDB( DB_MASTER
);
3061 $dbw->delete( 'user_groups',
3063 'ug_user' => $this->getID(),
3064 'ug_group' => $group,
3066 // Remember that the user was in this group
3067 $dbw->insert( 'user_former_groups',
3069 'ufg_user' => $this->getID(),
3070 'ufg_group' => $group,
3073 array( 'IGNORE' ) );
3075 $this->loadGroups();
3076 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
3078 // Refresh the groups caches, and clear the rights cache so it will be
3079 // refreshed on the next call to $this->getRights().
3080 $this->getEffectiveGroups( true );
3081 $this->mRights
= null;
3083 $this->invalidateCache();
3087 * Get whether the user is logged in
3090 public function isLoggedIn() {
3091 return $this->getID() != 0;
3095 * Get whether the user is anonymous
3098 public function isAnon() {
3099 return !$this->isLoggedIn();
3103 * Check if user is allowed to access a feature / make an action
3105 * @param string $permissions,... Permissions to test
3106 * @return bool True if user is allowed to perform *any* of the given actions
3108 public function isAllowedAny( /*...*/ ) {
3109 $permissions = func_get_args();
3110 foreach ( $permissions as $permission ) {
3111 if ( $this->isAllowed( $permission ) ) {
3120 * @param string $permissions,... Permissions to test
3121 * @return bool True if the user is allowed to perform *all* of the given actions
3123 public function isAllowedAll( /*...*/ ) {
3124 $permissions = func_get_args();
3125 foreach ( $permissions as $permission ) {
3126 if ( !$this->isAllowed( $permission ) ) {
3134 * Internal mechanics of testing a permission
3135 * @param string $action
3138 public function isAllowed( $action = '' ) {
3139 if ( $action === '' ) {
3140 return true; // In the spirit of DWIM
3142 // Patrolling may not be enabled
3143 if ( $action === 'patrol' ||
$action === 'autopatrol' ) {
3144 global $wgUseRCPatrol, $wgUseNPPatrol;
3145 if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) {
3149 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3150 // by misconfiguration: 0 == 'foo'
3151 return in_array( $action, $this->getRights(), true );
3155 * Check whether to enable recent changes patrol features for this user
3156 * @return bool True or false
3158 public function useRCPatrol() {
3159 global $wgUseRCPatrol;
3160 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3164 * Check whether to enable new pages patrol features for this user
3165 * @return bool True or false
3167 public function useNPPatrol() {
3168 global $wgUseRCPatrol, $wgUseNPPatrol;
3170 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3171 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3176 * Get the WebRequest object to use with this object
3178 * @return WebRequest
3180 public function getRequest() {
3181 if ( $this->mRequest
) {
3182 return $this->mRequest
;
3190 * Get the current skin, loading it if required
3191 * @return Skin The current skin
3192 * @todo FIXME: Need to check the old failback system [AV]
3193 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
3195 public function getSkin() {
3196 wfDeprecated( __METHOD__
, '1.18' );
3197 return RequestContext
::getMain()->getSkin();
3201 * Get a WatchedItem for this user and $title.
3203 * @since 1.22 $checkRights parameter added
3204 * @param Title $title
3205 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3206 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3207 * @return WatchedItem
3209 public function getWatchedItem( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3210 $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey();
3212 if ( isset( $this->mWatchedItems
[$key] ) ) {
3213 return $this->mWatchedItems
[$key];
3216 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
3217 $this->mWatchedItems
= array();
3220 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title, $checkRights );
3221 return $this->mWatchedItems
[$key];
3225 * Check the watched status of an article.
3226 * @since 1.22 $checkRights parameter added
3227 * @param Title $title Title of the article to look at
3228 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3229 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3232 public function isWatched( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3233 return $this->getWatchedItem( $title, $checkRights )->isWatched();
3238 * @since 1.22 $checkRights parameter added
3239 * @param Title $title Title of the article to look at
3240 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3241 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3243 public function addWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3244 $this->getWatchedItem( $title, $checkRights )->addWatch();
3245 $this->invalidateCache();
3249 * Stop watching an article.
3250 * @since 1.22 $checkRights parameter added
3251 * @param Title $title Title of the article to look at
3252 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3253 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3255 public function removeWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3256 $this->getWatchedItem( $title, $checkRights )->removeWatch();
3257 $this->invalidateCache();
3261 * Clear the user's notification timestamp for the given title.
3262 * If e-notif e-mails are on, they will receive notification mails on
3263 * the next change of the page if it's watched etc.
3264 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3265 * @param Title $title Title of the article to look at
3266 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3268 public function clearNotification( &$title, $oldid = 0 ) {
3269 global $wgUseEnotif, $wgShowUpdatedMarker;
3271 // Do nothing if the database is locked to writes
3272 if ( wfReadOnly() ) {
3276 // Do nothing if not allowed to edit the watchlist
3277 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3281 // If we're working on user's talk page, we should update the talk page message indicator
3282 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3283 if ( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this, $oldid ) ) ) {
3287 $nextid = $oldid ?
$title->getNextRevisionID( $oldid ) : null;
3289 if ( !$oldid ||
!$nextid ) {
3290 // If we're looking at the latest revision, we should definitely clear it
3291 $this->setNewtalk( false );
3293 // Otherwise we should update its revision, if it's present
3294 if ( $this->getNewtalk() ) {
3295 // Naturally the other one won't clear by itself
3296 $this->setNewtalk( false );
3297 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3302 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3306 if ( $this->isAnon() ) {
3307 // Nothing else to do...
3311 // Only update the timestamp if the page is being watched.
3312 // The query to find out if it is watched is cached both in memcached and per-invocation,
3313 // and when it does have to be executed, it can be on a slave
3314 // If this is the user's newtalk page, we always update the timestamp
3316 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3320 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force, $oldid );
3324 * Resets all of the given user's page-change notification timestamps.
3325 * If e-notif e-mails are on, they will receive notification mails on
3326 * the next change of any watched page.
3327 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3329 public function clearAllNotifications() {
3330 if ( wfReadOnly() ) {
3334 // Do nothing if not allowed to edit the watchlist
3335 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3339 global $wgUseEnotif, $wgShowUpdatedMarker;
3340 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3341 $this->setNewtalk( false );
3344 $id = $this->getId();
3346 $dbw = wfGetDB( DB_MASTER
);
3347 $dbw->update( 'watchlist',
3348 array( /* SET */ 'wl_notificationtimestamp' => null ),
3349 array( /* WHERE */ 'wl_user' => $id ),
3352 // We also need to clear here the "you have new message" notification for the own user_talk page;
3353 // it's cleared one page view later in WikiPage::doViewUpdates().
3358 * Set a cookie on the user's client. Wrapper for
3359 * WebResponse::setCookie
3360 * @param string $name Name of the cookie to set
3361 * @param string $value Value to set
3362 * @param int $exp Expiration time, as a UNIX time value;
3363 * if 0 or not specified, use the default $wgCookieExpiration
3364 * @param bool $secure
3365 * true: Force setting the secure attribute when setting the cookie
3366 * false: Force NOT setting the secure attribute when setting the cookie
3367 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3368 * @param array $params Array of options sent passed to WebResponse::setcookie()
3370 protected function setCookie( $name, $value, $exp = 0, $secure = null, $params = array() ) {
3371 $params['secure'] = $secure;
3372 $this->getRequest()->response()->setcookie( $name, $value, $exp, $params );
3376 * Clear a cookie on the user's client
3377 * @param string $name Name of the cookie to clear
3378 * @param bool $secure
3379 * true: Force setting the secure attribute when setting the cookie
3380 * false: Force NOT setting the secure attribute when setting the cookie
3381 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3382 * @param array $params Array of options sent passed to WebResponse::setcookie()
3384 protected function clearCookie( $name, $secure = null, $params = array() ) {
3385 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3389 * Set the default cookies for this session on the user's client.
3391 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3393 * @param bool $secure Whether to force secure/insecure cookies or use default
3394 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3396 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3397 if ( $request === null ) {
3398 $request = $this->getRequest();
3402 if ( 0 == $this->mId
) {
3405 if ( !$this->mToken
) {
3406 // When token is empty or NULL generate a new one and then save it to the database
3407 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
3408 // Simply by setting every cell in the user_token column to NULL and letting them be
3409 // regenerated as users log back into the wiki.
3411 $this->saveSettings();
3414 'wsUserID' => $this->mId
,
3415 'wsToken' => $this->mToken
,
3416 'wsUserName' => $this->getName()
3419 'UserID' => $this->mId
,
3420 'UserName' => $this->getName(),
3422 if ( $rememberMe ) {
3423 $cookies['Token'] = $this->mToken
;
3425 $cookies['Token'] = false;
3428 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
3430 foreach ( $session as $name => $value ) {
3431 $request->setSessionData( $name, $value );
3433 foreach ( $cookies as $name => $value ) {
3434 if ( $value === false ) {
3435 $this->clearCookie( $name );
3437 $this->setCookie( $name, $value, 0, $secure );
3442 * If wpStickHTTPS was selected, also set an insecure cookie that
3443 * will cause the site to redirect the user to HTTPS, if they access
3444 * it over HTTP. Bug 29898. Use an un-prefixed cookie, so it's the same
3445 * as the one set by centralauth (bug 53538). Also set it to session, or
3446 * standard time setting, based on if rememberme was set.
3448 if ( $request->getCheck( 'wpStickHTTPS' ) ||
$this->requiresHTTPS() ) {
3452 $rememberMe ?
0 : null,
3454 array( 'prefix' => '' ) // no prefix
3460 * Log this user out.
3462 public function logout() {
3463 if ( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
3469 * Clear the user's cookies and session, and reset the instance cache.
3472 public function doLogout() {
3473 $this->clearInstanceCache( 'defaults' );
3475 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3477 $this->clearCookie( 'UserID' );
3478 $this->clearCookie( 'Token' );
3479 $this->clearCookie( 'forceHTTPS', false, array( 'prefix' => '' ) );
3481 // Remember when user logged out, to prevent seeing cached pages
3482 $this->setCookie( 'LoggedOut', time(), time() +
86400 );
3486 * Save this user's settings into the database.
3487 * @todo Only rarely do all these fields need to be set!
3489 public function saveSettings() {
3493 $this->loadPasswords();
3494 if ( wfReadOnly() ) {
3497 if ( 0 == $this->mId
) {
3501 $this->mTouched
= self
::newTouchedTimestamp();
3502 if ( !$wgAuth->allowSetLocalPassword() ) {
3503 $this->mPassword
= self
::getPasswordFactory()->newFromCiphertext( null );
3506 $dbw = wfGetDB( DB_MASTER
);
3507 $dbw->update( 'user',
3509 'user_name' => $this->mName
,
3510 'user_password' => $this->mPassword
->toString(),
3511 'user_newpassword' => $this->mNewpassword
->toString(),
3512 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3513 'user_real_name' => $this->mRealName
,
3514 'user_email' => $this->mEmail
,
3515 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3516 'user_touched' => $dbw->timestamp( $this->mTouched
),
3517 'user_token' => strval( $this->mToken
),
3518 'user_email_token' => $this->mEmailToken
,
3519 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3520 'user_password_expires' => $dbw->timestampOrNull( $this->mPasswordExpires
),
3521 ), array( /* WHERE */
3522 'user_id' => $this->mId
3526 $this->saveOptions();
3528 wfRunHooks( 'UserSaveSettings', array( $this ) );
3529 $this->clearSharedCache();
3530 $this->getUserPage()->invalidateCache();
3534 * If only this user's username is known, and it exists, return the user ID.
3537 public function idForName() {
3538 $s = trim( $this->getName() );
3543 $dbr = wfGetDB( DB_SLAVE
);
3544 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
3545 if ( $id === false ) {
3552 * Add a user to the database, return the user object
3554 * @param string $name Username to add
3555 * @param array $params Array of Strings Non-default parameters to save to
3556 * the database as user_* fields:
3557 * - password: The user's password hash. Password logins will be disabled
3558 * if this is omitted.
3559 * - newpassword: Hash for a temporary password that has been mailed to
3561 * - email: The user's email address.
3562 * - email_authenticated: The email authentication timestamp.
3563 * - real_name: The user's real name.
3564 * - options: An associative array of non-default options.
3565 * - token: Random authentication token. Do not set.
3566 * - registration: Registration timestamp. Do not set.
3568 * @return User|null User object, or null if the username already exists.
3570 public static function createNew( $name, $params = array() ) {
3573 $user->loadPasswords();
3574 $user->setToken(); // init token
3575 if ( isset( $params['options'] ) ) {
3576 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3577 unset( $params['options'] );
3579 $dbw = wfGetDB( DB_MASTER
);
3580 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3583 'user_id' => $seqVal,
3584 'user_name' => $name,
3585 'user_password' => $user->mPassword
->toString(),
3586 'user_newpassword' => $user->mNewpassword
->toString(),
3587 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
3588 'user_email' => $user->mEmail
,
3589 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3590 'user_real_name' => $user->mRealName
,
3591 'user_token' => strval( $user->mToken
),
3592 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3593 'user_editcount' => 0,
3594 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3596 foreach ( $params as $name => $value ) {
3597 $fields["user_$name"] = $value;
3599 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3600 if ( $dbw->affectedRows() ) {
3601 $newUser = User
::newFromId( $dbw->insertId() );
3609 * Add this existing user object to the database. If the user already
3610 * exists, a fatal status object is returned, and the user object is
3611 * initialised with the data from the database.
3613 * Previously, this function generated a DB error due to a key conflict
3614 * if the user already existed. Many extension callers use this function
3615 * in code along the lines of:
3617 * $user = User::newFromName( $name );
3618 * if ( !$user->isLoggedIn() ) {
3619 * $user->addToDatabase();
3621 * // do something with $user...
3623 * However, this was vulnerable to a race condition (bug 16020). By
3624 * initialising the user object if the user exists, we aim to support this
3625 * calling sequence as far as possible.
3627 * Note that if the user exists, this function will acquire a write lock,
3628 * so it is still advisable to make the call conditional on isLoggedIn(),
3629 * and to commit the transaction after calling.
3631 * @throws MWException
3634 public function addToDatabase() {
3636 $this->loadPasswords();
3637 if ( !$this->mToken
) {
3638 $this->setToken(); // init token
3641 $this->mTouched
= self
::newTouchedTimestamp();
3643 $dbw = wfGetDB( DB_MASTER
);
3644 $inWrite = $dbw->writesOrCallbacksPending();
3645 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3646 $dbw->insert( 'user',
3648 'user_id' => $seqVal,
3649 'user_name' => $this->mName
,
3650 'user_password' => $this->mPassword
->toString(),
3651 'user_newpassword' => $this->mNewpassword
->toString(),
3652 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3653 'user_email' => $this->mEmail
,
3654 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3655 'user_real_name' => $this->mRealName
,
3656 'user_token' => strval( $this->mToken
),
3657 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3658 'user_editcount' => 0,
3659 'user_touched' => $dbw->timestamp( $this->mTouched
),
3663 if ( !$dbw->affectedRows() ) {
3664 // The queries below cannot happen in the same REPEATABLE-READ snapshot.
3665 // Handle this by COMMIT, if possible, or by LOCK IN SHARE MODE otherwise.
3667 // Can't commit due to pending writes that may need atomicity.
3668 // This may cause some lock contention unlike the case below.
3669 $options = array( 'LOCK IN SHARE MODE' );
3670 $flags = self
::READ_LOCKING
;
3672 // Often, this case happens early in views before any writes when
3673 // using CentralAuth. It's should be OK to commit and break the snapshot.
3674 $dbw->commit( __METHOD__
, 'flush' );
3678 $this->mId
= $dbw->selectField( 'user', 'user_id',
3679 array( 'user_name' => $this->mName
), __METHOD__
, $options );
3682 if ( $this->loadFromDatabase( $flags ) ) {
3687 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3688 "to insert user '{$this->mName}' row, but it was not present in select!" );
3690 return Status
::newFatal( 'userexists' );
3692 $this->mId
= $dbw->insertId();
3694 // Clear instance cache other than user table data, which is already accurate
3695 $this->clearInstanceCache();
3697 $this->saveOptions();
3698 return Status
::newGood();
3702 * If this user is logged-in and blocked,
3703 * block any IP address they've successfully logged in from.
3704 * @return bool A block was spread
3706 public function spreadAnyEditBlock() {
3707 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3708 return $this->spreadBlock();
3714 * If this (non-anonymous) user is blocked,
3715 * block the IP address they've successfully logged in from.
3716 * @return bool A block was spread
3718 protected function spreadBlock() {
3719 wfDebug( __METHOD__
. "()\n" );
3721 if ( $this->mId
== 0 ) {
3725 $userblock = Block
::newFromTarget( $this->getName() );
3726 if ( !$userblock ) {
3730 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3734 * Get whether the user is explicitly blocked from account creation.
3735 * @return bool|Block
3737 public function isBlockedFromCreateAccount() {
3738 $this->getBlockedStatus();
3739 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
3740 return $this->mBlock
;
3743 # bug 13611: if the IP address the user is trying to create an account from is
3744 # blocked with createaccount disabled, prevent new account creation there even
3745 # when the user is logged in
3746 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3747 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3749 return $this->mBlockedFromCreateAccount
instanceof Block
3750 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3751 ?
$this->mBlockedFromCreateAccount
3756 * Get whether the user is blocked from using Special:Emailuser.
3759 public function isBlockedFromEmailuser() {
3760 $this->getBlockedStatus();
3761 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3765 * Get whether the user is allowed to create an account.
3768 public function isAllowedToCreateAccount() {
3769 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3773 * Get this user's personal page title.
3775 * @return Title User's personal page title
3777 public function getUserPage() {
3778 return Title
::makeTitle( NS_USER
, $this->getName() );
3782 * Get this user's talk page title.
3784 * @return Title User's talk page title
3786 public function getTalkPage() {
3787 $title = $this->getUserPage();
3788 return $title->getTalkPage();
3792 * Determine whether the user is a newbie. Newbies are either
3793 * anonymous IPs, or the most recently created accounts.
3796 public function isNewbie() {
3797 return !$this->isAllowed( 'autoconfirmed' );
3801 * Check to see if the given clear-text password is one of the accepted passwords
3802 * @param string $password User password
3803 * @return bool True if the given password is correct, otherwise False
3805 public function checkPassword( $password ) {
3806 global $wgAuth, $wgLegacyEncoding;
3808 $section = new ProfileSection( __METHOD__
);
3810 $this->loadPasswords();
3812 // Certain authentication plugins do NOT want to save
3813 // domain passwords in a mysql database, so we should
3814 // check this (in case $wgAuth->strict() is false).
3815 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
3817 } elseif ( $wgAuth->strict() ) {
3818 // Auth plugin doesn't allow local authentication
3820 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
3821 // Auth plugin doesn't allow local authentication for this user name
3825 $passwordFactory = self
::getPasswordFactory();
3826 if ( !$this->mPassword
->equals( $password ) ) {
3827 if ( $wgLegacyEncoding ) {
3828 // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3829 // Check for this with iconv
3830 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3831 if ( $cp1252Password === $password ||
!$this->mPassword
->equals( $cp1252Password ) ) {
3839 if ( $passwordFactory->needsUpdate( $this->mPassword
) ) {
3840 $this->mPassword
= $passwordFactory->newFromPlaintext( $password );
3841 $this->saveSettings();
3848 * Check if the given clear-text password matches the temporary password
3849 * sent by e-mail for password reset operations.
3851 * @param string $plaintext
3853 * @return bool True if matches, false otherwise
3855 public function checkTemporaryPassword( $plaintext ) {
3856 global $wgNewPasswordExpiry;
3859 $this->loadPasswords();
3860 if ( $this->mNewpassword
->equals( $plaintext ) ) {
3861 if ( is_null( $this->mNewpassTime
) ) {
3864 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3865 return ( time() < $expiry );
3872 * Alias for getEditToken.
3873 * @deprecated since 1.19, use getEditToken instead.
3875 * @param string|array $salt Array of Strings Optional function-specific data for hashing
3876 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
3877 * @return string The new edit token
3879 public function editToken( $salt = '', $request = null ) {
3880 wfDeprecated( __METHOD__
, '1.19' );
3881 return $this->getEditToken( $salt, $request );
3885 * Initialize (if necessary) and return a session token value
3886 * which can be used in edit forms to show that the user's
3887 * login credentials aren't being hijacked with a foreign form
3892 * @param string|array $salt Array of Strings Optional function-specific data for hashing
3893 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
3894 * @return string The new edit token
3896 public function getEditToken( $salt = '', $request = null ) {
3897 if ( $request == null ) {
3898 $request = $this->getRequest();
3901 if ( $this->isAnon() ) {
3902 return self
::EDIT_TOKEN_SUFFIX
;
3904 $token = $request->getSessionData( 'wsEditToken' );
3905 if ( $token === null ) {
3906 $token = MWCryptRand
::generateHex( 32 );
3907 $request->setSessionData( 'wsEditToken', $token );
3909 if ( is_array( $salt ) ) {
3910 $salt = implode( '|', $salt );
3912 return md5( $token . $salt ) . self
::EDIT_TOKEN_SUFFIX
;
3917 * Generate a looking random token for various uses.
3919 * @return string The new random token
3920 * @deprecated since 1.20: Use MWCryptRand for secure purposes or
3921 * wfRandomString for pseudo-randomness.
3923 public static function generateToken() {
3924 return MWCryptRand
::generateHex( 32 );
3928 * Check given value against the token value stored in the session.
3929 * A match should confirm that the form was submitted from the
3930 * user's own login session, not a form submission from a third-party
3933 * @param string $val Input value to compare
3934 * @param string $salt Optional function-specific data for hashing
3935 * @param WebRequest|null $request Object to use or null to use $wgRequest
3936 * @return bool Whether the token matches
3938 public function matchEditToken( $val, $salt = '', $request = null ) {
3939 $sessionToken = $this->getEditToken( $salt, $request );
3940 if ( $val != $sessionToken ) {
3941 wfDebug( "User::matchEditToken: broken session data\n" );
3944 return $val == $sessionToken;
3948 * Check given value against the token value stored in the session,
3949 * ignoring the suffix.
3951 * @param string $val Input value to compare
3952 * @param string $salt Optional function-specific data for hashing
3953 * @param WebRequest|null $request Object to use or null to use $wgRequest
3954 * @return bool Whether the token matches
3956 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3957 $sessionToken = $this->getEditToken( $salt, $request );
3958 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3962 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3963 * mail to the user's given address.
3965 * @param string $type Message to send, either "created", "changed" or "set"
3968 public function sendConfirmationMail( $type = 'created' ) {
3970 $expiration = null; // gets passed-by-ref and defined in next line.
3971 $token = $this->confirmationToken( $expiration );
3972 $url = $this->confirmationTokenUrl( $token );
3973 $invalidateURL = $this->invalidationTokenUrl( $token );
3974 $this->saveSettings();
3976 if ( $type == 'created' ||
$type === false ) {
3977 $message = 'confirmemail_body';
3978 } elseif ( $type === true ) {
3979 $message = 'confirmemail_body_changed';
3981 // Messages: confirmemail_body_changed, confirmemail_body_set
3982 $message = 'confirmemail_body_' . $type;
3985 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3986 wfMessage( $message,
3987 $this->getRequest()->getIP(),
3990 $wgLang->timeanddate( $expiration, false ),
3992 $wgLang->date( $expiration, false ),
3993 $wgLang->time( $expiration, false ) )->text() );
3997 * Send an e-mail to this user's account. Does not check for
3998 * confirmed status or validity.
4000 * @param string $subject Message subject
4001 * @param string $body Message body
4002 * @param string $from Optional From address; if unspecified, default
4003 * $wgPasswordSender will be used.
4004 * @param string $replyto Reply-To address
4007 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4008 if ( is_null( $from ) ) {
4009 global $wgPasswordSender;
4010 $sender = new MailAddress( $wgPasswordSender,
4011 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4013 $sender = MailAddress
::newFromUser( $from );
4016 $to = MailAddress
::newFromUser( $this );
4017 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
4021 * Generate, store, and return a new e-mail confirmation code.
4022 * A hash (unsalted, since it's used as a key) is stored.
4024 * @note Call saveSettings() after calling this function to commit
4025 * this change to the database.
4027 * @param string &$expiration Accepts the expiration time
4028 * @return string New token
4030 protected function confirmationToken( &$expiration ) {
4031 global $wgUserEmailConfirmationTokenExpiry;
4033 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4034 $expiration = wfTimestamp( TS_MW
, $expires );
4036 $token = MWCryptRand
::generateHex( 32 );
4037 $hash = md5( $token );
4038 $this->mEmailToken
= $hash;
4039 $this->mEmailTokenExpires
= $expiration;
4044 * Return a URL the user can use to confirm their email address.
4045 * @param string $token Accepts the email confirmation token
4046 * @return string New token URL
4048 protected function confirmationTokenUrl( $token ) {
4049 return $this->getTokenUrl( 'ConfirmEmail', $token );
4053 * Return a URL the user can use to invalidate their email address.
4054 * @param string $token Accepts the email confirmation token
4055 * @return string New token URL
4057 protected function invalidationTokenUrl( $token ) {
4058 return $this->getTokenUrl( 'InvalidateEmail', $token );
4062 * Internal function to format the e-mail validation/invalidation URLs.
4063 * This uses a quickie hack to use the
4064 * hardcoded English names of the Special: pages, for ASCII safety.
4066 * @note Since these URLs get dropped directly into emails, using the
4067 * short English names avoids insanely long URL-encoded links, which
4068 * also sometimes can get corrupted in some browsers/mailers
4069 * (bug 6957 with Gmail and Internet Explorer).
4071 * @param string $page Special page
4072 * @param string $token Token
4073 * @return string Formatted URL
4075 protected function getTokenUrl( $page, $token ) {
4076 // Hack to bypass localization of 'Special:'
4077 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4078 return $title->getCanonicalURL();
4082 * Mark the e-mail address confirmed.
4084 * @note Call saveSettings() after calling this function to commit the change.
4088 public function confirmEmail() {
4089 // Check if it's already confirmed, so we don't touch the database
4090 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4091 if ( !$this->isEmailConfirmed() ) {
4092 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4093 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
4099 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4100 * address if it was already confirmed.
4102 * @note Call saveSettings() after calling this function to commit the change.
4103 * @return bool Returns true
4105 public function invalidateEmail() {
4107 $this->mEmailToken
= null;
4108 $this->mEmailTokenExpires
= null;
4109 $this->setEmailAuthenticationTimestamp( null );
4111 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
4116 * Set the e-mail authentication timestamp.
4117 * @param string $timestamp TS_MW timestamp
4119 public function setEmailAuthenticationTimestamp( $timestamp ) {
4121 $this->mEmailAuthenticated
= $timestamp;
4122 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
4126 * Is this user allowed to send e-mails within limits of current
4127 * site configuration?
4130 public function canSendEmail() {
4131 global $wgEnableEmail, $wgEnableUserEmail;
4132 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4135 $canSend = $this->isEmailConfirmed();
4136 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
4141 * Is this user allowed to receive e-mails within limits of current
4142 * site configuration?
4145 public function canReceiveEmail() {
4146 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4150 * Is this user's e-mail address valid-looking and confirmed within
4151 * limits of the current site configuration?
4153 * @note If $wgEmailAuthentication is on, this may require the user to have
4154 * confirmed their address by returning a code or using a password
4155 * sent to the address from the wiki.
4159 public function isEmailConfirmed() {
4160 global $wgEmailAuthentication;
4163 if ( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
4164 if ( $this->isAnon() ) {
4167 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4170 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4180 * Check whether there is an outstanding request for e-mail confirmation.
4183 public function isEmailConfirmationPending() {
4184 global $wgEmailAuthentication;
4185 return $wgEmailAuthentication &&
4186 !$this->isEmailConfirmed() &&
4187 $this->mEmailToken
&&
4188 $this->mEmailTokenExpires
> wfTimestamp();
4192 * Get the timestamp of account creation.
4194 * @return string|bool|null Timestamp of account creation, false for
4195 * non-existent/anonymous user accounts, or null if existing account
4196 * but information is not in database.
4198 public function getRegistration() {
4199 if ( $this->isAnon() ) {
4203 return $this->mRegistration
;
4207 * Get the timestamp of the first edit
4209 * @return string|bool Timestamp of first edit, or false for
4210 * non-existent/anonymous user accounts.
4212 public function getFirstEditTimestamp() {
4213 if ( $this->getId() == 0 ) {
4214 return false; // anons
4216 $dbr = wfGetDB( DB_SLAVE
);
4217 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4218 array( 'rev_user' => $this->getId() ),
4220 array( 'ORDER BY' => 'rev_timestamp ASC' )
4223 return false; // no edits
4225 return wfTimestamp( TS_MW
, $time );
4229 * Get the permissions associated with a given list of groups
4231 * @param array $groups Array of Strings List of internal group names
4232 * @return array Array of Strings List of permission key names for given groups combined
4234 public static function getGroupPermissions( $groups ) {
4235 global $wgGroupPermissions, $wgRevokePermissions;
4237 // grant every granted permission first
4238 foreach ( $groups as $group ) {
4239 if ( isset( $wgGroupPermissions[$group] ) ) {
4240 $rights = array_merge( $rights,
4241 // array_filter removes empty items
4242 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4245 // now revoke the revoked permissions
4246 foreach ( $groups as $group ) {
4247 if ( isset( $wgRevokePermissions[$group] ) ) {
4248 $rights = array_diff( $rights,
4249 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4252 return array_unique( $rights );
4256 * Get all the groups who have a given permission
4258 * @param string $role Role to check
4259 * @return array Array of Strings List of internal group names with the given permission
4261 public static function getGroupsWithPermission( $role ) {
4262 global $wgGroupPermissions;
4263 $allowedGroups = array();
4264 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4265 if ( self
::groupHasPermission( $group, $role ) ) {
4266 $allowedGroups[] = $group;
4269 return $allowedGroups;
4273 * Check, if the given group has the given permission
4275 * If you're wanting to check whether all users have a permission, use
4276 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4280 * @param string $group Group to check
4281 * @param string $role Role to check
4284 public static function groupHasPermission( $group, $role ) {
4285 global $wgGroupPermissions, $wgRevokePermissions;
4286 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4287 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4291 * Check if all users have the given permission
4294 * @param string $right Right to check
4297 public static function isEveryoneAllowed( $right ) {
4298 global $wgGroupPermissions, $wgRevokePermissions;
4299 static $cache = array();
4301 // Use the cached results, except in unit tests which rely on
4302 // being able change the permission mid-request
4303 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4304 return $cache[$right];
4307 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4308 $cache[$right] = false;
4312 // If it's revoked anywhere, then everyone doesn't have it
4313 foreach ( $wgRevokePermissions as $rights ) {
4314 if ( isset( $rights[$right] ) && $rights[$right] ) {
4315 $cache[$right] = false;
4320 // Allow extensions (e.g. OAuth) to say false
4321 if ( !wfRunHooks( 'UserIsEveryoneAllowed', array( $right ) ) ) {
4322 $cache[$right] = false;
4326 $cache[$right] = true;
4331 * Get the localized descriptive name for a group, if it exists
4333 * @param string $group Internal group name
4334 * @return string Localized descriptive group name
4336 public static function getGroupName( $group ) {
4337 $msg = wfMessage( "group-$group" );
4338 return $msg->isBlank() ?
$group : $msg->text();
4342 * Get the localized descriptive name for a member of a group, if it exists
4344 * @param string $group Internal group name
4345 * @param string $username Username for gender (since 1.19)
4346 * @return string Localized name for group member
4348 public static function getGroupMember( $group, $username = '#' ) {
4349 $msg = wfMessage( "group-$group-member", $username );
4350 return $msg->isBlank() ?
$group : $msg->text();
4354 * Return the set of defined explicit groups.
4355 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4356 * are not included, as they are defined automatically, not in the database.
4357 * @return array Array of internal group names
4359 public static function getAllGroups() {
4360 global $wgGroupPermissions, $wgRevokePermissions;
4362 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4363 self
::getImplicitGroups()
4368 * Get a list of all available permissions.
4369 * @return array Array of permission names
4371 public static function getAllRights() {
4372 if ( self
::$mAllRights === false ) {
4373 global $wgAvailableRights;
4374 if ( count( $wgAvailableRights ) ) {
4375 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4377 self
::$mAllRights = self
::$mCoreRights;
4379 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
4381 return self
::$mAllRights;
4385 * Get a list of implicit groups
4386 * @return array Array of Strings Array of internal group names
4388 public static function getImplicitGroups() {
4389 global $wgImplicitGroups;
4391 $groups = $wgImplicitGroups;
4392 # Deprecated, use $wgImplictGroups instead
4393 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) );
4399 * Get the title of a page describing a particular group
4401 * @param string $group Internal group name
4402 * @return Title|bool Title of the page if it exists, false otherwise
4404 public static function getGroupPage( $group ) {
4405 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4406 if ( $msg->exists() ) {
4407 $title = Title
::newFromText( $msg->text() );
4408 if ( is_object( $title ) ) {
4416 * Create a link to the group in HTML, if available;
4417 * else return the group name.
4419 * @param string $group Internal name of the group
4420 * @param string $text The text of the link
4421 * @return string HTML link to the group
4423 public static function makeGroupLinkHTML( $group, $text = '' ) {
4424 if ( $text == '' ) {
4425 $text = self
::getGroupName( $group );
4427 $title = self
::getGroupPage( $group );
4429 return Linker
::link( $title, htmlspecialchars( $text ) );
4436 * Create a link to the group in Wikitext, if available;
4437 * else return the group name.
4439 * @param string $group Internal name of the group
4440 * @param string $text The text of the link
4441 * @return string Wikilink to the group
4443 public static function makeGroupLinkWiki( $group, $text = '' ) {
4444 if ( $text == '' ) {
4445 $text = self
::getGroupName( $group );
4447 $title = self
::getGroupPage( $group );
4449 $page = $title->getPrefixedText();
4450 return "[[$page|$text]]";
4457 * Returns an array of the groups that a particular group can add/remove.
4459 * @param string $group The group to check for whether it can add/remove
4460 * @return array Array( 'add' => array( addablegroups ),
4461 * 'remove' => array( removablegroups ),
4462 * 'add-self' => array( addablegroups to self),
4463 * 'remove-self' => array( removable groups from self) )
4465 public static function changeableByGroup( $group ) {
4466 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4470 'remove' => array(),
4471 'add-self' => array(),
4472 'remove-self' => array()
4475 if ( empty( $wgAddGroups[$group] ) ) {
4476 // Don't add anything to $groups
4477 } elseif ( $wgAddGroups[$group] === true ) {
4478 // You get everything
4479 $groups['add'] = self
::getAllGroups();
4480 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4481 $groups['add'] = $wgAddGroups[$group];
4484 // Same thing for remove
4485 if ( empty( $wgRemoveGroups[$group] ) ) {
4486 } elseif ( $wgRemoveGroups[$group] === true ) {
4487 $groups['remove'] = self
::getAllGroups();
4488 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4489 $groups['remove'] = $wgRemoveGroups[$group];
4492 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4493 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4494 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4495 if ( is_int( $key ) ) {
4496 $wgGroupsAddToSelf['user'][] = $value;
4501 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4502 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4503 if ( is_int( $key ) ) {
4504 $wgGroupsRemoveFromSelf['user'][] = $value;
4509 // Now figure out what groups the user can add to him/herself
4510 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4511 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4512 // No idea WHY this would be used, but it's there
4513 $groups['add-self'] = User
::getAllGroups();
4514 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4515 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4518 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4519 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4520 $groups['remove-self'] = User
::getAllGroups();
4521 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4522 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4529 * Returns an array of groups that this user can add and remove
4530 * @return array Array( 'add' => array( addablegroups ),
4531 * 'remove' => array( removablegroups ),
4532 * 'add-self' => array( addablegroups to self),
4533 * 'remove-self' => array( removable groups from self) )
4535 public function changeableGroups() {
4536 if ( $this->isAllowed( 'userrights' ) ) {
4537 // This group gives the right to modify everything (reverse-
4538 // compatibility with old "userrights lets you change
4540 // Using array_merge to make the groups reindexed
4541 $all = array_merge( User
::getAllGroups() );
4545 'add-self' => array(),
4546 'remove-self' => array()
4550 // Okay, it's not so simple, we will have to go through the arrays
4553 'remove' => array(),
4554 'add-self' => array(),
4555 'remove-self' => array()
4557 $addergroups = $this->getEffectiveGroups();
4559 foreach ( $addergroups as $addergroup ) {
4560 $groups = array_merge_recursive(
4561 $groups, $this->changeableByGroup( $addergroup )
4563 $groups['add'] = array_unique( $groups['add'] );
4564 $groups['remove'] = array_unique( $groups['remove'] );
4565 $groups['add-self'] = array_unique( $groups['add-self'] );
4566 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4572 * Increment the user's edit-count field.
4573 * Will have no effect for anonymous users.
4575 public function incEditCount() {
4576 if ( !$this->isAnon() ) {
4577 $dbw = wfGetDB( DB_MASTER
);
4580 array( 'user_editcount=user_editcount+1' ),
4581 array( 'user_id' => $this->getId() ),
4585 // Lazy initialization check...
4586 if ( $dbw->affectedRows() == 0 ) {
4587 // Now here's a goddamn hack...
4588 $dbr = wfGetDB( DB_SLAVE
);
4589 if ( $dbr !== $dbw ) {
4590 // If we actually have a slave server, the count is
4591 // at least one behind because the current transaction
4592 // has not been committed and replicated.
4593 $this->initEditCount( 1 );
4595 // But if DB_SLAVE is selecting the master, then the
4596 // count we just read includes the revision that was
4597 // just added in the working transaction.
4598 $this->initEditCount();
4602 // edit count in user cache too
4603 $this->invalidateCache();
4607 * Initialize user_editcount from data out of the revision table
4609 * @param int $add Edits to add to the count from the revision table
4610 * @return int Number of edits
4612 protected function initEditCount( $add = 0 ) {
4613 // Pull from a slave to be less cruel to servers
4614 // Accuracy isn't the point anyway here
4615 $dbr = wfGetDB( DB_SLAVE
);
4616 $count = (int)$dbr->selectField(
4619 array( 'rev_user' => $this->getId() ),
4622 $count = $count +
$add;
4624 $dbw = wfGetDB( DB_MASTER
);
4627 array( 'user_editcount' => $count ),
4628 array( 'user_id' => $this->getId() ),
4636 * Get the description of a given right
4638 * @param string $right Right to query
4639 * @return string Localized description of the right
4641 public static function getRightDescription( $right ) {
4642 $key = "right-$right";
4643 $msg = wfMessage( $key );
4644 return $msg->isBlank() ?
$right : $msg->text();
4648 * Make a new-style password hash
4650 * @param string $password Plain-text password
4651 * @param bool|string $salt Optional salt, may be random or the user ID.
4652 * If unspecified or false, will generate one automatically
4653 * @return string Password hash
4654 * @deprecated since 1.24, use Password class
4656 public static function crypt( $password, $salt = false ) {
4657 wfDeprecated( __METHOD__
, '1.24' );
4658 $hash = self
::getPasswordFactory()->newFromPlaintext( $password );
4659 return $hash->toString();
4663 * Compare a password hash with a plain-text password. Requires the user
4664 * ID if there's a chance that the hash is an old-style hash.
4666 * @param string $hash Password hash
4667 * @param string $password Plain-text password to compare
4668 * @param string|bool $userId User ID for old-style password salt
4671 * @deprecated since 1.24, use Password class
4673 public static function comparePasswords( $hash, $password, $userId = false ) {
4674 wfDeprecated( __METHOD__
, '1.24' );
4676 // Check for *really* old password hashes that don't even have a type
4677 // The old hash format was just an md5 hex hash, with no type information
4678 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
4679 global $wgPasswordSalt;
4680 if ( $wgPasswordSalt ) {
4681 $password = ":B:{$userId}:{$hash}";
4683 $password = ":A:{$hash}";
4687 $hash = self
::getPasswordFactory()->newFromCiphertext( $hash );
4688 return $hash->equals( $password );
4692 * Add a newuser log entry for this user.
4693 * Before 1.19 the return value was always true.
4695 * @param string|bool $action Account creation type.
4696 * - String, one of the following values:
4697 * - 'create' for an anonymous user creating an account for himself.
4698 * This will force the action's performer to be the created user itself,
4699 * no matter the value of $wgUser
4700 * - 'create2' for a logged in user creating an account for someone else
4701 * - 'byemail' when the created user will receive its password by e-mail
4702 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4703 * - Boolean means whether the account was created by e-mail (deprecated):
4704 * - true will be converted to 'byemail'
4705 * - false will be converted to 'create' if this object is the same as
4706 * $wgUser and to 'create2' otherwise
4708 * @param string $reason User supplied reason
4710 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4712 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4713 global $wgUser, $wgNewUserLog;
4714 if ( empty( $wgNewUserLog ) ) {
4715 return true; // disabled
4718 if ( $action === true ) {
4719 $action = 'byemail';
4720 } elseif ( $action === false ) {
4721 if ( $this->getName() == $wgUser->getName() ) {
4724 $action = 'create2';
4728 if ( $action === 'create' ||
$action === 'autocreate' ) {
4731 $performer = $wgUser;
4734 $logEntry = new ManualLogEntry( 'newusers', $action );
4735 $logEntry->setPerformer( $performer );
4736 $logEntry->setTarget( $this->getUserPage() );
4737 $logEntry->setComment( $reason );
4738 $logEntry->setParameters( array(
4739 '4::userid' => $this->getId(),
4741 $logid = $logEntry->insert();
4743 if ( $action !== 'autocreate' ) {
4744 $logEntry->publish( $logid );
4751 * Add an autocreate newuser log entry for this user
4752 * Used by things like CentralAuth and perhaps other authplugins.
4753 * Consider calling addNewUserLogEntry() directly instead.
4757 public function addNewUserLogEntryAutoCreate() {
4758 $this->addNewUserLogEntry( 'autocreate' );
4764 * Load the user options either from cache, the database or an array
4766 * @param array $data Rows for the current user out of the user_properties table
4768 protected function loadOptions( $data = null ) {
4773 if ( $this->mOptionsLoaded
) {
4777 $this->mOptions
= self
::getDefaultOptions();
4779 if ( !$this->getId() ) {
4780 // For unlogged-in users, load language/variant options from request.
4781 // There's no need to do it for logged-in users: they can set preferences,
4782 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4783 // so don't override user's choice (especially when the user chooses site default).
4784 $variant = $wgContLang->getDefaultVariant();
4785 $this->mOptions
['variant'] = $variant;
4786 $this->mOptions
['language'] = $variant;
4787 $this->mOptionsLoaded
= true;
4791 // Maybe load from the object
4792 if ( !is_null( $this->mOptionOverrides
) ) {
4793 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4794 foreach ( $this->mOptionOverrides
as $key => $value ) {
4795 $this->mOptions
[$key] = $value;
4798 if ( !is_array( $data ) ) {
4799 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4800 // Load from database
4801 $dbr = wfGetDB( DB_SLAVE
);
4803 $res = $dbr->select(
4805 array( 'up_property', 'up_value' ),
4806 array( 'up_user' => $this->getId() ),
4810 $this->mOptionOverrides
= array();
4812 foreach ( $res as $row ) {
4813 $data[$row->up_property
] = $row->up_value
;
4816 foreach ( $data as $property => $value ) {
4817 $this->mOptionOverrides
[$property] = $value;
4818 $this->mOptions
[$property] = $value;
4822 $this->mOptionsLoaded
= true;
4824 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4828 * Saves the non-default options for this user, as previously set e.g. via
4829 * setOption(), in the database's "user_properties" (preferences) table.
4830 * Usually used via saveSettings().
4832 protected function saveOptions() {
4833 $this->loadOptions();
4835 // Not using getOptions(), to keep hidden preferences in database
4836 $saveOptions = $this->mOptions
;
4838 // Allow hooks to abort, for instance to save to a global profile.
4839 // Reset options to default state before saving.
4840 if ( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4844 $userId = $this->getId();
4846 $insert_rows = array(); // all the new preference rows
4847 foreach ( $saveOptions as $key => $value ) {
4848 // Don't bother storing default values
4849 $defaultOption = self
::getDefaultOption( $key );
4850 if ( ( $defaultOption === null && $value !== false && $value !== null )
4851 ||
$value != $defaultOption
4853 $insert_rows[] = array(
4854 'up_user' => $userId,
4855 'up_property' => $key,
4856 'up_value' => $value,
4861 $dbw = wfGetDB( DB_MASTER
);
4863 $res = $dbw->select( 'user_properties',
4864 array( 'up_property', 'up_value' ), array( 'up_user' => $userId ), __METHOD__
);
4866 // Find prior rows that need to be removed or updated. These rows will
4867 // all be deleted (the later so that INSERT IGNORE applies the new values).
4868 $keysDelete = array();
4869 foreach ( $res as $row ) {
4870 if ( !isset( $saveOptions[$row->up_property
] )
4871 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
4873 $keysDelete[] = $row->up_property
;
4877 if ( count( $keysDelete ) ) {
4878 // Do the DELETE by PRIMARY KEY for prior rows.
4879 // In the past a very large portion of calls to this function are for setting
4880 // 'rememberpassword' for new accounts (a preference that has since been removed).
4881 // Doing a blanket per-user DELETE for new accounts with no rows in the table
4882 // caused gap locks on [max user ID,+infinity) which caused high contention since
4883 // updates would pile up on each other as they are for higher (newer) user IDs.
4884 // It might not be necessary these days, but it shouldn't hurt either.
4885 $dbw->delete( 'user_properties',
4886 array( 'up_user' => $userId, 'up_property' => $keysDelete ), __METHOD__
);
4888 // Insert the new preference rows
4889 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, array( 'IGNORE' ) );
4893 * Lazily instantiate and return a factory object for making passwords
4895 * @return PasswordFactory
4897 public static function getPasswordFactory() {
4898 if ( self
::$mPasswordFactory === null ) {
4899 self
::$mPasswordFactory = new PasswordFactory();
4900 self
::$mPasswordFactory->init( RequestContext
::getMain()->getConfig() );
4903 return self
::$mPasswordFactory;
4907 * Provide an array of HTML5 attributes to put on an input element
4908 * intended for the user to enter a new password. This may include
4909 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4911 * Do *not* use this when asking the user to enter his current password!
4912 * Regardless of configuration, users may have invalid passwords for whatever
4913 * reason (e.g., they were set before requirements were tightened up).
4914 * Only use it when asking for a new password, like on account creation or
4917 * Obviously, you still need to do server-side checking.
4919 * NOTE: A combination of bugs in various browsers means that this function
4920 * actually just returns array() unconditionally at the moment. May as
4921 * well keep it around for when the browser bugs get fixed, though.
4923 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4925 * @return array Array of HTML attributes suitable for feeding to
4926 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4927 * That will get confused by the boolean attribute syntax used.)
4929 public static function passwordChangeInputAttribs() {
4930 global $wgMinimalPasswordLength;
4932 if ( $wgMinimalPasswordLength == 0 ) {
4936 # Note that the pattern requirement will always be satisfied if the
4937 # input is empty, so we need required in all cases.
4939 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4940 # if e-mail confirmation is being used. Since HTML5 input validation
4941 # is b0rked anyway in some browsers, just return nothing. When it's
4942 # re-enabled, fix this code to not output required for e-mail
4944 #$ret = array( 'required' );
4947 # We can't actually do this right now, because Opera 9.6 will print out
4948 # the entered password visibly in its error message! When other
4949 # browsers add support for this attribute, or Opera fixes its support,
4950 # we can add support with a version check to avoid doing this on Opera
4951 # versions where it will be a problem. Reported to Opera as
4952 # DSK-262266, but they don't have a public bug tracker for us to follow.
4954 if ( $wgMinimalPasswordLength > 1 ) {
4955 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4956 $ret['title'] = wfMessage( 'passwordtooshort' )
4957 ->numParams( $wgMinimalPasswordLength )->text();
4965 * Return the list of user fields that should be selected to create
4966 * a new user object.
4969 public static function selectFields() {
4977 'user_email_authenticated',
4979 'user_email_token_expires',
4980 'user_registration',
4986 * Factory function for fatal permission-denied errors
4989 * @param string $permission User right required
4992 static function newFatalPermissionDeniedStatus( $permission ) {
4995 $groups = array_map(
4996 array( 'User', 'makeGroupLinkWiki' ),
4997 User
::getGroupsWithPermission( $permission )
5001 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5003 return Status
::newFatal( 'badaccess-group0' );