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 /** @name Cache variables */
195 * @todo Make this actually private
201 * @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
524 public static function newFromConfirmationCode( $code ) {
525 $dbr = wfGetDB( DB_SLAVE
);
526 $id = $dbr->selectField( 'user', 'user_id', array(
527 'user_email_token' => md5( $code ),
528 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
530 if ( $id !== false ) {
531 return User
::newFromId( $id );
538 * Create a new user object using data from session or cookies. If the
539 * login credentials are invalid, the result is an anonymous user.
541 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
544 public static function newFromSession( WebRequest
$request = null ) {
546 $user->mFrom
= 'session';
547 $user->mRequest
= $request;
552 * Create a new user object from a user row.
553 * The row should have the following fields from the user table in it:
554 * - either user_name or user_id to load further data if needed (or both)
556 * - all other fields (email, password, etc.)
557 * It is useless to provide the remaining fields if either user_id,
558 * user_name and user_real_name are not provided because the whole row
559 * will be loaded once more from the database when accessing them.
561 * @param stdClass $row A row from the user table
562 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
565 public static function newFromRow( $row, $data = null ) {
567 $user->loadFromRow( $row, $data );
574 * Get the username corresponding to a given user ID
575 * @param int $id User ID
576 * @return string|bool The corresponding username
578 public static function whoIs( $id ) {
579 return UserCache
::singleton()->getProp( $id, 'name' );
583 * Get the real name of a user given their user ID
585 * @param int $id User ID
586 * @return string|bool The corresponding user's real name
588 public static function whoIsReal( $id ) {
589 return UserCache
::singleton()->getProp( $id, 'real_name' );
593 * Get database id given a user name
594 * @param string $name Username
595 * @param integer $flags User::READ_* constant bitfield
596 * @return int|null The corresponding user's ID, or null if user is nonexistent
598 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
599 $nt = Title
::makeTitleSafe( NS_USER
, $name );
600 if ( is_null( $nt ) ) {
605 if ( isset( self
::$idCacheByName[$name] ) ) {
606 return self
::$idCacheByName[$name];
609 $db = ( $flags & self
::READ_LATEST
)
610 ?
wfGetDB( DB_MASTER
)
611 : wfGetDB( DB_SLAVE
);
616 array( 'user_name' => $nt->getText() ),
620 if ( $s === false ) {
623 $result = $s->user_id
;
626 self
::$idCacheByName[$name] = $result;
628 if ( count( self
::$idCacheByName ) > 1000 ) {
629 self
::$idCacheByName = array();
636 * Reset the cache used in idFromName(). For use in tests.
638 public static function resetIdByNameCache() {
639 self
::$idCacheByName = array();
643 * Does the string match an anonymous IPv4 address?
645 * This function exists for username validation, in order to reject
646 * usernames which are similar in form to IP addresses. Strings such
647 * as 300.300.300.300 will return true because it looks like an IP
648 * address, despite not being strictly valid.
650 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
651 * address because the usemod software would "cloak" anonymous IP
652 * addresses like this, if we allowed accounts like this to be created
653 * new users could get the old edits of these anonymous users.
655 * @param string $name Name to match
658 public static function isIP( $name ) {
659 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
660 || IP
::isIPv6( $name );
664 * Is the input a valid username?
666 * Checks if the input is a valid username, we don't want an empty string,
667 * an IP address, anything that contains slashes (would mess up subpages),
668 * is longer than the maximum allowed username size or doesn't begin with
671 * @param string $name Name to match
674 public static function isValidUserName( $name ) {
675 global $wgContLang, $wgMaxNameChars;
678 || User
::isIP( $name )
679 ||
strpos( $name, '/' ) !== false
680 ||
strlen( $name ) > $wgMaxNameChars
681 ||
$name != $wgContLang->ucfirst( $name )
683 wfDebugLog( 'username', __METHOD__
.
684 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
688 // Ensure that the name can't be misresolved as a different title,
689 // such as with extra namespace keys at the start.
690 $parsed = Title
::newFromText( $name );
691 if ( is_null( $parsed )
692 ||
$parsed->getNamespace()
693 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
694 wfDebugLog( 'username', __METHOD__
.
695 ": '$name' invalid due to ambiguous prefixes" );
699 // Check an additional blacklist of troublemaker characters.
700 // Should these be merged into the title char list?
701 $unicodeBlacklist = '/[' .
702 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
703 '\x{00a0}' . # non-breaking space
704 '\x{2000}-\x{200f}' . # various whitespace
705 '\x{2028}-\x{202f}' . # breaks and control chars
706 '\x{3000}' . # ideographic space
707 '\x{e000}-\x{f8ff}' . # private use
709 if ( preg_match( $unicodeBlacklist, $name ) ) {
710 wfDebugLog( 'username', __METHOD__
.
711 ": '$name' invalid due to blacklisted characters" );
719 * Usernames which fail to pass this function will be blocked
720 * from user login and new account registrations, but may be used
721 * internally by batch processes.
723 * If an account already exists in this form, login will be blocked
724 * by a failure to pass this function.
726 * @param string $name Name to match
729 public static function isUsableName( $name ) {
730 global $wgReservedUsernames;
731 // Must be a valid username, obviously ;)
732 if ( !self
::isValidUserName( $name ) ) {
736 static $reservedUsernames = false;
737 if ( !$reservedUsernames ) {
738 $reservedUsernames = $wgReservedUsernames;
739 Hooks
::run( 'UserGetReservedNames', array( &$reservedUsernames ) );
742 // Certain names may be reserved for batch processes.
743 foreach ( $reservedUsernames as $reserved ) {
744 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
745 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
747 if ( $reserved == $name ) {
755 * Usernames which fail to pass this function will be blocked
756 * from new account registrations, but may be used internally
757 * either by batch processes or by user accounts which have
758 * already been created.
760 * Additional blacklisting may be added here rather than in
761 * isValidUserName() to avoid disrupting existing accounts.
763 * @param string $name String to match
766 public static function isCreatableName( $name ) {
767 global $wgInvalidUsernameCharacters;
769 // Ensure that the username isn't longer than 235 bytes, so that
770 // (at least for the builtin skins) user javascript and css files
771 // will work. (bug 23080)
772 if ( strlen( $name ) > 235 ) {
773 wfDebugLog( 'username', __METHOD__
.
774 ": '$name' invalid due to length" );
778 // Preg yells if you try to give it an empty string
779 if ( $wgInvalidUsernameCharacters !== '' ) {
780 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
781 wfDebugLog( 'username', __METHOD__
.
782 ": '$name' invalid due to wgInvalidUsernameCharacters" );
787 return self
::isUsableName( $name );
791 * Is the input a valid password for this user?
793 * @param string $password Desired password
796 public function isValidPassword( $password ) {
797 //simple boolean wrapper for getPasswordValidity
798 return $this->getPasswordValidity( $password ) === true;
803 * Given unvalidated password input, return error message on failure.
805 * @param string $password Desired password
806 * @return bool|string|array True on success, string or array of error message on failure
808 public function getPasswordValidity( $password ) {
809 $result = $this->checkPasswordValidity( $password );
810 if ( $result->isGood() ) {
814 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
815 $messages[] = $error['message'];
817 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
818 $messages[] = $warning['message'];
820 if ( count( $messages ) === 1 ) {
828 * Check if this is a valid password for this user
830 * Create a Status object based on the password's validity.
831 * The Status should be set to fatal if the user should not
832 * be allowed to log in, and should have any errors that
833 * would block changing the password.
835 * If the return value of this is not OK, the password
836 * should not be checked. If the return value is not Good,
837 * the password can be checked, but the user should not be
838 * able to set their password to this.
840 * @param string $password Desired password
844 public function checkPasswordValidity( $password ) {
845 global $wgPasswordPolicy;
847 $upp = new UserPasswordPolicy(
848 $wgPasswordPolicy['policies'],
849 $wgPasswordPolicy['checks']
852 $status = Status
::newGood();
853 $result = false; //init $result to false for the internal checks
855 if ( !Hooks
::run( 'isValidPassword', array( $password, &$result, $this ) ) ) {
856 $status->error( $result );
860 if ( $result === false ) {
861 $status->merge( $upp->checkUserPassword( $this, $password ) );
863 } elseif ( $result === true ) {
866 $status->error( $result );
867 return $status; //the isValidPassword hook set a string $result and returned true
872 * Expire a user's password
874 * @param int $ts Optional timestamp to convert, default 0 for the current time
876 public function expirePassword( $ts = 0 ) {
877 $this->loadPasswords();
878 $timestamp = wfTimestamp( TS_MW
, $ts );
879 $this->mPasswordExpires
= $timestamp;
880 $this->saveSettings();
884 * Clear the password expiration for a user
886 * @param bool $load Ensure user object is loaded first
888 public function resetPasswordExpiration( $load = true ) {
889 global $wgPasswordExpirationDays;
894 if ( $wgPasswordExpirationDays ) {
895 $newExpire = wfTimestamp(
897 time() +
( $wgPasswordExpirationDays * 24 * 3600 )
900 // Give extensions a chance to force an expiration
901 Hooks
::run( 'ResetPasswordExpiration', array( $this, &$newExpire ) );
902 $this->mPasswordExpires
= $newExpire;
906 * Check if the user's password is expired.
907 * TODO: Put this and password length into a PasswordPolicy object
909 * @return string|bool The expiration type, or false if not expired
910 * hard: A password change is required to login
911 * soft: Allow login, but encourage password change
912 * false: Password is not expired
914 public function getPasswordExpired() {
915 global $wgPasswordExpireGrace;
917 $now = wfTimestamp();
918 $expiration = $this->getPasswordExpireDate();
919 $expUnix = wfTimestamp( TS_UNIX
, $expiration );
920 if ( $expiration !== null && $expUnix < $now ) {
921 $expired = ( $expUnix +
$wgPasswordExpireGrace < $now ) ?
'hard' : 'soft';
927 * Get this user's password expiration date. Since this may be using
928 * the cached User object, we assume that whatever mechanism is setting
929 * the expiration date is also expiring the User cache.
931 * @return string|bool The datestamp of the expiration, or null if not set
933 public function getPasswordExpireDate() {
935 return $this->mPasswordExpires
;
939 * Given unvalidated user input, return a canonical username, or false if
940 * the username is invalid.
941 * @param string $name User input
942 * @param string|bool $validate Type of validation to use:
943 * - false No validation
944 * - 'valid' Valid for batch processes
945 * - 'usable' Valid for batch processes and login
946 * - 'creatable' Valid for batch processes, login and account creation
948 * @throws InvalidArgumentException
949 * @return bool|string
951 public static function getCanonicalName( $name, $validate = 'valid' ) {
952 // Force usernames to capital
954 $name = $wgContLang->ucfirst( $name );
956 # Reject names containing '#'; these will be cleaned up
957 # with title normalisation, but then it's too late to
959 if ( strpos( $name, '#' ) !== false ) {
963 // Clean up name according to title rules,
964 // but only when validation is requested (bug 12654)
965 $t = ( $validate !== false ) ?
966 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
967 // Check for invalid titles
968 if ( is_null( $t ) ) {
972 // Reject various classes of invalid names
974 $name = $wgAuth->getCanonicalName( $t->getText() );
976 switch ( $validate ) {
980 if ( !User
::isValidUserName( $name ) ) {
985 if ( !User
::isUsableName( $name ) ) {
990 if ( !User
::isCreatableName( $name ) ) {
995 throw new InvalidArgumentException(
996 'Invalid parameter value for $validate in ' . __METHOD__
);
1002 * Count the number of edits of a user
1004 * @param int $uid User ID to check
1005 * @return int The user's edit count
1007 * @deprecated since 1.21 in favour of User::getEditCount
1009 public static function edits( $uid ) {
1010 wfDeprecated( __METHOD__
, '1.21' );
1011 $user = self
::newFromId( $uid );
1012 return $user->getEditCount();
1016 * Return a random password.
1018 * @return string New random password
1020 public static function randomPassword() {
1021 global $wgMinimalPasswordLength;
1022 // Decide the final password length based on our min password length,
1023 // stopping at a minimum of 10 chars.
1024 $length = max( 10, $wgMinimalPasswordLength );
1025 // Multiply by 1.25 to get the number of hex characters we need
1026 $length = $length * 1.25;
1027 // Generate random hex chars
1028 $hex = MWCryptRand
::generateHex( $length );
1029 // Convert from base 16 to base 32 to get a proper password like string
1030 return wfBaseConvert( $hex, 16, 32 );
1034 * Set cached properties to default.
1036 * @note This no longer clears uncached lazy-initialised properties;
1037 * the constructor does that instead.
1039 * @param string|bool $name
1041 public function loadDefaults( $name = false ) {
1043 $passwordFactory = self
::getPasswordFactory();
1046 $this->mName
= $name;
1047 $this->mRealName
= '';
1048 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1049 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1050 $this->mNewpassTime
= null;
1052 $this->mOptionOverrides
= null;
1053 $this->mOptionsLoaded
= false;
1055 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
1056 if ( $loggedOut !== null ) {
1057 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1059 $this->mTouched
= '1'; # Allow any pages to be cached
1062 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1063 $this->mEmailAuthenticated
= null;
1064 $this->mEmailToken
= '';
1065 $this->mEmailTokenExpires
= null;
1066 $this->mPasswordExpires
= null;
1067 $this->resetPasswordExpiration( false );
1068 $this->mRegistration
= wfTimestamp( TS_MW
);
1069 $this->mGroups
= array();
1071 Hooks
::run( 'UserLoadDefaults', array( $this, $name ) );
1075 * Return whether an item has been loaded.
1077 * @param string $item Item to check. Current possibilities:
1081 * @param string $all 'all' to check if the whole object has been loaded
1082 * or any other string to check if only the item is available (e.g.
1086 public function isItemLoaded( $item, $all = 'all' ) {
1087 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1088 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1092 * Set that an item has been loaded
1094 * @param string $item
1096 protected function setItemLoaded( $item ) {
1097 if ( is_array( $this->mLoadedItems
) ) {
1098 $this->mLoadedItems
[$item] = true;
1103 * Load user data from the session or login cookie.
1105 * @return bool True if the user is logged in, false otherwise.
1107 private function loadFromSession() {
1109 Hooks
::run( 'UserLoadFromSession', array( $this, &$result ) );
1110 if ( $result !== null ) {
1114 $request = $this->getRequest();
1116 $cookieId = $request->getCookie( 'UserID' );
1117 $sessId = $request->getSessionData( 'wsUserID' );
1119 if ( $cookieId !== null ) {
1120 $sId = intval( $cookieId );
1121 if ( $sessId !== null && $cookieId != $sessId ) {
1122 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
1123 cookie user ID ($sId) don't match!" );
1126 $request->setSessionData( 'wsUserID', $sId );
1127 } elseif ( $sessId !== null && $sessId != 0 ) {
1133 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
1134 $sName = $request->getSessionData( 'wsUserName' );
1135 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
1136 $sName = $request->getCookie( 'UserName' );
1137 $request->setSessionData( 'wsUserName', $sName );
1142 $proposedUser = User
::newFromId( $sId );
1143 if ( !$proposedUser->isLoggedIn() ) {
1148 global $wgBlockDisablesLogin;
1149 if ( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
1150 // User blocked and we've disabled blocked user logins
1154 if ( $request->getSessionData( 'wsToken' ) ) {
1156 ( $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ) );
1158 } elseif ( $request->getCookie( 'Token' ) ) {
1159 # Get the token from DB/cache and clean it up to remove garbage padding.
1160 # This deals with historical problems with bugs and the default column value.
1161 $token = rtrim( $proposedUser->getToken( false ) ); // correct token
1162 // Make comparison in constant time (bug 61346)
1163 $passwordCorrect = strlen( $token )
1164 && hash_equals( $token, $request->getCookie( 'Token' ) );
1167 // No session or persistent login cookie
1171 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1172 $this->loadFromUserObject( $proposedUser );
1173 $request->setSessionData( 'wsToken', $this->mToken
);
1174 wfDebug( "User: logged in from $from\n" );
1177 // Invalid credentials
1178 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1184 * Load user and user_group data from the database.
1185 * $this->mId must be set, this is how the user is identified.
1187 * @param integer $flags User::READ_* constant bitfield
1188 * @return bool True if the user exists, false if the user is anonymous
1190 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1192 $this->mId
= intval( $this->mId
);
1195 if ( !$this->mId
) {
1196 $this->loadDefaults();
1200 $db = ( $flags & self
::READ_LATEST
)
1201 ?
wfGetDB( DB_MASTER
)
1202 : wfGetDB( DB_SLAVE
);
1204 $s = $db->selectRow(
1206 self
::selectFields(),
1207 array( 'user_id' => $this->mId
),
1209 ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
1210 ?
array( 'LOCK IN SHARE MODE' )
1214 $this->queryFlagsUsed
= $flags;
1215 Hooks
::run( 'UserLoadFromDatabase', array( $this, &$s ) );
1217 if ( $s !== false ) {
1218 // Initialise user table data
1219 $this->loadFromRow( $s );
1220 $this->mGroups
= null; // deferred
1221 $this->getEditCount(); // revalidation for nulls
1226 $this->loadDefaults();
1232 * Initialize this object from a row from the user table.
1234 * @param stdClass $row Row from the user table to load.
1235 * @param array $data Further user data to load into the object
1237 * user_groups Array with groups out of the user_groups table
1238 * user_properties Array with properties out of the user_properties table
1240 protected function loadFromRow( $row, $data = null ) {
1242 $passwordFactory = self
::getPasswordFactory();
1244 $this->mGroups
= null; // deferred
1246 if ( isset( $row->user_name
) ) {
1247 $this->mName
= $row->user_name
;
1248 $this->mFrom
= 'name';
1249 $this->setItemLoaded( 'name' );
1254 if ( isset( $row->user_real_name
) ) {
1255 $this->mRealName
= $row->user_real_name
;
1256 $this->setItemLoaded( 'realname' );
1261 if ( isset( $row->user_id
) ) {
1262 $this->mId
= intval( $row->user_id
);
1263 $this->mFrom
= 'id';
1264 $this->setItemLoaded( 'id' );
1269 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1270 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1273 if ( isset( $row->user_editcount
) ) {
1274 $this->mEditCount
= $row->user_editcount
;
1279 if ( isset( $row->user_password
) ) {
1280 // Check for *really* old password hashes that don't even have a type
1281 // The old hash format was just an md5 hex hash, with no type information
1282 if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password
) ) {
1283 $row->user_password
= ":A:{$this->mId}:{$row->user_password}";
1287 $this->mPassword
= $passwordFactory->newFromCiphertext( $row->user_password
);
1288 } catch ( PasswordError
$e ) {
1289 wfDebug( 'Invalid password hash found in database.' );
1290 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1294 $this->mNewpassword
= $passwordFactory->newFromCiphertext( $row->user_newpassword
);
1295 } catch ( PasswordError
$e ) {
1296 wfDebug( 'Invalid password hash found in database.' );
1297 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1300 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1301 $this->mPasswordExpires
= wfTimestampOrNull( TS_MW
, $row->user_password_expires
);
1304 if ( isset( $row->user_email
) ) {
1305 $this->mEmail
= $row->user_email
;
1306 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1307 $this->mToken
= $row->user_token
;
1308 if ( $this->mToken
== '' ) {
1309 $this->mToken
= null;
1311 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1312 $this->mEmailToken
= $row->user_email_token
;
1313 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1314 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1320 $this->mLoadedItems
= true;
1323 if ( is_array( $data ) ) {
1324 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1325 $this->mGroups
= $data['user_groups'];
1327 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1328 $this->loadOptions( $data['user_properties'] );
1334 * Load the data for this user object from another user object.
1338 protected function loadFromUserObject( $user ) {
1340 $user->loadGroups();
1341 $user->loadOptions();
1342 foreach ( self
::$mCacheVars as $var ) {
1343 $this->$var = $user->$var;
1348 * Load the groups from the database if they aren't already loaded.
1350 private function loadGroups() {
1351 if ( is_null( $this->mGroups
) ) {
1352 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1353 ?
wfGetDB( DB_MASTER
)
1354 : wfGetDB( DB_SLAVE
);
1355 $res = $db->select( 'user_groups',
1356 array( 'ug_group' ),
1357 array( 'ug_user' => $this->mId
),
1359 $this->mGroups
= array();
1360 foreach ( $res as $row ) {
1361 $this->mGroups
[] = $row->ug_group
;
1367 * Load the user's password hashes from the database
1369 * This is usually called in a scenario where the actual User object was
1370 * loaded from the cache, and then password comparison needs to be performed.
1371 * Password hashes are not stored in memcached.
1375 private function loadPasswords() {
1376 if ( $this->getId() !== 0 &&
1377 ( $this->mPassword
=== null ||
$this->mNewpassword
=== null )
1379 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1380 ?
wfGetDB( DB_MASTER
)
1381 : wfGetDB( DB_SLAVE
);
1383 $this->loadFromRow( $db->selectRow(
1385 array( 'user_password', 'user_newpassword',
1386 'user_newpass_time', 'user_password_expires' ),
1387 array( 'user_id' => $this->getId() ),
1394 * Add the user to the group if he/she meets given criteria.
1396 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1397 * possible to remove manually via Special:UserRights. In such case it
1398 * will not be re-added automatically. The user will also not lose the
1399 * group if they no longer meet the criteria.
1401 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1403 * @return array Array of groups the user has been promoted to.
1405 * @see $wgAutopromoteOnce
1407 public function addAutopromoteOnceGroups( $event ) {
1408 global $wgAutopromoteOnceLogInRC, $wgAuth;
1410 if ( wfReadOnly() ||
!$this->getId() ) {
1414 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1415 if ( !count( $toPromote ) ) {
1419 if ( !$this->checkAndSetTouched() ) {
1420 return array(); // raced out (bug T48834)
1423 $oldGroups = $this->getGroups(); // previous groups
1424 foreach ( $toPromote as $group ) {
1425 $this->addGroup( $group );
1428 // update groups in external authentication database
1429 $wgAuth->updateExternalDBGroups( $this, $toPromote );
1431 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1433 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1434 $logEntry->setPerformer( $this );
1435 $logEntry->setTarget( $this->getUserPage() );
1436 $logEntry->setParameters( array(
1437 '4::oldgroups' => $oldGroups,
1438 '5::newgroups' => $newGroups,
1440 $logid = $logEntry->insert();
1441 if ( $wgAutopromoteOnceLogInRC ) {
1442 $logEntry->publish( $logid );
1449 * Bump user_touched if it didn't change since this object was loaded
1451 * On success, the mTouched field is updated.
1452 * The user serialization cache is always cleared.
1454 * @return bool Whether user_touched was actually updated
1457 protected function checkAndSetTouched() {
1460 if ( !$this->mId
) {
1461 return false; // anon
1464 // Get a new user_touched that is higher than the old one
1465 $oldTouched = $this->mTouched
;
1466 $newTouched = $this->newTouchedTimestamp();
1468 $dbw = wfGetDB( DB_MASTER
);
1469 $dbw->update( 'user',
1470 array( 'user_touched' => $dbw->timestamp( $newTouched ) ),
1472 'user_id' => $this->mId
,
1473 'user_touched' => $dbw->timestamp( $oldTouched ) // CAS check
1477 $success = ( $dbw->affectedRows() > 0 );
1480 $this->mTouched
= $newTouched;
1483 // Clears on failure too since that is desired if the cache is stale
1484 $this->clearSharedCache();
1490 * Clear various cached data stored in this object. The cache of the user table
1491 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1493 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1494 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1496 public function clearInstanceCache( $reloadFrom = false ) {
1497 $this->mNewtalk
= -1;
1498 $this->mDatePreference
= null;
1499 $this->mBlockedby
= -1; # Unset
1500 $this->mHash
= false;
1501 $this->mRights
= null;
1502 $this->mEffectiveGroups
= null;
1503 $this->mImplicitGroups
= null;
1504 $this->mGroups
= null;
1505 $this->mOptions
= null;
1506 $this->mOptionsLoaded
= false;
1507 $this->mEditCount
= null;
1509 if ( $reloadFrom ) {
1510 $this->mLoadedItems
= array();
1511 $this->mFrom
= $reloadFrom;
1516 * Combine the language default options with any site-specific options
1517 * and add the default language variants.
1519 * @return array Array of String options
1521 public static function getDefaultOptions() {
1522 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1524 static $defOpt = null;
1525 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1526 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1527 // mid-request and see that change reflected in the return value of this function.
1528 // Which is insane and would never happen during normal MW operation
1532 $defOpt = $wgDefaultUserOptions;
1533 // Default language setting
1534 $defOpt['language'] = $wgContLang->getCode();
1535 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1536 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1538 foreach ( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1539 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1541 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1543 Hooks
::run( 'UserGetDefaultOptions', array( &$defOpt ) );
1549 * Get a given default option value.
1551 * @param string $opt Name of option to retrieve
1552 * @return string Default option value
1554 public static function getDefaultOption( $opt ) {
1555 $defOpts = self
::getDefaultOptions();
1556 if ( isset( $defOpts[$opt] ) ) {
1557 return $defOpts[$opt];
1564 * Get blocking information
1565 * @param bool $bFromSlave Whether to check the slave database first.
1566 * To improve performance, non-critical checks are done against slaves.
1567 * Check when actually saving should be done against master.
1569 private function getBlockedStatus( $bFromSlave = true ) {
1570 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1572 if ( -1 != $this->mBlockedby
) {
1576 wfDebug( __METHOD__
. ": checking...\n" );
1578 // Initialize data...
1579 // Otherwise something ends up stomping on $this->mBlockedby when
1580 // things get lazy-loaded later, causing false positive block hits
1581 // due to -1 !== 0. Probably session-related... Nothing should be
1582 // overwriting mBlockedby, surely?
1585 # We only need to worry about passing the IP address to the Block generator if the
1586 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1587 # know which IP address they're actually coming from
1588 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1589 $ip = $this->getRequest()->getIP();
1595 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1598 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1599 && !in_array( $ip, $wgProxyWhitelist )
1602 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1604 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1605 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1606 $block->setTarget( $ip );
1607 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1609 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1610 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1611 $block->setTarget( $ip );
1615 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1616 if ( !$block instanceof Block
1617 && $wgApplyIpBlocksToXff
1619 && !$this->isAllowed( 'proxyunbannable' )
1620 && !in_array( $ip, $wgProxyWhitelist )
1622 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1623 $xff = array_map( 'trim', explode( ',', $xff ) );
1624 $xff = array_diff( $xff, array( $ip ) );
1625 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1626 $block = Block
::chooseBlock( $xffblocks, $xff );
1627 if ( $block instanceof Block
) {
1628 # Mangle the reason to alert the user that the block
1629 # originated from matching the X-Forwarded-For header.
1630 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1634 if ( $block instanceof Block
) {
1635 wfDebug( __METHOD__
. ": Found block.\n" );
1636 $this->mBlock
= $block;
1637 $this->mBlockedby
= $block->getByName();
1638 $this->mBlockreason
= $block->mReason
;
1639 $this->mHideName
= $block->mHideName
;
1640 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1642 $this->mBlockedby
= '';
1643 $this->mHideName
= 0;
1644 $this->mAllowUsertalk
= false;
1648 Hooks
::run( 'GetBlockedStatus', array( &$this ) );
1653 * Whether the given IP is in a DNS blacklist.
1655 * @param string $ip IP to check
1656 * @param bool $checkWhitelist Whether to check the whitelist first
1657 * @return bool True if blacklisted.
1659 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1660 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1662 if ( !$wgEnableDnsBlacklist ) {
1666 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1670 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1674 * Whether the given IP is in a given DNS blacklist.
1676 * @param string $ip IP to check
1677 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1678 * @return bool True if blacklisted.
1680 public function inDnsBlacklist( $ip, $bases ) {
1683 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1684 if ( IP
::isIPv4( $ip ) ) {
1685 // Reverse IP, bug 21255
1686 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1688 foreach ( (array)$bases as $base ) {
1690 // If we have an access key, use that too (ProjectHoneypot, etc.)
1691 if ( is_array( $base ) ) {
1692 if ( count( $base ) >= 2 ) {
1693 // Access key is 1, base URL is 0
1694 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1696 $host = "$ipReversed.{$base[0]}";
1699 $host = "$ipReversed.$base";
1703 $ipList = gethostbynamel( $host );
1706 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!" );
1710 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base." );
1719 * Check if an IP address is in the local proxy list
1725 public static function isLocallyBlockedProxy( $ip ) {
1726 global $wgProxyList;
1728 if ( !$wgProxyList ) {
1732 if ( !is_array( $wgProxyList ) ) {
1733 // Load from the specified file
1734 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1737 if ( !is_array( $wgProxyList ) ) {
1739 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1741 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1742 // Old-style flipped proxy list
1751 * Is this user subject to rate limiting?
1753 * @return bool True if rate limited
1755 public function isPingLimitable() {
1756 global $wgRateLimitsExcludedIPs;
1757 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1758 // No other good way currently to disable rate limits
1759 // for specific IPs. :P
1760 // But this is a crappy hack and should die.
1763 return !$this->isAllowed( 'noratelimit' );
1767 * Primitive rate limits: enforce maximum actions per time period
1768 * to put a brake on flooding.
1770 * The method generates both a generic profiling point and a per action one
1771 * (suffix being "-$action".
1773 * @note When using a shared cache like memcached, IP-address
1774 * last-hit counters will be shared across wikis.
1776 * @param string $action Action to enforce; 'edit' if unspecified
1777 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1778 * @return bool True if a rate limiter was tripped
1780 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1781 // Call the 'PingLimiter' hook
1783 if ( !Hooks
::run( 'PingLimiter', array( &$this, $action, &$result, $incrBy ) ) ) {
1787 global $wgRateLimits;
1788 if ( !isset( $wgRateLimits[$action] ) ) {
1792 // Some groups shouldn't trigger the ping limiter, ever
1793 if ( !$this->isPingLimitable() ) {
1799 $limits = $wgRateLimits[$action];
1801 $id = $this->getId();
1804 if ( isset( $limits['anon'] ) && $id == 0 ) {
1805 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1808 if ( isset( $limits['user'] ) && $id != 0 ) {
1809 $userLimit = $limits['user'];
1811 if ( $this->isNewbie() ) {
1812 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1813 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1815 if ( isset( $limits['ip'] ) ) {
1816 $ip = $this->getRequest()->getIP();
1817 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1819 if ( isset( $limits['subnet'] ) ) {
1820 $ip = $this->getRequest()->getIP();
1823 if ( IP
::isIPv6( $ip ) ) {
1824 $parts = IP
::parseRange( "$ip/64" );
1825 $subnet = $parts[0];
1826 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1828 $subnet = $matches[1];
1830 if ( $subnet !== false ) {
1831 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1835 // Check for group-specific permissions
1836 // If more than one group applies, use the group with the highest limit
1837 foreach ( $this->getGroups() as $group ) {
1838 if ( isset( $limits[$group] ) ) {
1839 if ( $userLimit === false
1840 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1842 $userLimit = $limits[$group];
1846 // Set the user limit key
1847 if ( $userLimit !== false ) {
1848 list( $max, $period ) = $userLimit;
1849 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1850 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1854 foreach ( $keys as $key => $limit ) {
1855 list( $max, $period ) = $limit;
1856 $summary = "(limit $max in {$period}s)";
1857 $count = $wgMemc->get( $key );
1860 if ( $count >= $max ) {
1861 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1862 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1865 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1868 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1869 if ( $incrBy > 0 ) {
1870 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1873 if ( $incrBy > 0 ) {
1874 $wgMemc->incr( $key, $incrBy );
1882 * Check if user is blocked
1884 * @param bool $bFromSlave Whether to check the slave database instead of
1885 * the master. Hacked from false due to horrible probs on site.
1886 * @return bool True if blocked, false otherwise
1888 public function isBlocked( $bFromSlave = true ) {
1889 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1893 * Get the block affecting the user, or null if the user is not blocked
1895 * @param bool $bFromSlave Whether to check the slave database instead of the master
1896 * @return Block|null
1898 public function getBlock( $bFromSlave = true ) {
1899 $this->getBlockedStatus( $bFromSlave );
1900 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1904 * Check if user is blocked from editing a particular article
1906 * @param Title $title Title to check
1907 * @param bool $bFromSlave Whether to check the slave database instead of the master
1910 public function isBlockedFrom( $title, $bFromSlave = false ) {
1911 global $wgBlockAllowsUTEdit;
1913 $blocked = $this->isBlocked( $bFromSlave );
1914 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1915 // If a user's name is suppressed, they cannot make edits anywhere
1916 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1917 && $title->getNamespace() == NS_USER_TALK
) {
1919 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1922 Hooks
::run( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1928 * If user is blocked, return the name of the user who placed the block
1929 * @return string Name of blocker
1931 public function blockedBy() {
1932 $this->getBlockedStatus();
1933 return $this->mBlockedby
;
1937 * If user is blocked, return the specified reason for the block
1938 * @return string Blocking reason
1940 public function blockedFor() {
1941 $this->getBlockedStatus();
1942 return $this->mBlockreason
;
1946 * If user is blocked, return the ID for the block
1947 * @return int Block ID
1949 public function getBlockId() {
1950 $this->getBlockedStatus();
1951 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1955 * Check if user is blocked on all wikis.
1956 * Do not use for actual edit permission checks!
1957 * This is intended for quick UI checks.
1959 * @param string $ip IP address, uses current client if none given
1960 * @return bool True if blocked, false otherwise
1962 public function isBlockedGlobally( $ip = '' ) {
1963 if ( $this->mBlockedGlobally
!== null ) {
1964 return $this->mBlockedGlobally
;
1966 // User is already an IP?
1967 if ( IP
::isIPAddress( $this->getName() ) ) {
1968 $ip = $this->getName();
1970 $ip = $this->getRequest()->getIP();
1973 Hooks
::run( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1974 $this->mBlockedGlobally
= (bool)$blocked;
1975 return $this->mBlockedGlobally
;
1979 * Check if user account is locked
1981 * @return bool True if locked, false otherwise
1983 public function isLocked() {
1984 if ( $this->mLocked
!== null ) {
1985 return $this->mLocked
;
1988 $authUser = $wgAuth->getUserInstance( $this );
1989 $this->mLocked
= (bool)$authUser->isLocked();
1990 return $this->mLocked
;
1994 * Check if user account is hidden
1996 * @return bool True if hidden, false otherwise
1998 public function isHidden() {
1999 if ( $this->mHideName
!== null ) {
2000 return $this->mHideName
;
2002 $this->getBlockedStatus();
2003 if ( !$this->mHideName
) {
2005 $authUser = $wgAuth->getUserInstance( $this );
2006 $this->mHideName
= (bool)$authUser->isHidden();
2008 return $this->mHideName
;
2012 * Get the user's ID.
2013 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2015 public function getId() {
2016 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
2017 // Special case, we know the user is anonymous
2019 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2020 // Don't load if this was initialized from an ID
2027 * Set the user and reload all fields according to a given ID
2028 * @param int $v User ID to reload
2030 public function setId( $v ) {
2032 $this->clearInstanceCache( 'id' );
2036 * Get the user name, or the IP of an anonymous user
2037 * @return string User's name or IP address
2039 public function getName() {
2040 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2041 // Special case optimisation
2042 return $this->mName
;
2045 if ( $this->mName
=== false ) {
2047 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2049 return $this->mName
;
2054 * Set the user name.
2056 * This does not reload fields from the database according to the given
2057 * name. Rather, it is used to create a temporary "nonexistent user" for
2058 * later addition to the database. It can also be used to set the IP
2059 * address for an anonymous user to something other than the current
2062 * @note User::newFromName() has roughly the same function, when the named user
2064 * @param string $str New user name to set
2066 public function setName( $str ) {
2068 $this->mName
= $str;
2072 * Get the user's name escaped by underscores.
2073 * @return string Username escaped by underscores.
2075 public function getTitleKey() {
2076 return str_replace( ' ', '_', $this->getName() );
2080 * Check if the user has new messages.
2081 * @return bool True if the user has new messages
2083 public function getNewtalk() {
2086 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2087 if ( $this->mNewtalk
=== -1 ) {
2088 $this->mNewtalk
= false; # reset talk page status
2090 // Check memcached separately for anons, who have no
2091 // entire User object stored in there.
2092 if ( !$this->mId
) {
2093 global $wgDisableAnonTalk;
2094 if ( $wgDisableAnonTalk ) {
2095 // Anon newtalk disabled by configuration.
2096 $this->mNewtalk
= false;
2098 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2101 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2105 return (bool)$this->mNewtalk
;
2109 * Return the data needed to construct links for new talk page message
2110 * alerts. If there are new messages, this will return an associative array
2111 * with the following data:
2112 * wiki: The database name of the wiki
2113 * link: Root-relative link to the user's talk page
2114 * rev: The last talk page revision that the user has seen or null. This
2115 * is useful for building diff links.
2116 * If there are no new messages, it returns an empty array.
2117 * @note This function was designed to accomodate multiple talk pages, but
2118 * currently only returns a single link and revision.
2121 public function getNewMessageLinks() {
2123 if ( !Hooks
::run( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
2125 } elseif ( !$this->getNewtalk() ) {
2128 $utp = $this->getTalkPage();
2129 $dbr = wfGetDB( DB_SLAVE
);
2130 // Get the "last viewed rev" timestamp from the oldest message notification
2131 $timestamp = $dbr->selectField( 'user_newtalk',
2132 'MIN(user_last_timestamp)',
2133 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
2135 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2136 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
2140 * Get the revision ID for the last talk page revision viewed by the talk
2142 * @return int|null Revision ID or null
2144 public function getNewMessageRevisionId() {
2145 $newMessageRevisionId = null;
2146 $newMessageLinks = $this->getNewMessageLinks();
2147 if ( $newMessageLinks ) {
2148 // Note: getNewMessageLinks() never returns more than a single link
2149 // and it is always for the same wiki, but we double-check here in
2150 // case that changes some time in the future.
2151 if ( count( $newMessageLinks ) === 1
2152 && $newMessageLinks[0]['wiki'] === wfWikiID()
2153 && $newMessageLinks[0]['rev']
2155 $newMessageRevision = $newMessageLinks[0]['rev'];
2156 $newMessageRevisionId = $newMessageRevision->getId();
2159 return $newMessageRevisionId;
2163 * Internal uncached check for new messages
2166 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2167 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2168 * @return bool True if the user has new messages
2170 protected function checkNewtalk( $field, $id ) {
2171 $dbr = wfGetDB( DB_SLAVE
);
2173 $ok = $dbr->selectField( 'user_newtalk', $field, array( $field => $id ), __METHOD__
);
2175 return $ok !== false;
2179 * Add or update the new messages flag
2180 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2181 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2182 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2183 * @return bool True if successful, false otherwise
2185 protected function updateNewtalk( $field, $id, $curRev = null ) {
2186 // Get timestamp of the talk page revision prior to the current one
2187 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2188 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2189 // Mark the user as having new messages since this revision
2190 $dbw = wfGetDB( DB_MASTER
);
2191 $dbw->insert( 'user_newtalk',
2192 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
2195 if ( $dbw->affectedRows() ) {
2196 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2199 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2205 * Clear the new messages flag for the given user
2206 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2207 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2208 * @return bool True if successful, false otherwise
2210 protected function deleteNewtalk( $field, $id ) {
2211 $dbw = wfGetDB( DB_MASTER
);
2212 $dbw->delete( 'user_newtalk',
2213 array( $field => $id ),
2215 if ( $dbw->affectedRows() ) {
2216 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2219 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2225 * Update the 'You have new messages!' status.
2226 * @param bool $val Whether the user has new messages
2227 * @param Revision $curRev New, as yet unseen revision of the user talk
2228 * page. Ignored if null or !$val.
2230 public function setNewtalk( $val, $curRev = null ) {
2231 if ( wfReadOnly() ) {
2236 $this->mNewtalk
= $val;
2238 if ( $this->isAnon() ) {
2240 $id = $this->getName();
2243 $id = $this->getId();
2247 $changed = $this->updateNewtalk( $field, $id, $curRev );
2249 $changed = $this->deleteNewtalk( $field, $id );
2253 $this->invalidateCache();
2258 * Generate a current or new-future timestamp to be stored in the
2259 * user_touched field when we update things.
2260 * @return string Timestamp in TS_MW format
2262 private function newTouchedTimestamp() {
2263 global $wgClockSkewFudge;
2265 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2266 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2267 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2274 * Clear user data from memcached.
2275 * Use after applying fun updates to the database; caller's
2276 * responsibility to update user_touched if appropriate.
2278 * Called implicitly from invalidateCache() and saveSettings().
2280 public function clearSharedCache() {
2281 $id = $this->getId();
2283 $key = wfMemcKey( 'user', 'id', $id );
2284 ObjectCache
::getMainWANInstance()->delete( $key );
2289 * Immediately touch the user data cache for this account
2291 * Calls touch() and removes account data from memcached
2293 public function invalidateCache() {
2295 $this->clearSharedCache();
2299 * Update the "touched" timestamp for the user
2301 * This is useful on various login/logout events when making sure that
2302 * a browser or proxy that has multiple tenants does not suffer cache
2303 * pollution where the new user sees the old users content. The value
2304 * of getTouched() is checked when determining 304 vs 200 responses.
2305 * Unlike invalidateCache(), this preserves the User object cache and
2306 * avoids database writes.
2310 public function touch() {
2311 $id = $this->getId();
2313 $key = wfMemcKey( 'user-quicktouched', 'id', $id );
2314 ObjectCache
::getMainWANInstance()->touchCheckKey( $key );
2315 $this->mQuickTouched
= null;
2320 * Validate the cache for this account.
2321 * @param string $timestamp A timestamp in TS_MW format
2324 public function validateCache( $timestamp ) {
2325 return ( $timestamp >= $this->getTouched() );
2329 * Get the user touched timestamp
2331 * Use this value only to validate caches via inequalities
2332 * such as in the case of HTTP If-Modified-Since response logic
2334 * @return string TS_MW Timestamp
2336 public function getTouched() {
2340 if ( $this->mQuickTouched
=== null ) {
2341 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2342 $cache = ObjectCache
::getMainWANInstance();
2344 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2347 return max( $this->mTouched
, $this->mQuickTouched
);
2350 return $this->mTouched
;
2354 * Get the user_touched timestamp field (time of last DB updates)
2355 * @return string TS_MW Timestamp
2358 public function getDBTouched() {
2361 return $this->mTouched
;
2368 public function getPassword() {
2369 $this->loadPasswords();
2371 return $this->mPassword
;
2378 public function getTemporaryPassword() {
2379 $this->loadPasswords();
2381 return $this->mNewpassword
;
2385 * Set the password and reset the random token.
2386 * Calls through to authentication plugin if necessary;
2387 * will have no effect if the auth plugin refuses to
2388 * pass the change through or if the legal password
2391 * As a special case, setting the password to null
2392 * wipes it, so the account cannot be logged in until
2393 * a new password is set, for instance via e-mail.
2395 * @param string $str New password to set
2396 * @throws PasswordError On failure
2400 public function setPassword( $str ) {
2403 $this->loadPasswords();
2405 if ( $str !== null ) {
2406 if ( !$wgAuth->allowPasswordChange() ) {
2407 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2410 $status = $this->checkPasswordValidity( $str );
2411 if ( !$status->isGood() ) {
2412 throw new PasswordError( $status->getMessage()->text() );
2416 if ( !$wgAuth->setPassword( $this, $str ) ) {
2417 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2420 $this->setInternalPassword( $str );
2426 * Set the password and reset the random token unconditionally.
2428 * @param string|null $str New password to set or null to set an invalid
2429 * password hash meaning that the user will not be able to log in
2430 * through the web interface.
2432 public function setInternalPassword( $str ) {
2435 $passwordFactory = self
::getPasswordFactory();
2436 $this->mPassword
= $passwordFactory->newFromPlaintext( $str );
2438 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
2439 $this->mNewpassTime
= null;
2443 * Get the user's current token.
2444 * @param bool $forceCreation Force the generation of a new token if the
2445 * user doesn't have one (default=true for backwards compatibility).
2446 * @return string Token
2448 public function getToken( $forceCreation = true ) {
2450 if ( !$this->mToken
&& $forceCreation ) {
2453 return $this->mToken
;
2457 * Set the random token (used for persistent authentication)
2458 * Called from loadDefaults() among other places.
2460 * @param string|bool $token If specified, set the token to this value
2462 public function setToken( $token = false ) {
2465 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2467 $this->mToken
= $token;
2472 * Set the password for a password reminder or new account email
2474 * @param string $str New password to set or null to set an invalid
2475 * password hash meaning that the user will not be able to use it
2476 * @param bool $throttle If true, reset the throttle timestamp to the present
2478 public function setNewpassword( $str, $throttle = true ) {
2479 $this->loadPasswords();
2481 $this->mNewpassword
= self
::getPasswordFactory()->newFromPlaintext( $str );
2482 if ( $str === null ) {
2483 $this->mNewpassTime
= null;
2484 } elseif ( $throttle ) {
2485 $this->mNewpassTime
= wfTimestampNow();
2490 * Has password reminder email been sent within the last
2491 * $wgPasswordReminderResendTime hours?
2494 public function isPasswordReminderThrottled() {
2495 global $wgPasswordReminderResendTime;
2497 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2500 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2501 return time() < $expiry;
2505 * Get the user's e-mail address
2506 * @return string User's email address
2508 public function getEmail() {
2510 Hooks
::run( 'UserGetEmail', array( $this, &$this->mEmail
) );
2511 return $this->mEmail
;
2515 * Get the timestamp of the user's e-mail authentication
2516 * @return string TS_MW timestamp
2518 public function getEmailAuthenticationTimestamp() {
2520 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2521 return $this->mEmailAuthenticated
;
2525 * Set the user's e-mail address
2526 * @param string $str New e-mail address
2528 public function setEmail( $str ) {
2530 if ( $str == $this->mEmail
) {
2533 $this->invalidateEmail();
2534 $this->mEmail
= $str;
2535 Hooks
::run( 'UserSetEmail', array( $this, &$this->mEmail
) );
2539 * Set the user's e-mail address and a confirmation mail if needed.
2542 * @param string $str New e-mail address
2545 public function setEmailWithConfirmation( $str ) {
2546 global $wgEnableEmail, $wgEmailAuthentication;
2548 if ( !$wgEnableEmail ) {
2549 return Status
::newFatal( 'emaildisabled' );
2552 $oldaddr = $this->getEmail();
2553 if ( $str === $oldaddr ) {
2554 return Status
::newGood( true );
2557 $this->setEmail( $str );
2559 if ( $str !== '' && $wgEmailAuthentication ) {
2560 // Send a confirmation request to the new address if needed
2561 $type = $oldaddr != '' ?
'changed' : 'set';
2562 $result = $this->sendConfirmationMail( $type );
2563 if ( $result->isGood() ) {
2564 // Say to the caller that a confirmation mail has been sent
2565 $result->value
= 'eauth';
2568 $result = Status
::newGood( true );
2575 * Get the user's real name
2576 * @return string User's real name
2578 public function getRealName() {
2579 if ( !$this->isItemLoaded( 'realname' ) ) {
2583 return $this->mRealName
;
2587 * Set the user's real name
2588 * @param string $str New real name
2590 public function setRealName( $str ) {
2592 $this->mRealName
= $str;
2596 * Get the user's current setting for a given option.
2598 * @param string $oname The option to check
2599 * @param string $defaultOverride A default value returned if the option does not exist
2600 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2601 * @return string User's current value for the option
2602 * @see getBoolOption()
2603 * @see getIntOption()
2605 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2606 global $wgHiddenPrefs;
2607 $this->loadOptions();
2609 # We want 'disabled' preferences to always behave as the default value for
2610 # users, even if they have set the option explicitly in their settings (ie they
2611 # set it, and then it was disabled removing their ability to change it). But
2612 # we don't want to erase the preferences in the database in case the preference
2613 # is re-enabled again. So don't touch $mOptions, just override the returned value
2614 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2615 return self
::getDefaultOption( $oname );
2618 if ( array_key_exists( $oname, $this->mOptions
) ) {
2619 return $this->mOptions
[$oname];
2621 return $defaultOverride;
2626 * Get all user's options
2628 * @param int $flags Bitwise combination of:
2629 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2630 * to the default value. (Since 1.25)
2633 public function getOptions( $flags = 0 ) {
2634 global $wgHiddenPrefs;
2635 $this->loadOptions();
2636 $options = $this->mOptions
;
2638 # We want 'disabled' preferences to always behave as the default value for
2639 # users, even if they have set the option explicitly in their settings (ie they
2640 # set it, and then it was disabled removing their ability to change it). But
2641 # we don't want to erase the preferences in the database in case the preference
2642 # is re-enabled again. So don't touch $mOptions, just override the returned value
2643 foreach ( $wgHiddenPrefs as $pref ) {
2644 $default = self
::getDefaultOption( $pref );
2645 if ( $default !== null ) {
2646 $options[$pref] = $default;
2650 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2651 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2658 * Get the user's current setting for a given option, as a boolean value.
2660 * @param string $oname The option to check
2661 * @return bool User's current value for the option
2664 public function getBoolOption( $oname ) {
2665 return (bool)$this->getOption( $oname );
2669 * Get the user's current setting for a given option, as an integer value.
2671 * @param string $oname The option to check
2672 * @param int $defaultOverride A default value returned if the option does not exist
2673 * @return int User's current value for the option
2676 public function getIntOption( $oname, $defaultOverride = 0 ) {
2677 $val = $this->getOption( $oname );
2679 $val = $defaultOverride;
2681 return intval( $val );
2685 * Set the given option for a user.
2687 * You need to call saveSettings() to actually write to the database.
2689 * @param string $oname The option to set
2690 * @param mixed $val New value to set
2692 public function setOption( $oname, $val ) {
2693 $this->loadOptions();
2695 // Explicitly NULL values should refer to defaults
2696 if ( is_null( $val ) ) {
2697 $val = self
::getDefaultOption( $oname );
2700 $this->mOptions
[$oname] = $val;
2704 * Get a token stored in the preferences (like the watchlist one),
2705 * resetting it if it's empty (and saving changes).
2707 * @param string $oname The option name to retrieve the token from
2708 * @return string|bool User's current value for the option, or false if this option is disabled.
2709 * @see resetTokenFromOption()
2712 public function getTokenFromOption( $oname ) {
2713 global $wgHiddenPrefs;
2714 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2718 $token = $this->getOption( $oname );
2720 $token = $this->resetTokenFromOption( $oname );
2721 if ( !wfReadOnly() ) {
2722 $this->saveSettings();
2729 * Reset a token stored in the preferences (like the watchlist one).
2730 * *Does not* save user's preferences (similarly to setOption()).
2732 * @param string $oname The option name to reset the token in
2733 * @return string|bool New token value, or false if this option is disabled.
2734 * @see getTokenFromOption()
2737 public function resetTokenFromOption( $oname ) {
2738 global $wgHiddenPrefs;
2739 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2743 $token = MWCryptRand
::generateHex( 40 );
2744 $this->setOption( $oname, $token );
2749 * Return a list of the types of user options currently returned by
2750 * User::getOptionKinds().
2752 * Currently, the option kinds are:
2753 * - 'registered' - preferences which are registered in core MediaWiki or
2754 * by extensions using the UserGetDefaultOptions hook.
2755 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2756 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2757 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2758 * be used by user scripts.
2759 * - 'special' - "preferences" that are not accessible via User::getOptions
2760 * or User::setOptions.
2761 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2762 * These are usually legacy options, removed in newer versions.
2764 * The API (and possibly others) use this function to determine the possible
2765 * option types for validation purposes, so make sure to update this when a
2766 * new option kind is added.
2768 * @see User::getOptionKinds
2769 * @return array Option kinds
2771 public static function listOptionKinds() {
2774 'registered-multiselect',
2775 'registered-checkmatrix',
2783 * Return an associative array mapping preferences keys to the kind of a preference they're
2784 * used for. Different kinds are handled differently when setting or reading preferences.
2786 * See User::listOptionKinds for the list of valid option types that can be provided.
2788 * @see User::listOptionKinds
2789 * @param IContextSource $context
2790 * @param array $options Assoc. array with options keys to check as keys.
2791 * Defaults to $this->mOptions.
2792 * @return array The key => kind mapping data
2794 public function getOptionKinds( IContextSource
$context, $options = null ) {
2795 $this->loadOptions();
2796 if ( $options === null ) {
2797 $options = $this->mOptions
;
2800 $prefs = Preferences
::getPreferences( $this, $context );
2803 // Pull out the "special" options, so they don't get converted as
2804 // multiselect or checkmatrix.
2805 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2806 foreach ( $specialOptions as $name => $value ) {
2807 unset( $prefs[$name] );
2810 // Multiselect and checkmatrix options are stored in the database with
2811 // one key per option, each having a boolean value. Extract those keys.
2812 $multiselectOptions = array();
2813 foreach ( $prefs as $name => $info ) {
2814 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2815 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2816 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2817 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2819 foreach ( $opts as $value ) {
2820 $multiselectOptions["$prefix$value"] = true;
2823 unset( $prefs[$name] );
2826 $checkmatrixOptions = array();
2827 foreach ( $prefs as $name => $info ) {
2828 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2829 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2830 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2831 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2832 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2834 foreach ( $columns as $column ) {
2835 foreach ( $rows as $row ) {
2836 $checkmatrixOptions["$prefix$column-$row"] = true;
2840 unset( $prefs[$name] );
2844 // $value is ignored
2845 foreach ( $options as $key => $value ) {
2846 if ( isset( $prefs[$key] ) ) {
2847 $mapping[$key] = 'registered';
2848 } elseif ( isset( $multiselectOptions[$key] ) ) {
2849 $mapping[$key] = 'registered-multiselect';
2850 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2851 $mapping[$key] = 'registered-checkmatrix';
2852 } elseif ( isset( $specialOptions[$key] ) ) {
2853 $mapping[$key] = 'special';
2854 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2855 $mapping[$key] = 'userjs';
2857 $mapping[$key] = 'unused';
2865 * Reset certain (or all) options to the site defaults
2867 * The optional parameter determines which kinds of preferences will be reset.
2868 * Supported values are everything that can be reported by getOptionKinds()
2869 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2871 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
2872 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2873 * for backwards-compatibility.
2874 * @param IContextSource|null $context Context source used when $resetKinds
2875 * does not contain 'all', passed to getOptionKinds().
2876 * Defaults to RequestContext::getMain() when null.
2878 public function resetOptions(
2879 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2880 IContextSource
$context = null
2883 $defaultOptions = self
::getDefaultOptions();
2885 if ( !is_array( $resetKinds ) ) {
2886 $resetKinds = array( $resetKinds );
2889 if ( in_array( 'all', $resetKinds ) ) {
2890 $newOptions = $defaultOptions;
2892 if ( $context === null ) {
2893 $context = RequestContext
::getMain();
2896 $optionKinds = $this->getOptionKinds( $context );
2897 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
2898 $newOptions = array();
2900 // Use default values for the options that should be deleted, and
2901 // copy old values for the ones that shouldn't.
2902 foreach ( $this->mOptions
as $key => $value ) {
2903 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2904 if ( array_key_exists( $key, $defaultOptions ) ) {
2905 $newOptions[$key] = $defaultOptions[$key];
2908 $newOptions[$key] = $value;
2913 Hooks
::run( 'UserResetAllOptions', array( $this, &$newOptions, $this->mOptions
, $resetKinds ) );
2915 $this->mOptions
= $newOptions;
2916 $this->mOptionsLoaded
= true;
2920 * Get the user's preferred date format.
2921 * @return string User's preferred date format
2923 public function getDatePreference() {
2924 // Important migration for old data rows
2925 if ( is_null( $this->mDatePreference
) ) {
2927 $value = $this->getOption( 'date' );
2928 $map = $wgLang->getDatePreferenceMigrationMap();
2929 if ( isset( $map[$value] ) ) {
2930 $value = $map[$value];
2932 $this->mDatePreference
= $value;
2934 return $this->mDatePreference
;
2938 * Determine based on the wiki configuration and the user's options,
2939 * whether this user must be over HTTPS no matter what.
2943 public function requiresHTTPS() {
2944 global $wgSecureLogin;
2945 if ( !$wgSecureLogin ) {
2948 $https = $this->getBoolOption( 'prefershttps' );
2949 Hooks
::run( 'UserRequiresHTTPS', array( $this, &$https ) );
2951 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
2958 * Get the user preferred stub threshold
2962 public function getStubThreshold() {
2963 global $wgMaxArticleSize; # Maximum article size, in Kb
2964 $threshold = $this->getIntOption( 'stubthreshold' );
2965 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2966 // If they have set an impossible value, disable the preference
2967 // so we can use the parser cache again.
2974 * Get the permissions this user has.
2975 * @return array Array of String permission names
2977 public function getRights() {
2978 if ( is_null( $this->mRights
) ) {
2979 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2980 Hooks
::run( 'UserGetRights', array( $this, &$this->mRights
) );
2981 // Force reindexation of rights when a hook has unset one of them
2982 $this->mRights
= array_values( array_unique( $this->mRights
) );
2984 return $this->mRights
;
2988 * Get the list of explicit group memberships this user has.
2989 * The implicit * and user groups are not included.
2990 * @return array Array of String internal group names
2992 public function getGroups() {
2994 $this->loadGroups();
2995 return $this->mGroups
;
2999 * Get the list of implicit group memberships this user has.
3000 * This includes all explicit groups, plus 'user' if logged in,
3001 * '*' for all accounts, and autopromoted groups
3002 * @param bool $recache Whether to avoid the cache
3003 * @return array Array of String internal group names
3005 public function getEffectiveGroups( $recache = false ) {
3006 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3007 $this->mEffectiveGroups
= array_unique( array_merge(
3008 $this->getGroups(), // explicit groups
3009 $this->getAutomaticGroups( $recache ) // implicit groups
3011 // Hook for additional groups
3012 Hooks
::run( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
3013 // Force reindexation of groups when a hook has unset one of them
3014 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3016 return $this->mEffectiveGroups
;
3020 * Get the list of implicit group memberships this user has.
3021 * This includes 'user' if logged in, '*' for all accounts,
3022 * and autopromoted groups
3023 * @param bool $recache Whether to avoid the cache
3024 * @return array Array of String internal group names
3026 public function getAutomaticGroups( $recache = false ) {
3027 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3028 $this->mImplicitGroups
= array( '*' );
3029 if ( $this->getId() ) {
3030 $this->mImplicitGroups
[] = 'user';
3032 $this->mImplicitGroups
= array_unique( array_merge(
3033 $this->mImplicitGroups
,
3034 Autopromote
::getAutopromoteGroups( $this )
3038 // Assure data consistency with rights/groups,
3039 // as getEffectiveGroups() depends on this function
3040 $this->mEffectiveGroups
= null;
3043 return $this->mImplicitGroups
;
3047 * Returns the groups the user has belonged to.
3049 * The user may still belong to the returned groups. Compare with getGroups().
3051 * The function will not return groups the user had belonged to before MW 1.17
3053 * @return array Names of the groups the user has belonged to.
3055 public function getFormerGroups() {
3058 if ( is_null( $this->mFormerGroups
) ) {
3059 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3060 ?
wfGetDB( DB_MASTER
)
3061 : wfGetDB( DB_SLAVE
);
3062 $res = $db->select( 'user_former_groups',
3063 array( 'ufg_group' ),
3064 array( 'ufg_user' => $this->mId
),
3066 $this->mFormerGroups
= array();
3067 foreach ( $res as $row ) {
3068 $this->mFormerGroups
[] = $row->ufg_group
;
3072 return $this->mFormerGroups
;
3076 * Get the user's edit count.
3077 * @return int|null Null for anonymous users
3079 public function getEditCount() {
3080 if ( !$this->getId() ) {
3084 if ( $this->mEditCount
=== null ) {
3085 /* Populate the count, if it has not been populated yet */
3086 $dbr = wfGetDB( DB_SLAVE
);
3087 // check if the user_editcount field has been initialized
3088 $count = $dbr->selectField(
3089 'user', 'user_editcount',
3090 array( 'user_id' => $this->mId
),
3094 if ( $count === null ) {
3095 // it has not been initialized. do so.
3096 $count = $this->initEditCount();
3098 $this->mEditCount
= $count;
3100 return (int)$this->mEditCount
;
3104 * Add the user to the given group.
3105 * This takes immediate effect.
3106 * @param string $group Name of the group to add
3109 public function addGroup( $group ) {
3112 if ( !Hooks
::run( 'UserAddGroup', array( $this, &$group ) ) ) {
3116 $dbw = wfGetDB( DB_MASTER
);
3117 if ( $this->getId() ) {
3118 $dbw->insert( 'user_groups',
3120 'ug_user' => $this->getID(),
3121 'ug_group' => $group,
3124 array( 'IGNORE' ) );
3127 $this->loadGroups();
3128 $this->mGroups
[] = $group;
3129 // In case loadGroups was not called before, we now have the right twice.
3130 // Get rid of the duplicate.
3131 $this->mGroups
= array_unique( $this->mGroups
);
3133 // Refresh the groups caches, and clear the rights cache so it will be
3134 // refreshed on the next call to $this->getRights().
3135 $this->getEffectiveGroups( true );
3136 $this->mRights
= null;
3138 $this->invalidateCache();
3144 * Remove the user from the given group.
3145 * This takes immediate effect.
3146 * @param string $group Name of the group to remove
3149 public function removeGroup( $group ) {
3151 if ( !Hooks
::run( 'UserRemoveGroup', array( $this, &$group ) ) ) {
3155 $dbw = wfGetDB( DB_MASTER
);
3156 $dbw->delete( 'user_groups',
3158 'ug_user' => $this->getID(),
3159 'ug_group' => $group,
3162 // Remember that the user was in this group
3163 $dbw->insert( 'user_former_groups',
3165 'ufg_user' => $this->getID(),
3166 'ufg_group' => $group,
3172 $this->loadGroups();
3173 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
3175 // Refresh the groups caches, and clear the rights cache so it will be
3176 // refreshed on the next call to $this->getRights().
3177 $this->getEffectiveGroups( true );
3178 $this->mRights
= null;
3180 $this->invalidateCache();
3186 * Get whether the user is logged in
3189 public function isLoggedIn() {
3190 return $this->getID() != 0;
3194 * Get whether the user is anonymous
3197 public function isAnon() {
3198 return !$this->isLoggedIn();
3202 * Check if user is allowed to access a feature / make an action
3204 * @param string $permissions,... Permissions to test
3205 * @return bool True if user is allowed to perform *any* of the given actions
3207 public function isAllowedAny( /*...*/ ) {
3208 $permissions = func_get_args();
3209 foreach ( $permissions as $permission ) {
3210 if ( $this->isAllowed( $permission ) ) {
3219 * @param string $permissions,... Permissions to test
3220 * @return bool True if the user is allowed to perform *all* of the given actions
3222 public function isAllowedAll( /*...*/ ) {
3223 $permissions = func_get_args();
3224 foreach ( $permissions as $permission ) {
3225 if ( !$this->isAllowed( $permission ) ) {
3233 * Internal mechanics of testing a permission
3234 * @param string $action
3237 public function isAllowed( $action = '' ) {
3238 if ( $action === '' ) {
3239 return true; // In the spirit of DWIM
3241 // Patrolling may not be enabled
3242 if ( $action === 'patrol' ||
$action === 'autopatrol' ) {
3243 global $wgUseRCPatrol, $wgUseNPPatrol;
3244 if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) {
3248 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3249 // by misconfiguration: 0 == 'foo'
3250 return in_array( $action, $this->getRights(), true );
3254 * Check whether to enable recent changes patrol features for this user
3255 * @return bool True or false
3257 public function useRCPatrol() {
3258 global $wgUseRCPatrol;
3259 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3263 * Check whether to enable new pages patrol features for this user
3264 * @return bool True or false
3266 public function useNPPatrol() {
3267 global $wgUseRCPatrol, $wgUseNPPatrol;
3269 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3270 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3275 * Get the WebRequest object to use with this object
3277 * @return WebRequest
3279 public function getRequest() {
3280 if ( $this->mRequest
) {
3281 return $this->mRequest
;
3289 * Get the current skin, loading it if required
3290 * @return Skin The current skin
3291 * @todo FIXME: Need to check the old failback system [AV]
3292 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
3294 public function getSkin() {
3295 wfDeprecated( __METHOD__
, '1.18' );
3296 return RequestContext
::getMain()->getSkin();
3300 * Get a WatchedItem for this user and $title.
3302 * @since 1.22 $checkRights parameter added
3303 * @param Title $title
3304 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3305 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3306 * @return WatchedItem
3308 public function getWatchedItem( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3309 $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey();
3311 if ( isset( $this->mWatchedItems
[$key] ) ) {
3312 return $this->mWatchedItems
[$key];
3315 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
3316 $this->mWatchedItems
= array();
3319 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title, $checkRights );
3320 return $this->mWatchedItems
[$key];
3324 * Check the watched status of an article.
3325 * @since 1.22 $checkRights parameter added
3326 * @param Title $title Title of the article to look at
3327 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3328 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3331 public function isWatched( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3332 return $this->getWatchedItem( $title, $checkRights )->isWatched();
3337 * @since 1.22 $checkRights parameter added
3338 * @param Title $title Title of the article to look at
3339 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3340 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3342 public function addWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3343 $this->getWatchedItem( $title, $checkRights )->addWatch();
3344 $this->invalidateCache();
3348 * Stop watching an article.
3349 * @since 1.22 $checkRights parameter added
3350 * @param Title $title Title of the article to look at
3351 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3352 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3354 public function removeWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3355 $this->getWatchedItem( $title, $checkRights )->removeWatch();
3356 $this->invalidateCache();
3360 * Clear the user's notification timestamp for the given title.
3361 * If e-notif e-mails are on, they will receive notification mails on
3362 * the next change of the page if it's watched etc.
3363 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3364 * @param Title $title Title of the article to look at
3365 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3367 public function clearNotification( &$title, $oldid = 0 ) {
3368 global $wgUseEnotif, $wgShowUpdatedMarker;
3370 // Do nothing if the database is locked to writes
3371 if ( wfReadOnly() ) {
3375 // Do nothing if not allowed to edit the watchlist
3376 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3380 // If we're working on user's talk page, we should update the talk page message indicator
3381 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3382 if ( !Hooks
::run( 'UserClearNewTalkNotification', array( &$this, $oldid ) ) ) {
3386 $nextid = $oldid ?
$title->getNextRevisionID( $oldid ) : null;
3388 if ( !$oldid ||
!$nextid ) {
3389 // If we're looking at the latest revision, we should definitely clear it
3390 $this->setNewtalk( false );
3392 // Otherwise we should update its revision, if it's present
3393 if ( $this->getNewtalk() ) {
3394 // Naturally the other one won't clear by itself
3395 $this->setNewtalk( false );
3396 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3401 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3405 if ( $this->isAnon() ) {
3406 // Nothing else to do...
3410 // Only update the timestamp if the page is being watched.
3411 // The query to find out if it is watched is cached both in memcached and per-invocation,
3412 // and when it does have to be executed, it can be on a slave
3413 // If this is the user's newtalk page, we always update the timestamp
3415 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3419 $this->getWatchedItem( $title )->resetNotificationTimestamp(
3420 $force, $oldid, WatchedItem
::DEFERRED
3425 * Resets all of the given user's page-change notification timestamps.
3426 * If e-notif e-mails are on, they will receive notification mails on
3427 * the next change of any watched page.
3428 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3430 public function clearAllNotifications() {
3431 if ( wfReadOnly() ) {
3435 // Do nothing if not allowed to edit the watchlist
3436 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3440 global $wgUseEnotif, $wgShowUpdatedMarker;
3441 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3442 $this->setNewtalk( false );
3445 $id = $this->getId();
3447 $dbw = wfGetDB( DB_MASTER
);
3448 $dbw->update( 'watchlist',
3449 array( /* SET */ 'wl_notificationtimestamp' => null ),
3450 array( /* WHERE */ 'wl_user' => $id ),
3453 // We also need to clear here the "you have new message" notification for the own user_talk page;
3454 // it's cleared one page view later in WikiPage::doViewUpdates().
3459 * Set a cookie on the user's client. Wrapper for
3460 * WebResponse::setCookie
3461 * @param string $name Name of the cookie to set
3462 * @param string $value Value to set
3463 * @param int $exp Expiration time, as a UNIX time value;
3464 * if 0 or not specified, use the default $wgCookieExpiration
3465 * @param bool $secure
3466 * true: Force setting the secure attribute when setting the cookie
3467 * false: Force NOT setting the secure attribute when setting the cookie
3468 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3469 * @param array $params Array of options sent passed to WebResponse::setcookie()
3470 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3473 protected function setCookie(
3474 $name, $value, $exp = 0, $secure = null, $params = array(), $request = null
3476 if ( $request === null ) {
3477 $request = $this->getRequest();
3479 $params['secure'] = $secure;
3480 $request->response()->setcookie( $name, $value, $exp, $params );
3484 * Clear a cookie on the user's client
3485 * @param string $name Name of the cookie to clear
3486 * @param bool $secure
3487 * true: Force setting the secure attribute when setting the cookie
3488 * false: Force NOT setting the secure attribute when setting the cookie
3489 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3490 * @param array $params Array of options sent passed to WebResponse::setcookie()
3492 protected function clearCookie( $name, $secure = null, $params = array() ) {
3493 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3497 * Set an extended login cookie on the user's client. The expiry of the cookie
3498 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3501 * @see User::setCookie
3503 * @param string $name Name of the cookie to set
3504 * @param string $value Value to set
3505 * @param bool $secure
3506 * true: Force setting the secure attribute when setting the cookie
3507 * false: Force NOT setting the secure attribute when setting the cookie
3508 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3510 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3511 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3514 $exp +
= $wgExtendedLoginCookieExpiration !== null
3515 ?
$wgExtendedLoginCookieExpiration
3516 : $wgCookieExpiration;
3518 $this->setCookie( $name, $value, $exp, $secure );
3522 * Set the default cookies for this session on the user's client.
3524 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3526 * @param bool $secure Whether to force secure/insecure cookies or use default
3527 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3529 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3530 global $wgExtendedLoginCookies;
3532 if ( $request === null ) {
3533 $request = $this->getRequest();
3537 if ( 0 == $this->mId
) {
3540 if ( !$this->mToken
) {
3541 // When token is empty or NULL generate a new one and then save it to the database
3542 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
3543 // Simply by setting every cell in the user_token column to NULL and letting them be
3544 // regenerated as users log back into the wiki.
3546 if ( !wfReadOnly() ) {
3547 $this->saveSettings();
3551 'wsUserID' => $this->mId
,
3552 'wsToken' => $this->mToken
,
3553 'wsUserName' => $this->getName()
3556 'UserID' => $this->mId
,
3557 'UserName' => $this->getName(),
3559 if ( $rememberMe ) {
3560 $cookies['Token'] = $this->mToken
;
3562 $cookies['Token'] = false;
3565 Hooks
::run( 'UserSetCookies', array( $this, &$session, &$cookies ) );
3567 foreach ( $session as $name => $value ) {
3568 $request->setSessionData( $name, $value );
3570 foreach ( $cookies as $name => $value ) {
3571 if ( $value === false ) {
3572 $this->clearCookie( $name );
3573 } elseif ( $rememberMe && in_array( $name, $wgExtendedLoginCookies ) ) {
3574 $this->setExtendedLoginCookie( $name, $value, $secure );
3576 $this->setCookie( $name, $value, 0, $secure, array(), $request );
3581 * If wpStickHTTPS was selected, also set an insecure cookie that
3582 * will cause the site to redirect the user to HTTPS, if they access
3583 * it over HTTP. Bug 29898. Use an un-prefixed cookie, so it's the same
3584 * as the one set by centralauth (bug 53538). Also set it to session, or
3585 * standard time setting, based on if rememberme was set.
3587 if ( $request->getCheck( 'wpStickHTTPS' ) ||
$this->requiresHTTPS() ) {
3591 $rememberMe ?
0 : null,
3593 array( 'prefix' => '' ) // no prefix
3599 * Log this user out.
3601 public function logout() {
3602 if ( Hooks
::run( 'UserLogout', array( &$this ) ) ) {
3608 * Clear the user's cookies and session, and reset the instance cache.
3611 public function doLogout() {
3612 $this->clearInstanceCache( 'defaults' );
3614 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3616 $this->clearCookie( 'UserID' );
3617 $this->clearCookie( 'Token' );
3618 $this->clearCookie( 'forceHTTPS', false, array( 'prefix' => '' ) );
3620 // Remember when user logged out, to prevent seeing cached pages
3621 $this->setCookie( 'LoggedOut', time(), time() +
86400 );
3625 * Save this user's settings into the database.
3626 * @todo Only rarely do all these fields need to be set!
3628 public function saveSettings() {
3631 if ( wfReadOnly() ) {
3632 // @TODO: caller should deal with this instead!
3633 // This should really just be an exception.
3634 MWExceptionHandler
::logException( new DBExpectedError(
3636 "Could not update user with ID '{$this->mId}'; DB is read-only."
3642 $this->loadPasswords();
3643 if ( 0 == $this->mId
) {
3647 // Get a new user_touched that is higher than the old one.
3648 // This will be used for a CAS check as a last-resort safety
3649 // check against race conditions and slave lag.
3650 $oldTouched = $this->mTouched
;
3651 $newTouched = $this->newTouchedTimestamp();
3653 if ( !$wgAuth->allowSetLocalPassword() ) {
3654 $this->mPassword
= self
::getPasswordFactory()->newFromCiphertext( null );
3657 $dbw = wfGetDB( DB_MASTER
);
3658 $dbw->update( 'user',
3660 'user_name' => $this->mName
,
3661 'user_password' => $this->mPassword
->toString(),
3662 'user_newpassword' => $this->mNewpassword
->toString(),
3663 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3664 'user_real_name' => $this->mRealName
,
3665 'user_email' => $this->mEmail
,
3666 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3667 'user_touched' => $dbw->timestamp( $newTouched ),
3668 'user_token' => strval( $this->mToken
),
3669 'user_email_token' => $this->mEmailToken
,
3670 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3671 'user_password_expires' => $dbw->timestampOrNull( $this->mPasswordExpires
),
3672 ), array( /* WHERE */
3673 'user_id' => $this->mId
,
3674 'user_touched' => $dbw->timestamp( $oldTouched ) // CAS check
3678 if ( !$dbw->affectedRows() ) {
3679 // Maybe the problem was a missed cache update; clear it to be safe
3680 $this->clearSharedCache();
3681 // User was changed in the meantime or loaded with stale data
3682 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'slave';
3683 MWExceptionHandler
::logException( new MWException(
3684 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3685 "the version of the user to be saved is older than the current version."
3691 $this->mTouched
= $newTouched;
3692 $this->saveOptions();
3694 Hooks
::run( 'UserSaveSettings', array( $this ) );
3695 $this->clearSharedCache();
3696 $this->getUserPage()->invalidateCache();
3698 // T95839: clear the cache again post-commit to reduce race conditions
3699 // where stale values are written back to the cache by other threads.
3700 // Note: this *still* doesn't deal with REPEATABLE-READ snapshot lag...
3702 $dbw->onTransactionIdle( function() use ( $that ) {
3703 $that->clearSharedCache();
3708 * If only this user's username is known, and it exists, return the user ID.
3710 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3713 public function idForName( $flags = 0 ) {
3714 $s = trim( $this->getName() );
3719 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
3720 ?
wfGetDB( DB_MASTER
)
3721 : wfGetDB( DB_SLAVE
);
3723 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
3724 ?
array( 'FOR UPDATE' )
3727 $id = $db->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
, $options );
3728 if ( $id === false ) {
3736 * Add a user to the database, return the user object
3738 * @param string $name Username to add
3739 * @param array $params Array of Strings Non-default parameters to save to
3740 * the database as user_* fields:
3741 * - password: The user's password hash. Password logins will be disabled
3742 * if this is omitted.
3743 * - newpassword: Hash for a temporary password that has been mailed to
3745 * - email: The user's email address.
3746 * - email_authenticated: The email authentication timestamp.
3747 * - real_name: The user's real name.
3748 * - options: An associative array of non-default options.
3749 * - token: Random authentication token. Do not set.
3750 * - registration: Registration timestamp. Do not set.
3752 * @return User|null User object, or null if the username already exists.
3754 public static function createNew( $name, $params = array() ) {
3757 $user->loadPasswords();
3758 $user->setToken(); // init token
3759 if ( isset( $params['options'] ) ) {
3760 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3761 unset( $params['options'] );
3763 $dbw = wfGetDB( DB_MASTER
);
3764 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3767 'user_id' => $seqVal,
3768 'user_name' => $name,
3769 'user_password' => $user->mPassword
->toString(),
3770 'user_newpassword' => $user->mNewpassword
->toString(),
3771 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
3772 'user_email' => $user->mEmail
,
3773 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3774 'user_real_name' => $user->mRealName
,
3775 'user_token' => strval( $user->mToken
),
3776 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3777 'user_editcount' => 0,
3778 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3780 foreach ( $params as $name => $value ) {
3781 $fields["user_$name"] = $value;
3783 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3784 if ( $dbw->affectedRows() ) {
3785 $newUser = User
::newFromId( $dbw->insertId() );
3793 * Add this existing user object to the database. If the user already
3794 * exists, a fatal status object is returned, and the user object is
3795 * initialised with the data from the database.
3797 * Previously, this function generated a DB error due to a key conflict
3798 * if the user already existed. Many extension callers use this function
3799 * in code along the lines of:
3801 * $user = User::newFromName( $name );
3802 * if ( !$user->isLoggedIn() ) {
3803 * $user->addToDatabase();
3805 * // do something with $user...
3807 * However, this was vulnerable to a race condition (bug 16020). By
3808 * initialising the user object if the user exists, we aim to support this
3809 * calling sequence as far as possible.
3811 * Note that if the user exists, this function will acquire a write lock,
3812 * so it is still advisable to make the call conditional on isLoggedIn(),
3813 * and to commit the transaction after calling.
3815 * @throws MWException
3818 public function addToDatabase() {
3820 $this->loadPasswords();
3821 if ( !$this->mToken
) {
3822 $this->setToken(); // init token
3825 $this->mTouched
= $this->newTouchedTimestamp();
3827 $dbw = wfGetDB( DB_MASTER
);
3828 $inWrite = $dbw->writesOrCallbacksPending();
3829 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3830 $dbw->insert( 'user',
3832 'user_id' => $seqVal,
3833 'user_name' => $this->mName
,
3834 'user_password' => $this->mPassword
->toString(),
3835 'user_newpassword' => $this->mNewpassword
->toString(),
3836 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3837 'user_email' => $this->mEmail
,
3838 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3839 'user_real_name' => $this->mRealName
,
3840 'user_token' => strval( $this->mToken
),
3841 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3842 'user_editcount' => 0,
3843 'user_touched' => $dbw->timestamp( $this->mTouched
),
3847 if ( !$dbw->affectedRows() ) {
3848 // The queries below cannot happen in the same REPEATABLE-READ snapshot.
3849 // Handle this by COMMIT, if possible, or by LOCK IN SHARE MODE otherwise.
3851 // Can't commit due to pending writes that may need atomicity.
3852 // This may cause some lock contention unlike the case below.
3853 $options = array( 'LOCK IN SHARE MODE' );
3854 $flags = self
::READ_LOCKING
;
3856 // Often, this case happens early in views before any writes when
3857 // using CentralAuth. It's should be OK to commit and break the snapshot.
3858 $dbw->commit( __METHOD__
, 'flush' );
3860 $flags = self
::READ_LATEST
;
3862 $this->mId
= $dbw->selectField( 'user', 'user_id',
3863 array( 'user_name' => $this->mName
), __METHOD__
, $options );
3866 if ( $this->loadFromDatabase( $flags ) ) {
3871 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3872 "to insert user '{$this->mName}' row, but it was not present in select!" );
3874 return Status
::newFatal( 'userexists' );
3876 $this->mId
= $dbw->insertId();
3878 // Clear instance cache other than user table data, which is already accurate
3879 $this->clearInstanceCache();
3881 $this->saveOptions();
3882 return Status
::newGood();
3886 * If this user is logged-in and blocked,
3887 * block any IP address they've successfully logged in from.
3888 * @return bool A block was spread
3890 public function spreadAnyEditBlock() {
3891 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3892 return $this->spreadBlock();
3898 * If this (non-anonymous) user is blocked,
3899 * block the IP address they've successfully logged in from.
3900 * @return bool A block was spread
3902 protected function spreadBlock() {
3903 wfDebug( __METHOD__
. "()\n" );
3905 if ( $this->mId
== 0 ) {
3909 $userblock = Block
::newFromTarget( $this->getName() );
3910 if ( !$userblock ) {
3914 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3918 * Get whether the user is explicitly blocked from account creation.
3919 * @return bool|Block
3921 public function isBlockedFromCreateAccount() {
3922 $this->getBlockedStatus();
3923 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
3924 return $this->mBlock
;
3927 # bug 13611: if the IP address the user is trying to create an account from is
3928 # blocked with createaccount disabled, prevent new account creation there even
3929 # when the user is logged in
3930 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3931 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3933 return $this->mBlockedFromCreateAccount
instanceof Block
3934 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3935 ?
$this->mBlockedFromCreateAccount
3940 * Get whether the user is blocked from using Special:Emailuser.
3943 public function isBlockedFromEmailuser() {
3944 $this->getBlockedStatus();
3945 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3949 * Get whether the user is allowed to create an account.
3952 public function isAllowedToCreateAccount() {
3953 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3957 * Get this user's personal page title.
3959 * @return Title User's personal page title
3961 public function getUserPage() {
3962 return Title
::makeTitle( NS_USER
, $this->getName() );
3966 * Get this user's talk page title.
3968 * @return Title User's talk page title
3970 public function getTalkPage() {
3971 $title = $this->getUserPage();
3972 return $title->getTalkPage();
3976 * Determine whether the user is a newbie. Newbies are either
3977 * anonymous IPs, or the most recently created accounts.
3980 public function isNewbie() {
3981 return !$this->isAllowed( 'autoconfirmed' );
3985 * Check to see if the given clear-text password is one of the accepted passwords
3986 * @param string $password User password
3987 * @return bool True if the given password is correct, otherwise False
3989 public function checkPassword( $password ) {
3990 global $wgAuth, $wgLegacyEncoding;
3992 $this->loadPasswords();
3994 // Some passwords will give a fatal Status, which means there is
3995 // some sort of technical or security reason for this password to
3996 // be completely invalid and should never be checked (e.g., T64685)
3997 if ( !$this->checkPasswordValidity( $password )->isOK() ) {
4001 // Certain authentication plugins do NOT want to save
4002 // domain passwords in a mysql database, so we should
4003 // check this (in case $wgAuth->strict() is false).
4004 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
4006 } elseif ( $wgAuth->strict() ) {
4007 // Auth plugin doesn't allow local authentication
4009 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
4010 // Auth plugin doesn't allow local authentication for this user name
4014 if ( !$this->mPassword
->equals( $password ) ) {
4015 if ( $wgLegacyEncoding ) {
4016 // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
4017 // Check for this with iconv
4018 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
4019 if ( $cp1252Password === $password ||
!$this->mPassword
->equals( $cp1252Password ) ) {
4027 $passwordFactory = self
::getPasswordFactory();
4028 if ( $passwordFactory->needsUpdate( $this->mPassword
) && !wfReadOnly() ) {
4029 $this->mPassword
= $passwordFactory->newFromPlaintext( $password );
4030 $this->saveSettings();
4037 * Check if the given clear-text password matches the temporary password
4038 * sent by e-mail for password reset operations.
4040 * @param string $plaintext
4042 * @return bool True if matches, false otherwise
4044 public function checkTemporaryPassword( $plaintext ) {
4045 global $wgNewPasswordExpiry;
4048 $this->loadPasswords();
4049 if ( $this->mNewpassword
->equals( $plaintext ) ) {
4050 if ( is_null( $this->mNewpassTime
) ) {
4053 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
4054 return ( time() < $expiry );
4061 * Alias for getEditToken.
4062 * @deprecated since 1.19, use getEditToken instead.
4064 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4065 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4066 * @return string The new edit token
4068 public function editToken( $salt = '', $request = null ) {
4069 wfDeprecated( __METHOD__
, '1.19' );
4070 return $this->getEditToken( $salt, $request );
4074 * Internal implementation for self::getEditToken() and
4075 * self::matchEditToken().
4077 * @param string|array $salt
4078 * @param WebRequest $request
4079 * @param string|int $timestamp
4082 private function getEditTokenAtTimestamp( $salt, $request, $timestamp ) {
4083 if ( $this->isAnon() ) {
4084 return self
::EDIT_TOKEN_SUFFIX
;
4086 $token = $request->getSessionData( 'wsEditToken' );
4087 if ( $token === null ) {
4088 $token = MWCryptRand
::generateHex( 32 );
4089 $request->setSessionData( 'wsEditToken', $token );
4091 if ( is_array( $salt ) ) {
4092 $salt = implode( '|', $salt );
4094 return hash_hmac( 'md5', $timestamp . $salt, $token, false ) .
4095 dechex( $timestamp ) .
4096 self
::EDIT_TOKEN_SUFFIX
;
4101 * Initialize (if necessary) and return a session token value
4102 * which can be used in edit forms to show that the user's
4103 * login credentials aren't being hijacked with a foreign form
4108 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4109 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4110 * @return string The new edit token
4112 public function getEditToken( $salt = '', $request = null ) {
4113 return $this->getEditTokenAtTimestamp(
4114 $salt, $request ?
: $this->getRequest(), wfTimestamp()
4119 * Generate a looking random token for various uses.
4121 * @return string The new random token
4122 * @deprecated since 1.20: Use MWCryptRand for secure purposes or
4123 * wfRandomString for pseudo-randomness.
4125 public static function generateToken() {
4126 return MWCryptRand
::generateHex( 32 );
4130 * Get the embedded timestamp from a token.
4131 * @param string $val Input token
4134 public static function getEditTokenTimestamp( $val ) {
4135 $suffixLen = strlen( self
::EDIT_TOKEN_SUFFIX
);
4136 if ( strlen( $val ) <= 32 +
$suffixLen ) {
4140 return hexdec( substr( $val, 32, -$suffixLen ) );
4144 * Check given value against the token value stored in the session.
4145 * A match should confirm that the form was submitted from the
4146 * user's own login session, not a form submission from a third-party
4149 * @param string $val Input value to compare
4150 * @param string $salt Optional function-specific data for hashing
4151 * @param WebRequest|null $request Object to use or null to use $wgRequest
4152 * @param int $maxage Fail tokens older than this, in seconds
4153 * @return bool Whether the token matches
4155 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4156 if ( $this->isAnon() ) {
4157 return $val === self
::EDIT_TOKEN_SUFFIX
;
4160 $timestamp = self
::getEditTokenTimestamp( $val );
4161 if ( $timestamp === null ) {
4164 if ( $maxage !== null && $timestamp < wfTimestamp() - $maxage ) {
4169 $sessionToken = $this->getEditTokenAtTimestamp(
4170 $salt, $request ?
: $this->getRequest(), $timestamp
4173 if ( $val != $sessionToken ) {
4174 wfDebug( "User::matchEditToken: broken session data\n" );
4177 return hash_equals( $sessionToken, $val );
4181 * Check given value against the token value stored in the session,
4182 * ignoring the suffix.
4184 * @param string $val Input value to compare
4185 * @param string $salt Optional function-specific data for hashing
4186 * @param WebRequest|null $request Object to use or null to use $wgRequest
4187 * @param int $maxage Fail tokens older than this, in seconds
4188 * @return bool Whether the token matches
4190 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4191 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . self
::EDIT_TOKEN_SUFFIX
;
4192 return $this->matchEditToken( $val, $salt, $request, $maxage );
4196 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4197 * mail to the user's given address.
4199 * @param string $type Message to send, either "created", "changed" or "set"
4202 public function sendConfirmationMail( $type = 'created' ) {
4204 $expiration = null; // gets passed-by-ref and defined in next line.
4205 $token = $this->confirmationToken( $expiration );
4206 $url = $this->confirmationTokenUrl( $token );
4207 $invalidateURL = $this->invalidationTokenUrl( $token );
4208 $this->saveSettings();
4210 if ( $type == 'created' ||
$type === false ) {
4211 $message = 'confirmemail_body';
4212 } elseif ( $type === true ) {
4213 $message = 'confirmemail_body_changed';
4215 // Messages: confirmemail_body_changed, confirmemail_body_set
4216 $message = 'confirmemail_body_' . $type;
4219 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4220 wfMessage( $message,
4221 $this->getRequest()->getIP(),
4224 $wgLang->timeanddate( $expiration, false ),
4226 $wgLang->date( $expiration, false ),
4227 $wgLang->time( $expiration, false ) )->text() );
4231 * Send an e-mail to this user's account. Does not check for
4232 * confirmed status or validity.
4234 * @param string $subject Message subject
4235 * @param string $body Message body
4236 * @param string $from Optional From address; if unspecified, default
4237 * $wgPasswordSender will be used.
4238 * @param string $replyto Reply-To address
4241 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4242 if ( is_null( $from ) ) {
4243 global $wgPasswordSender;
4244 $sender = new MailAddress( $wgPasswordSender,
4245 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4247 $sender = MailAddress
::newFromUser( $from );
4250 $to = MailAddress
::newFromUser( $this );
4251 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
4255 * Generate, store, and return a new e-mail confirmation code.
4256 * A hash (unsalted, since it's used as a key) is stored.
4258 * @note Call saveSettings() after calling this function to commit
4259 * this change to the database.
4261 * @param string &$expiration Accepts the expiration time
4262 * @return string New token
4264 protected function confirmationToken( &$expiration ) {
4265 global $wgUserEmailConfirmationTokenExpiry;
4267 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4268 $expiration = wfTimestamp( TS_MW
, $expires );
4270 $token = MWCryptRand
::generateHex( 32 );
4271 $hash = md5( $token );
4272 $this->mEmailToken
= $hash;
4273 $this->mEmailTokenExpires
= $expiration;
4278 * Return a URL the user can use to confirm their email address.
4279 * @param string $token Accepts the email confirmation token
4280 * @return string New token URL
4282 protected function confirmationTokenUrl( $token ) {
4283 return $this->getTokenUrl( 'ConfirmEmail', $token );
4287 * Return a URL the user can use to invalidate their email address.
4288 * @param string $token Accepts the email confirmation token
4289 * @return string New token URL
4291 protected function invalidationTokenUrl( $token ) {
4292 return $this->getTokenUrl( 'InvalidateEmail', $token );
4296 * Internal function to format the e-mail validation/invalidation URLs.
4297 * This uses a quickie hack to use the
4298 * hardcoded English names of the Special: pages, for ASCII safety.
4300 * @note Since these URLs get dropped directly into emails, using the
4301 * short English names avoids insanely long URL-encoded links, which
4302 * also sometimes can get corrupted in some browsers/mailers
4303 * (bug 6957 with Gmail and Internet Explorer).
4305 * @param string $page Special page
4306 * @param string $token Token
4307 * @return string Formatted URL
4309 protected function getTokenUrl( $page, $token ) {
4310 // Hack to bypass localization of 'Special:'
4311 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4312 return $title->getCanonicalURL();
4316 * Mark the e-mail address confirmed.
4318 * @note Call saveSettings() after calling this function to commit the change.
4322 public function confirmEmail() {
4323 // Check if it's already confirmed, so we don't touch the database
4324 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4325 if ( !$this->isEmailConfirmed() ) {
4326 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4327 Hooks
::run( 'ConfirmEmailComplete', array( $this ) );
4333 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4334 * address if it was already confirmed.
4336 * @note Call saveSettings() after calling this function to commit the change.
4337 * @return bool Returns true
4339 public function invalidateEmail() {
4341 $this->mEmailToken
= null;
4342 $this->mEmailTokenExpires
= null;
4343 $this->setEmailAuthenticationTimestamp( null );
4345 Hooks
::run( 'InvalidateEmailComplete', array( $this ) );
4350 * Set the e-mail authentication timestamp.
4351 * @param string $timestamp TS_MW timestamp
4353 public function setEmailAuthenticationTimestamp( $timestamp ) {
4355 $this->mEmailAuthenticated
= $timestamp;
4356 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
4360 * Is this user allowed to send e-mails within limits of current
4361 * site configuration?
4364 public function canSendEmail() {
4365 global $wgEnableEmail, $wgEnableUserEmail;
4366 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4369 $canSend = $this->isEmailConfirmed();
4370 Hooks
::run( 'UserCanSendEmail', array( &$this, &$canSend ) );
4375 * Is this user allowed to receive e-mails within limits of current
4376 * site configuration?
4379 public function canReceiveEmail() {
4380 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4384 * Is this user's e-mail address valid-looking and confirmed within
4385 * limits of the current site configuration?
4387 * @note If $wgEmailAuthentication is on, this may require the user to have
4388 * confirmed their address by returning a code or using a password
4389 * sent to the address from the wiki.
4393 public function isEmailConfirmed() {
4394 global $wgEmailAuthentication;
4397 if ( Hooks
::run( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
4398 if ( $this->isAnon() ) {
4401 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4404 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4414 * Check whether there is an outstanding request for e-mail confirmation.
4417 public function isEmailConfirmationPending() {
4418 global $wgEmailAuthentication;
4419 return $wgEmailAuthentication &&
4420 !$this->isEmailConfirmed() &&
4421 $this->mEmailToken
&&
4422 $this->mEmailTokenExpires
> wfTimestamp();
4426 * Get the timestamp of account creation.
4428 * @return string|bool|null Timestamp of account creation, false for
4429 * non-existent/anonymous user accounts, or null if existing account
4430 * but information is not in database.
4432 public function getRegistration() {
4433 if ( $this->isAnon() ) {
4437 return $this->mRegistration
;
4441 * Get the timestamp of the first edit
4443 * @return string|bool Timestamp of first edit, or false for
4444 * non-existent/anonymous user accounts.
4446 public function getFirstEditTimestamp() {
4447 if ( $this->getId() == 0 ) {
4448 return false; // anons
4450 $dbr = wfGetDB( DB_SLAVE
);
4451 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4452 array( 'rev_user' => $this->getId() ),
4454 array( 'ORDER BY' => 'rev_timestamp ASC' )
4457 return false; // no edits
4459 return wfTimestamp( TS_MW
, $time );
4463 * Get the permissions associated with a given list of groups
4465 * @param array $groups Array of Strings List of internal group names
4466 * @return array Array of Strings List of permission key names for given groups combined
4468 public static function getGroupPermissions( $groups ) {
4469 global $wgGroupPermissions, $wgRevokePermissions;
4471 // grant every granted permission first
4472 foreach ( $groups as $group ) {
4473 if ( isset( $wgGroupPermissions[$group] ) ) {
4474 $rights = array_merge( $rights,
4475 // array_filter removes empty items
4476 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4479 // now revoke the revoked permissions
4480 foreach ( $groups as $group ) {
4481 if ( isset( $wgRevokePermissions[$group] ) ) {
4482 $rights = array_diff( $rights,
4483 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4486 return array_unique( $rights );
4490 * Get all the groups who have a given permission
4492 * @param string $role Role to check
4493 * @return array Array of Strings List of internal group names with the given permission
4495 public static function getGroupsWithPermission( $role ) {
4496 global $wgGroupPermissions;
4497 $allowedGroups = array();
4498 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4499 if ( self
::groupHasPermission( $group, $role ) ) {
4500 $allowedGroups[] = $group;
4503 return $allowedGroups;
4507 * Check, if the given group has the given permission
4509 * If you're wanting to check whether all users have a permission, use
4510 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4514 * @param string $group Group to check
4515 * @param string $role Role to check
4518 public static function groupHasPermission( $group, $role ) {
4519 global $wgGroupPermissions, $wgRevokePermissions;
4520 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4521 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4525 * Check if all users have the given permission
4528 * @param string $right Right to check
4531 public static function isEveryoneAllowed( $right ) {
4532 global $wgGroupPermissions, $wgRevokePermissions;
4533 static $cache = array();
4535 // Use the cached results, except in unit tests which rely on
4536 // being able change the permission mid-request
4537 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4538 return $cache[$right];
4541 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4542 $cache[$right] = false;
4546 // If it's revoked anywhere, then everyone doesn't have it
4547 foreach ( $wgRevokePermissions as $rights ) {
4548 if ( isset( $rights[$right] ) && $rights[$right] ) {
4549 $cache[$right] = false;
4554 // Allow extensions (e.g. OAuth) to say false
4555 if ( !Hooks
::run( 'UserIsEveryoneAllowed', array( $right ) ) ) {
4556 $cache[$right] = false;
4560 $cache[$right] = true;
4565 * Get the localized descriptive name for a group, if it exists
4567 * @param string $group Internal group name
4568 * @return string Localized descriptive group name
4570 public static function getGroupName( $group ) {
4571 $msg = wfMessage( "group-$group" );
4572 return $msg->isBlank() ?
$group : $msg->text();
4576 * Get the localized descriptive name for a member of a group, if it exists
4578 * @param string $group Internal group name
4579 * @param string $username Username for gender (since 1.19)
4580 * @return string Localized name for group member
4582 public static function getGroupMember( $group, $username = '#' ) {
4583 $msg = wfMessage( "group-$group-member", $username );
4584 return $msg->isBlank() ?
$group : $msg->text();
4588 * Return the set of defined explicit groups.
4589 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4590 * are not included, as they are defined automatically, not in the database.
4591 * @return array Array of internal group names
4593 public static function getAllGroups() {
4594 global $wgGroupPermissions, $wgRevokePermissions;
4596 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4597 self
::getImplicitGroups()
4602 * Get a list of all available permissions.
4603 * @return string[] Array of permission names
4605 public static function getAllRights() {
4606 if ( self
::$mAllRights === false ) {
4607 global $wgAvailableRights;
4608 if ( count( $wgAvailableRights ) ) {
4609 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4611 self
::$mAllRights = self
::$mCoreRights;
4613 Hooks
::run( 'UserGetAllRights', array( &self
::$mAllRights ) );
4615 return self
::$mAllRights;
4619 * Get a list of implicit groups
4620 * @return array Array of Strings Array of internal group names
4622 public static function getImplicitGroups() {
4623 global $wgImplicitGroups;
4625 $groups = $wgImplicitGroups;
4626 # Deprecated, use $wgImplicitGroups instead
4627 Hooks
::run( 'UserGetImplicitGroups', array( &$groups ), '1.25' );
4633 * Get the title of a page describing a particular group
4635 * @param string $group Internal group name
4636 * @return Title|bool Title of the page if it exists, false otherwise
4638 public static function getGroupPage( $group ) {
4639 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4640 if ( $msg->exists() ) {
4641 $title = Title
::newFromText( $msg->text() );
4642 if ( is_object( $title ) ) {
4650 * Create a link to the group in HTML, if available;
4651 * else return the group name.
4653 * @param string $group Internal name of the group
4654 * @param string $text The text of the link
4655 * @return string HTML link to the group
4657 public static function makeGroupLinkHTML( $group, $text = '' ) {
4658 if ( $text == '' ) {
4659 $text = self
::getGroupName( $group );
4661 $title = self
::getGroupPage( $group );
4663 return Linker
::link( $title, htmlspecialchars( $text ) );
4665 return htmlspecialchars( $text );
4670 * Create a link to the group in Wikitext, if available;
4671 * else return the group name.
4673 * @param string $group Internal name of the group
4674 * @param string $text The text of the link
4675 * @return string Wikilink to the group
4677 public static function makeGroupLinkWiki( $group, $text = '' ) {
4678 if ( $text == '' ) {
4679 $text = self
::getGroupName( $group );
4681 $title = self
::getGroupPage( $group );
4683 $page = $title->getFullText();
4684 return "[[$page|$text]]";
4691 * Returns an array of the groups that a particular group can add/remove.
4693 * @param string $group The group to check for whether it can add/remove
4694 * @return array Array( 'add' => array( addablegroups ),
4695 * 'remove' => array( removablegroups ),
4696 * 'add-self' => array( addablegroups to self),
4697 * 'remove-self' => array( removable groups from self) )
4699 public static function changeableByGroup( $group ) {
4700 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4704 'remove' => array(),
4705 'add-self' => array(),
4706 'remove-self' => array()
4709 if ( empty( $wgAddGroups[$group] ) ) {
4710 // Don't add anything to $groups
4711 } elseif ( $wgAddGroups[$group] === true ) {
4712 // You get everything
4713 $groups['add'] = self
::getAllGroups();
4714 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4715 $groups['add'] = $wgAddGroups[$group];
4718 // Same thing for remove
4719 if ( empty( $wgRemoveGroups[$group] ) ) {
4721 } elseif ( $wgRemoveGroups[$group] === true ) {
4722 $groups['remove'] = self
::getAllGroups();
4723 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4724 $groups['remove'] = $wgRemoveGroups[$group];
4727 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4728 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4729 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4730 if ( is_int( $key ) ) {
4731 $wgGroupsAddToSelf['user'][] = $value;
4736 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4737 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4738 if ( is_int( $key ) ) {
4739 $wgGroupsRemoveFromSelf['user'][] = $value;
4744 // Now figure out what groups the user can add to him/herself
4745 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4747 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4748 // No idea WHY this would be used, but it's there
4749 $groups['add-self'] = User
::getAllGroups();
4750 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4751 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4754 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4756 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4757 $groups['remove-self'] = User
::getAllGroups();
4758 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4759 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4766 * Returns an array of groups that this user can add and remove
4767 * @return array Array( 'add' => array( addablegroups ),
4768 * 'remove' => array( removablegroups ),
4769 * 'add-self' => array( addablegroups to self),
4770 * 'remove-self' => array( removable groups from self) )
4772 public function changeableGroups() {
4773 if ( $this->isAllowed( 'userrights' ) ) {
4774 // This group gives the right to modify everything (reverse-
4775 // compatibility with old "userrights lets you change
4777 // Using array_merge to make the groups reindexed
4778 $all = array_merge( User
::getAllGroups() );
4782 'add-self' => array(),
4783 'remove-self' => array()
4787 // Okay, it's not so simple, we will have to go through the arrays
4790 'remove' => array(),
4791 'add-self' => array(),
4792 'remove-self' => array()
4794 $addergroups = $this->getEffectiveGroups();
4796 foreach ( $addergroups as $addergroup ) {
4797 $groups = array_merge_recursive(
4798 $groups, $this->changeableByGroup( $addergroup )
4800 $groups['add'] = array_unique( $groups['add'] );
4801 $groups['remove'] = array_unique( $groups['remove'] );
4802 $groups['add-self'] = array_unique( $groups['add-self'] );
4803 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4809 * Deferred version of incEditCountImmediate()
4811 public function incEditCount() {
4813 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle( function() use ( $that ) {
4814 $that->incEditCountImmediate();
4819 * Increment the user's edit-count field.
4820 * Will have no effect for anonymous users.
4823 public function incEditCountImmediate() {
4824 if ( $this->isAnon() ) {
4828 $dbw = wfGetDB( DB_MASTER
);
4829 // No rows will be "affected" if user_editcount is NULL
4832 array( 'user_editcount=user_editcount+1' ),
4833 array( 'user_id' => $this->getId() ),
4836 // Lazy initialization check...
4837 if ( $dbw->affectedRows() == 0 ) {
4838 // Now here's a goddamn hack...
4839 $dbr = wfGetDB( DB_SLAVE
);
4840 if ( $dbr !== $dbw ) {
4841 // If we actually have a slave server, the count is
4842 // at least one behind because the current transaction
4843 // has not been committed and replicated.
4844 $this->initEditCount( 1 );
4846 // But if DB_SLAVE is selecting the master, then the
4847 // count we just read includes the revision that was
4848 // just added in the working transaction.
4849 $this->initEditCount();
4852 // Edit count in user cache too
4853 $this->invalidateCache();
4857 * Initialize user_editcount from data out of the revision table
4859 * @param int $add Edits to add to the count from the revision table
4860 * @return int Number of edits
4862 protected function initEditCount( $add = 0 ) {
4863 // Pull from a slave to be less cruel to servers
4864 // Accuracy isn't the point anyway here
4865 $dbr = wfGetDB( DB_SLAVE
);
4866 $count = (int)$dbr->selectField(
4869 array( 'rev_user' => $this->getId() ),
4872 $count = $count +
$add;
4874 $dbw = wfGetDB( DB_MASTER
);
4877 array( 'user_editcount' => $count ),
4878 array( 'user_id' => $this->getId() ),
4886 * Get the description of a given right
4888 * @param string $right Right to query
4889 * @return string Localized description of the right
4891 public static function getRightDescription( $right ) {
4892 $key = "right-$right";
4893 $msg = wfMessage( $key );
4894 return $msg->isBlank() ?
$right : $msg->text();
4898 * Make a new-style password hash
4900 * @param string $password Plain-text password
4901 * @param bool|string $salt Optional salt, may be random or the user ID.
4902 * If unspecified or false, will generate one automatically
4903 * @return string Password hash
4904 * @deprecated since 1.24, use Password class
4906 public static function crypt( $password, $salt = false ) {
4907 wfDeprecated( __METHOD__
, '1.24' );
4908 $hash = self
::getPasswordFactory()->newFromPlaintext( $password );
4909 return $hash->toString();
4913 * Compare a password hash with a plain-text password. Requires the user
4914 * ID if there's a chance that the hash is an old-style hash.
4916 * @param string $hash Password hash
4917 * @param string $password Plain-text password to compare
4918 * @param string|bool $userId User ID for old-style password salt
4921 * @deprecated since 1.24, use Password class
4923 public static function comparePasswords( $hash, $password, $userId = false ) {
4924 wfDeprecated( __METHOD__
, '1.24' );
4926 // Check for *really* old password hashes that don't even have a type
4927 // The old hash format was just an md5 hex hash, with no type information
4928 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
4929 global $wgPasswordSalt;
4930 if ( $wgPasswordSalt ) {
4931 $password = ":B:{$userId}:{$hash}";
4933 $password = ":A:{$hash}";
4937 $hash = self
::getPasswordFactory()->newFromCiphertext( $hash );
4938 return $hash->equals( $password );
4942 * Add a newuser log entry for this user.
4943 * Before 1.19 the return value was always true.
4945 * @param string|bool $action Account creation type.
4946 * - String, one of the following values:
4947 * - 'create' for an anonymous user creating an account for himself.
4948 * This will force the action's performer to be the created user itself,
4949 * no matter the value of $wgUser
4950 * - 'create2' for a logged in user creating an account for someone else
4951 * - 'byemail' when the created user will receive its password by e-mail
4952 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4953 * - Boolean means whether the account was created by e-mail (deprecated):
4954 * - true will be converted to 'byemail'
4955 * - false will be converted to 'create' if this object is the same as
4956 * $wgUser and to 'create2' otherwise
4958 * @param string $reason User supplied reason
4960 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4962 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4963 global $wgUser, $wgNewUserLog;
4964 if ( empty( $wgNewUserLog ) ) {
4965 return true; // disabled
4968 if ( $action === true ) {
4969 $action = 'byemail';
4970 } elseif ( $action === false ) {
4971 if ( $this->equals( $wgUser ) ) {
4974 $action = 'create2';
4978 if ( $action === 'create' ||
$action === 'autocreate' ) {
4981 $performer = $wgUser;
4984 $logEntry = new ManualLogEntry( 'newusers', $action );
4985 $logEntry->setPerformer( $performer );
4986 $logEntry->setTarget( $this->getUserPage() );
4987 $logEntry->setComment( $reason );
4988 $logEntry->setParameters( array(
4989 '4::userid' => $this->getId(),
4991 $logid = $logEntry->insert();
4993 if ( $action !== 'autocreate' ) {
4994 $logEntry->publish( $logid );
5001 * Add an autocreate newuser log entry for this user
5002 * Used by things like CentralAuth and perhaps other authplugins.
5003 * Consider calling addNewUserLogEntry() directly instead.
5007 public function addNewUserLogEntryAutoCreate() {
5008 $this->addNewUserLogEntry( 'autocreate' );
5014 * Load the user options either from cache, the database or an array
5016 * @param array $data Rows for the current user out of the user_properties table
5018 protected function loadOptions( $data = null ) {
5023 if ( $this->mOptionsLoaded
) {
5027 $this->mOptions
= self
::getDefaultOptions();
5029 if ( !$this->getId() ) {
5030 // For unlogged-in users, load language/variant options from request.
5031 // There's no need to do it for logged-in users: they can set preferences,
5032 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5033 // so don't override user's choice (especially when the user chooses site default).
5034 $variant = $wgContLang->getDefaultVariant();
5035 $this->mOptions
['variant'] = $variant;
5036 $this->mOptions
['language'] = $variant;
5037 $this->mOptionsLoaded
= true;
5041 // Maybe load from the object
5042 if ( !is_null( $this->mOptionOverrides
) ) {
5043 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5044 foreach ( $this->mOptionOverrides
as $key => $value ) {
5045 $this->mOptions
[$key] = $value;
5048 if ( !is_array( $data ) ) {
5049 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5050 // Load from database
5051 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5052 ?
wfGetDB( DB_MASTER
)
5053 : wfGetDB( DB_SLAVE
);
5055 $res = $dbr->select(
5057 array( 'up_property', 'up_value' ),
5058 array( 'up_user' => $this->getId() ),
5062 $this->mOptionOverrides
= array();
5064 foreach ( $res as $row ) {
5065 $data[$row->up_property
] = $row->up_value
;
5068 foreach ( $data as $property => $value ) {
5069 $this->mOptionOverrides
[$property] = $value;
5070 $this->mOptions
[$property] = $value;
5074 $this->mOptionsLoaded
= true;
5076 Hooks
::run( 'UserLoadOptions', array( $this, &$this->mOptions
) );
5080 * Saves the non-default options for this user, as previously set e.g. via
5081 * setOption(), in the database's "user_properties" (preferences) table.
5082 * Usually used via saveSettings().
5084 protected function saveOptions() {
5085 $this->loadOptions();
5087 // Not using getOptions(), to keep hidden preferences in database
5088 $saveOptions = $this->mOptions
;
5090 // Allow hooks to abort, for instance to save to a global profile.
5091 // Reset options to default state before saving.
5092 if ( !Hooks
::run( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
5096 $userId = $this->getId();
5098 $insert_rows = array(); // all the new preference rows
5099 foreach ( $saveOptions as $key => $value ) {
5100 // Don't bother storing default values
5101 $defaultOption = self
::getDefaultOption( $key );
5102 if ( ( $defaultOption === null && $value !== false && $value !== null )
5103 ||
$value != $defaultOption
5105 $insert_rows[] = array(
5106 'up_user' => $userId,
5107 'up_property' => $key,
5108 'up_value' => $value,
5113 $dbw = wfGetDB( DB_MASTER
);
5115 $res = $dbw->select( 'user_properties',
5116 array( 'up_property', 'up_value' ), array( 'up_user' => $userId ), __METHOD__
);
5118 // Find prior rows that need to be removed or updated. These rows will
5119 // all be deleted (the later so that INSERT IGNORE applies the new values).
5120 $keysDelete = array();
5121 foreach ( $res as $row ) {
5122 if ( !isset( $saveOptions[$row->up_property
] )
5123 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5125 $keysDelete[] = $row->up_property
;
5129 if ( count( $keysDelete ) ) {
5130 // Do the DELETE by PRIMARY KEY for prior rows.
5131 // In the past a very large portion of calls to this function are for setting
5132 // 'rememberpassword' for new accounts (a preference that has since been removed).
5133 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5134 // caused gap locks on [max user ID,+infinity) which caused high contention since
5135 // updates would pile up on each other as they are for higher (newer) user IDs.
5136 // It might not be necessary these days, but it shouldn't hurt either.
5137 $dbw->delete( 'user_properties',
5138 array( 'up_user' => $userId, 'up_property' => $keysDelete ), __METHOD__
);
5140 // Insert the new preference rows
5141 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, array( 'IGNORE' ) );
5145 * Lazily instantiate and return a factory object for making passwords
5147 * @return PasswordFactory
5149 public static function getPasswordFactory() {
5150 if ( self
::$mPasswordFactory === null ) {
5151 self
::$mPasswordFactory = new PasswordFactory();
5152 self
::$mPasswordFactory->init( RequestContext
::getMain()->getConfig() );
5155 return self
::$mPasswordFactory;
5159 * Provide an array of HTML5 attributes to put on an input element
5160 * intended for the user to enter a new password. This may include
5161 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5163 * Do *not* use this when asking the user to enter his current password!
5164 * Regardless of configuration, users may have invalid passwords for whatever
5165 * reason (e.g., they were set before requirements were tightened up).
5166 * Only use it when asking for a new password, like on account creation or
5169 * Obviously, you still need to do server-side checking.
5171 * NOTE: A combination of bugs in various browsers means that this function
5172 * actually just returns array() unconditionally at the moment. May as
5173 * well keep it around for when the browser bugs get fixed, though.
5175 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5177 * @return array Array of HTML attributes suitable for feeding to
5178 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5179 * That will get confused by the boolean attribute syntax used.)
5181 public static function passwordChangeInputAttribs() {
5182 global $wgMinimalPasswordLength;
5184 if ( $wgMinimalPasswordLength == 0 ) {
5188 # Note that the pattern requirement will always be satisfied if the
5189 # input is empty, so we need required in all cases.
5191 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5192 # if e-mail confirmation is being used. Since HTML5 input validation
5193 # is b0rked anyway in some browsers, just return nothing. When it's
5194 # re-enabled, fix this code to not output required for e-mail
5196 #$ret = array( 'required' );
5199 # We can't actually do this right now, because Opera 9.6 will print out
5200 # the entered password visibly in its error message! When other
5201 # browsers add support for this attribute, or Opera fixes its support,
5202 # we can add support with a version check to avoid doing this on Opera
5203 # versions where it will be a problem. Reported to Opera as
5204 # DSK-262266, but they don't have a public bug tracker for us to follow.
5206 if ( $wgMinimalPasswordLength > 1 ) {
5207 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5208 $ret['title'] = wfMessage( 'passwordtooshort' )
5209 ->numParams( $wgMinimalPasswordLength )->text();
5217 * Return the list of user fields that should be selected to create
5218 * a new user object.
5221 public static function selectFields() {
5229 'user_email_authenticated',
5231 'user_email_token_expires',
5232 'user_registration',
5238 * Factory function for fatal permission-denied errors
5241 * @param string $permission User right required
5244 static function newFatalPermissionDeniedStatus( $permission ) {
5247 $groups = array_map(
5248 array( 'User', 'makeGroupLinkWiki' ),
5249 User
::getGroupsWithPermission( $permission )
5253 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5255 return Status
::newFatal( 'badaccess-group0' );
5260 * Checks if two user objects point to the same user.
5266 public function equals( User
$user ) {
5267 return $this->getName() === $user->getName();