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 * Exclude user options that are set to their default value.
65 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
68 * @var PasswordFactory Lazily loaded factory object for passwords
70 private static $mPasswordFactory = null;
73 * Array of Strings List of member variables which are saved to the
74 * shared cache (memcached). Any operation which changes the
75 * corresponding database fields must call a cache-clearing function.
78 protected static $mCacheVars = array(
86 'mEmailAuthenticated',
93 // user_properties table
98 * Array of Strings Core rights.
99 * Each of these should have a corresponding message of the form
103 protected static $mCoreRights = array(
132 'editusercssjs', #deprecated
145 'move-categorypages',
146 'move-rootuserpages',
150 'override-export-depth',
174 'userrights-interwiki',
182 * String Cached results of getAllRights()
184 protected static $mAllRights = false;
186 /** Cache variables */
194 * @todo Make this actually private
200 * @todo Make this actually private
204 public $mNewpassword;
206 public $mNewpassTime;
209 /** @var string TS_MW timestamp from the DB */
211 /** @var string TS_MW timestamp from cache */
212 protected $mQuickTouched;
216 public $mEmailAuthenticated;
218 protected $mEmailToken;
220 protected $mEmailTokenExpires;
222 protected $mRegistration;
224 protected $mEditCount;
228 protected $mOptionOverrides;
230 protected $mPasswordExpires;
234 * Bool Whether the cache variables have been loaded.
237 public $mOptionsLoaded;
240 * Array with already loaded items or true if all items have been loaded.
242 protected $mLoadedItems = array();
246 * String Initialization data source if mLoadedItems!==true. May be one of:
247 * - 'defaults' anonymous user initialised from class defaults
248 * - 'name' initialise from mName
249 * - 'id' initialise from mId
250 * - 'session' log in from cookies or session if possible
252 * Use the User::newFrom*() family of functions to set this.
257 * Lazy-initialized variables, invalidated with clearInstanceCache
261 protected $mDatePreference;
269 protected $mBlockreason;
271 protected $mEffectiveGroups;
273 protected $mImplicitGroups;
275 protected $mFormerGroups;
277 protected $mBlockedGlobally;
294 protected $mAllowUsertalk;
297 private $mBlockedFromCreateAccount = false;
300 private $mWatchedItems = array();
302 /** @var integer User::READ_* constant bitfield used to load data */
303 protected $queryFlagsUsed = self
::READ_NORMAL
;
305 public static $idCacheByName = array();
308 * Lightweight constructor for an anonymous user.
309 * Use the User::newFrom* factory functions for other kinds of users.
313 * @see newFromConfirmationCode()
314 * @see newFromSession()
317 public function __construct() {
318 $this->clearInstanceCache( 'defaults' );
324 public function __toString() {
325 return $this->getName();
329 * Load the user table data for this object from the source given by mFrom.
331 * @param integer $flags User::READ_* constant bitfield
333 public function load( $flags = self
::READ_NORMAL
) {
334 if ( $this->mLoadedItems
=== true ) {
338 // Set it now to avoid infinite recursion in accessors
339 $this->mLoadedItems
= true;
340 $this->queryFlagsUsed
= $flags;
342 switch ( $this->mFrom
) {
344 $this->loadDefaults();
347 // Make sure this thread sees its own changes
348 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
349 $flags |
= self
::READ_LATEST
;
350 $this->queryFlagsUsed
= $flags;
353 $this->mId
= self
::idFromName( $this->mName
, $flags );
355 // Nonexistent user placeholder object
356 $this->loadDefaults( $this->mName
);
358 $this->loadFromId( $flags );
362 $this->loadFromId( $flags );
365 if ( !$this->loadFromSession() ) {
366 // Loading from session failed. Load defaults.
367 $this->loadDefaults();
369 Hooks
::run( 'UserLoadAfterLoadFromSession', array( $this ) );
372 throw new UnexpectedValueException(
373 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
378 * Load user table data, given mId has already been set.
379 * @param integer $flags User::READ_* constant bitfield
380 * @return bool False if the ID does not exist, true otherwise
382 public function loadFromId( $flags = self
::READ_NORMAL
) {
383 if ( $this->mId
== 0 ) {
384 $this->loadDefaults();
388 // Try cache (unless this needs to lock the DB).
389 // NOTE: if this thread called saveSettings(), the cache was cleared.
390 $locking = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
);
391 if ( $locking ||
!$this->loadFromCache() ) {
392 wfDebug( "User: cache miss for user {$this->mId}\n" );
393 // Load from DB (make sure this thread sees its own changes)
394 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
395 $flags |
= self
::READ_LATEST
;
397 if ( !$this->loadFromDatabase( $flags ) ) {
398 // Can't load from ID, user is anonymous
401 $this->saveToCache();
404 $this->mLoadedItems
= true;
405 $this->queryFlagsUsed
= $flags;
411 * Load user data from shared cache, given mId has already been set.
413 * @return bool false if the ID does not exist or data is invalid, true otherwise
416 protected function loadFromCache() {
417 if ( $this->mId
== 0 ) {
418 $this->loadDefaults();
422 $key = wfMemcKey( 'user', 'id', $this->mId
);
423 $data = ObjectCache
::getMainWANInstance()->get( $key );
424 if ( !is_array( $data ) ||
$data['mVersion'] < self
::VERSION
) {
429 wfDebug( "User: got user {$this->mId} from cache\n" );
431 // Restore from cache
432 foreach ( self
::$mCacheVars as $name ) {
433 $this->$name = $data[$name];
440 * Save user data to the shared cache
442 * This method should not be called outside the User class
444 public function saveToCache() {
447 $this->loadOptions();
449 if ( $this->isAnon() ) {
450 // Anonymous users are uncached
455 foreach ( self
::$mCacheVars as $name ) {
456 $data[$name] = $this->$name;
458 $data['mVersion'] = self
::VERSION
;
459 $key = wfMemcKey( 'user', 'id', $this->mId
);
461 ObjectCache
::getMainWANInstance()->set( $key, $data, 3600 );
464 /** @name newFrom*() static factory methods */
468 * Static factory method for creation from username.
470 * This is slightly less efficient than newFromId(), so use newFromId() if
471 * you have both an ID and a name handy.
473 * @param string $name Username, validated by Title::newFromText()
474 * @param string|bool $validate Validate username. Takes the same parameters as
475 * User::getCanonicalName(), except that true is accepted as an alias
476 * for 'valid', for BC.
478 * @return User|bool User object, or false if the username is invalid
479 * (e.g. if it contains illegal characters or is an IP address). If the
480 * username is not present in the database, the result will be a user object
481 * with a name, zero user ID and default settings.
483 public static function newFromName( $name, $validate = 'valid' ) {
484 if ( $validate === true ) {
487 $name = self
::getCanonicalName( $name, $validate );
488 if ( $name === false ) {
491 // Create unloaded user object
495 $u->setItemLoaded( 'name' );
501 * Static factory method for creation from a given user ID.
503 * @param int $id Valid user ID
504 * @return User The corresponding User object
506 public static function newFromId( $id ) {
510 $u->setItemLoaded( 'id' );
515 * Factory method to fetch whichever user has a given email confirmation code.
516 * This code is generated when an account is created or its e-mail address
519 * If the code is invalid or has expired, returns NULL.
521 * @param string $code Confirmation code
522 * @param int $flags User::READ_* bitfield
525 public static function newFromConfirmationCode( $code, $flags = 0 ) {
526 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
527 ?
wfGetDB( DB_MASTER
)
528 : wfGetDB( DB_SLAVE
);
530 $id = $db->selectField(
534 'user_email_token' => md5( $code ),
535 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
539 return $id ? User
::newFromId( $id ) : null;
543 * Create a new user object using data from session or cookies. If the
544 * login credentials are invalid, the result is an anonymous user.
546 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
549 public static function newFromSession( WebRequest
$request = null ) {
551 $user->mFrom
= 'session';
552 $user->mRequest
= $request;
557 * Create a new user object from a user row.
558 * The row should have the following fields from the user table in it:
559 * - either user_name or user_id to load further data if needed (or both)
561 * - all other fields (email, password, etc.)
562 * It is useless to provide the remaining fields if either user_id,
563 * user_name and user_real_name are not provided because the whole row
564 * will be loaded once more from the database when accessing them.
566 * @param stdClass $row A row from the user table
567 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
570 public static function newFromRow( $row, $data = null ) {
572 $user->loadFromRow( $row, $data );
579 * Get the username corresponding to a given user ID
580 * @param int $id User ID
581 * @return string|bool The corresponding username
583 public static function whoIs( $id ) {
584 return UserCache
::singleton()->getProp( $id, 'name' );
588 * Get the real name of a user given their user ID
590 * @param int $id User ID
591 * @return string|bool The corresponding user's real name
593 public static function whoIsReal( $id ) {
594 return UserCache
::singleton()->getProp( $id, 'real_name' );
598 * Get database id given a user name
599 * @param string $name Username
600 * @param integer $flags User::READ_* constant bitfield
601 * @return int|null The corresponding user's ID, or null if user is nonexistent
603 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
604 $nt = Title
::makeTitleSafe( NS_USER
, $name );
605 if ( is_null( $nt ) ) {
610 if ( isset( self
::$idCacheByName[$name] ) ) {
611 return self
::$idCacheByName[$name];
614 $db = ( $flags & self
::READ_LATEST
)
615 ?
wfGetDB( DB_MASTER
)
616 : wfGetDB( DB_SLAVE
);
621 array( 'user_name' => $nt->getText() ),
625 if ( $s === false ) {
628 $result = $s->user_id
;
631 self
::$idCacheByName[$name] = $result;
633 if ( count( self
::$idCacheByName ) > 1000 ) {
634 self
::$idCacheByName = array();
641 * Reset the cache used in idFromName(). For use in tests.
643 public static function resetIdByNameCache() {
644 self
::$idCacheByName = array();
648 * Does the string match an anonymous IPv4 address?
650 * This function exists for username validation, in order to reject
651 * usernames which are similar in form to IP addresses. Strings such
652 * as 300.300.300.300 will return true because it looks like an IP
653 * address, despite not being strictly valid.
655 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
656 * address because the usemod software would "cloak" anonymous IP
657 * addresses like this, if we allowed accounts like this to be created
658 * new users could get the old edits of these anonymous users.
660 * @param string $name Name to match
663 public static function isIP( $name ) {
664 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
665 || IP
::isIPv6( $name );
669 * Is the input a valid username?
671 * Checks if the input is a valid username, we don't want an empty string,
672 * an IP address, anything that contains slashes (would mess up subpages),
673 * is longer than the maximum allowed username size or doesn't begin with
676 * @param string $name Name to match
679 public static function isValidUserName( $name ) {
680 global $wgContLang, $wgMaxNameChars;
683 || User
::isIP( $name )
684 ||
strpos( $name, '/' ) !== false
685 ||
strlen( $name ) > $wgMaxNameChars
686 ||
$name != $wgContLang->ucfirst( $name )
688 wfDebugLog( 'username', __METHOD__
.
689 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
693 // Ensure that the name can't be misresolved as a different title,
694 // such as with extra namespace keys at the start.
695 $parsed = Title
::newFromText( $name );
696 if ( is_null( $parsed )
697 ||
$parsed->getNamespace()
698 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
699 wfDebugLog( 'username', __METHOD__
.
700 ": '$name' invalid due to ambiguous prefixes" );
704 // Check an additional blacklist of troublemaker characters.
705 // Should these be merged into the title char list?
706 $unicodeBlacklist = '/[' .
707 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
708 '\x{00a0}' . # non-breaking space
709 '\x{2000}-\x{200f}' . # various whitespace
710 '\x{2028}-\x{202f}' . # breaks and control chars
711 '\x{3000}' . # ideographic space
712 '\x{e000}-\x{f8ff}' . # private use
714 if ( preg_match( $unicodeBlacklist, $name ) ) {
715 wfDebugLog( 'username', __METHOD__
.
716 ": '$name' invalid due to blacklisted characters" );
724 * Usernames which fail to pass this function will be blocked
725 * from user login and new account registrations, but may be used
726 * internally by batch processes.
728 * If an account already exists in this form, login will be blocked
729 * by a failure to pass this function.
731 * @param string $name Name to match
734 public static function isUsableName( $name ) {
735 global $wgReservedUsernames;
736 // Must be a valid username, obviously ;)
737 if ( !self
::isValidUserName( $name ) ) {
741 static $reservedUsernames = false;
742 if ( !$reservedUsernames ) {
743 $reservedUsernames = $wgReservedUsernames;
744 Hooks
::run( 'UserGetReservedNames', array( &$reservedUsernames ) );
747 // Certain names may be reserved for batch processes.
748 foreach ( $reservedUsernames as $reserved ) {
749 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
750 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
752 if ( $reserved == $name ) {
760 * Usernames which fail to pass this function will be blocked
761 * from new account registrations, but may be used internally
762 * either by batch processes or by user accounts which have
763 * already been created.
765 * Additional blacklisting may be added here rather than in
766 * isValidUserName() to avoid disrupting existing accounts.
768 * @param string $name String to match
771 public static function isCreatableName( $name ) {
772 global $wgInvalidUsernameCharacters;
774 // Ensure that the username isn't longer than 235 bytes, so that
775 // (at least for the builtin skins) user javascript and css files
776 // will work. (bug 23080)
777 if ( strlen( $name ) > 235 ) {
778 wfDebugLog( 'username', __METHOD__
.
779 ": '$name' invalid due to length" );
783 // Preg yells if you try to give it an empty string
784 if ( $wgInvalidUsernameCharacters !== '' ) {
785 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
786 wfDebugLog( 'username', __METHOD__
.
787 ": '$name' invalid due to wgInvalidUsernameCharacters" );
792 return self
::isUsableName( $name );
796 * Is the input a valid password for this user?
798 * @param string $password Desired password
801 public function isValidPassword( $password ) {
802 //simple boolean wrapper for getPasswordValidity
803 return $this->getPasswordValidity( $password ) === true;
808 * Given unvalidated password input, return error message on failure.
810 * @param string $password Desired password
811 * @return bool|string|array True on success, string or array of error message on failure
813 public function getPasswordValidity( $password ) {
814 $result = $this->checkPasswordValidity( $password );
815 if ( $result->isGood() ) {
819 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
820 $messages[] = $error['message'];
822 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
823 $messages[] = $warning['message'];
825 if ( count( $messages ) === 1 ) {
833 * Check if this is a valid password for this user
835 * Create a Status object based on the password's validity.
836 * The Status should be set to fatal if the user should not
837 * be allowed to log in, and should have any errors that
838 * would block changing the password.
840 * If the return value of this is not OK, the password
841 * should not be checked. If the return value is not Good,
842 * the password can be checked, but the user should not be
843 * able to set their password to this.
845 * @param string $password Desired password
846 * @param string $purpose one of 'login', 'create', 'reset'
850 public function checkPasswordValidity( $password, $purpose = 'login' ) {
851 global $wgPasswordPolicy;
853 $upp = new UserPasswordPolicy(
854 $wgPasswordPolicy['policies'],
855 $wgPasswordPolicy['checks']
858 $status = Status
::newGood();
859 $result = false; //init $result to false for the internal checks
861 if ( !Hooks
::run( 'isValidPassword', array( $password, &$result, $this ) ) ) {
862 $status->error( $result );
866 if ( $result === false ) {
867 $status->merge( $upp->checkUserPassword( $this, $password, $purpose ) );
869 } elseif ( $result === true ) {
872 $status->error( $result );
873 return $status; //the isValidPassword hook set a string $result and returned true
878 * Expire a user's password
880 * @param int $ts Optional timestamp to convert, default 0 for the current time
882 public function expirePassword( $ts = 0 ) {
883 $this->loadPasswords();
884 $timestamp = wfTimestamp( TS_MW
, $ts );
885 $this->mPasswordExpires
= $timestamp;
886 $this->saveSettings();
890 * Clear the password expiration for a user
892 * @param bool $load Ensure user object is loaded first
894 public function resetPasswordExpiration( $load = true ) {
895 global $wgPasswordExpirationDays;
900 if ( $wgPasswordExpirationDays ) {
901 $newExpire = wfTimestamp(
903 time() +
( $wgPasswordExpirationDays * 24 * 3600 )
906 // Give extensions a chance to force an expiration
907 Hooks
::run( 'ResetPasswordExpiration', array( $this, &$newExpire ) );
908 $this->mPasswordExpires
= $newExpire;
912 * Check if the user's password is expired.
913 * TODO: Put this and password length into a PasswordPolicy object
915 * @return string|bool The expiration type, or false if not expired
916 * hard: A password change is required to login
917 * soft: Allow login, but encourage password change
918 * false: Password is not expired
920 public function getPasswordExpired() {
921 global $wgPasswordExpireGrace;
923 $now = wfTimestamp();
924 $expiration = $this->getPasswordExpireDate();
925 $expUnix = wfTimestamp( TS_UNIX
, $expiration );
926 if ( $expiration !== null && $expUnix < $now ) {
927 $expired = ( $expUnix +
$wgPasswordExpireGrace < $now ) ?
'hard' : 'soft';
933 * Get this user's password expiration date. Since this may be using
934 * the cached User object, we assume that whatever mechanism is setting
935 * the expiration date is also expiring the User cache.
937 * @return string|bool The datestamp of the expiration, or null if not set
939 public function getPasswordExpireDate() {
941 return $this->mPasswordExpires
;
945 * Given unvalidated user input, return a canonical username, or false if
946 * the username is invalid.
947 * @param string $name User input
948 * @param string|bool $validate Type of validation to use:
949 * - false No validation
950 * - 'valid' Valid for batch processes
951 * - 'usable' Valid for batch processes and login
952 * - 'creatable' Valid for batch processes, login and account creation
954 * @throws InvalidArgumentException
955 * @return bool|string
957 public static function getCanonicalName( $name, $validate = 'valid' ) {
958 // Force usernames to capital
960 $name = $wgContLang->ucfirst( $name );
962 # Reject names containing '#'; these will be cleaned up
963 # with title normalisation, but then it's too late to
965 if ( strpos( $name, '#' ) !== false ) {
969 // Clean up name according to title rules,
970 // but only when validation is requested (bug 12654)
971 $t = ( $validate !== false ) ?
972 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
973 // Check for invalid titles
974 if ( is_null( $t ) ) {
978 // Reject various classes of invalid names
980 $name = $wgAuth->getCanonicalName( $t->getText() );
982 switch ( $validate ) {
986 if ( !User
::isValidUserName( $name ) ) {
991 if ( !User
::isUsableName( $name ) ) {
996 if ( !User
::isCreatableName( $name ) ) {
1001 throw new InvalidArgumentException(
1002 'Invalid parameter value for $validate in ' . __METHOD__
);
1008 * Count the number of edits of a user
1010 * @param int $uid User ID to check
1011 * @return int The user's edit count
1013 * @deprecated since 1.21 in favour of User::getEditCount
1015 public static function edits( $uid ) {
1016 wfDeprecated( __METHOD__
, '1.21' );
1017 $user = self
::newFromId( $uid );
1018 return $user->getEditCount();
1022 * Return a random password.
1024 * @return string New random password
1026 public static function randomPassword() {
1027 global $wgMinimalPasswordLength;
1028 // Decide the final password length based on our min password length,
1029 // stopping at a minimum of 10 chars.
1030 $length = max( 10, $wgMinimalPasswordLength );
1031 // Multiply by 1.25 to get the number of hex characters we need
1032 $length = $length * 1.25;
1033 // Generate random hex chars
1034 $hex = MWCryptRand
::generateHex( $length );
1035 // Convert from base 16 to base 32 to get a proper password like string
1036 return wfBaseConvert( $hex, 16, 32 );
1040 * Set cached properties to default.
1042 * @note This no longer clears uncached lazy-initialised properties;
1043 * the constructor does that instead.
1045 * @param string|bool $name
1047 public function loadDefaults( $name = false ) {
1049 $passwordFactory = self
::getPasswordFactory();
1052 $this->mName
= $name;
1053 $this->mRealName
= '';
1054 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1055 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1056 $this->mNewpassTime
= null;
1058 $this->mOptionOverrides
= null;
1059 $this->mOptionsLoaded
= false;
1061 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
1062 if ( $loggedOut !== null ) {
1063 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1065 $this->mTouched
= '1'; # Allow any pages to be cached
1068 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1069 $this->mEmailAuthenticated
= null;
1070 $this->mEmailToken
= '';
1071 $this->mEmailTokenExpires
= null;
1072 $this->mPasswordExpires
= null;
1073 $this->resetPasswordExpiration( false );
1074 $this->mRegistration
= wfTimestamp( TS_MW
);
1075 $this->mGroups
= array();
1077 Hooks
::run( 'UserLoadDefaults', array( $this, $name ) );
1081 * Return whether an item has been loaded.
1083 * @param string $item Item to check. Current possibilities:
1087 * @param string $all 'all' to check if the whole object has been loaded
1088 * or any other string to check if only the item is available (e.g.
1092 public function isItemLoaded( $item, $all = 'all' ) {
1093 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1094 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1098 * Set that an item has been loaded
1100 * @param string $item
1102 protected function setItemLoaded( $item ) {
1103 if ( is_array( $this->mLoadedItems
) ) {
1104 $this->mLoadedItems
[$item] = true;
1109 * Load user data from the session or login cookie.
1111 * @return bool True if the user is logged in, false otherwise.
1113 private function loadFromSession() {
1115 Hooks
::run( 'UserLoadFromSession', array( $this, &$result ) );
1116 if ( $result !== null ) {
1120 $request = $this->getRequest();
1122 $cookieId = $request->getCookie( 'UserID' );
1123 $sessId = $request->getSessionData( 'wsUserID' );
1125 if ( $cookieId !== null ) {
1126 $sId = intval( $cookieId );
1127 if ( $sessId !== null && $cookieId != $sessId ) {
1128 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
1129 cookie user ID ($sId) don't match!" );
1132 $request->setSessionData( 'wsUserID', $sId );
1133 } elseif ( $sessId !== null && $sessId != 0 ) {
1139 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
1140 $sName = $request->getSessionData( 'wsUserName' );
1141 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
1142 $sName = $request->getCookie( 'UserName' );
1143 $request->setSessionData( 'wsUserName', $sName );
1148 $proposedUser = User
::newFromId( $sId );
1149 if ( !$proposedUser->isLoggedIn() ) {
1154 global $wgBlockDisablesLogin;
1155 if ( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
1156 // User blocked and we've disabled blocked user logins
1160 if ( $request->getSessionData( 'wsToken' ) ) {
1162 ( $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ) );
1164 } elseif ( $request->getCookie( 'Token' ) ) {
1165 # Get the token from DB/cache and clean it up to remove garbage padding.
1166 # This deals with historical problems with bugs and the default column value.
1167 $token = rtrim( $proposedUser->getToken( false ) ); // correct token
1168 // Make comparison in constant time (bug 61346)
1169 $passwordCorrect = strlen( $token )
1170 && hash_equals( $token, $request->getCookie( 'Token' ) );
1173 // No session or persistent login cookie
1177 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1178 $this->loadFromUserObject( $proposedUser );
1179 $request->setSessionData( 'wsToken', $this->mToken
);
1180 wfDebug( "User: logged in from $from\n" );
1183 // Invalid credentials
1184 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1190 * Load user and user_group data from the database.
1191 * $this->mId must be set, this is how the user is identified.
1193 * @param integer $flags User::READ_* constant bitfield
1194 * @return bool True if the user exists, false if the user is anonymous
1196 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1198 $this->mId
= intval( $this->mId
);
1201 if ( !$this->mId
) {
1202 $this->loadDefaults();
1206 $db = ( $flags & self
::READ_LATEST
)
1207 ?
wfGetDB( DB_MASTER
)
1208 : wfGetDB( DB_SLAVE
);
1210 $s = $db->selectRow(
1212 self
::selectFields(),
1213 array( 'user_id' => $this->mId
),
1215 ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
1216 ?
array( 'LOCK IN SHARE MODE' )
1220 $this->queryFlagsUsed
= $flags;
1221 Hooks
::run( 'UserLoadFromDatabase', array( $this, &$s ) );
1223 if ( $s !== false ) {
1224 // Initialise user table data
1225 $this->loadFromRow( $s );
1226 $this->mGroups
= null; // deferred
1227 $this->getEditCount(); // revalidation for nulls
1232 $this->loadDefaults();
1238 * Initialize this object from a row from the user table.
1240 * @param stdClass $row Row from the user table to load.
1241 * @param array $data Further user data to load into the object
1243 * user_groups Array with groups out of the user_groups table
1244 * user_properties Array with properties out of the user_properties table
1246 protected function loadFromRow( $row, $data = null ) {
1248 $passwordFactory = self
::getPasswordFactory();
1250 $this->mGroups
= null; // deferred
1252 if ( isset( $row->user_name
) ) {
1253 $this->mName
= $row->user_name
;
1254 $this->mFrom
= 'name';
1255 $this->setItemLoaded( 'name' );
1260 if ( isset( $row->user_real_name
) ) {
1261 $this->mRealName
= $row->user_real_name
;
1262 $this->setItemLoaded( 'realname' );
1267 if ( isset( $row->user_id
) ) {
1268 $this->mId
= intval( $row->user_id
);
1269 $this->mFrom
= 'id';
1270 $this->setItemLoaded( 'id' );
1275 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1276 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1279 if ( isset( $row->user_editcount
) ) {
1280 $this->mEditCount
= $row->user_editcount
;
1285 if ( isset( $row->user_password
) ) {
1286 // Check for *really* old password hashes that don't even have a type
1287 // The old hash format was just an md5 hex hash, with no type information
1288 if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password
) ) {
1289 $row->user_password
= ":A:{$this->mId}:{$row->user_password}";
1293 $this->mPassword
= $passwordFactory->newFromCiphertext( $row->user_password
);
1294 } catch ( PasswordError
$e ) {
1295 wfDebug( 'Invalid password hash found in database.' );
1296 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1300 $this->mNewpassword
= $passwordFactory->newFromCiphertext( $row->user_newpassword
);
1301 } catch ( PasswordError
$e ) {
1302 wfDebug( 'Invalid password hash found in database.' );
1303 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1306 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1307 $this->mPasswordExpires
= wfTimestampOrNull( TS_MW
, $row->user_password_expires
);
1310 if ( isset( $row->user_email
) ) {
1311 $this->mEmail
= $row->user_email
;
1312 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1313 $this->mToken
= $row->user_token
;
1314 if ( $this->mToken
== '' ) {
1315 $this->mToken
= null;
1317 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1318 $this->mEmailToken
= $row->user_email_token
;
1319 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1320 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1326 $this->mLoadedItems
= true;
1329 if ( is_array( $data ) ) {
1330 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1331 $this->mGroups
= $data['user_groups'];
1333 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1334 $this->loadOptions( $data['user_properties'] );
1340 * Load the data for this user object from another user object.
1344 protected function loadFromUserObject( $user ) {
1346 $user->loadGroups();
1347 $user->loadOptions();
1348 foreach ( self
::$mCacheVars as $var ) {
1349 $this->$var = $user->$var;
1354 * Load the groups from the database if they aren't already loaded.
1356 private function loadGroups() {
1357 if ( is_null( $this->mGroups
) ) {
1358 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1359 ?
wfGetDB( DB_MASTER
)
1360 : wfGetDB( DB_SLAVE
);
1361 $res = $db->select( 'user_groups',
1362 array( 'ug_group' ),
1363 array( 'ug_user' => $this->mId
),
1365 $this->mGroups
= array();
1366 foreach ( $res as $row ) {
1367 $this->mGroups
[] = $row->ug_group
;
1373 * Load the user's password hashes from the database
1375 * This is usually called in a scenario where the actual User object was
1376 * loaded from the cache, and then password comparison needs to be performed.
1377 * Password hashes are not stored in memcached.
1381 private function loadPasswords() {
1382 if ( $this->getId() !== 0 &&
1383 ( $this->mPassword
=== null ||
$this->mNewpassword
=== null )
1385 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1386 ?
wfGetDB( DB_MASTER
)
1387 : wfGetDB( DB_SLAVE
);
1389 $this->loadFromRow( $db->selectRow(
1391 array( 'user_password', 'user_newpassword',
1392 'user_newpass_time', 'user_password_expires' ),
1393 array( 'user_id' => $this->getId() ),
1400 * Add the user to the group if he/she meets given criteria.
1402 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1403 * possible to remove manually via Special:UserRights. In such case it
1404 * will not be re-added automatically. The user will also not lose the
1405 * group if they no longer meet the criteria.
1407 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1409 * @return array Array of groups the user has been promoted to.
1411 * @see $wgAutopromoteOnce
1413 public function addAutopromoteOnceGroups( $event ) {
1414 global $wgAutopromoteOnceLogInRC, $wgAuth;
1416 if ( wfReadOnly() ||
!$this->getId() ) {
1420 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1421 if ( !count( $toPromote ) ) {
1425 if ( !$this->checkAndSetTouched() ) {
1426 return array(); // raced out (bug T48834)
1429 $oldGroups = $this->getGroups(); // previous groups
1430 foreach ( $toPromote as $group ) {
1431 $this->addGroup( $group );
1434 // update groups in external authentication database
1435 $wgAuth->updateExternalDBGroups( $this, $toPromote );
1437 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1439 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1440 $logEntry->setPerformer( $this );
1441 $logEntry->setTarget( $this->getUserPage() );
1442 $logEntry->setParameters( array(
1443 '4::oldgroups' => $oldGroups,
1444 '5::newgroups' => $newGroups,
1446 $logid = $logEntry->insert();
1447 if ( $wgAutopromoteOnceLogInRC ) {
1448 $logEntry->publish( $logid );
1455 * Bump user_touched if it didn't change since this object was loaded
1457 * On success, the mTouched field is updated.
1458 * The user serialization cache is always cleared.
1460 * @return bool Whether user_touched was actually updated
1463 protected function checkAndSetTouched() {
1466 if ( !$this->mId
) {
1467 return false; // anon
1470 // Get a new user_touched that is higher than the old one
1471 $oldTouched = $this->mTouched
;
1472 $newTouched = $this->newTouchedTimestamp();
1474 $dbw = wfGetDB( DB_MASTER
);
1475 $dbw->update( 'user',
1476 array( 'user_touched' => $dbw->timestamp( $newTouched ) ),
1478 'user_id' => $this->mId
,
1479 'user_touched' => $dbw->timestamp( $oldTouched ) // CAS check
1483 $success = ( $dbw->affectedRows() > 0 );
1486 $this->mTouched
= $newTouched;
1489 // Clears on failure too since that is desired if the cache is stale
1490 $this->clearSharedCache();
1496 * Clear various cached data stored in this object. The cache of the user table
1497 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1499 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1500 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1502 public function clearInstanceCache( $reloadFrom = false ) {
1503 $this->mNewtalk
= -1;
1504 $this->mDatePreference
= null;
1505 $this->mBlockedby
= -1; # Unset
1506 $this->mHash
= false;
1507 $this->mRights
= null;
1508 $this->mEffectiveGroups
= null;
1509 $this->mImplicitGroups
= null;
1510 $this->mGroups
= null;
1511 $this->mOptions
= null;
1512 $this->mOptionsLoaded
= false;
1513 $this->mEditCount
= null;
1515 if ( $reloadFrom ) {
1516 $this->mLoadedItems
= array();
1517 $this->mFrom
= $reloadFrom;
1522 * Combine the language default options with any site-specific options
1523 * and add the default language variants.
1525 * @return array Array of String options
1527 public static function getDefaultOptions() {
1528 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1530 static $defOpt = null;
1531 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1532 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1533 // mid-request and see that change reflected in the return value of this function.
1534 // Which is insane and would never happen during normal MW operation
1538 $defOpt = $wgDefaultUserOptions;
1539 // Default language setting
1540 $defOpt['language'] = $wgContLang->getCode();
1541 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1542 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1544 foreach ( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1545 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1547 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1549 Hooks
::run( 'UserGetDefaultOptions', array( &$defOpt ) );
1555 * Get a given default option value.
1557 * @param string $opt Name of option to retrieve
1558 * @return string Default option value
1560 public static function getDefaultOption( $opt ) {
1561 $defOpts = self
::getDefaultOptions();
1562 if ( isset( $defOpts[$opt] ) ) {
1563 return $defOpts[$opt];
1570 * Get blocking information
1571 * @param bool $bFromSlave Whether to check the slave database first.
1572 * To improve performance, non-critical checks are done against slaves.
1573 * Check when actually saving should be done against master.
1575 private function getBlockedStatus( $bFromSlave = true ) {
1576 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1578 if ( -1 != $this->mBlockedby
) {
1582 wfDebug( __METHOD__
. ": checking...\n" );
1584 // Initialize data...
1585 // Otherwise something ends up stomping on $this->mBlockedby when
1586 // things get lazy-loaded later, causing false positive block hits
1587 // due to -1 !== 0. Probably session-related... Nothing should be
1588 // overwriting mBlockedby, surely?
1591 # We only need to worry about passing the IP address to the Block generator if the
1592 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1593 # know which IP address they're actually coming from
1594 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->equals( $wgUser ) ) {
1595 $ip = $this->getRequest()->getIP();
1601 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1604 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1605 && !in_array( $ip, $wgProxyWhitelist )
1608 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1610 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1611 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1612 $block->setTarget( $ip );
1613 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1615 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1616 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1617 $block->setTarget( $ip );
1621 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1622 if ( !$block instanceof Block
1623 && $wgApplyIpBlocksToXff
1625 && !$this->isAllowed( 'proxyunbannable' )
1626 && !in_array( $ip, $wgProxyWhitelist )
1628 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1629 $xff = array_map( 'trim', explode( ',', $xff ) );
1630 $xff = array_diff( $xff, array( $ip ) );
1631 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1632 $block = Block
::chooseBlock( $xffblocks, $xff );
1633 if ( $block instanceof Block
) {
1634 # Mangle the reason to alert the user that the block
1635 # originated from matching the X-Forwarded-For header.
1636 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1640 if ( $block instanceof Block
) {
1641 wfDebug( __METHOD__
. ": Found block.\n" );
1642 $this->mBlock
= $block;
1643 $this->mBlockedby
= $block->getByName();
1644 $this->mBlockreason
= $block->mReason
;
1645 $this->mHideName
= $block->mHideName
;
1646 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1648 $this->mBlockedby
= '';
1649 $this->mHideName
= 0;
1650 $this->mAllowUsertalk
= false;
1654 Hooks
::run( 'GetBlockedStatus', array( &$this ) );
1659 * Whether the given IP is in a DNS blacklist.
1661 * @param string $ip IP to check
1662 * @param bool $checkWhitelist Whether to check the whitelist first
1663 * @return bool True if blacklisted.
1665 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1666 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1668 if ( !$wgEnableDnsBlacklist ) {
1672 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1676 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1680 * Whether the given IP is in a given DNS blacklist.
1682 * @param string $ip IP to check
1683 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1684 * @return bool True if blacklisted.
1686 public function inDnsBlacklist( $ip, $bases ) {
1689 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1690 if ( IP
::isIPv4( $ip ) ) {
1691 // Reverse IP, bug 21255
1692 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1694 foreach ( (array)$bases as $base ) {
1696 // If we have an access key, use that too (ProjectHoneypot, etc.)
1697 if ( is_array( $base ) ) {
1698 if ( count( $base ) >= 2 ) {
1699 // Access key is 1, base URL is 0
1700 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1702 $host = "$ipReversed.{$base[0]}";
1705 $host = "$ipReversed.$base";
1709 $ipList = gethostbynamel( $host );
1712 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!" );
1716 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base." );
1725 * Check if an IP address is in the local proxy list
1731 public static function isLocallyBlockedProxy( $ip ) {
1732 global $wgProxyList;
1734 if ( !$wgProxyList ) {
1738 if ( !is_array( $wgProxyList ) ) {
1739 // Load from the specified file
1740 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1743 if ( !is_array( $wgProxyList ) ) {
1745 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1747 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1748 // Old-style flipped proxy list
1757 * Is this user subject to rate limiting?
1759 * @return bool True if rate limited
1761 public function isPingLimitable() {
1762 global $wgRateLimitsExcludedIPs;
1763 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1764 // No other good way currently to disable rate limits
1765 // for specific IPs. :P
1766 // But this is a crappy hack and should die.
1769 return !$this->isAllowed( 'noratelimit' );
1773 * Primitive rate limits: enforce maximum actions per time period
1774 * to put a brake on flooding.
1776 * The method generates both a generic profiling point and a per action one
1777 * (suffix being "-$action".
1779 * @note When using a shared cache like memcached, IP-address
1780 * last-hit counters will be shared across wikis.
1782 * @param string $action Action to enforce; 'edit' if unspecified
1783 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1784 * @return bool True if a rate limiter was tripped
1786 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1787 // Call the 'PingLimiter' hook
1789 if ( !Hooks
::run( 'PingLimiter', array( &$this, $action, &$result, $incrBy ) ) ) {
1793 global $wgRateLimits;
1794 if ( !isset( $wgRateLimits[$action] ) ) {
1798 // Some groups shouldn't trigger the ping limiter, ever
1799 if ( !$this->isPingLimitable() ) {
1805 $limits = $wgRateLimits[$action];
1807 $id = $this->getId();
1810 if ( isset( $limits['anon'] ) && $id == 0 ) {
1811 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1814 if ( isset( $limits['user'] ) && $id != 0 ) {
1815 $userLimit = $limits['user'];
1817 if ( $this->isNewbie() ) {
1818 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1819 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1821 if ( isset( $limits['ip'] ) ) {
1822 $ip = $this->getRequest()->getIP();
1823 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1825 if ( isset( $limits['subnet'] ) ) {
1826 $ip = $this->getRequest()->getIP();
1829 if ( IP
::isIPv6( $ip ) ) {
1830 $parts = IP
::parseRange( "$ip/64" );
1831 $subnet = $parts[0];
1832 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1834 $subnet = $matches[1];
1836 if ( $subnet !== false ) {
1837 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1841 // Check for group-specific permissions
1842 // If more than one group applies, use the group with the highest limit
1843 foreach ( $this->getGroups() as $group ) {
1844 if ( isset( $limits[$group] ) ) {
1845 if ( $userLimit === false
1846 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1848 $userLimit = $limits[$group];
1852 // Set the user limit key
1853 if ( $userLimit !== false ) {
1854 list( $max, $period ) = $userLimit;
1855 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1856 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1860 foreach ( $keys as $key => $limit ) {
1861 list( $max, $period ) = $limit;
1862 $summary = "(limit $max in {$period}s)";
1863 $count = $wgMemc->get( $key );
1866 if ( $count >= $max ) {
1867 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1868 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1871 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1874 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1875 if ( $incrBy > 0 ) {
1876 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1879 if ( $incrBy > 0 ) {
1880 $wgMemc->incr( $key, $incrBy );
1888 * Check if user is blocked
1890 * @param bool $bFromSlave Whether to check the slave database instead of
1891 * the master. Hacked from false due to horrible probs on site.
1892 * @return bool True if blocked, false otherwise
1894 public function isBlocked( $bFromSlave = true ) {
1895 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1899 * Get the block affecting the user, or null if the user is not blocked
1901 * @param bool $bFromSlave Whether to check the slave database instead of the master
1902 * @return Block|null
1904 public function getBlock( $bFromSlave = true ) {
1905 $this->getBlockedStatus( $bFromSlave );
1906 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1910 * Check if user is blocked from editing a particular article
1912 * @param Title $title Title to check
1913 * @param bool $bFromSlave Whether to check the slave database instead of the master
1916 public function isBlockedFrom( $title, $bFromSlave = false ) {
1917 global $wgBlockAllowsUTEdit;
1919 $blocked = $this->isBlocked( $bFromSlave );
1920 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1921 // If a user's name is suppressed, they cannot make edits anywhere
1922 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1923 && $title->getNamespace() == NS_USER_TALK
) {
1925 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1928 Hooks
::run( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1934 * If user is blocked, return the name of the user who placed the block
1935 * @return string Name of blocker
1937 public function blockedBy() {
1938 $this->getBlockedStatus();
1939 return $this->mBlockedby
;
1943 * If user is blocked, return the specified reason for the block
1944 * @return string Blocking reason
1946 public function blockedFor() {
1947 $this->getBlockedStatus();
1948 return $this->mBlockreason
;
1952 * If user is blocked, return the ID for the block
1953 * @return int Block ID
1955 public function getBlockId() {
1956 $this->getBlockedStatus();
1957 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1961 * Check if user is blocked on all wikis.
1962 * Do not use for actual edit permission checks!
1963 * This is intended for quick UI checks.
1965 * @param string $ip IP address, uses current client if none given
1966 * @return bool True if blocked, false otherwise
1968 public function isBlockedGlobally( $ip = '' ) {
1969 if ( $this->mBlockedGlobally
!== null ) {
1970 return $this->mBlockedGlobally
;
1972 // User is already an IP?
1973 if ( IP
::isIPAddress( $this->getName() ) ) {
1974 $ip = $this->getName();
1976 $ip = $this->getRequest()->getIP();
1979 Hooks
::run( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1980 $this->mBlockedGlobally
= (bool)$blocked;
1981 return $this->mBlockedGlobally
;
1985 * Check if user account is locked
1987 * @return bool True if locked, false otherwise
1989 public function isLocked() {
1990 if ( $this->mLocked
!== null ) {
1991 return $this->mLocked
;
1994 $authUser = $wgAuth->getUserInstance( $this );
1995 $this->mLocked
= (bool)$authUser->isLocked();
1996 return $this->mLocked
;
2000 * Check if user account is hidden
2002 * @return bool True if hidden, false otherwise
2004 public function isHidden() {
2005 if ( $this->mHideName
!== null ) {
2006 return $this->mHideName
;
2008 $this->getBlockedStatus();
2009 if ( !$this->mHideName
) {
2011 $authUser = $wgAuth->getUserInstance( $this );
2012 $this->mHideName
= (bool)$authUser->isHidden();
2014 return $this->mHideName
;
2018 * Get the user's ID.
2019 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2021 public function getId() {
2022 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
2023 // Special case, we know the user is anonymous
2025 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2026 // Don't load if this was initialized from an ID
2033 * Set the user and reload all fields according to a given ID
2034 * @param int $v User ID to reload
2036 public function setId( $v ) {
2038 $this->clearInstanceCache( 'id' );
2042 * Get the user name, or the IP of an anonymous user
2043 * @return string User's name or IP address
2045 public function getName() {
2046 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2047 // Special case optimisation
2048 return $this->mName
;
2051 if ( $this->mName
=== false ) {
2053 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2055 return $this->mName
;
2060 * Set the user name.
2062 * This does not reload fields from the database according to the given
2063 * name. Rather, it is used to create a temporary "nonexistent user" for
2064 * later addition to the database. It can also be used to set the IP
2065 * address for an anonymous user to something other than the current
2068 * @note User::newFromName() has roughly the same function, when the named user
2070 * @param string $str New user name to set
2072 public function setName( $str ) {
2074 $this->mName
= $str;
2078 * Get the user's name escaped by underscores.
2079 * @return string Username escaped by underscores.
2081 public function getTitleKey() {
2082 return str_replace( ' ', '_', $this->getName() );
2086 * Check if the user has new messages.
2087 * @return bool True if the user has new messages
2089 public function getNewtalk() {
2092 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2093 if ( $this->mNewtalk
=== -1 ) {
2094 $this->mNewtalk
= false; # reset talk page status
2096 // Check memcached separately for anons, who have no
2097 // entire User object stored in there.
2098 if ( !$this->mId
) {
2099 global $wgDisableAnonTalk;
2100 if ( $wgDisableAnonTalk ) {
2101 // Anon newtalk disabled by configuration.
2102 $this->mNewtalk
= false;
2104 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2107 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2111 return (bool)$this->mNewtalk
;
2115 * Return the data needed to construct links for new talk page message
2116 * alerts. If there are new messages, this will return an associative array
2117 * with the following data:
2118 * wiki: The database name of the wiki
2119 * link: Root-relative link to the user's talk page
2120 * rev: The last talk page revision that the user has seen or null. This
2121 * is useful for building diff links.
2122 * If there are no new messages, it returns an empty array.
2123 * @note This function was designed to accomodate multiple talk pages, but
2124 * currently only returns a single link and revision.
2127 public function getNewMessageLinks() {
2129 if ( !Hooks
::run( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
2131 } elseif ( !$this->getNewtalk() ) {
2134 $utp = $this->getTalkPage();
2135 $dbr = wfGetDB( DB_SLAVE
);
2136 // Get the "last viewed rev" timestamp from the oldest message notification
2137 $timestamp = $dbr->selectField( 'user_newtalk',
2138 'MIN(user_last_timestamp)',
2139 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
2141 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2142 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
2146 * Get the revision ID for the last talk page revision viewed by the talk
2148 * @return int|null Revision ID or null
2150 public function getNewMessageRevisionId() {
2151 $newMessageRevisionId = null;
2152 $newMessageLinks = $this->getNewMessageLinks();
2153 if ( $newMessageLinks ) {
2154 // Note: getNewMessageLinks() never returns more than a single link
2155 // and it is always for the same wiki, but we double-check here in
2156 // case that changes some time in the future.
2157 if ( count( $newMessageLinks ) === 1
2158 && $newMessageLinks[0]['wiki'] === wfWikiID()
2159 && $newMessageLinks[0]['rev']
2161 /** @var Revision $newMessageRevision */
2162 $newMessageRevision = $newMessageLinks[0]['rev'];
2163 $newMessageRevisionId = $newMessageRevision->getId();
2166 return $newMessageRevisionId;
2170 * Internal uncached check for new messages
2173 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2174 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2175 * @return bool True if the user has new messages
2177 protected function checkNewtalk( $field, $id ) {
2178 $dbr = wfGetDB( DB_SLAVE
);
2180 $ok = $dbr->selectField( 'user_newtalk', $field, array( $field => $id ), __METHOD__
);
2182 return $ok !== false;
2186 * Add or update the new messages flag
2187 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2188 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2189 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2190 * @return bool True if successful, false otherwise
2192 protected function updateNewtalk( $field, $id, $curRev = null ) {
2193 // Get timestamp of the talk page revision prior to the current one
2194 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2195 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2196 // Mark the user as having new messages since this revision
2197 $dbw = wfGetDB( DB_MASTER
);
2198 $dbw->insert( 'user_newtalk',
2199 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
2202 if ( $dbw->affectedRows() ) {
2203 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2206 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2212 * Clear the new messages flag for the given user
2213 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2214 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2215 * @return bool True if successful, false otherwise
2217 protected function deleteNewtalk( $field, $id ) {
2218 $dbw = wfGetDB( DB_MASTER
);
2219 $dbw->delete( 'user_newtalk',
2220 array( $field => $id ),
2222 if ( $dbw->affectedRows() ) {
2223 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2226 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2232 * Update the 'You have new messages!' status.
2233 * @param bool $val Whether the user has new messages
2234 * @param Revision $curRev New, as yet unseen revision of the user talk
2235 * page. Ignored if null or !$val.
2237 public function setNewtalk( $val, $curRev = null ) {
2238 if ( wfReadOnly() ) {
2243 $this->mNewtalk
= $val;
2245 if ( $this->isAnon() ) {
2247 $id = $this->getName();
2250 $id = $this->getId();
2254 $changed = $this->updateNewtalk( $field, $id, $curRev );
2256 $changed = $this->deleteNewtalk( $field, $id );
2260 $this->invalidateCache();
2265 * Generate a current or new-future timestamp to be stored in the
2266 * user_touched field when we update things.
2267 * @return string Timestamp in TS_MW format
2269 private function newTouchedTimestamp() {
2270 global $wgClockSkewFudge;
2272 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2273 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2274 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2281 * Clear user data from memcached.
2282 * Use after applying fun updates to the database; caller's
2283 * responsibility to update user_touched if appropriate.
2285 * Called implicitly from invalidateCache() and saveSettings().
2287 public function clearSharedCache() {
2288 $id = $this->getId();
2290 $key = wfMemcKey( 'user', 'id', $id );
2291 ObjectCache
::getMainWANInstance()->delete( $key );
2296 * Immediately touch the user data cache for this account
2298 * Calls touch() and removes account data from memcached
2300 public function invalidateCache() {
2302 $this->clearSharedCache();
2306 * Update the "touched" timestamp for the user
2308 * This is useful on various login/logout events when making sure that
2309 * a browser or proxy that has multiple tenants does not suffer cache
2310 * pollution where the new user sees the old users content. The value
2311 * of getTouched() is checked when determining 304 vs 200 responses.
2312 * Unlike invalidateCache(), this preserves the User object cache and
2313 * avoids database writes.
2317 public function touch() {
2318 $id = $this->getId();
2320 $key = wfMemcKey( 'user-quicktouched', 'id', $id );
2321 ObjectCache
::getMainWANInstance()->touchCheckKey( $key );
2322 $this->mQuickTouched
= null;
2327 * Validate the cache for this account.
2328 * @param string $timestamp A timestamp in TS_MW format
2331 public function validateCache( $timestamp ) {
2332 return ( $timestamp >= $this->getTouched() );
2336 * Get the user touched timestamp
2338 * Use this value only to validate caches via inequalities
2339 * such as in the case of HTTP If-Modified-Since response logic
2341 * @return string TS_MW Timestamp
2343 public function getTouched() {
2347 if ( $this->mQuickTouched
=== null ) {
2348 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2349 $cache = ObjectCache
::getMainWANInstance();
2351 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2354 return max( $this->mTouched
, $this->mQuickTouched
);
2357 return $this->mTouched
;
2361 * Get the user_touched timestamp field (time of last DB updates)
2362 * @return string TS_MW Timestamp
2365 public function getDBTouched() {
2368 return $this->mTouched
;
2375 public function getPassword() {
2376 $this->loadPasswords();
2378 return $this->mPassword
;
2385 public function getTemporaryPassword() {
2386 $this->loadPasswords();
2388 return $this->mNewpassword
;
2392 * Set the password and reset the random token.
2393 * Calls through to authentication plugin if necessary;
2394 * will have no effect if the auth plugin refuses to
2395 * pass the change through or if the legal password
2398 * As a special case, setting the password to null
2399 * wipes it, so the account cannot be logged in until
2400 * a new password is set, for instance via e-mail.
2402 * @param string $str New password to set
2403 * @throws PasswordError On failure
2407 public function setPassword( $str ) {
2410 $this->loadPasswords();
2412 if ( $str !== null ) {
2413 if ( !$wgAuth->allowPasswordChange() ) {
2414 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2417 $status = $this->checkPasswordValidity( $str );
2418 if ( !$status->isGood() ) {
2419 throw new PasswordError( $status->getMessage()->text() );
2423 if ( !$wgAuth->setPassword( $this, $str ) ) {
2424 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2427 $this->setInternalPassword( $str );
2433 * Set the password and reset the random token unconditionally.
2435 * @param string|null $str New password to set or null to set an invalid
2436 * password hash meaning that the user will not be able to log in
2437 * through the web interface.
2439 public function setInternalPassword( $str ) {
2442 $passwordFactory = self
::getPasswordFactory();
2443 $this->mPassword
= $passwordFactory->newFromPlaintext( $str );
2445 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
2446 $this->mNewpassTime
= null;
2450 * Get the user's current token.
2451 * @param bool $forceCreation Force the generation of a new token if the
2452 * user doesn't have one (default=true for backwards compatibility).
2453 * @return string Token
2455 public function getToken( $forceCreation = true ) {
2457 if ( !$this->mToken
&& $forceCreation ) {
2460 return $this->mToken
;
2464 * Set the random token (used for persistent authentication)
2465 * Called from loadDefaults() among other places.
2467 * @param string|bool $token If specified, set the token to this value
2469 public function setToken( $token = false ) {
2472 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2474 $this->mToken
= $token;
2479 * Set the password for a password reminder or new account email
2481 * @param string $str New password to set or null to set an invalid
2482 * password hash meaning that the user will not be able to use it
2483 * @param bool $throttle If true, reset the throttle timestamp to the present
2485 public function setNewpassword( $str, $throttle = true ) {
2486 $this->loadPasswords();
2488 $this->mNewpassword
= self
::getPasswordFactory()->newFromPlaintext( $str );
2489 if ( $str === null ) {
2490 $this->mNewpassTime
= null;
2491 } elseif ( $throttle ) {
2492 $this->mNewpassTime
= wfTimestampNow();
2497 * Has password reminder email been sent within the last
2498 * $wgPasswordReminderResendTime hours?
2501 public function isPasswordReminderThrottled() {
2502 global $wgPasswordReminderResendTime;
2504 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2507 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2508 return time() < $expiry;
2512 * Get the user's e-mail address
2513 * @return string User's email address
2515 public function getEmail() {
2517 Hooks
::run( 'UserGetEmail', array( $this, &$this->mEmail
) );
2518 return $this->mEmail
;
2522 * Get the timestamp of the user's e-mail authentication
2523 * @return string TS_MW timestamp
2525 public function getEmailAuthenticationTimestamp() {
2527 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2528 return $this->mEmailAuthenticated
;
2532 * Set the user's e-mail address
2533 * @param string $str New e-mail address
2535 public function setEmail( $str ) {
2537 if ( $str == $this->mEmail
) {
2540 $this->invalidateEmail();
2541 $this->mEmail
= $str;
2542 Hooks
::run( 'UserSetEmail', array( $this, &$this->mEmail
) );
2546 * Set the user's e-mail address and a confirmation mail if needed.
2549 * @param string $str New e-mail address
2552 public function setEmailWithConfirmation( $str ) {
2553 global $wgEnableEmail, $wgEmailAuthentication;
2555 if ( !$wgEnableEmail ) {
2556 return Status
::newFatal( 'emaildisabled' );
2559 $oldaddr = $this->getEmail();
2560 if ( $str === $oldaddr ) {
2561 return Status
::newGood( true );
2564 $this->setEmail( $str );
2566 if ( $str !== '' && $wgEmailAuthentication ) {
2567 // Send a confirmation request to the new address if needed
2568 $type = $oldaddr != '' ?
'changed' : 'set';
2569 $result = $this->sendConfirmationMail( $type );
2570 if ( $result->isGood() ) {
2571 // Say to the caller that a confirmation mail has been sent
2572 $result->value
= 'eauth';
2575 $result = Status
::newGood( true );
2582 * Get the user's real name
2583 * @return string User's real name
2585 public function getRealName() {
2586 if ( !$this->isItemLoaded( 'realname' ) ) {
2590 return $this->mRealName
;
2594 * Set the user's real name
2595 * @param string $str New real name
2597 public function setRealName( $str ) {
2599 $this->mRealName
= $str;
2603 * Get the user's current setting for a given option.
2605 * @param string $oname The option to check
2606 * @param string $defaultOverride A default value returned if the option does not exist
2607 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2608 * @return string User's current value for the option
2609 * @see getBoolOption()
2610 * @see getIntOption()
2612 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2613 global $wgHiddenPrefs;
2614 $this->loadOptions();
2616 # We want 'disabled' preferences to always behave as the default value for
2617 # users, even if they have set the option explicitly in their settings (ie they
2618 # set it, and then it was disabled removing their ability to change it). But
2619 # we don't want to erase the preferences in the database in case the preference
2620 # is re-enabled again. So don't touch $mOptions, just override the returned value
2621 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2622 return self
::getDefaultOption( $oname );
2625 if ( array_key_exists( $oname, $this->mOptions
) ) {
2626 return $this->mOptions
[$oname];
2628 return $defaultOverride;
2633 * Get all user's options
2635 * @param int $flags Bitwise combination of:
2636 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2637 * to the default value. (Since 1.25)
2640 public function getOptions( $flags = 0 ) {
2641 global $wgHiddenPrefs;
2642 $this->loadOptions();
2643 $options = $this->mOptions
;
2645 # We want 'disabled' preferences to always behave as the default value for
2646 # users, even if they have set the option explicitly in their settings (ie they
2647 # set it, and then it was disabled removing their ability to change it). But
2648 # we don't want to erase the preferences in the database in case the preference
2649 # is re-enabled again. So don't touch $mOptions, just override the returned value
2650 foreach ( $wgHiddenPrefs as $pref ) {
2651 $default = self
::getDefaultOption( $pref );
2652 if ( $default !== null ) {
2653 $options[$pref] = $default;
2657 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2658 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2665 * Get the user's current setting for a given option, as a boolean value.
2667 * @param string $oname The option to check
2668 * @return bool User's current value for the option
2671 public function getBoolOption( $oname ) {
2672 return (bool)$this->getOption( $oname );
2676 * Get the user's current setting for a given option, as an integer value.
2678 * @param string $oname The option to check
2679 * @param int $defaultOverride A default value returned if the option does not exist
2680 * @return int User's current value for the option
2683 public function getIntOption( $oname, $defaultOverride = 0 ) {
2684 $val = $this->getOption( $oname );
2686 $val = $defaultOverride;
2688 return intval( $val );
2692 * Set the given option for a user.
2694 * You need to call saveSettings() to actually write to the database.
2696 * @param string $oname The option to set
2697 * @param mixed $val New value to set
2699 public function setOption( $oname, $val ) {
2700 $this->loadOptions();
2702 // Explicitly NULL values should refer to defaults
2703 if ( is_null( $val ) ) {
2704 $val = self
::getDefaultOption( $oname );
2707 $this->mOptions
[$oname] = $val;
2711 * Get a token stored in the preferences (like the watchlist one),
2712 * resetting it if it's empty (and saving changes).
2714 * @param string $oname The option name to retrieve the token from
2715 * @return string|bool User's current value for the option, or false if this option is disabled.
2716 * @see resetTokenFromOption()
2719 public function getTokenFromOption( $oname ) {
2720 global $wgHiddenPrefs;
2721 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2725 $token = $this->getOption( $oname );
2727 $token = $this->resetTokenFromOption( $oname );
2728 if ( !wfReadOnly() ) {
2729 $this->saveSettings();
2736 * Reset a token stored in the preferences (like the watchlist one).
2737 * *Does not* save user's preferences (similarly to setOption()).
2739 * @param string $oname The option name to reset the token in
2740 * @return string|bool New token value, or false if this option is disabled.
2741 * @see getTokenFromOption()
2744 public function resetTokenFromOption( $oname ) {
2745 global $wgHiddenPrefs;
2746 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2750 $token = MWCryptRand
::generateHex( 40 );
2751 $this->setOption( $oname, $token );
2756 * Return a list of the types of user options currently returned by
2757 * User::getOptionKinds().
2759 * Currently, the option kinds are:
2760 * - 'registered' - preferences which are registered in core MediaWiki or
2761 * by extensions using the UserGetDefaultOptions hook.
2762 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2763 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2764 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2765 * be used by user scripts.
2766 * - 'special' - "preferences" that are not accessible via User::getOptions
2767 * or User::setOptions.
2768 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2769 * These are usually legacy options, removed in newer versions.
2771 * The API (and possibly others) use this function to determine the possible
2772 * option types for validation purposes, so make sure to update this when a
2773 * new option kind is added.
2775 * @see User::getOptionKinds
2776 * @return array Option kinds
2778 public static function listOptionKinds() {
2781 'registered-multiselect',
2782 'registered-checkmatrix',
2790 * Return an associative array mapping preferences keys to the kind of a preference they're
2791 * used for. Different kinds are handled differently when setting or reading preferences.
2793 * See User::listOptionKinds for the list of valid option types that can be provided.
2795 * @see User::listOptionKinds
2796 * @param IContextSource $context
2797 * @param array $options Assoc. array with options keys to check as keys.
2798 * Defaults to $this->mOptions.
2799 * @return array The key => kind mapping data
2801 public function getOptionKinds( IContextSource
$context, $options = null ) {
2802 $this->loadOptions();
2803 if ( $options === null ) {
2804 $options = $this->mOptions
;
2807 $prefs = Preferences
::getPreferences( $this, $context );
2810 // Pull out the "special" options, so they don't get converted as
2811 // multiselect or checkmatrix.
2812 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2813 foreach ( $specialOptions as $name => $value ) {
2814 unset( $prefs[$name] );
2817 // Multiselect and checkmatrix options are stored in the database with
2818 // one key per option, each having a boolean value. Extract those keys.
2819 $multiselectOptions = array();
2820 foreach ( $prefs as $name => $info ) {
2821 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2822 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2823 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2824 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2826 foreach ( $opts as $value ) {
2827 $multiselectOptions["$prefix$value"] = true;
2830 unset( $prefs[$name] );
2833 $checkmatrixOptions = array();
2834 foreach ( $prefs as $name => $info ) {
2835 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2836 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2837 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2838 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2839 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2841 foreach ( $columns as $column ) {
2842 foreach ( $rows as $row ) {
2843 $checkmatrixOptions["$prefix$column-$row"] = true;
2847 unset( $prefs[$name] );
2851 // $value is ignored
2852 foreach ( $options as $key => $value ) {
2853 if ( isset( $prefs[$key] ) ) {
2854 $mapping[$key] = 'registered';
2855 } elseif ( isset( $multiselectOptions[$key] ) ) {
2856 $mapping[$key] = 'registered-multiselect';
2857 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2858 $mapping[$key] = 'registered-checkmatrix';
2859 } elseif ( isset( $specialOptions[$key] ) ) {
2860 $mapping[$key] = 'special';
2861 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2862 $mapping[$key] = 'userjs';
2864 $mapping[$key] = 'unused';
2872 * Reset certain (or all) options to the site defaults
2874 * The optional parameter determines which kinds of preferences will be reset.
2875 * Supported values are everything that can be reported by getOptionKinds()
2876 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2878 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
2879 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2880 * for backwards-compatibility.
2881 * @param IContextSource|null $context Context source used when $resetKinds
2882 * does not contain 'all', passed to getOptionKinds().
2883 * Defaults to RequestContext::getMain() when null.
2885 public function resetOptions(
2886 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2887 IContextSource
$context = null
2890 $defaultOptions = self
::getDefaultOptions();
2892 if ( !is_array( $resetKinds ) ) {
2893 $resetKinds = array( $resetKinds );
2896 if ( in_array( 'all', $resetKinds ) ) {
2897 $newOptions = $defaultOptions;
2899 if ( $context === null ) {
2900 $context = RequestContext
::getMain();
2903 $optionKinds = $this->getOptionKinds( $context );
2904 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
2905 $newOptions = array();
2907 // Use default values for the options that should be deleted, and
2908 // copy old values for the ones that shouldn't.
2909 foreach ( $this->mOptions
as $key => $value ) {
2910 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2911 if ( array_key_exists( $key, $defaultOptions ) ) {
2912 $newOptions[$key] = $defaultOptions[$key];
2915 $newOptions[$key] = $value;
2920 Hooks
::run( 'UserResetAllOptions', array( $this, &$newOptions, $this->mOptions
, $resetKinds ) );
2922 $this->mOptions
= $newOptions;
2923 $this->mOptionsLoaded
= true;
2927 * Get the user's preferred date format.
2928 * @return string User's preferred date format
2930 public function getDatePreference() {
2931 // Important migration for old data rows
2932 if ( is_null( $this->mDatePreference
) ) {
2934 $value = $this->getOption( 'date' );
2935 $map = $wgLang->getDatePreferenceMigrationMap();
2936 if ( isset( $map[$value] ) ) {
2937 $value = $map[$value];
2939 $this->mDatePreference
= $value;
2941 return $this->mDatePreference
;
2945 * Determine based on the wiki configuration and the user's options,
2946 * whether this user must be over HTTPS no matter what.
2950 public function requiresHTTPS() {
2951 global $wgSecureLogin;
2952 if ( !$wgSecureLogin ) {
2955 $https = $this->getBoolOption( 'prefershttps' );
2956 Hooks
::run( 'UserRequiresHTTPS', array( $this, &$https ) );
2958 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
2965 * Get the user preferred stub threshold
2969 public function getStubThreshold() {
2970 global $wgMaxArticleSize; # Maximum article size, in Kb
2971 $threshold = $this->getIntOption( 'stubthreshold' );
2972 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2973 // If they have set an impossible value, disable the preference
2974 // so we can use the parser cache again.
2981 * Get the permissions this user has.
2982 * @return array Array of String permission names
2984 public function getRights() {
2985 if ( is_null( $this->mRights
) ) {
2986 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2987 Hooks
::run( 'UserGetRights', array( $this, &$this->mRights
) );
2988 // Force reindexation of rights when a hook has unset one of them
2989 $this->mRights
= array_values( array_unique( $this->mRights
) );
2991 return $this->mRights
;
2995 * Get the list of explicit group memberships this user has.
2996 * The implicit * and user groups are not included.
2997 * @return array Array of String internal group names
2999 public function getGroups() {
3001 $this->loadGroups();
3002 return $this->mGroups
;
3006 * Get the list of implicit group memberships this user has.
3007 * This includes all explicit groups, plus 'user' if logged in,
3008 * '*' for all accounts, and autopromoted groups
3009 * @param bool $recache Whether to avoid the cache
3010 * @return array Array of String internal group names
3012 public function getEffectiveGroups( $recache = false ) {
3013 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3014 $this->mEffectiveGroups
= array_unique( array_merge(
3015 $this->getGroups(), // explicit groups
3016 $this->getAutomaticGroups( $recache ) // implicit groups
3018 // Hook for additional groups
3019 Hooks
::run( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
3020 // Force reindexation of groups when a hook has unset one of them
3021 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3023 return $this->mEffectiveGroups
;
3027 * Get the list of implicit group memberships this user has.
3028 * This includes 'user' if logged in, '*' for all accounts,
3029 * and autopromoted groups
3030 * @param bool $recache Whether to avoid the cache
3031 * @return array Array of String internal group names
3033 public function getAutomaticGroups( $recache = false ) {
3034 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3035 $this->mImplicitGroups
= array( '*' );
3036 if ( $this->getId() ) {
3037 $this->mImplicitGroups
[] = 'user';
3039 $this->mImplicitGroups
= array_unique( array_merge(
3040 $this->mImplicitGroups
,
3041 Autopromote
::getAutopromoteGroups( $this )
3045 // Assure data consistency with rights/groups,
3046 // as getEffectiveGroups() depends on this function
3047 $this->mEffectiveGroups
= null;
3050 return $this->mImplicitGroups
;
3054 * Returns the groups the user has belonged to.
3056 * The user may still belong to the returned groups. Compare with getGroups().
3058 * The function will not return groups the user had belonged to before MW 1.17
3060 * @return array Names of the groups the user has belonged to.
3062 public function getFormerGroups() {
3065 if ( is_null( $this->mFormerGroups
) ) {
3066 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3067 ?
wfGetDB( DB_MASTER
)
3068 : wfGetDB( DB_SLAVE
);
3069 $res = $db->select( 'user_former_groups',
3070 array( 'ufg_group' ),
3071 array( 'ufg_user' => $this->mId
),
3073 $this->mFormerGroups
= array();
3074 foreach ( $res as $row ) {
3075 $this->mFormerGroups
[] = $row->ufg_group
;
3079 return $this->mFormerGroups
;
3083 * Get the user's edit count.
3084 * @return int|null Null for anonymous users
3086 public function getEditCount() {
3087 if ( !$this->getId() ) {
3091 if ( $this->mEditCount
=== null ) {
3092 /* Populate the count, if it has not been populated yet */
3093 $dbr = wfGetDB( DB_SLAVE
);
3094 // check if the user_editcount field has been initialized
3095 $count = $dbr->selectField(
3096 'user', 'user_editcount',
3097 array( 'user_id' => $this->mId
),
3101 if ( $count === null ) {
3102 // it has not been initialized. do so.
3103 $count = $this->initEditCount();
3105 $this->mEditCount
= $count;
3107 return (int)$this->mEditCount
;
3111 * Add the user to the given group.
3112 * This takes immediate effect.
3113 * @param string $group Name of the group to add
3116 public function addGroup( $group ) {
3119 if ( !Hooks
::run( 'UserAddGroup', array( $this, &$group ) ) ) {
3123 $dbw = wfGetDB( DB_MASTER
);
3124 if ( $this->getId() ) {
3125 $dbw->insert( 'user_groups',
3127 'ug_user' => $this->getID(),
3128 'ug_group' => $group,
3131 array( 'IGNORE' ) );
3134 $this->loadGroups();
3135 $this->mGroups
[] = $group;
3136 // In case loadGroups was not called before, we now have the right twice.
3137 // Get rid of the duplicate.
3138 $this->mGroups
= array_unique( $this->mGroups
);
3140 // Refresh the groups caches, and clear the rights cache so it will be
3141 // refreshed on the next call to $this->getRights().
3142 $this->getEffectiveGroups( true );
3143 $this->mRights
= null;
3145 $this->invalidateCache();
3151 * Remove the user from the given group.
3152 * This takes immediate effect.
3153 * @param string $group Name of the group to remove
3156 public function removeGroup( $group ) {
3158 if ( !Hooks
::run( 'UserRemoveGroup', array( $this, &$group ) ) ) {
3162 $dbw = wfGetDB( DB_MASTER
);
3163 $dbw->delete( 'user_groups',
3165 'ug_user' => $this->getID(),
3166 'ug_group' => $group,
3169 // Remember that the user was in this group
3170 $dbw->insert( 'user_former_groups',
3172 'ufg_user' => $this->getID(),
3173 'ufg_group' => $group,
3179 $this->loadGroups();
3180 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
3182 // Refresh the groups caches, and clear the rights cache so it will be
3183 // refreshed on the next call to $this->getRights().
3184 $this->getEffectiveGroups( true );
3185 $this->mRights
= null;
3187 $this->invalidateCache();
3193 * Get whether the user is logged in
3196 public function isLoggedIn() {
3197 return $this->getID() != 0;
3201 * Get whether the user is anonymous
3204 public function isAnon() {
3205 return !$this->isLoggedIn();
3209 * Check if user is allowed to access a feature / make an action
3211 * @param string $permissions,... Permissions to test
3212 * @return bool True if user is allowed to perform *any* of the given actions
3214 public function isAllowedAny( /*...*/ ) {
3215 $permissions = func_get_args();
3216 foreach ( $permissions as $permission ) {
3217 if ( $this->isAllowed( $permission ) ) {
3226 * @param string $permissions,... Permissions to test
3227 * @return bool True if the user is allowed to perform *all* of the given actions
3229 public function isAllowedAll( /*...*/ ) {
3230 $permissions = func_get_args();
3231 foreach ( $permissions as $permission ) {
3232 if ( !$this->isAllowed( $permission ) ) {
3240 * Internal mechanics of testing a permission
3241 * @param string $action
3244 public function isAllowed( $action = '' ) {
3245 if ( $action === '' ) {
3246 return true; // In the spirit of DWIM
3248 // Patrolling may not be enabled
3249 if ( $action === 'patrol' ||
$action === 'autopatrol' ) {
3250 global $wgUseRCPatrol, $wgUseNPPatrol;
3251 if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) {
3255 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3256 // by misconfiguration: 0 == 'foo'
3257 return in_array( $action, $this->getRights(), true );
3261 * Check whether to enable recent changes patrol features for this user
3262 * @return bool True or false
3264 public function useRCPatrol() {
3265 global $wgUseRCPatrol;
3266 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3270 * Check whether to enable new pages patrol features for this user
3271 * @return bool True or false
3273 public function useNPPatrol() {
3274 global $wgUseRCPatrol, $wgUseNPPatrol;
3276 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3277 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3282 * Get the WebRequest object to use with this object
3284 * @return WebRequest
3286 public function getRequest() {
3287 if ( $this->mRequest
) {
3288 return $this->mRequest
;
3296 * Get the current skin, loading it if required
3297 * @return Skin The current skin
3298 * @todo FIXME: Need to check the old failback system [AV]
3299 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
3301 public function getSkin() {
3302 wfDeprecated( __METHOD__
, '1.18' );
3303 return RequestContext
::getMain()->getSkin();
3307 * Get a WatchedItem for this user and $title.
3309 * @since 1.22 $checkRights parameter added
3310 * @param Title $title
3311 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3312 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3313 * @return WatchedItem
3315 public function getWatchedItem( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3316 $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey();
3318 if ( isset( $this->mWatchedItems
[$key] ) ) {
3319 return $this->mWatchedItems
[$key];
3322 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
3323 $this->mWatchedItems
= array();
3326 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title, $checkRights );
3327 return $this->mWatchedItems
[$key];
3331 * Check the watched status of an article.
3332 * @since 1.22 $checkRights parameter added
3333 * @param Title $title Title of the article to look at
3334 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3335 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3338 public function isWatched( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3339 return $this->getWatchedItem( $title, $checkRights )->isWatched();
3344 * @since 1.22 $checkRights parameter added
3345 * @param Title $title Title of the article to look at
3346 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3347 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3349 public function addWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3350 $this->getWatchedItem( $title, $checkRights )->addWatch();
3351 $this->invalidateCache();
3355 * Stop watching an article.
3356 * @since 1.22 $checkRights parameter added
3357 * @param Title $title Title of the article to look at
3358 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3359 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3361 public function removeWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3362 $this->getWatchedItem( $title, $checkRights )->removeWatch();
3363 $this->invalidateCache();
3367 * Clear the user's notification timestamp for the given title.
3368 * If e-notif e-mails are on, they will receive notification mails on
3369 * the next change of the page if it's watched etc.
3370 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3371 * @param Title $title Title of the article to look at
3372 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3374 public function clearNotification( &$title, $oldid = 0 ) {
3375 global $wgUseEnotif, $wgShowUpdatedMarker;
3377 // Do nothing if the database is locked to writes
3378 if ( wfReadOnly() ) {
3382 // Do nothing if not allowed to edit the watchlist
3383 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3387 // If we're working on user's talk page, we should update the talk page message indicator
3388 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3389 if ( !Hooks
::run( 'UserClearNewTalkNotification', array( &$this, $oldid ) ) ) {
3394 // Try to update the DB post-send and only if needed...
3395 DeferredUpdates
::addCallableUpdate( function() use ( $that, $title, $oldid ) {
3396 if ( !$that->getNewtalk() ) {
3397 return; // no notifications to clear
3400 // Delete the last notifications (they stack up)
3401 $that->setNewtalk( false );
3403 // If there is a new, unseen, revision, use its timestamp
3405 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3408 $that->setNewtalk( true, Revision
::newFromId( $nextid ) );
3413 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3417 if ( $this->isAnon() ) {
3418 // Nothing else to do...
3422 // Only update the timestamp if the page is being watched.
3423 // The query to find out if it is watched is cached both in memcached and per-invocation,
3424 // and when it does have to be executed, it can be on a slave
3425 // If this is the user's newtalk page, we always update the timestamp
3427 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3431 $this->getWatchedItem( $title )->resetNotificationTimestamp(
3432 $force, $oldid, WatchedItem
::DEFERRED
3437 * Resets all of the given user's page-change notification timestamps.
3438 * If e-notif e-mails are on, they will receive notification mails on
3439 * the next change of any watched page.
3440 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3442 public function clearAllNotifications() {
3443 if ( wfReadOnly() ) {
3447 // Do nothing if not allowed to edit the watchlist
3448 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3452 global $wgUseEnotif, $wgShowUpdatedMarker;
3453 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3454 $this->setNewtalk( false );
3457 $id = $this->getId();
3459 $dbw = wfGetDB( DB_MASTER
);
3460 $dbw->update( 'watchlist',
3461 array( /* SET */ 'wl_notificationtimestamp' => null ),
3462 array( /* WHERE */ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ),
3465 // We also need to clear here the "you have new message" notification for the own user_talk page;
3466 // it's cleared one page view later in WikiPage::doViewUpdates().
3471 * Set a cookie on the user's client. Wrapper for
3472 * WebResponse::setCookie
3473 * @param string $name Name of the cookie to set
3474 * @param string $value Value to set
3475 * @param int $exp Expiration time, as a UNIX time value;
3476 * if 0 or not specified, use the default $wgCookieExpiration
3477 * @param bool $secure
3478 * true: Force setting the secure attribute when setting the cookie
3479 * false: Force NOT setting the secure attribute when setting the cookie
3480 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3481 * @param array $params Array of options sent passed to WebResponse::setcookie()
3482 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3485 protected function setCookie(
3486 $name, $value, $exp = 0, $secure = null, $params = array(), $request = null
3488 if ( $request === null ) {
3489 $request = $this->getRequest();
3491 $params['secure'] = $secure;
3492 $request->response()->setcookie( $name, $value, $exp, $params );
3496 * Clear a cookie on the user's client
3497 * @param string $name Name of the cookie to clear
3498 * @param bool $secure
3499 * true: Force setting the secure attribute when setting the cookie
3500 * false: Force NOT setting the secure attribute when setting the cookie
3501 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3502 * @param array $params Array of options sent passed to WebResponse::setcookie()
3504 protected function clearCookie( $name, $secure = null, $params = array() ) {
3505 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3509 * Set an extended login cookie on the user's client. The expiry of the cookie
3510 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3513 * @see User::setCookie
3515 * @param string $name Name of the cookie to set
3516 * @param string $value Value to set
3517 * @param bool $secure
3518 * true: Force setting the secure attribute when setting the cookie
3519 * false: Force NOT setting the secure attribute when setting the cookie
3520 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3522 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3523 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3526 $exp +
= $wgExtendedLoginCookieExpiration !== null
3527 ?
$wgExtendedLoginCookieExpiration
3528 : $wgCookieExpiration;
3530 $this->setCookie( $name, $value, $exp, $secure );
3534 * Set the default cookies for this session on the user's client.
3536 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3538 * @param bool $secure Whether to force secure/insecure cookies or use default
3539 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3541 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3542 global $wgExtendedLoginCookies;
3544 if ( $request === null ) {
3545 $request = $this->getRequest();
3549 if ( 0 == $this->mId
) {
3552 if ( !$this->mToken
) {
3553 // When token is empty or NULL generate a new one and then save it to the database
3554 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
3555 // Simply by setting every cell in the user_token column to NULL and letting them be
3556 // regenerated as users log back into the wiki.
3558 if ( !wfReadOnly() ) {
3559 $this->saveSettings();
3563 'wsUserID' => $this->mId
,
3564 'wsToken' => $this->mToken
,
3565 'wsUserName' => $this->getName()
3568 'UserID' => $this->mId
,
3569 'UserName' => $this->getName(),
3571 if ( $rememberMe ) {
3572 $cookies['Token'] = $this->mToken
;
3574 $cookies['Token'] = false;
3577 Hooks
::run( 'UserSetCookies', array( $this, &$session, &$cookies ) );
3579 foreach ( $session as $name => $value ) {
3580 $request->setSessionData( $name, $value );
3582 foreach ( $cookies as $name => $value ) {
3583 if ( $value === false ) {
3584 $this->clearCookie( $name );
3585 } elseif ( $rememberMe && in_array( $name, $wgExtendedLoginCookies ) ) {
3586 $this->setExtendedLoginCookie( $name, $value, $secure );
3588 $this->setCookie( $name, $value, 0, $secure, array(), $request );
3593 * If wpStickHTTPS was selected, also set an insecure cookie that
3594 * will cause the site to redirect the user to HTTPS, if they access
3595 * it over HTTP. Bug 29898. Use an un-prefixed cookie, so it's the same
3596 * as the one set by centralauth (bug 53538). Also set it to session, or
3597 * standard time setting, based on if rememberme was set.
3599 if ( $request->getCheck( 'wpStickHTTPS' ) ||
$this->requiresHTTPS() ) {
3603 $rememberMe ?
0 : null,
3605 array( 'prefix' => '' ) // no prefix
3611 * Log this user out.
3613 public function logout() {
3614 if ( Hooks
::run( 'UserLogout', array( &$this ) ) ) {
3620 * Clear the user's cookies and session, and reset the instance cache.
3623 public function doLogout() {
3624 $this->clearInstanceCache( 'defaults' );
3626 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3628 $this->clearCookie( 'UserID' );
3629 $this->clearCookie( 'Token' );
3630 $this->clearCookie( 'forceHTTPS', false, array( 'prefix' => '' ) );
3632 // Remember when user logged out, to prevent seeing cached pages
3633 $this->setCookie( 'LoggedOut', time(), time() +
86400 );
3637 * Save this user's settings into the database.
3638 * @todo Only rarely do all these fields need to be set!
3640 public function saveSettings() {
3643 if ( wfReadOnly() ) {
3644 // @TODO: caller should deal with this instead!
3645 // This should really just be an exception.
3646 MWExceptionHandler
::logException( new DBExpectedError(
3648 "Could not update user with ID '{$this->mId}'; DB is read-only."
3654 $this->loadPasswords();
3655 if ( 0 == $this->mId
) {
3659 // Get a new user_touched that is higher than the old one.
3660 // This will be used for a CAS check as a last-resort safety
3661 // check against race conditions and slave lag.
3662 $oldTouched = $this->mTouched
;
3663 $newTouched = $this->newTouchedTimestamp();
3665 if ( !$wgAuth->allowSetLocalPassword() ) {
3666 $this->mPassword
= self
::getPasswordFactory()->newFromCiphertext( null );
3669 $dbw = wfGetDB( DB_MASTER
);
3670 $dbw->update( 'user',
3672 'user_name' => $this->mName
,
3673 'user_password' => $this->mPassword
->toString(),
3674 'user_newpassword' => $this->mNewpassword
->toString(),
3675 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3676 'user_real_name' => $this->mRealName
,
3677 'user_email' => $this->mEmail
,
3678 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3679 'user_touched' => $dbw->timestamp( $newTouched ),
3680 'user_token' => strval( $this->mToken
),
3681 'user_email_token' => $this->mEmailToken
,
3682 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3683 'user_password_expires' => $dbw->timestampOrNull( $this->mPasswordExpires
),
3684 ), array( /* WHERE */
3685 'user_id' => $this->mId
,
3686 'user_touched' => $dbw->timestamp( $oldTouched ) // CAS check
3690 if ( !$dbw->affectedRows() ) {
3691 // Maybe the problem was a missed cache update; clear it to be safe
3692 $this->clearSharedCache();
3693 // User was changed in the meantime or loaded with stale data
3694 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'slave';
3695 throw new MWException(
3696 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3697 " the version of the user to be saved is older than the current version."
3701 $this->mTouched
= $newTouched;
3702 $this->saveOptions();
3704 Hooks
::run( 'UserSaveSettings', array( $this ) );
3705 $this->clearSharedCache();
3706 $this->getUserPage()->invalidateCache();
3708 // T95839: clear the cache again post-commit to reduce race conditions
3709 // where stale values are written back to the cache by other threads.
3710 // Note: this *still* doesn't deal with REPEATABLE-READ snapshot lag...
3712 $dbw->onTransactionIdle( function() use ( $that ) {
3713 $that->clearSharedCache();
3718 * If only this user's username is known, and it exists, return the user ID.
3720 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3723 public function idForName( $flags = 0 ) {
3724 $s = trim( $this->getName() );
3729 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
3730 ?
wfGetDB( DB_MASTER
)
3731 : wfGetDB( DB_SLAVE
);
3733 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
3734 ?
array( 'LOCK IN SHARE MODE' )
3737 $id = $db->selectField( 'user',
3738 'user_id', array( 'user_name' => $s ), __METHOD__
, $options );
3744 * Add a user to the database, return the user object
3746 * @param string $name Username to add
3747 * @param array $params Array of Strings Non-default parameters to save to
3748 * the database as user_* fields:
3749 * - password: The user's password hash. Password logins will be disabled
3750 * if this is omitted.
3751 * - newpassword: Hash for a temporary password that has been mailed to
3753 * - email: The user's email address.
3754 * - email_authenticated: The email authentication timestamp.
3755 * - real_name: The user's real name.
3756 * - options: An associative array of non-default options.
3757 * - token: Random authentication token. Do not set.
3758 * - registration: Registration timestamp. Do not set.
3760 * @return User|null User object, or null if the username already exists.
3762 public static function createNew( $name, $params = array() ) {
3765 $user->loadPasswords();
3766 $user->setToken(); // init token
3767 if ( isset( $params['options'] ) ) {
3768 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3769 unset( $params['options'] );
3771 $dbw = wfGetDB( DB_MASTER
);
3772 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3775 'user_id' => $seqVal,
3776 'user_name' => $name,
3777 'user_password' => $user->mPassword
->toString(),
3778 'user_newpassword' => $user->mNewpassword
->toString(),
3779 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
3780 'user_email' => $user->mEmail
,
3781 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3782 'user_real_name' => $user->mRealName
,
3783 'user_token' => strval( $user->mToken
),
3784 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3785 'user_editcount' => 0,
3786 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3788 foreach ( $params as $name => $value ) {
3789 $fields["user_$name"] = $value;
3791 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3792 if ( $dbw->affectedRows() ) {
3793 $newUser = User
::newFromId( $dbw->insertId() );
3801 * Add this existing user object to the database. If the user already
3802 * exists, a fatal status object is returned, and the user object is
3803 * initialised with the data from the database.
3805 * Previously, this function generated a DB error due to a key conflict
3806 * if the user already existed. Many extension callers use this function
3807 * in code along the lines of:
3809 * $user = User::newFromName( $name );
3810 * if ( !$user->isLoggedIn() ) {
3811 * $user->addToDatabase();
3813 * // do something with $user...
3815 * However, this was vulnerable to a race condition (bug 16020). By
3816 * initialising the user object if the user exists, we aim to support this
3817 * calling sequence as far as possible.
3819 * Note that if the user exists, this function will acquire a write lock,
3820 * so it is still advisable to make the call conditional on isLoggedIn(),
3821 * and to commit the transaction after calling.
3823 * @throws MWException
3826 public function addToDatabase() {
3828 $this->loadPasswords();
3829 if ( !$this->mToken
) {
3830 $this->setToken(); // init token
3833 $this->mTouched
= $this->newTouchedTimestamp();
3835 $dbw = wfGetDB( DB_MASTER
);
3836 $inWrite = $dbw->writesOrCallbacksPending();
3837 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3838 $dbw->insert( 'user',
3840 'user_id' => $seqVal,
3841 'user_name' => $this->mName
,
3842 'user_password' => $this->mPassword
->toString(),
3843 'user_newpassword' => $this->mNewpassword
->toString(),
3844 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3845 'user_email' => $this->mEmail
,
3846 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3847 'user_real_name' => $this->mRealName
,
3848 'user_token' => strval( $this->mToken
),
3849 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3850 'user_editcount' => 0,
3851 'user_touched' => $dbw->timestamp( $this->mTouched
),
3855 if ( !$dbw->affectedRows() ) {
3856 // The queries below cannot happen in the same REPEATABLE-READ snapshot.
3857 // Handle this by COMMIT, if possible, or by LOCK IN SHARE MODE otherwise.
3859 // Can't commit due to pending writes that may need atomicity.
3860 // This may cause some lock contention unlike the case below.
3861 $options = array( 'LOCK IN SHARE MODE' );
3862 $flags = self
::READ_LOCKING
;
3864 // Often, this case happens early in views before any writes when
3865 // using CentralAuth. It's should be OK to commit and break the snapshot.
3866 $dbw->commit( __METHOD__
, 'flush' );
3868 $flags = self
::READ_LATEST
;
3870 $this->mId
= $dbw->selectField( 'user', 'user_id',
3871 array( 'user_name' => $this->mName
), __METHOD__
, $options );
3874 if ( $this->loadFromDatabase( $flags ) ) {
3879 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3880 "to insert user '{$this->mName}' row, but it was not present in select!" );
3882 return Status
::newFatal( 'userexists' );
3884 $this->mId
= $dbw->insertId();
3886 // Clear instance cache other than user table data, which is already accurate
3887 $this->clearInstanceCache();
3889 $this->saveOptions();
3890 return Status
::newGood();
3894 * If this user is logged-in and blocked,
3895 * block any IP address they've successfully logged in from.
3896 * @return bool A block was spread
3898 public function spreadAnyEditBlock() {
3899 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3900 return $this->spreadBlock();
3906 * If this (non-anonymous) user is blocked,
3907 * block the IP address they've successfully logged in from.
3908 * @return bool A block was spread
3910 protected function spreadBlock() {
3911 wfDebug( __METHOD__
. "()\n" );
3913 if ( $this->mId
== 0 ) {
3917 $userblock = Block
::newFromTarget( $this->getName() );
3918 if ( !$userblock ) {
3922 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3926 * Get whether the user is explicitly blocked from account creation.
3927 * @return bool|Block
3929 public function isBlockedFromCreateAccount() {
3930 $this->getBlockedStatus();
3931 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
3932 return $this->mBlock
;
3935 # bug 13611: if the IP address the user is trying to create an account from is
3936 # blocked with createaccount disabled, prevent new account creation there even
3937 # when the user is logged in
3938 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3939 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3941 return $this->mBlockedFromCreateAccount
instanceof Block
3942 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3943 ?
$this->mBlockedFromCreateAccount
3948 * Get whether the user is blocked from using Special:Emailuser.
3951 public function isBlockedFromEmailuser() {
3952 $this->getBlockedStatus();
3953 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3957 * Get whether the user is allowed to create an account.
3960 public function isAllowedToCreateAccount() {
3961 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3965 * Get this user's personal page title.
3967 * @return Title User's personal page title
3969 public function getUserPage() {
3970 return Title
::makeTitle( NS_USER
, $this->getName() );
3974 * Get this user's talk page title.
3976 * @return Title User's talk page title
3978 public function getTalkPage() {
3979 $title = $this->getUserPage();
3980 return $title->getTalkPage();
3984 * Determine whether the user is a newbie. Newbies are either
3985 * anonymous IPs, or the most recently created accounts.
3988 public function isNewbie() {
3989 return !$this->isAllowed( 'autoconfirmed' );
3993 * Check to see if the given clear-text password is one of the accepted passwords
3994 * @param string $password User password
3995 * @return bool True if the given password is correct, otherwise False
3997 public function checkPassword( $password ) {
3998 global $wgAuth, $wgLegacyEncoding;
4000 $this->loadPasswords();
4002 // Some passwords will give a fatal Status, which means there is
4003 // some sort of technical or security reason for this password to
4004 // be completely invalid and should never be checked (e.g., T64685)
4005 if ( !$this->checkPasswordValidity( $password )->isOK() ) {
4009 // Certain authentication plugins do NOT want to save
4010 // domain passwords in a mysql database, so we should
4011 // check this (in case $wgAuth->strict() is false).
4012 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
4014 } elseif ( $wgAuth->strict() ) {
4015 // Auth plugin doesn't allow local authentication
4017 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
4018 // Auth plugin doesn't allow local authentication for this user name
4022 if ( !$this->mPassword
->equals( $password ) ) {
4023 if ( $wgLegacyEncoding ) {
4024 // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
4025 // Check for this with iconv
4026 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
4027 if ( $cp1252Password === $password ||
!$this->mPassword
->equals( $cp1252Password ) ) {
4035 $passwordFactory = self
::getPasswordFactory();
4036 if ( $passwordFactory->needsUpdate( $this->mPassword
) && !wfReadOnly() ) {
4037 $this->mPassword
= $passwordFactory->newFromPlaintext( $password );
4038 $this->saveSettings();
4045 * Check if the given clear-text password matches the temporary password
4046 * sent by e-mail for password reset operations.
4048 * @param string $plaintext
4050 * @return bool True if matches, false otherwise
4052 public function checkTemporaryPassword( $plaintext ) {
4053 global $wgNewPasswordExpiry;
4056 $this->loadPasswords();
4057 if ( $this->mNewpassword
->equals( $plaintext ) ) {
4058 if ( is_null( $this->mNewpassTime
) ) {
4061 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
4062 return ( time() < $expiry );
4069 * Alias for getEditToken.
4070 * @deprecated since 1.19, use getEditToken instead.
4072 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4073 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4074 * @return string The new edit token
4076 public function editToken( $salt = '', $request = null ) {
4077 wfDeprecated( __METHOD__
, '1.19' );
4078 return $this->getEditToken( $salt, $request );
4082 * Internal implementation for self::getEditToken() and
4083 * self::matchEditToken().
4085 * @param string|array $salt
4086 * @param WebRequest $request
4087 * @param string|int $timestamp
4090 private function getEditTokenAtTimestamp( $salt, $request, $timestamp ) {
4091 if ( $this->isAnon() ) {
4092 return self
::EDIT_TOKEN_SUFFIX
;
4094 $token = $request->getSessionData( 'wsEditToken' );
4095 if ( $token === null ) {
4096 $token = MWCryptRand
::generateHex( 32 );
4097 $request->setSessionData( 'wsEditToken', $token );
4099 if ( is_array( $salt ) ) {
4100 $salt = implode( '|', $salt );
4102 return hash_hmac( 'md5', $timestamp . $salt, $token, false ) .
4103 dechex( $timestamp ) .
4104 self
::EDIT_TOKEN_SUFFIX
;
4109 * Initialize (if necessary) and return a session token value
4110 * which can be used in edit forms to show that the user's
4111 * login credentials aren't being hijacked with a foreign form
4116 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4117 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4118 * @return string The new edit token
4120 public function getEditToken( $salt = '', $request = null ) {
4121 return $this->getEditTokenAtTimestamp(
4122 $salt, $request ?
: $this->getRequest(), wfTimestamp()
4127 * Generate a looking random token for various uses.
4129 * @return string The new random token
4130 * @deprecated since 1.20: Use MWCryptRand for secure purposes or
4131 * wfRandomString for pseudo-randomness.
4133 public static function generateToken() {
4134 return MWCryptRand
::generateHex( 32 );
4138 * Get the embedded timestamp from a token.
4139 * @param string $val Input token
4142 public static function getEditTokenTimestamp( $val ) {
4143 $suffixLen = strlen( self
::EDIT_TOKEN_SUFFIX
);
4144 if ( strlen( $val ) <= 32 +
$suffixLen ) {
4148 return hexdec( substr( $val, 32, -$suffixLen ) );
4152 * Check given value against the token value stored in the session.
4153 * A match should confirm that the form was submitted from the
4154 * user's own login session, not a form submission from a third-party
4157 * @param string $val Input value to compare
4158 * @param string $salt Optional function-specific data for hashing
4159 * @param WebRequest|null $request Object to use or null to use $wgRequest
4160 * @param int $maxage Fail tokens older than this, in seconds
4161 * @return bool Whether the token matches
4163 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4164 if ( $this->isAnon() ) {
4165 return $val === self
::EDIT_TOKEN_SUFFIX
;
4168 $timestamp = self
::getEditTokenTimestamp( $val );
4169 if ( $timestamp === null ) {
4172 if ( $maxage !== null && $timestamp < wfTimestamp() - $maxage ) {
4177 $sessionToken = $this->getEditTokenAtTimestamp(
4178 $salt, $request ?
: $this->getRequest(), $timestamp
4181 if ( $val != $sessionToken ) {
4182 wfDebug( "User::matchEditToken: broken session data\n" );
4185 return hash_equals( $sessionToken, $val );
4189 * Check given value against the token value stored in the session,
4190 * ignoring the suffix.
4192 * @param string $val Input value to compare
4193 * @param string $salt Optional function-specific data for hashing
4194 * @param WebRequest|null $request Object to use or null to use $wgRequest
4195 * @param int $maxage Fail tokens older than this, in seconds
4196 * @return bool Whether the token matches
4198 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4199 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . self
::EDIT_TOKEN_SUFFIX
;
4200 return $this->matchEditToken( $val, $salt, $request, $maxage );
4204 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4205 * mail to the user's given address.
4207 * @param string $type Message to send, either "created", "changed" or "set"
4210 public function sendConfirmationMail( $type = 'created' ) {
4212 $expiration = null; // gets passed-by-ref and defined in next line.
4213 $token = $this->confirmationToken( $expiration );
4214 $url = $this->confirmationTokenUrl( $token );
4215 $invalidateURL = $this->invalidationTokenUrl( $token );
4216 $this->saveSettings();
4218 if ( $type == 'created' ||
$type === false ) {
4219 $message = 'confirmemail_body';
4220 } elseif ( $type === true ) {
4221 $message = 'confirmemail_body_changed';
4223 // Messages: confirmemail_body_changed, confirmemail_body_set
4224 $message = 'confirmemail_body_' . $type;
4227 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4228 wfMessage( $message,
4229 $this->getRequest()->getIP(),
4232 $wgLang->timeanddate( $expiration, false ),
4234 $wgLang->date( $expiration, false ),
4235 $wgLang->time( $expiration, false ) )->text() );
4239 * Send an e-mail to this user's account. Does not check for
4240 * confirmed status or validity.
4242 * @param string $subject Message subject
4243 * @param string $body Message body
4244 * @param User|null $from Optional sending user; if unspecified, default
4245 * $wgPasswordSender will be used.
4246 * @param string $replyto Reply-To address
4249 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4250 global $wgPasswordSender;
4252 if ( $from instanceof User
) {
4253 $sender = MailAddress
::newFromUser( $from );
4255 $sender = new MailAddress( $wgPasswordSender,
4256 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4258 $to = MailAddress
::newFromUser( $this );
4260 return UserMailer
::send( $to, $sender, $subject, $body, array(
4261 'replyTo' => $replyto,
4266 * Generate, store, and return a new e-mail confirmation code.
4267 * A hash (unsalted, since it's used as a key) is stored.
4269 * @note Call saveSettings() after calling this function to commit
4270 * this change to the database.
4272 * @param string &$expiration Accepts the expiration time
4273 * @return string New token
4275 protected function confirmationToken( &$expiration ) {
4276 global $wgUserEmailConfirmationTokenExpiry;
4278 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4279 $expiration = wfTimestamp( TS_MW
, $expires );
4281 $token = MWCryptRand
::generateHex( 32 );
4282 $hash = md5( $token );
4283 $this->mEmailToken
= $hash;
4284 $this->mEmailTokenExpires
= $expiration;
4289 * Return a URL the user can use to confirm their email address.
4290 * @param string $token Accepts the email confirmation token
4291 * @return string New token URL
4293 protected function confirmationTokenUrl( $token ) {
4294 return $this->getTokenUrl( 'ConfirmEmail', $token );
4298 * Return a URL the user can use to invalidate their email address.
4299 * @param string $token Accepts the email confirmation token
4300 * @return string New token URL
4302 protected function invalidationTokenUrl( $token ) {
4303 return $this->getTokenUrl( 'InvalidateEmail', $token );
4307 * Internal function to format the e-mail validation/invalidation URLs.
4308 * This uses a quickie hack to use the
4309 * hardcoded English names of the Special: pages, for ASCII safety.
4311 * @note Since these URLs get dropped directly into emails, using the
4312 * short English names avoids insanely long URL-encoded links, which
4313 * also sometimes can get corrupted in some browsers/mailers
4314 * (bug 6957 with Gmail and Internet Explorer).
4316 * @param string $page Special page
4317 * @param string $token Token
4318 * @return string Formatted URL
4320 protected function getTokenUrl( $page, $token ) {
4321 // Hack to bypass localization of 'Special:'
4322 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4323 return $title->getCanonicalURL();
4327 * Mark the e-mail address confirmed.
4329 * @note Call saveSettings() after calling this function to commit the change.
4333 public function confirmEmail() {
4334 // Check if it's already confirmed, so we don't touch the database
4335 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4336 if ( !$this->isEmailConfirmed() ) {
4337 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4338 Hooks
::run( 'ConfirmEmailComplete', array( $this ) );
4344 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4345 * address if it was already confirmed.
4347 * @note Call saveSettings() after calling this function to commit the change.
4348 * @return bool Returns true
4350 public function invalidateEmail() {
4352 $this->mEmailToken
= null;
4353 $this->mEmailTokenExpires
= null;
4354 $this->setEmailAuthenticationTimestamp( null );
4356 Hooks
::run( 'InvalidateEmailComplete', array( $this ) );
4361 * Set the e-mail authentication timestamp.
4362 * @param string $timestamp TS_MW timestamp
4364 public function setEmailAuthenticationTimestamp( $timestamp ) {
4366 $this->mEmailAuthenticated
= $timestamp;
4367 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
4371 * Is this user allowed to send e-mails within limits of current
4372 * site configuration?
4375 public function canSendEmail() {
4376 global $wgEnableEmail, $wgEnableUserEmail;
4377 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4380 $canSend = $this->isEmailConfirmed();
4381 Hooks
::run( 'UserCanSendEmail', array( &$this, &$canSend ) );
4386 * Is this user allowed to receive e-mails within limits of current
4387 * site configuration?
4390 public function canReceiveEmail() {
4391 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4395 * Is this user's e-mail address valid-looking and confirmed within
4396 * limits of the current site configuration?
4398 * @note If $wgEmailAuthentication is on, this may require the user to have
4399 * confirmed their address by returning a code or using a password
4400 * sent to the address from the wiki.
4404 public function isEmailConfirmed() {
4405 global $wgEmailAuthentication;
4408 if ( Hooks
::run( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
4409 if ( $this->isAnon() ) {
4412 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4415 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4425 * Check whether there is an outstanding request for e-mail confirmation.
4428 public function isEmailConfirmationPending() {
4429 global $wgEmailAuthentication;
4430 return $wgEmailAuthentication &&
4431 !$this->isEmailConfirmed() &&
4432 $this->mEmailToken
&&
4433 $this->mEmailTokenExpires
> wfTimestamp();
4437 * Get the timestamp of account creation.
4439 * @return string|bool|null Timestamp of account creation, false for
4440 * non-existent/anonymous user accounts, or null if existing account
4441 * but information is not in database.
4443 public function getRegistration() {
4444 if ( $this->isAnon() ) {
4448 return $this->mRegistration
;
4452 * Get the timestamp of the first edit
4454 * @return string|bool Timestamp of first edit, or false for
4455 * non-existent/anonymous user accounts.
4457 public function getFirstEditTimestamp() {
4458 if ( $this->getId() == 0 ) {
4459 return false; // anons
4461 $dbr = wfGetDB( DB_SLAVE
);
4462 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4463 array( 'rev_user' => $this->getId() ),
4465 array( 'ORDER BY' => 'rev_timestamp ASC' )
4468 return false; // no edits
4470 return wfTimestamp( TS_MW
, $time );
4474 * Get the permissions associated with a given list of groups
4476 * @param array $groups Array of Strings List of internal group names
4477 * @return array Array of Strings List of permission key names for given groups combined
4479 public static function getGroupPermissions( $groups ) {
4480 global $wgGroupPermissions, $wgRevokePermissions;
4482 // grant every granted permission first
4483 foreach ( $groups as $group ) {
4484 if ( isset( $wgGroupPermissions[$group] ) ) {
4485 $rights = array_merge( $rights,
4486 // array_filter removes empty items
4487 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4490 // now revoke the revoked permissions
4491 foreach ( $groups as $group ) {
4492 if ( isset( $wgRevokePermissions[$group] ) ) {
4493 $rights = array_diff( $rights,
4494 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4497 return array_unique( $rights );
4501 * Get all the groups who have a given permission
4503 * @param string $role Role to check
4504 * @return array Array of Strings List of internal group names with the given permission
4506 public static function getGroupsWithPermission( $role ) {
4507 global $wgGroupPermissions;
4508 $allowedGroups = array();
4509 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4510 if ( self
::groupHasPermission( $group, $role ) ) {
4511 $allowedGroups[] = $group;
4514 return $allowedGroups;
4518 * Check, if the given group has the given permission
4520 * If you're wanting to check whether all users have a permission, use
4521 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4525 * @param string $group Group to check
4526 * @param string $role Role to check
4529 public static function groupHasPermission( $group, $role ) {
4530 global $wgGroupPermissions, $wgRevokePermissions;
4531 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4532 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4536 * Check if all users have the given permission
4539 * @param string $right Right to check
4542 public static function isEveryoneAllowed( $right ) {
4543 global $wgGroupPermissions, $wgRevokePermissions;
4544 static $cache = array();
4546 // Use the cached results, except in unit tests which rely on
4547 // being able change the permission mid-request
4548 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4549 return $cache[$right];
4552 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4553 $cache[$right] = false;
4557 // If it's revoked anywhere, then everyone doesn't have it
4558 foreach ( $wgRevokePermissions as $rights ) {
4559 if ( isset( $rights[$right] ) && $rights[$right] ) {
4560 $cache[$right] = false;
4565 // Allow extensions (e.g. OAuth) to say false
4566 if ( !Hooks
::run( 'UserIsEveryoneAllowed', array( $right ) ) ) {
4567 $cache[$right] = false;
4571 $cache[$right] = true;
4576 * Get the localized descriptive name for a group, if it exists
4578 * @param string $group Internal group name
4579 * @return string Localized descriptive group name
4581 public static function getGroupName( $group ) {
4582 $msg = wfMessage( "group-$group" );
4583 return $msg->isBlank() ?
$group : $msg->text();
4587 * Get the localized descriptive name for a member of a group, if it exists
4589 * @param string $group Internal group name
4590 * @param string $username Username for gender (since 1.19)
4591 * @return string Localized name for group member
4593 public static function getGroupMember( $group, $username = '#' ) {
4594 $msg = wfMessage( "group-$group-member", $username );
4595 return $msg->isBlank() ?
$group : $msg->text();
4599 * Return the set of defined explicit groups.
4600 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4601 * are not included, as they are defined automatically, not in the database.
4602 * @return array Array of internal group names
4604 public static function getAllGroups() {
4605 global $wgGroupPermissions, $wgRevokePermissions;
4607 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4608 self
::getImplicitGroups()
4613 * Get a list of all available permissions.
4614 * @return string[] Array of permission names
4616 public static function getAllRights() {
4617 if ( self
::$mAllRights === false ) {
4618 global $wgAvailableRights;
4619 if ( count( $wgAvailableRights ) ) {
4620 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4622 self
::$mAllRights = self
::$mCoreRights;
4624 Hooks
::run( 'UserGetAllRights', array( &self
::$mAllRights ) );
4626 return self
::$mAllRights;
4630 * Get a list of implicit groups
4631 * @return array Array of Strings Array of internal group names
4633 public static function getImplicitGroups() {
4634 global $wgImplicitGroups;
4636 $groups = $wgImplicitGroups;
4637 # Deprecated, use $wgImplicitGroups instead
4638 Hooks
::run( 'UserGetImplicitGroups', array( &$groups ), '1.25' );
4644 * Get the title of a page describing a particular group
4646 * @param string $group Internal group name
4647 * @return Title|bool Title of the page if it exists, false otherwise
4649 public static function getGroupPage( $group ) {
4650 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4651 if ( $msg->exists() ) {
4652 $title = Title
::newFromText( $msg->text() );
4653 if ( is_object( $title ) ) {
4661 * Create a link to the group in HTML, if available;
4662 * else return the group name.
4664 * @param string $group Internal name of the group
4665 * @param string $text The text of the link
4666 * @return string HTML link to the group
4668 public static function makeGroupLinkHTML( $group, $text = '' ) {
4669 if ( $text == '' ) {
4670 $text = self
::getGroupName( $group );
4672 $title = self
::getGroupPage( $group );
4674 return Linker
::link( $title, htmlspecialchars( $text ) );
4676 return htmlspecialchars( $text );
4681 * Create a link to the group in Wikitext, if available;
4682 * else return the group name.
4684 * @param string $group Internal name of the group
4685 * @param string $text The text of the link
4686 * @return string Wikilink to the group
4688 public static function makeGroupLinkWiki( $group, $text = '' ) {
4689 if ( $text == '' ) {
4690 $text = self
::getGroupName( $group );
4692 $title = self
::getGroupPage( $group );
4694 $page = $title->getFullText();
4695 return "[[$page|$text]]";
4702 * Returns an array of the groups that a particular group can add/remove.
4704 * @param string $group The group to check for whether it can add/remove
4705 * @return array Array( 'add' => array( addablegroups ),
4706 * 'remove' => array( removablegroups ),
4707 * 'add-self' => array( addablegroups to self),
4708 * 'remove-self' => array( removable groups from self) )
4710 public static function changeableByGroup( $group ) {
4711 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4715 'remove' => array(),
4716 'add-self' => array(),
4717 'remove-self' => array()
4720 if ( empty( $wgAddGroups[$group] ) ) {
4721 // Don't add anything to $groups
4722 } elseif ( $wgAddGroups[$group] === true ) {
4723 // You get everything
4724 $groups['add'] = self
::getAllGroups();
4725 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4726 $groups['add'] = $wgAddGroups[$group];
4729 // Same thing for remove
4730 if ( empty( $wgRemoveGroups[$group] ) ) {
4732 } elseif ( $wgRemoveGroups[$group] === true ) {
4733 $groups['remove'] = self
::getAllGroups();
4734 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4735 $groups['remove'] = $wgRemoveGroups[$group];
4738 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4739 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4740 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4741 if ( is_int( $key ) ) {
4742 $wgGroupsAddToSelf['user'][] = $value;
4747 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4748 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4749 if ( is_int( $key ) ) {
4750 $wgGroupsRemoveFromSelf['user'][] = $value;
4755 // Now figure out what groups the user can add to him/herself
4756 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4758 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4759 // No idea WHY this would be used, but it's there
4760 $groups['add-self'] = User
::getAllGroups();
4761 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4762 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4765 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4767 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4768 $groups['remove-self'] = User
::getAllGroups();
4769 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4770 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4777 * Returns an array of groups that this user can add and remove
4778 * @return array Array( 'add' => array( addablegroups ),
4779 * 'remove' => array( removablegroups ),
4780 * 'add-self' => array( addablegroups to self),
4781 * 'remove-self' => array( removable groups from self) )
4783 public function changeableGroups() {
4784 if ( $this->isAllowed( 'userrights' ) ) {
4785 // This group gives the right to modify everything (reverse-
4786 // compatibility with old "userrights lets you change
4788 // Using array_merge to make the groups reindexed
4789 $all = array_merge( User
::getAllGroups() );
4793 'add-self' => array(),
4794 'remove-self' => array()
4798 // Okay, it's not so simple, we will have to go through the arrays
4801 'remove' => array(),
4802 'add-self' => array(),
4803 'remove-self' => array()
4805 $addergroups = $this->getEffectiveGroups();
4807 foreach ( $addergroups as $addergroup ) {
4808 $groups = array_merge_recursive(
4809 $groups, $this->changeableByGroup( $addergroup )
4811 $groups['add'] = array_unique( $groups['add'] );
4812 $groups['remove'] = array_unique( $groups['remove'] );
4813 $groups['add-self'] = array_unique( $groups['add-self'] );
4814 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4820 * Deferred version of incEditCountImmediate()
4822 public function incEditCount() {
4824 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle( function() use ( $that ) {
4825 $that->incEditCountImmediate();
4830 * Increment the user's edit-count field.
4831 * Will have no effect for anonymous users.
4834 public function incEditCountImmediate() {
4835 if ( $this->isAnon() ) {
4839 $dbw = wfGetDB( DB_MASTER
);
4840 // No rows will be "affected" if user_editcount is NULL
4843 array( 'user_editcount=user_editcount+1' ),
4844 array( 'user_id' => $this->getId() ),
4847 // Lazy initialization check...
4848 if ( $dbw->affectedRows() == 0 ) {
4849 // Now here's a goddamn hack...
4850 $dbr = wfGetDB( DB_SLAVE
);
4851 if ( $dbr !== $dbw ) {
4852 // If we actually have a slave server, the count is
4853 // at least one behind because the current transaction
4854 // has not been committed and replicated.
4855 $this->initEditCount( 1 );
4857 // But if DB_SLAVE is selecting the master, then the
4858 // count we just read includes the revision that was
4859 // just added in the working transaction.
4860 $this->initEditCount();
4863 // Edit count in user cache too
4864 $this->invalidateCache();
4868 * Initialize user_editcount from data out of the revision table
4870 * @param int $add Edits to add to the count from the revision table
4871 * @return int Number of edits
4873 protected function initEditCount( $add = 0 ) {
4874 // Pull from a slave to be less cruel to servers
4875 // Accuracy isn't the point anyway here
4876 $dbr = wfGetDB( DB_SLAVE
);
4877 $count = (int)$dbr->selectField(
4880 array( 'rev_user' => $this->getId() ),
4883 $count = $count +
$add;
4885 $dbw = wfGetDB( DB_MASTER
);
4888 array( 'user_editcount' => $count ),
4889 array( 'user_id' => $this->getId() ),
4897 * Get the description of a given right
4899 * @param string $right Right to query
4900 * @return string Localized description of the right
4902 public static function getRightDescription( $right ) {
4903 $key = "right-$right";
4904 $msg = wfMessage( $key );
4905 return $msg->isBlank() ?
$right : $msg->text();
4909 * Make a new-style password hash
4911 * @param string $password Plain-text password
4912 * @param bool|string $salt Optional salt, may be random or the user ID.
4913 * If unspecified or false, will generate one automatically
4914 * @return string Password hash
4915 * @deprecated since 1.24, use Password class
4917 public static function crypt( $password, $salt = false ) {
4918 wfDeprecated( __METHOD__
, '1.24' );
4919 $hash = self
::getPasswordFactory()->newFromPlaintext( $password );
4920 return $hash->toString();
4924 * Compare a password hash with a plain-text password. Requires the user
4925 * ID if there's a chance that the hash is an old-style hash.
4927 * @param string $hash Password hash
4928 * @param string $password Plain-text password to compare
4929 * @param string|bool $userId User ID for old-style password salt
4932 * @deprecated since 1.24, use Password class
4934 public static function comparePasswords( $hash, $password, $userId = false ) {
4935 wfDeprecated( __METHOD__
, '1.24' );
4937 // Check for *really* old password hashes that don't even have a type
4938 // The old hash format was just an md5 hex hash, with no type information
4939 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
4940 global $wgPasswordSalt;
4941 if ( $wgPasswordSalt ) {
4942 $password = ":B:{$userId}:{$hash}";
4944 $password = ":A:{$hash}";
4948 $hash = self
::getPasswordFactory()->newFromCiphertext( $hash );
4949 return $hash->equals( $password );
4953 * Add a newuser log entry for this user.
4954 * Before 1.19 the return value was always true.
4956 * @param string|bool $action Account creation type.
4957 * - String, one of the following values:
4958 * - 'create' for an anonymous user creating an account for himself.
4959 * This will force the action's performer to be the created user itself,
4960 * no matter the value of $wgUser
4961 * - 'create2' for a logged in user creating an account for someone else
4962 * - 'byemail' when the created user will receive its password by e-mail
4963 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4964 * - Boolean means whether the account was created by e-mail (deprecated):
4965 * - true will be converted to 'byemail'
4966 * - false will be converted to 'create' if this object is the same as
4967 * $wgUser and to 'create2' otherwise
4969 * @param string $reason User supplied reason
4971 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4973 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4974 global $wgUser, $wgNewUserLog;
4975 if ( empty( $wgNewUserLog ) ) {
4976 return true; // disabled
4979 if ( $action === true ) {
4980 $action = 'byemail';
4981 } elseif ( $action === false ) {
4982 if ( $this->equals( $wgUser ) ) {
4985 $action = 'create2';
4989 if ( $action === 'create' ||
$action === 'autocreate' ) {
4992 $performer = $wgUser;
4995 $logEntry = new ManualLogEntry( 'newusers', $action );
4996 $logEntry->setPerformer( $performer );
4997 $logEntry->setTarget( $this->getUserPage() );
4998 $logEntry->setComment( $reason );
4999 $logEntry->setParameters( array(
5000 '4::userid' => $this->getId(),
5002 $logid = $logEntry->insert();
5004 if ( $action !== 'autocreate' ) {
5005 $logEntry->publish( $logid );
5012 * Add an autocreate newuser log entry for this user
5013 * Used by things like CentralAuth and perhaps other authplugins.
5014 * Consider calling addNewUserLogEntry() directly instead.
5018 public function addNewUserLogEntryAutoCreate() {
5019 $this->addNewUserLogEntry( 'autocreate' );
5025 * Load the user options either from cache, the database or an array
5027 * @param array $data Rows for the current user out of the user_properties table
5029 protected function loadOptions( $data = null ) {
5034 if ( $this->mOptionsLoaded
) {
5038 $this->mOptions
= self
::getDefaultOptions();
5040 if ( !$this->getId() ) {
5041 // For unlogged-in users, load language/variant options from request.
5042 // There's no need to do it for logged-in users: they can set preferences,
5043 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5044 // so don't override user's choice (especially when the user chooses site default).
5045 $variant = $wgContLang->getDefaultVariant();
5046 $this->mOptions
['variant'] = $variant;
5047 $this->mOptions
['language'] = $variant;
5048 $this->mOptionsLoaded
= true;
5052 // Maybe load from the object
5053 if ( !is_null( $this->mOptionOverrides
) ) {
5054 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5055 foreach ( $this->mOptionOverrides
as $key => $value ) {
5056 $this->mOptions
[$key] = $value;
5059 if ( !is_array( $data ) ) {
5060 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5061 // Load from database
5062 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5063 ?
wfGetDB( DB_MASTER
)
5064 : wfGetDB( DB_SLAVE
);
5066 $res = $dbr->select(
5068 array( 'up_property', 'up_value' ),
5069 array( 'up_user' => $this->getId() ),
5073 $this->mOptionOverrides
= array();
5075 foreach ( $res as $row ) {
5076 $data[$row->up_property
] = $row->up_value
;
5079 foreach ( $data as $property => $value ) {
5080 $this->mOptionOverrides
[$property] = $value;
5081 $this->mOptions
[$property] = $value;
5085 $this->mOptionsLoaded
= true;
5087 Hooks
::run( 'UserLoadOptions', array( $this, &$this->mOptions
) );
5091 * Saves the non-default options for this user, as previously set e.g. via
5092 * setOption(), in the database's "user_properties" (preferences) table.
5093 * Usually used via saveSettings().
5095 protected function saveOptions() {
5096 $this->loadOptions();
5098 // Not using getOptions(), to keep hidden preferences in database
5099 $saveOptions = $this->mOptions
;
5101 // Allow hooks to abort, for instance to save to a global profile.
5102 // Reset options to default state before saving.
5103 if ( !Hooks
::run( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
5107 $userId = $this->getId();
5109 $insert_rows = array(); // all the new preference rows
5110 foreach ( $saveOptions as $key => $value ) {
5111 // Don't bother storing default values
5112 $defaultOption = self
::getDefaultOption( $key );
5113 if ( ( $defaultOption === null && $value !== false && $value !== null )
5114 ||
$value != $defaultOption
5116 $insert_rows[] = array(
5117 'up_user' => $userId,
5118 'up_property' => $key,
5119 'up_value' => $value,
5124 $dbw = wfGetDB( DB_MASTER
);
5126 $res = $dbw->select( 'user_properties',
5127 array( 'up_property', 'up_value' ), array( 'up_user' => $userId ), __METHOD__
);
5129 // Find prior rows that need to be removed or updated. These rows will
5130 // all be deleted (the later so that INSERT IGNORE applies the new values).
5131 $keysDelete = array();
5132 foreach ( $res as $row ) {
5133 if ( !isset( $saveOptions[$row->up_property
] )
5134 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5136 $keysDelete[] = $row->up_property
;
5140 if ( count( $keysDelete ) ) {
5141 // Do the DELETE by PRIMARY KEY for prior rows.
5142 // In the past a very large portion of calls to this function are for setting
5143 // 'rememberpassword' for new accounts (a preference that has since been removed).
5144 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5145 // caused gap locks on [max user ID,+infinity) which caused high contention since
5146 // updates would pile up on each other as they are for higher (newer) user IDs.
5147 // It might not be necessary these days, but it shouldn't hurt either.
5148 $dbw->delete( 'user_properties',
5149 array( 'up_user' => $userId, 'up_property' => $keysDelete ), __METHOD__
);
5151 // Insert the new preference rows
5152 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, array( 'IGNORE' ) );
5156 * Lazily instantiate and return a factory object for making passwords
5158 * @return PasswordFactory
5160 public static function getPasswordFactory() {
5161 if ( self
::$mPasswordFactory === null ) {
5162 self
::$mPasswordFactory = new PasswordFactory();
5163 self
::$mPasswordFactory->init( RequestContext
::getMain()->getConfig() );
5166 return self
::$mPasswordFactory;
5170 * Provide an array of HTML5 attributes to put on an input element
5171 * intended for the user to enter a new password. This may include
5172 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5174 * Do *not* use this when asking the user to enter his current password!
5175 * Regardless of configuration, users may have invalid passwords for whatever
5176 * reason (e.g., they were set before requirements were tightened up).
5177 * Only use it when asking for a new password, like on account creation or
5180 * Obviously, you still need to do server-side checking.
5182 * NOTE: A combination of bugs in various browsers means that this function
5183 * actually just returns array() unconditionally at the moment. May as
5184 * well keep it around for when the browser bugs get fixed, though.
5186 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5188 * @return array Array of HTML attributes suitable for feeding to
5189 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5190 * That will get confused by the boolean attribute syntax used.)
5192 public static function passwordChangeInputAttribs() {
5193 global $wgMinimalPasswordLength;
5195 if ( $wgMinimalPasswordLength == 0 ) {
5199 # Note that the pattern requirement will always be satisfied if the
5200 # input is empty, so we need required in all cases.
5202 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5203 # if e-mail confirmation is being used. Since HTML5 input validation
5204 # is b0rked anyway in some browsers, just return nothing. When it's
5205 # re-enabled, fix this code to not output required for e-mail
5207 #$ret = array( 'required' );
5210 # We can't actually do this right now, because Opera 9.6 will print out
5211 # the entered password visibly in its error message! When other
5212 # browsers add support for this attribute, or Opera fixes its support,
5213 # we can add support with a version check to avoid doing this on Opera
5214 # versions where it will be a problem. Reported to Opera as
5215 # DSK-262266, but they don't have a public bug tracker for us to follow.
5217 if ( $wgMinimalPasswordLength > 1 ) {
5218 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5219 $ret['title'] = wfMessage( 'passwordtooshort' )
5220 ->numParams( $wgMinimalPasswordLength )->text();
5228 * Return the list of user fields that should be selected to create
5229 * a new user object.
5232 public static function selectFields() {
5240 'user_email_authenticated',
5242 'user_email_token_expires',
5243 'user_registration',
5249 * Factory function for fatal permission-denied errors
5252 * @param string $permission User right required
5255 static function newFatalPermissionDeniedStatus( $permission ) {
5258 $groups = array_map(
5259 array( 'User', 'makeGroupLinkWiki' ),
5260 User
::getGroupsWithPermission( $permission )
5264 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5266 return Status
::newFatal( 'badaccess-group0' );
5271 * Checks if two user objects point to the same user.
5277 public function equals( User
$user ) {
5278 return $this->getName() === $user->getName();