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
23 use MediaWiki\Session\SessionManager
;
26 * String Some punctuation to prevent editing from broken text-mangling proxies.
27 * @deprecated since 1.27, use \\MediaWiki\\Session\\Token::SUFFIX
30 define( 'EDIT_TOKEN_SUFFIX', MediaWiki\Session\Token
::SUFFIX
);
33 * The User object encapsulates all of the user-specific settings (user_id,
34 * name, rights, email address, options, last login time). Client
35 * classes use the getXXX() functions to access these fields. These functions
36 * do all the work of determining whether the user is logged in,
37 * whether the requested option can be satisfied from cookies or
38 * whether a database query is needed. Most of the settings needed
39 * for rendering normal pages are set in the cookie to minimize use
42 class User
implements IDBAccessObject
{
44 * @const int Number of characters in user_token field.
46 const TOKEN_LENGTH
= 32;
49 * Global constant made accessible as class constants so that autoloader
51 * @deprecated since 1.27, use \\MediaWiki\\Session\\Token::SUFFIX
53 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
56 * @const int Serialized record version.
61 * Maximum items in $mWatchedItems
63 const MAX_WATCHED_ITEMS_CACHE
= 100;
66 * Exclude user options that are set to their default value.
69 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
72 * Array of Strings List of member variables which are saved to the
73 * shared cache (memcached). Any operation which changes the
74 * corresponding database fields must call a cache-clearing function.
77 protected static $mCacheVars = array(
85 'mEmailAuthenticated',
92 // user_properties table
97 * Array of Strings Core rights.
98 * Each of these should have a corresponding message of the form
102 protected static $mCoreRights = array(
132 'editusercssjs', # deprecated
145 'move-categorypages',
146 'move-rootuserpages',
150 'override-export-depth',
173 'userrights-interwiki',
181 * String Cached results of getAllRights()
183 protected static $mAllRights = false;
185 /** Cache variables */
195 /** @var string TS_MW timestamp from the DB */
197 /** @var string TS_MW timestamp from cache */
198 protected $mQuickTouched;
202 public $mEmailAuthenticated;
204 protected $mEmailToken;
206 protected $mEmailTokenExpires;
208 protected $mRegistration;
210 protected $mEditCount;
214 protected $mOptionOverrides;
218 * Bool Whether the cache variables have been loaded.
221 public $mOptionsLoaded;
224 * Array with already loaded items or true if all items have been loaded.
226 protected $mLoadedItems = array();
230 * String Initialization data source if mLoadedItems!==true. May be one of:
231 * - 'defaults' anonymous user initialised from class defaults
232 * - 'name' initialise from mName
233 * - 'id' initialise from mId
234 * - 'session' log in from session if possible
236 * Use the User::newFrom*() family of functions to set this.
241 * Lazy-initialized variables, invalidated with clearInstanceCache
245 protected $mDatePreference;
253 protected $mBlockreason;
255 protected $mEffectiveGroups;
257 protected $mImplicitGroups;
259 protected $mFormerGroups;
261 protected $mBlockedGlobally;
278 protected $mAllowUsertalk;
281 private $mBlockedFromCreateAccount = false;
284 private $mWatchedItems = array();
286 /** @var integer User::READ_* constant bitfield used to load data */
287 protected $queryFlagsUsed = self
::READ_NORMAL
;
289 public static $idCacheByName = array();
292 * Lightweight constructor for an anonymous user.
293 * Use the User::newFrom* factory functions for other kinds of users.
297 * @see newFromConfirmationCode()
298 * @see newFromSession()
301 public function __construct() {
302 $this->clearInstanceCache( 'defaults' );
308 public function __toString() {
309 return $this->getName();
313 * Test if it's safe to load this User object
316 public function isSafeToLoad() {
317 global $wgFullyInitialised;
318 return $wgFullyInitialised ||
$this->mLoadedItems
=== true ||
$this->mFrom
!== 'session';
322 * Load the user table data for this object from the source given by mFrom.
324 * @param integer $flags User::READ_* constant bitfield
326 public function load( $flags = self
::READ_NORMAL
) {
327 global $wgFullyInitialised;
329 if ( $this->mLoadedItems
=== true ) {
333 // Set it now to avoid infinite recursion in accessors
334 $oldLoadedItems = $this->mLoadedItems
;
335 $this->mLoadedItems
= true;
336 $this->queryFlagsUsed
= $flags;
338 // If this is called too early, things are likely to break.
339 if ( !$wgFullyInitialised && $this->mFrom
=== 'session' ) {
340 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
341 ->warning( 'User::loadFromSession called before the end of Setup.php', array(
342 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
344 $this->loadDefaults();
345 $this->mLoadedItems
= $oldLoadedItems;
349 switch ( $this->mFrom
) {
351 $this->loadDefaults();
354 // Make sure this thread sees its own changes
355 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
356 $flags |
= self
::READ_LATEST
;
357 $this->queryFlagsUsed
= $flags;
360 $this->mId
= self
::idFromName( $this->mName
, $flags );
362 // Nonexistent user placeholder object
363 $this->loadDefaults( $this->mName
);
365 $this->loadFromId( $flags );
369 $this->loadFromId( $flags );
372 if ( !$this->loadFromSession() ) {
373 // Loading from session failed. Load defaults.
374 $this->loadDefaults();
376 Hooks
::run( 'UserLoadAfterLoadFromSession', array( $this ) );
379 throw new UnexpectedValueException(
380 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
385 * Load user table data, given mId has already been set.
386 * @param integer $flags User::READ_* constant bitfield
387 * @return bool False if the ID does not exist, true otherwise
389 public function loadFromId( $flags = self
::READ_NORMAL
) {
390 if ( $this->mId
== 0 ) {
391 $this->loadDefaults();
395 // Try cache (unless this needs data from the master DB).
396 // NOTE: if this thread called saveSettings(), the cache was cleared.
397 $latest = DBAccessObjectUtils
::hasFlags( $flags, self
::READ_LATEST
);
398 if ( $latest ||
!$this->loadFromCache() ) {
399 wfDebug( "User: cache miss for user {$this->mId}\n" );
400 // Load from DB (make sure this thread sees its own changes)
401 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
402 $flags |
= self
::READ_LATEST
;
404 if ( !$this->loadFromDatabase( $flags ) ) {
405 // Can't load from ID, user is anonymous
408 $this->saveToCache();
411 $this->mLoadedItems
= true;
412 $this->queryFlagsUsed
= $flags;
419 * @param string $wikiId
420 * @param integer $userId
422 public static function purge( $wikiId, $userId ) {
423 $cache = ObjectCache
::getMainWANInstance();
424 $cache->delete( $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId ) );
429 * @param WANObjectCache $cache
432 protected function getCacheKey( WANObjectCache
$cache ) {
433 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId
);
437 * Load user data from shared cache, given mId has already been set.
439 * @return bool false if the ID does not exist or data is invalid, true otherwise
442 protected function loadFromCache() {
443 if ( $this->mId
== 0 ) {
444 $this->loadDefaults();
448 $cache = ObjectCache
::getMainWANInstance();
449 $data = $cache->get( $this->getCacheKey( $cache ) );
450 if ( !is_array( $data ) ||
$data['mVersion'] < self
::VERSION
) {
455 wfDebug( "User: got user {$this->mId} from cache\n" );
457 // Restore from cache
458 foreach ( self
::$mCacheVars as $name ) {
459 $this->$name = $data[$name];
466 * Save user data to the shared cache
468 * This method should not be called outside the User class
470 public function saveToCache() {
473 $this->loadOptions();
475 if ( $this->isAnon() ) {
476 // Anonymous users are uncached
481 foreach ( self
::$mCacheVars as $name ) {
482 $data[$name] = $this->$name;
484 $data['mVersion'] = self
::VERSION
;
485 $opts = Database
::getCacheSetOptions( wfGetDB( DB_SLAVE
) );
487 $cache = ObjectCache
::getMainWANInstance();
488 $key = $this->getCacheKey( $cache );
489 $cache->set( $key, $data, $cache::TTL_HOUR
, $opts );
492 /** @name newFrom*() static factory methods */
496 * Static factory method for creation from username.
498 * This is slightly less efficient than newFromId(), so use newFromId() if
499 * you have both an ID and a name handy.
501 * @param string $name Username, validated by Title::newFromText()
502 * @param string|bool $validate Validate username. Takes the same parameters as
503 * User::getCanonicalName(), except that true is accepted as an alias
504 * for 'valid', for BC.
506 * @return User|bool User object, or false if the username is invalid
507 * (e.g. if it contains illegal characters or is an IP address). If the
508 * username is not present in the database, the result will be a user object
509 * with a name, zero user ID and default settings.
511 public static function newFromName( $name, $validate = 'valid' ) {
512 if ( $validate === true ) {
515 $name = self
::getCanonicalName( $name, $validate );
516 if ( $name === false ) {
519 // Create unloaded user object
523 $u->setItemLoaded( 'name' );
529 * Static factory method for creation from a given user ID.
531 * @param int $id Valid user ID
532 * @return User The corresponding User object
534 public static function newFromId( $id ) {
538 $u->setItemLoaded( 'id' );
543 * Factory method to fetch whichever user has a given email confirmation code.
544 * This code is generated when an account is created or its e-mail address
547 * If the code is invalid or has expired, returns NULL.
549 * @param string $code Confirmation code
550 * @param int $flags User::READ_* bitfield
553 public static function newFromConfirmationCode( $code, $flags = 0 ) {
554 $db = ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
555 ?
wfGetDB( DB_MASTER
)
556 : wfGetDB( DB_SLAVE
);
558 $id = $db->selectField(
562 'user_email_token' => md5( $code ),
563 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
567 return $id ? User
::newFromId( $id ) : null;
571 * Create a new user object using data from session. If the login
572 * credentials are invalid, the result is an anonymous user.
574 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
577 public static function newFromSession( WebRequest
$request = null ) {
579 $user->mFrom
= 'session';
580 $user->mRequest
= $request;
585 * Create a new user object from a user row.
586 * The row should have the following fields from the user table in it:
587 * - either user_name or user_id to load further data if needed (or both)
589 * - all other fields (email, etc.)
590 * It is useless to provide the remaining fields if either user_id,
591 * user_name and user_real_name are not provided because the whole row
592 * will be loaded once more from the database when accessing them.
594 * @param stdClass $row A row from the user table
595 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
598 public static function newFromRow( $row, $data = null ) {
600 $user->loadFromRow( $row, $data );
605 * Static factory method for creation of a "system" user from username.
607 * A "system" user is an account that's used to attribute logged actions
608 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
609 * might include the 'Maintenance script' or 'Conversion script' accounts
610 * used by various scripts in the maintenance/ directory or accounts such
611 * as 'MediaWiki message delivery' used by the MassMessage extension.
613 * This can optionally create the user if it doesn't exist, and "steal" the
614 * account if it does exist.
616 * @param string $name Username
617 * @param array $options Options are:
618 * - validate: As for User::getCanonicalName(), default 'valid'
619 * - create: Whether to create the user if it doesn't already exist, default true
620 * - steal: Whether to reset the account's password and email if it
621 * already exists, default false
624 public static function newSystemUser( $name, $options = array() ) {
626 'validate' => 'valid',
631 $name = self
::getCanonicalName( $name, $options['validate'] );
632 if ( $name === false ) {
636 $dbw = wfGetDB( DB_MASTER
);
637 $row = $dbw->selectRow(
640 self
::selectFields(),
641 array( 'user_password', 'user_newpassword' )
643 array( 'user_name' => $name ),
647 // No user. Create it?
648 return $options['create'] ? self
::createNew( $name ) : null;
650 $user = self
::newFromRow( $row );
652 // A user is considered to exist as a non-system user if it has a
653 // password set, or a temporary password set, or an email set.
654 $passwordFactory = new PasswordFactory();
655 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
657 $password = $passwordFactory->newFromCiphertext( $row->user_password
);
658 } catch ( PasswordError
$e ) {
659 wfDebug( 'Invalid password hash found in database.' );
660 $password = PasswordFactory
::newInvalidPassword();
663 $newpassword = $passwordFactory->newFromCiphertext( $row->user_newpassword
);
664 } catch ( PasswordError
$e ) {
665 wfDebug( 'Invalid password hash found in database.' );
666 $newpassword = PasswordFactory
::newInvalidPassword();
668 if ( !$password instanceof InvalidPassword ||
!$newpassword instanceof InvalidPassword
671 // User exists. Steal it?
672 if ( !$options['steal'] ) {
676 $nopass = PasswordFactory
::newInvalidPassword()->toString();
681 'user_password' => $nopass,
682 'user_newpassword' => $nopass,
683 'user_newpass_time' => null,
685 array( 'user_id' => $user->getId() ),
688 $user->invalidateEmail();
689 $user->saveSettings();
692 SessionManager
::singleton()->preventSessionsForUser( $user->getName() );
700 * Get the username corresponding to a given user ID
701 * @param int $id User ID
702 * @return string|bool The corresponding username
704 public static function whoIs( $id ) {
705 return UserCache
::singleton()->getProp( $id, 'name' );
709 * Get the real name of a user given their user ID
711 * @param int $id User ID
712 * @return string|bool The corresponding user's real name
714 public static function whoIsReal( $id ) {
715 return UserCache
::singleton()->getProp( $id, 'real_name' );
719 * Get database id given a user name
720 * @param string $name Username
721 * @param integer $flags User::READ_* constant bitfield
722 * @return int|null The corresponding user's ID, or null if user is nonexistent
724 public static function idFromName( $name, $flags = self
::READ_NORMAL
) {
725 $nt = Title
::makeTitleSafe( NS_USER
, $name );
726 if ( is_null( $nt ) ) {
731 if ( !( $flags & self
::READ_LATEST
) && isset( self
::$idCacheByName[$name] ) ) {
732 return self
::$idCacheByName[$name];
735 $db = ( $flags & self
::READ_LATEST
)
736 ?
wfGetDB( DB_MASTER
)
737 : wfGetDB( DB_SLAVE
);
742 array( 'user_name' => $nt->getText() ),
746 if ( $s === false ) {
749 $result = $s->user_id
;
752 self
::$idCacheByName[$name] = $result;
754 if ( count( self
::$idCacheByName ) > 1000 ) {
755 self
::$idCacheByName = array();
762 * Reset the cache used in idFromName(). For use in tests.
764 public static function resetIdByNameCache() {
765 self
::$idCacheByName = array();
769 * Does the string match an anonymous IPv4 address?
771 * This function exists for username validation, in order to reject
772 * usernames which are similar in form to IP addresses. Strings such
773 * as 300.300.300.300 will return true because it looks like an IP
774 * address, despite not being strictly valid.
776 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
777 * address because the usemod software would "cloak" anonymous IP
778 * addresses like this, if we allowed accounts like this to be created
779 * new users could get the old edits of these anonymous users.
781 * @param string $name Name to match
784 public static function isIP( $name ) {
785 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
786 || IP
::isIPv6( $name );
790 * Is the input a valid username?
792 * Checks if the input is a valid username, we don't want an empty string,
793 * an IP address, anything that contains slashes (would mess up subpages),
794 * is longer than the maximum allowed username size or doesn't begin with
797 * @param string $name Name to match
800 public static function isValidUserName( $name ) {
801 global $wgContLang, $wgMaxNameChars;
804 || User
::isIP( $name )
805 ||
strpos( $name, '/' ) !== false
806 ||
strlen( $name ) > $wgMaxNameChars
807 ||
$name != $wgContLang->ucfirst( $name )
809 wfDebugLog( 'username', __METHOD__
.
810 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
814 // Ensure that the name can't be misresolved as a different title,
815 // such as with extra namespace keys at the start.
816 $parsed = Title
::newFromText( $name );
817 if ( is_null( $parsed )
818 ||
$parsed->getNamespace()
819 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
820 wfDebugLog( 'username', __METHOD__
.
821 ": '$name' invalid due to ambiguous prefixes" );
825 // Check an additional blacklist of troublemaker characters.
826 // Should these be merged into the title char list?
827 $unicodeBlacklist = '/[' .
828 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
829 '\x{00a0}' . # non-breaking space
830 '\x{2000}-\x{200f}' . # various whitespace
831 '\x{2028}-\x{202f}' . # breaks and control chars
832 '\x{3000}' . # ideographic space
833 '\x{e000}-\x{f8ff}' . # private use
835 if ( preg_match( $unicodeBlacklist, $name ) ) {
836 wfDebugLog( 'username', __METHOD__
.
837 ": '$name' invalid due to blacklisted characters" );
845 * Usernames which fail to pass this function will be blocked
846 * from user login and new account registrations, but may be used
847 * internally by batch processes.
849 * If an account already exists in this form, login will be blocked
850 * by a failure to pass this function.
852 * @param string $name Name to match
855 public static function isUsableName( $name ) {
856 global $wgReservedUsernames;
857 // Must be a valid username, obviously ;)
858 if ( !self
::isValidUserName( $name ) ) {
862 static $reservedUsernames = false;
863 if ( !$reservedUsernames ) {
864 $reservedUsernames = $wgReservedUsernames;
865 Hooks
::run( 'UserGetReservedNames', array( &$reservedUsernames ) );
868 // Certain names may be reserved for batch processes.
869 foreach ( $reservedUsernames as $reserved ) {
870 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
871 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
873 if ( $reserved == $name ) {
881 * Usernames which fail to pass this function will be blocked
882 * from new account registrations, but may be used internally
883 * either by batch processes or by user accounts which have
884 * already been created.
886 * Additional blacklisting may be added here rather than in
887 * isValidUserName() to avoid disrupting existing accounts.
889 * @param string $name String to match
892 public static function isCreatableName( $name ) {
893 global $wgInvalidUsernameCharacters;
895 // Ensure that the username isn't longer than 235 bytes, so that
896 // (at least for the builtin skins) user javascript and css files
897 // will work. (bug 23080)
898 if ( strlen( $name ) > 235 ) {
899 wfDebugLog( 'username', __METHOD__
.
900 ": '$name' invalid due to length" );
904 // Preg yells if you try to give it an empty string
905 if ( $wgInvalidUsernameCharacters !== '' ) {
906 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
907 wfDebugLog( 'username', __METHOD__
.
908 ": '$name' invalid due to wgInvalidUsernameCharacters" );
913 return self
::isUsableName( $name );
917 * Is the input a valid password for this user?
919 * @param string $password Desired password
922 public function isValidPassword( $password ) {
923 // simple boolean wrapper for getPasswordValidity
924 return $this->getPasswordValidity( $password ) === true;
928 * Given unvalidated password input, return error message on failure.
930 * @param string $password Desired password
931 * @return bool|string|array True on success, string or array of error message on failure
933 public function getPasswordValidity( $password ) {
934 $result = $this->checkPasswordValidity( $password );
935 if ( $result->isGood() ) {
939 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
940 $messages[] = $error['message'];
942 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
943 $messages[] = $warning['message'];
945 if ( count( $messages ) === 1 ) {
953 * Check if this is a valid password for this user
955 * Create a Status object based on the password's validity.
956 * The Status should be set to fatal if the user should not
957 * be allowed to log in, and should have any errors that
958 * would block changing the password.
960 * If the return value of this is not OK, the password
961 * should not be checked. If the return value is not Good,
962 * the password can be checked, but the user should not be
963 * able to set their password to this.
965 * @param string $password Desired password
966 * @param string $purpose one of 'login', 'create', 'reset'
970 public function checkPasswordValidity( $password, $purpose = 'login' ) {
971 global $wgPasswordPolicy;
973 $upp = new UserPasswordPolicy(
974 $wgPasswordPolicy['policies'],
975 $wgPasswordPolicy['checks']
978 $status = Status
::newGood();
979 $result = false; // init $result to false for the internal checks
981 if ( !Hooks
::run( 'isValidPassword', array( $password, &$result, $this ) ) ) {
982 $status->error( $result );
986 if ( $result === false ) {
987 $status->merge( $upp->checkUserPassword( $this, $password, $purpose ) );
989 } elseif ( $result === true ) {
992 $status->error( $result );
993 return $status; // the isValidPassword hook set a string $result and returned true
998 * Given unvalidated user input, return a canonical username, or false if
999 * the username is invalid.
1000 * @param string $name User input
1001 * @param string|bool $validate Type of validation to use:
1002 * - false No validation
1003 * - 'valid' Valid for batch processes
1004 * - 'usable' Valid for batch processes and login
1005 * - 'creatable' Valid for batch processes, login and account creation
1007 * @throws InvalidArgumentException
1008 * @return bool|string
1010 public static function getCanonicalName( $name, $validate = 'valid' ) {
1011 // Force usernames to capital
1013 $name = $wgContLang->ucfirst( $name );
1015 # Reject names containing '#'; these will be cleaned up
1016 # with title normalisation, but then it's too late to
1018 if ( strpos( $name, '#' ) !== false ) {
1022 // Clean up name according to title rules,
1023 // but only when validation is requested (bug 12654)
1024 $t = ( $validate !== false ) ?
1025 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
1026 // Check for invalid titles
1027 if ( is_null( $t ) ) {
1031 // Reject various classes of invalid names
1033 $name = $wgAuth->getCanonicalName( $t->getText() );
1035 switch ( $validate ) {
1039 if ( !User
::isValidUserName( $name ) ) {
1044 if ( !User
::isUsableName( $name ) ) {
1049 if ( !User
::isCreatableName( $name ) ) {
1054 throw new InvalidArgumentException(
1055 'Invalid parameter value for $validate in ' . __METHOD__
);
1061 * Count the number of edits of a user
1063 * @param int $uid User ID to check
1064 * @return int The user's edit count
1066 * @deprecated since 1.21 in favour of User::getEditCount
1068 public static function edits( $uid ) {
1069 wfDeprecated( __METHOD__
, '1.21' );
1070 $user = self
::newFromId( $uid );
1071 return $user->getEditCount();
1075 * Return a random password.
1077 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1078 * @return string New random password
1080 public static function randomPassword() {
1081 global $wgMinimalPasswordLength;
1082 return PasswordFactory
::generateRandomPasswordString( $wgMinimalPasswordLength );
1086 * Set cached properties to default.
1088 * @note This no longer clears uncached lazy-initialised properties;
1089 * the constructor does that instead.
1091 * @param string|bool $name
1093 public function loadDefaults( $name = false ) {
1095 $this->mName
= $name;
1096 $this->mRealName
= '';
1098 $this->mOptionOverrides
= null;
1099 $this->mOptionsLoaded
= false;
1101 $loggedOut = $this->mRequest ?
$this->mRequest
->getSession()->getLoggedOutTimestamp() : 0;
1102 if ( $loggedOut !== 0 ) {
1103 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1105 $this->mTouched
= '1'; # Allow any pages to be cached
1108 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1109 $this->mEmailAuthenticated
= null;
1110 $this->mEmailToken
= '';
1111 $this->mEmailTokenExpires
= null;
1112 $this->mRegistration
= wfTimestamp( TS_MW
);
1113 $this->mGroups
= array();
1115 Hooks
::run( 'UserLoadDefaults', array( $this, $name ) );
1119 * Return whether an item has been loaded.
1121 * @param string $item Item to check. Current possibilities:
1125 * @param string $all 'all' to check if the whole object has been loaded
1126 * or any other string to check if only the item is available (e.g.
1130 public function isItemLoaded( $item, $all = 'all' ) {
1131 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1132 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1136 * Set that an item has been loaded
1138 * @param string $item
1140 protected function setItemLoaded( $item ) {
1141 if ( is_array( $this->mLoadedItems
) ) {
1142 $this->mLoadedItems
[$item] = true;
1147 * Load user data from the session.
1149 * @return bool True if the user is logged in, false otherwise.
1151 private function loadFromSession() {
1154 Hooks
::run( 'UserLoadFromSession', array( $this, &$result ), '1.27' );
1155 if ( $result !== null ) {
1159 // MediaWiki\Session\Session already did the necessary authentication of the user
1160 // returned here, so just use it if applicable.
1161 $session = $this->getRequest()->getSession();
1162 $user = $session->getUser();
1163 if ( $user->isLoggedIn() ) {
1164 $this->loadFromUserObject( $user );
1165 // Other code expects these to be set in the session, so set them.
1166 $session->set( 'wsUserID', $this->getId() );
1167 $session->set( 'wsUserName', $this->getName() );
1168 $session->set( 'wsToken', $this->getToken() );
1176 * Load user and user_group data from the database.
1177 * $this->mId must be set, this is how the user is identified.
1179 * @param integer $flags User::READ_* constant bitfield
1180 * @return bool True if the user exists, false if the user is anonymous
1182 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1184 $this->mId
= intval( $this->mId
);
1187 if ( !$this->mId
) {
1188 $this->loadDefaults();
1192 list( $index, $options ) = DBAccessObjectUtils
::getDBOptions( $flags );
1193 $db = wfGetDB( $index );
1195 $s = $db->selectRow(
1197 self
::selectFields(),
1198 array( 'user_id' => $this->mId
),
1203 $this->queryFlagsUsed
= $flags;
1204 Hooks
::run( 'UserLoadFromDatabase', array( $this, &$s ) );
1206 if ( $s !== false ) {
1207 // Initialise user table data
1208 $this->loadFromRow( $s );
1209 $this->mGroups
= null; // deferred
1210 $this->getEditCount(); // revalidation for nulls
1215 $this->loadDefaults();
1221 * Initialize this object from a row from the user table.
1223 * @param stdClass $row Row from the user table to load.
1224 * @param array $data Further user data to load into the object
1226 * user_groups Array with groups out of the user_groups table
1227 * user_properties Array with properties out of the user_properties table
1229 protected function loadFromRow( $row, $data = null ) {
1232 $this->mGroups
= null; // deferred
1234 if ( isset( $row->user_name
) ) {
1235 $this->mName
= $row->user_name
;
1236 $this->mFrom
= 'name';
1237 $this->setItemLoaded( 'name' );
1242 if ( isset( $row->user_real_name
) ) {
1243 $this->mRealName
= $row->user_real_name
;
1244 $this->setItemLoaded( 'realname' );
1249 if ( isset( $row->user_id
) ) {
1250 $this->mId
= intval( $row->user_id
);
1251 $this->mFrom
= 'id';
1252 $this->setItemLoaded( 'id' );
1257 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1258 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1261 if ( isset( $row->user_editcount
) ) {
1262 $this->mEditCount
= $row->user_editcount
;
1267 if ( isset( $row->user_touched
) ) {
1268 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1273 if ( isset( $row->user_token
) ) {
1274 // The definition for the column is binary(32), so trim the NULs
1275 // that appends. The previous definition was char(32), so trim
1277 $this->mToken
= rtrim( $row->user_token
, " \0" );
1278 if ( $this->mToken
=== '' ) {
1279 $this->mToken
= null;
1285 if ( isset( $row->user_email
) ) {
1286 $this->mEmail
= $row->user_email
;
1287 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1288 $this->mEmailToken
= $row->user_email_token
;
1289 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1290 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1296 $this->mLoadedItems
= true;
1299 if ( is_array( $data ) ) {
1300 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1301 $this->mGroups
= $data['user_groups'];
1303 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1304 $this->loadOptions( $data['user_properties'] );
1310 * Load the data for this user object from another user object.
1314 protected function loadFromUserObject( $user ) {
1316 $user->loadGroups();
1317 $user->loadOptions();
1318 foreach ( self
::$mCacheVars as $var ) {
1319 $this->$var = $user->$var;
1324 * Load the groups from the database if they aren't already loaded.
1326 private function loadGroups() {
1327 if ( is_null( $this->mGroups
) ) {
1328 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1329 ?
wfGetDB( DB_MASTER
)
1330 : wfGetDB( DB_SLAVE
);
1331 $res = $db->select( 'user_groups',
1332 array( 'ug_group' ),
1333 array( 'ug_user' => $this->mId
),
1335 $this->mGroups
= array();
1336 foreach ( $res as $row ) {
1337 $this->mGroups
[] = $row->ug_group
;
1343 * Add the user to the group if he/she meets given criteria.
1345 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1346 * possible to remove manually via Special:UserRights. In such case it
1347 * will not be re-added automatically. The user will also not lose the
1348 * group if they no longer meet the criteria.
1350 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1352 * @return array Array of groups the user has been promoted to.
1354 * @see $wgAutopromoteOnce
1356 public function addAutopromoteOnceGroups( $event ) {
1357 global $wgAutopromoteOnceLogInRC, $wgAuth;
1359 if ( wfReadOnly() ||
!$this->getId() ) {
1363 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1364 if ( !count( $toPromote ) ) {
1368 if ( !$this->checkAndSetTouched() ) {
1369 return array(); // raced out (bug T48834)
1372 $oldGroups = $this->getGroups(); // previous groups
1373 foreach ( $toPromote as $group ) {
1374 $this->addGroup( $group );
1376 // update groups in external authentication database
1377 Hooks
::run( 'UserGroupsChanged', array( $this, $toPromote, array(), false ) );
1378 $wgAuth->updateExternalDBGroups( $this, $toPromote );
1380 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1382 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1383 $logEntry->setPerformer( $this );
1384 $logEntry->setTarget( $this->getUserPage() );
1385 $logEntry->setParameters( array(
1386 '4::oldgroups' => $oldGroups,
1387 '5::newgroups' => $newGroups,
1389 $logid = $logEntry->insert();
1390 if ( $wgAutopromoteOnceLogInRC ) {
1391 $logEntry->publish( $logid );
1398 * Bump user_touched if it didn't change since this object was loaded
1400 * On success, the mTouched field is updated.
1401 * The user serialization cache is always cleared.
1403 * @return bool Whether user_touched was actually updated
1406 protected function checkAndSetTouched() {
1409 if ( !$this->mId
) {
1410 return false; // anon
1413 // Get a new user_touched that is higher than the old one
1414 $oldTouched = $this->mTouched
;
1415 $newTouched = $this->newTouchedTimestamp();
1417 $dbw = wfGetDB( DB_MASTER
);
1418 $dbw->update( 'user',
1419 array( 'user_touched' => $dbw->timestamp( $newTouched ) ),
1421 'user_id' => $this->mId
,
1422 'user_touched' => $dbw->timestamp( $oldTouched ) // CAS check
1426 $success = ( $dbw->affectedRows() > 0 );
1429 $this->mTouched
= $newTouched;
1430 $this->clearSharedCache();
1432 // Clears on failure too since that is desired if the cache is stale
1433 $this->clearSharedCache( 'refresh' );
1440 * Clear various cached data stored in this object. The cache of the user table
1441 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1443 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1444 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1446 public function clearInstanceCache( $reloadFrom = false ) {
1447 $this->mNewtalk
= -1;
1448 $this->mDatePreference
= null;
1449 $this->mBlockedby
= -1; # Unset
1450 $this->mHash
= false;
1451 $this->mRights
= null;
1452 $this->mEffectiveGroups
= null;
1453 $this->mImplicitGroups
= null;
1454 $this->mGroups
= null;
1455 $this->mOptions
= null;
1456 $this->mOptionsLoaded
= false;
1457 $this->mEditCount
= null;
1459 if ( $reloadFrom ) {
1460 $this->mLoadedItems
= array();
1461 $this->mFrom
= $reloadFrom;
1466 * Combine the language default options with any site-specific options
1467 * and add the default language variants.
1469 * @return array Array of String options
1471 public static function getDefaultOptions() {
1472 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1474 static $defOpt = null;
1475 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1476 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1477 // mid-request and see that change reflected in the return value of this function.
1478 // Which is insane and would never happen during normal MW operation
1482 $defOpt = $wgDefaultUserOptions;
1483 // Default language setting
1484 $defOpt['language'] = $wgContLang->getCode();
1485 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1486 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1488 foreach ( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1489 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1491 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1493 Hooks
::run( 'UserGetDefaultOptions', array( &$defOpt ) );
1499 * Get a given default option value.
1501 * @param string $opt Name of option to retrieve
1502 * @return string Default option value
1504 public static function getDefaultOption( $opt ) {
1505 $defOpts = self
::getDefaultOptions();
1506 if ( isset( $defOpts[$opt] ) ) {
1507 return $defOpts[$opt];
1514 * Get blocking information
1515 * @param bool $bFromSlave Whether to check the slave database first.
1516 * To improve performance, non-critical checks are done against slaves.
1517 * Check when actually saving should be done against master.
1519 private function getBlockedStatus( $bFromSlave = true ) {
1520 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1522 if ( -1 != $this->mBlockedby
) {
1526 wfDebug( __METHOD__
. ": checking...\n" );
1528 // Initialize data...
1529 // Otherwise something ends up stomping on $this->mBlockedby when
1530 // things get lazy-loaded later, causing false positive block hits
1531 // due to -1 !== 0. Probably session-related... Nothing should be
1532 // overwriting mBlockedby, surely?
1535 # We only need to worry about passing the IP address to the Block generator if the
1536 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1537 # know which IP address they're actually coming from
1538 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->equals( $wgUser ) ) {
1539 $ip = $this->getRequest()->getIP();
1545 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1548 if ( !$block instanceof Block
&& $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1550 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1552 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1553 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1554 $block->setTarget( $ip );
1555 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1557 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1558 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1559 $block->setTarget( $ip );
1563 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1564 if ( !$block instanceof Block
1565 && $wgApplyIpBlocksToXff
1567 && !in_array( $ip, $wgProxyWhitelist )
1569 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1570 $xff = array_map( 'trim', explode( ',', $xff ) );
1571 $xff = array_diff( $xff, array( $ip ) );
1572 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1573 $block = Block
::chooseBlock( $xffblocks, $xff );
1574 if ( $block instanceof Block
) {
1575 # Mangle the reason to alert the user that the block
1576 # originated from matching the X-Forwarded-For header.
1577 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1581 if ( $block instanceof Block
) {
1582 wfDebug( __METHOD__
. ": Found block.\n" );
1583 $this->mBlock
= $block;
1584 $this->mBlockedby
= $block->getByName();
1585 $this->mBlockreason
= $block->mReason
;
1586 $this->mHideName
= $block->mHideName
;
1587 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1589 $this->mBlockedby
= '';
1590 $this->mHideName
= 0;
1591 $this->mAllowUsertalk
= false;
1595 Hooks
::run( 'GetBlockedStatus', array( &$this ) );
1600 * Whether the given IP is in a DNS blacklist.
1602 * @param string $ip IP to check
1603 * @param bool $checkWhitelist Whether to check the whitelist first
1604 * @return bool True if blacklisted.
1606 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1607 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1609 if ( !$wgEnableDnsBlacklist ) {
1613 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1617 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1621 * Whether the given IP is in a given DNS blacklist.
1623 * @param string $ip IP to check
1624 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1625 * @return bool True if blacklisted.
1627 public function inDnsBlacklist( $ip, $bases ) {
1630 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1631 if ( IP
::isIPv4( $ip ) ) {
1632 // Reverse IP, bug 21255
1633 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1635 foreach ( (array)$bases as $base ) {
1637 // If we have an access key, use that too (ProjectHoneypot, etc.)
1639 if ( is_array( $base ) ) {
1640 if ( count( $base ) >= 2 ) {
1641 // Access key is 1, base URL is 0
1642 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1644 $host = "$ipReversed.{$base[0]}";
1646 $basename = $base[0];
1648 $host = "$ipReversed.$base";
1652 $ipList = gethostbynamel( $host );
1655 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1659 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1668 * Check if an IP address is in the local proxy list
1674 public static function isLocallyBlockedProxy( $ip ) {
1675 global $wgProxyList;
1677 if ( !$wgProxyList ) {
1681 if ( !is_array( $wgProxyList ) ) {
1682 // Load from the specified file
1683 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1686 if ( !is_array( $wgProxyList ) ) {
1688 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1690 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1691 // Old-style flipped proxy list
1700 * Is this user subject to rate limiting?
1702 * @return bool True if rate limited
1704 public function isPingLimitable() {
1705 global $wgRateLimitsExcludedIPs;
1706 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1707 // No other good way currently to disable rate limits
1708 // for specific IPs. :P
1709 // But this is a crappy hack and should die.
1712 return !$this->isAllowed( 'noratelimit' );
1716 * Primitive rate limits: enforce maximum actions per time period
1717 * to put a brake on flooding.
1719 * The method generates both a generic profiling point and a per action one
1720 * (suffix being "-$action".
1722 * @note When using a shared cache like memcached, IP-address
1723 * last-hit counters will be shared across wikis.
1725 * @param string $action Action to enforce; 'edit' if unspecified
1726 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1727 * @return bool True if a rate limiter was tripped
1729 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1730 // Call the 'PingLimiter' hook
1732 if ( !Hooks
::run( 'PingLimiter', array( &$this, $action, &$result, $incrBy ) ) ) {
1736 global $wgRateLimits;
1737 if ( !isset( $wgRateLimits[$action] ) ) {
1741 // Some groups shouldn't trigger the ping limiter, ever
1742 if ( !$this->isPingLimitable() ) {
1746 $limits = $wgRateLimits[$action];
1748 $id = $this->getId();
1751 if ( isset( $limits['anon'] ) && $id == 0 ) {
1752 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1755 if ( isset( $limits['user'] ) && $id != 0 ) {
1756 $userLimit = $limits['user'];
1758 if ( $this->isNewbie() ) {
1759 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1760 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1762 if ( isset( $limits['ip'] ) ) {
1763 $ip = $this->getRequest()->getIP();
1764 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1766 if ( isset( $limits['subnet'] ) ) {
1767 $ip = $this->getRequest()->getIP();
1770 if ( IP
::isIPv6( $ip ) ) {
1771 $parts = IP
::parseRange( "$ip/64" );
1772 $subnet = $parts[0];
1773 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1775 $subnet = $matches[1];
1777 if ( $subnet !== false ) {
1778 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1782 // Check for group-specific permissions
1783 // If more than one group applies, use the group with the highest limit
1784 foreach ( $this->getGroups() as $group ) {
1785 if ( isset( $limits[$group] ) ) {
1786 if ( $userLimit === false
1787 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1789 $userLimit = $limits[$group];
1793 // Set the user limit key
1794 if ( $userLimit !== false ) {
1795 list( $max, $period ) = $userLimit;
1796 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1797 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1800 $cache = ObjectCache
::getLocalClusterInstance();
1803 foreach ( $keys as $key => $limit ) {
1804 list( $max, $period ) = $limit;
1805 $summary = "(limit $max in {$period}s)";
1806 $count = $cache->get( $key );
1809 if ( $count >= $max ) {
1810 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1811 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1814 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1817 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1818 if ( $incrBy > 0 ) {
1819 $cache->add( $key, 0, intval( $period ) ); // first ping
1822 if ( $incrBy > 0 ) {
1823 $cache->incr( $key, $incrBy );
1831 * Check if user is blocked
1833 * @param bool $bFromSlave Whether to check the slave database instead of
1834 * the master. Hacked from false due to horrible probs on site.
1835 * @return bool True if blocked, false otherwise
1837 public function isBlocked( $bFromSlave = true ) {
1838 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1842 * Get the block affecting the user, or null if the user is not blocked
1844 * @param bool $bFromSlave Whether to check the slave database instead of the master
1845 * @return Block|null
1847 public function getBlock( $bFromSlave = true ) {
1848 $this->getBlockedStatus( $bFromSlave );
1849 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1853 * Check if user is blocked from editing a particular article
1855 * @param Title $title Title to check
1856 * @param bool $bFromSlave Whether to check the slave database instead of the master
1859 public function isBlockedFrom( $title, $bFromSlave = false ) {
1860 global $wgBlockAllowsUTEdit;
1862 $blocked = $this->isBlocked( $bFromSlave );
1863 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1864 // If a user's name is suppressed, they cannot make edits anywhere
1865 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1866 && $title->getNamespace() == NS_USER_TALK
) {
1868 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1871 Hooks
::run( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1877 * If user is blocked, return the name of the user who placed the block
1878 * @return string Name of blocker
1880 public function blockedBy() {
1881 $this->getBlockedStatus();
1882 return $this->mBlockedby
;
1886 * If user is blocked, return the specified reason for the block
1887 * @return string Blocking reason
1889 public function blockedFor() {
1890 $this->getBlockedStatus();
1891 return $this->mBlockreason
;
1895 * If user is blocked, return the ID for the block
1896 * @return int Block ID
1898 public function getBlockId() {
1899 $this->getBlockedStatus();
1900 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1904 * Check if user is blocked on all wikis.
1905 * Do not use for actual edit permission checks!
1906 * This is intended for quick UI checks.
1908 * @param string $ip IP address, uses current client if none given
1909 * @return bool True if blocked, false otherwise
1911 public function isBlockedGlobally( $ip = '' ) {
1912 if ( $this->mBlockedGlobally
!== null ) {
1913 return $this->mBlockedGlobally
;
1915 // User is already an IP?
1916 if ( IP
::isIPAddress( $this->getName() ) ) {
1917 $ip = $this->getName();
1919 $ip = $this->getRequest()->getIP();
1922 Hooks
::run( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1923 $this->mBlockedGlobally
= (bool)$blocked;
1924 return $this->mBlockedGlobally
;
1928 * Check if user account is locked
1930 * @return bool True if locked, false otherwise
1932 public function isLocked() {
1933 if ( $this->mLocked
!== null ) {
1934 return $this->mLocked
;
1937 $authUser = $wgAuth->getUserInstance( $this );
1938 $this->mLocked
= (bool)$authUser->isLocked();
1939 Hooks
::run( 'UserIsLocked', array( $this, &$this->mLocked
) );
1940 return $this->mLocked
;
1944 * Check if user account is hidden
1946 * @return bool True if hidden, false otherwise
1948 public function isHidden() {
1949 if ( $this->mHideName
!== null ) {
1950 return $this->mHideName
;
1952 $this->getBlockedStatus();
1953 if ( !$this->mHideName
) {
1955 $authUser = $wgAuth->getUserInstance( $this );
1956 $this->mHideName
= (bool)$authUser->isHidden();
1957 Hooks
::run( 'UserIsHidden', array( $this, &$this->mHideName
) );
1959 return $this->mHideName
;
1963 * Get the user's ID.
1964 * @return int The user's ID; 0 if the user is anonymous or nonexistent
1966 public function getId() {
1967 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
1968 // Special case, we know the user is anonymous
1970 } elseif ( !$this->isItemLoaded( 'id' ) ) {
1971 // Don't load if this was initialized from an ID
1978 * Set the user and reload all fields according to a given ID
1979 * @param int $v User ID to reload
1981 public function setId( $v ) {
1983 $this->clearInstanceCache( 'id' );
1987 * Get the user name, or the IP of an anonymous user
1988 * @return string User's name or IP address
1990 public function getName() {
1991 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1992 // Special case optimisation
1993 return $this->mName
;
1996 if ( $this->mName
=== false ) {
1998 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2000 return $this->mName
;
2005 * Set the user name.
2007 * This does not reload fields from the database according to the given
2008 * name. Rather, it is used to create a temporary "nonexistent user" for
2009 * later addition to the database. It can also be used to set the IP
2010 * address for an anonymous user to something other than the current
2013 * @note User::newFromName() has roughly the same function, when the named user
2015 * @param string $str New user name to set
2017 public function setName( $str ) {
2019 $this->mName
= $str;
2023 * Get the user's name escaped by underscores.
2024 * @return string Username escaped by underscores.
2026 public function getTitleKey() {
2027 return str_replace( ' ', '_', $this->getName() );
2031 * Check if the user has new messages.
2032 * @return bool True if the user has new messages
2034 public function getNewtalk() {
2037 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2038 if ( $this->mNewtalk
=== -1 ) {
2039 $this->mNewtalk
= false; # reset talk page status
2041 // Check memcached separately for anons, who have no
2042 // entire User object stored in there.
2043 if ( !$this->mId
) {
2044 global $wgDisableAnonTalk;
2045 if ( $wgDisableAnonTalk ) {
2046 // Anon newtalk disabled by configuration.
2047 $this->mNewtalk
= false;
2049 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2052 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2056 return (bool)$this->mNewtalk
;
2060 * Return the data needed to construct links for new talk page message
2061 * alerts. If there are new messages, this will return an associative array
2062 * with the following data:
2063 * wiki: The database name of the wiki
2064 * link: Root-relative link to the user's talk page
2065 * rev: The last talk page revision that the user has seen or null. This
2066 * is useful for building diff links.
2067 * If there are no new messages, it returns an empty array.
2068 * @note This function was designed to accomodate multiple talk pages, but
2069 * currently only returns a single link and revision.
2072 public function getNewMessageLinks() {
2074 if ( !Hooks
::run( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
2076 } elseif ( !$this->getNewtalk() ) {
2079 $utp = $this->getTalkPage();
2080 $dbr = wfGetDB( DB_SLAVE
);
2081 // Get the "last viewed rev" timestamp from the oldest message notification
2082 $timestamp = $dbr->selectField( 'user_newtalk',
2083 'MIN(user_last_timestamp)',
2084 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
2086 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2087 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
2091 * Get the revision ID for the last talk page revision viewed by the talk
2093 * @return int|null Revision ID or null
2095 public function getNewMessageRevisionId() {
2096 $newMessageRevisionId = null;
2097 $newMessageLinks = $this->getNewMessageLinks();
2098 if ( $newMessageLinks ) {
2099 // Note: getNewMessageLinks() never returns more than a single link
2100 // and it is always for the same wiki, but we double-check here in
2101 // case that changes some time in the future.
2102 if ( count( $newMessageLinks ) === 1
2103 && $newMessageLinks[0]['wiki'] === wfWikiID()
2104 && $newMessageLinks[0]['rev']
2106 /** @var Revision $newMessageRevision */
2107 $newMessageRevision = $newMessageLinks[0]['rev'];
2108 $newMessageRevisionId = $newMessageRevision->getId();
2111 return $newMessageRevisionId;
2115 * Internal uncached check for new messages
2118 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2119 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2120 * @return bool True if the user has new messages
2122 protected function checkNewtalk( $field, $id ) {
2123 $dbr = wfGetDB( DB_SLAVE
);
2125 $ok = $dbr->selectField( 'user_newtalk', $field, array( $field => $id ), __METHOD__
);
2127 return $ok !== false;
2131 * Add or update the new messages flag
2132 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2133 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2134 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2135 * @return bool True if successful, false otherwise
2137 protected function updateNewtalk( $field, $id, $curRev = null ) {
2138 // Get timestamp of the talk page revision prior to the current one
2139 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2140 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2141 // Mark the user as having new messages since this revision
2142 $dbw = wfGetDB( DB_MASTER
);
2143 $dbw->insert( 'user_newtalk',
2144 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
2147 if ( $dbw->affectedRows() ) {
2148 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2151 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2157 * Clear the new messages flag for the given user
2158 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2159 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2160 * @return bool True if successful, false otherwise
2162 protected function deleteNewtalk( $field, $id ) {
2163 $dbw = wfGetDB( DB_MASTER
);
2164 $dbw->delete( 'user_newtalk',
2165 array( $field => $id ),
2167 if ( $dbw->affectedRows() ) {
2168 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2171 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2177 * Update the 'You have new messages!' status.
2178 * @param bool $val Whether the user has new messages
2179 * @param Revision $curRev New, as yet unseen revision of the user talk
2180 * page. Ignored if null or !$val.
2182 public function setNewtalk( $val, $curRev = null ) {
2183 if ( wfReadOnly() ) {
2188 $this->mNewtalk
= $val;
2190 if ( $this->isAnon() ) {
2192 $id = $this->getName();
2195 $id = $this->getId();
2199 $changed = $this->updateNewtalk( $field, $id, $curRev );
2201 $changed = $this->deleteNewtalk( $field, $id );
2205 $this->invalidateCache();
2210 * Generate a current or new-future timestamp to be stored in the
2211 * user_touched field when we update things.
2212 * @return string Timestamp in TS_MW format
2214 private function newTouchedTimestamp() {
2215 global $wgClockSkewFudge;
2217 $time = wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2218 if ( $this->mTouched
&& $time <= $this->mTouched
) {
2219 $time = wfTimestamp( TS_MW
, wfTimestamp( TS_UNIX
, $this->mTouched
) +
1 );
2226 * Clear user data from memcached
2228 * Use after applying updates to the database; caller's
2229 * responsibility to update user_touched if appropriate.
2231 * Called implicitly from invalidateCache() and saveSettings().
2233 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2235 public function clearSharedCache( $mode = 'changed' ) {
2236 if ( !$this->getId() ) {
2240 $cache = ObjectCache
::getMainWANInstance();
2241 $key = $this->getCacheKey( $cache );
2242 if ( $mode === 'refresh' ) {
2243 $cache->delete( $key, 1 );
2245 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle( function() use ( $cache, $key ) {
2246 $cache->delete( $key );
2252 * Immediately touch the user data cache for this account
2254 * Calls touch() and removes account data from memcached
2256 public function invalidateCache() {
2258 $this->clearSharedCache();
2262 * Update the "touched" timestamp for the user
2264 * This is useful on various login/logout events when making sure that
2265 * a browser or proxy that has multiple tenants does not suffer cache
2266 * pollution where the new user sees the old users content. The value
2267 * of getTouched() is checked when determining 304 vs 200 responses.
2268 * Unlike invalidateCache(), this preserves the User object cache and
2269 * avoids database writes.
2273 public function touch() {
2274 $id = $this->getId();
2276 $key = wfMemcKey( 'user-quicktouched', 'id', $id );
2277 ObjectCache
::getMainWANInstance()->touchCheckKey( $key );
2278 $this->mQuickTouched
= null;
2283 * Validate the cache for this account.
2284 * @param string $timestamp A timestamp in TS_MW format
2287 public function validateCache( $timestamp ) {
2288 return ( $timestamp >= $this->getTouched() );
2292 * Get the user touched timestamp
2294 * Use this value only to validate caches via inequalities
2295 * such as in the case of HTTP If-Modified-Since response logic
2297 * @return string TS_MW Timestamp
2299 public function getTouched() {
2303 if ( $this->mQuickTouched
=== null ) {
2304 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2305 $cache = ObjectCache
::getMainWANInstance();
2307 $this->mQuickTouched
= wfTimestamp( TS_MW
, $cache->getCheckKeyTime( $key ) );
2310 return max( $this->mTouched
, $this->mQuickTouched
);
2313 return $this->mTouched
;
2317 * Get the user_touched timestamp field (time of last DB updates)
2318 * @return string TS_MW Timestamp
2321 public function getDBTouched() {
2324 return $this->mTouched
;
2328 * @deprecated Removed in 1.27.
2332 public function getPassword() {
2333 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2337 * @deprecated Removed in 1.27.
2341 public function getTemporaryPassword() {
2342 throw new BadMethodCallException( __METHOD__
. ' has been removed in 1.27' );
2346 * Set the password and reset the random token.
2347 * Calls through to authentication plugin if necessary;
2348 * will have no effect if the auth plugin refuses to
2349 * pass the change through or if the legal password
2352 * As a special case, setting the password to null
2353 * wipes it, so the account cannot be logged in until
2354 * a new password is set, for instance via e-mail.
2356 * @deprecated since 1.27. AuthManager is coming.
2357 * @param string $str New password to set
2358 * @throws PasswordError On failure
2361 public function setPassword( $str ) {
2364 if ( $str !== null ) {
2365 if ( !$wgAuth->allowPasswordChange() ) {
2366 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2369 $status = $this->checkPasswordValidity( $str );
2370 if ( !$status->isGood() ) {
2371 throw new PasswordError( $status->getMessage()->text() );
2375 if ( !$wgAuth->setPassword( $this, $str ) ) {
2376 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2380 $this->setOption( 'watchlisttoken', false );
2381 $this->setPasswordInternal( $str );
2387 * Set the password and reset the random token unconditionally.
2389 * @deprecated since 1.27. AuthManager is coming.
2390 * @param string|null $str New password to set or null to set an invalid
2391 * password hash meaning that the user will not be able to log in
2392 * through the web interface.
2394 public function setInternalPassword( $str ) {
2397 if ( $wgAuth->allowSetLocalPassword() ) {
2399 $this->setOption( 'watchlisttoken', false );
2400 $this->setPasswordInternal( $str );
2405 * Actually set the password and such
2406 * @since 1.27 cannot set a password for a user not in the database
2407 * @param string|null $str New password to set or null to set an invalid
2408 * password hash meaning that the user will not be able to log in
2409 * through the web interface.
2411 private function setPasswordInternal( $str ) {
2412 $id = self
::idFromName( $this->getName(), self
::READ_LATEST
);
2414 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2417 $passwordFactory = new PasswordFactory();
2418 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
2419 $dbw = wfGetDB( DB_MASTER
);
2423 'user_password' => $passwordFactory->newFromPlaintext( $str )->toString(),
2424 'user_newpassword' => PasswordFactory
::newInvalidPassword()->toString(),
2425 'user_newpass_time' => $dbw->timestampOrNull( null ),
2433 // When the main password is changed, invalidate all bot passwords too
2434 BotPassword
::invalidateAllPasswordsForUser( $this->getName() );
2438 * Get the user's current token.
2439 * @param bool $forceCreation Force the generation of a new token if the
2440 * user doesn't have one (default=true for backwards compatibility).
2441 * @return string|null Token
2443 public function getToken( $forceCreation = true ) {
2444 global $wgAuthenticationTokenVersion;
2447 if ( !$this->mToken
&& $forceCreation ) {
2451 // If the user doesn't have a token, return null to indicate that.
2452 // Otherwise, hmac the version with the secret if we have a version.
2453 if ( !$this->mToken
) {
2455 } elseif ( $wgAuthenticationTokenVersion === null ) {
2456 return $this->mToken
;
2458 $ret = MWCryptHash
::hmac( $wgAuthenticationTokenVersion, $this->mToken
, false );
2460 // The raw hash can be overly long. Shorten it up.
2461 $len = max( 32, self
::TOKEN_LENGTH
);
2462 if ( strlen( $ret ) < $len ) {
2463 // Should never happen, even md5 is 128 bits
2464 throw new \
UnexpectedValueException( 'Hmac returned less than 128 bits' );
2466 return substr( $ret, -$len );
2471 * Set the random token (used for persistent authentication)
2472 * Called from loadDefaults() among other places.
2474 * @param string|bool $token If specified, set the token to this value
2476 public function setToken( $token = false ) {
2479 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2481 $this->mToken
= $token;
2486 * Set the password for a password reminder or new account email
2488 * @deprecated since 1.27, AuthManager is coming
2489 * @param string $str New password to set or null to set an invalid
2490 * password hash meaning that the user will not be able to use it
2491 * @param bool $throttle If true, reset the throttle timestamp to the present
2493 public function setNewpassword( $str, $throttle = true ) {
2494 $id = $this->getId();
2496 throw new LogicException( 'Cannot set new password for a user that is not in the database.' );
2499 $dbw = wfGetDB( DB_MASTER
);
2501 $passwordFactory = new PasswordFactory();
2502 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
2504 'user_newpassword' => $passwordFactory->newFromPlaintext( $str )->toString(),
2507 if ( $str === null ) {
2508 $update['user_newpass_time'] = null;
2509 } elseif ( $throttle ) {
2510 $update['user_newpass_time'] = $dbw->timestamp();
2513 $dbw->update( 'user', $update, array( 'user_id' => $id ), __METHOD__
);
2517 * Has password reminder email been sent within the last
2518 * $wgPasswordReminderResendTime hours?
2521 public function isPasswordReminderThrottled() {
2522 global $wgPasswordReminderResendTime;
2524 if ( !$wgPasswordReminderResendTime ) {
2530 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
2531 ?
wfGetDB( DB_MASTER
)
2532 : wfGetDB( DB_SLAVE
);
2533 $newpassTime = $db->selectField(
2535 'user_newpass_time',
2536 array( 'user_id' => $this->getId() ),
2540 if ( $newpassTime === null ) {
2543 $expiry = wfTimestamp( TS_UNIX
, $newpassTime ) +
$wgPasswordReminderResendTime * 3600;
2544 return time() < $expiry;
2548 * Get the user's e-mail address
2549 * @return string User's email address
2551 public function getEmail() {
2553 Hooks
::run( 'UserGetEmail', array( $this, &$this->mEmail
) );
2554 return $this->mEmail
;
2558 * Get the timestamp of the user's e-mail authentication
2559 * @return string TS_MW timestamp
2561 public function getEmailAuthenticationTimestamp() {
2563 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2564 return $this->mEmailAuthenticated
;
2568 * Set the user's e-mail address
2569 * @param string $str New e-mail address
2571 public function setEmail( $str ) {
2573 if ( $str == $this->mEmail
) {
2576 $this->invalidateEmail();
2577 $this->mEmail
= $str;
2578 Hooks
::run( 'UserSetEmail', array( $this, &$this->mEmail
) );
2582 * Set the user's e-mail address and a confirmation mail if needed.
2585 * @param string $str New e-mail address
2588 public function setEmailWithConfirmation( $str ) {
2589 global $wgEnableEmail, $wgEmailAuthentication;
2591 if ( !$wgEnableEmail ) {
2592 return Status
::newFatal( 'emaildisabled' );
2595 $oldaddr = $this->getEmail();
2596 if ( $str === $oldaddr ) {
2597 return Status
::newGood( true );
2600 $this->setEmail( $str );
2602 if ( $str !== '' && $wgEmailAuthentication ) {
2603 // Send a confirmation request to the new address if needed
2604 $type = $oldaddr != '' ?
'changed' : 'set';
2605 $result = $this->sendConfirmationMail( $type );
2606 if ( $result->isGood() ) {
2607 // Say to the caller that a confirmation mail has been sent
2608 $result->value
= 'eauth';
2611 $result = Status
::newGood( true );
2618 * Get the user's real name
2619 * @return string User's real name
2621 public function getRealName() {
2622 if ( !$this->isItemLoaded( 'realname' ) ) {
2626 return $this->mRealName
;
2630 * Set the user's real name
2631 * @param string $str New real name
2633 public function setRealName( $str ) {
2635 $this->mRealName
= $str;
2639 * Get the user's current setting for a given option.
2641 * @param string $oname The option to check
2642 * @param string $defaultOverride A default value returned if the option does not exist
2643 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2644 * @return string User's current value for the option
2645 * @see getBoolOption()
2646 * @see getIntOption()
2648 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2649 global $wgHiddenPrefs;
2650 $this->loadOptions();
2652 # We want 'disabled' preferences to always behave as the default value for
2653 # users, even if they have set the option explicitly in their settings (ie they
2654 # set it, and then it was disabled removing their ability to change it). But
2655 # we don't want to erase the preferences in the database in case the preference
2656 # is re-enabled again. So don't touch $mOptions, just override the returned value
2657 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2658 return self
::getDefaultOption( $oname );
2661 if ( array_key_exists( $oname, $this->mOptions
) ) {
2662 return $this->mOptions
[$oname];
2664 return $defaultOverride;
2669 * Get all user's options
2671 * @param int $flags Bitwise combination of:
2672 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2673 * to the default value. (Since 1.25)
2676 public function getOptions( $flags = 0 ) {
2677 global $wgHiddenPrefs;
2678 $this->loadOptions();
2679 $options = $this->mOptions
;
2681 # We want 'disabled' preferences to always behave as the default value for
2682 # users, even if they have set the option explicitly in their settings (ie they
2683 # set it, and then it was disabled removing their ability to change it). But
2684 # we don't want to erase the preferences in the database in case the preference
2685 # is re-enabled again. So don't touch $mOptions, just override the returned value
2686 foreach ( $wgHiddenPrefs as $pref ) {
2687 $default = self
::getDefaultOption( $pref );
2688 if ( $default !== null ) {
2689 $options[$pref] = $default;
2693 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2694 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2701 * Get the user's current setting for a given option, as a boolean value.
2703 * @param string $oname The option to check
2704 * @return bool User's current value for the option
2707 public function getBoolOption( $oname ) {
2708 return (bool)$this->getOption( $oname );
2712 * Get the user's current setting for a given option, as an integer value.
2714 * @param string $oname The option to check
2715 * @param int $defaultOverride A default value returned if the option does not exist
2716 * @return int User's current value for the option
2719 public function getIntOption( $oname, $defaultOverride = 0 ) {
2720 $val = $this->getOption( $oname );
2722 $val = $defaultOverride;
2724 return intval( $val );
2728 * Set the given option for a user.
2730 * You need to call saveSettings() to actually write to the database.
2732 * @param string $oname The option to set
2733 * @param mixed $val New value to set
2735 public function setOption( $oname, $val ) {
2736 $this->loadOptions();
2738 // Explicitly NULL values should refer to defaults
2739 if ( is_null( $val ) ) {
2740 $val = self
::getDefaultOption( $oname );
2743 $this->mOptions
[$oname] = $val;
2747 * Get a token stored in the preferences (like the watchlist one),
2748 * resetting it if it's empty (and saving changes).
2750 * @param string $oname The option name to retrieve the token from
2751 * @return string|bool User's current value for the option, or false if this option is disabled.
2752 * @see resetTokenFromOption()
2754 * @deprecated 1.26 Applications should use the OAuth extension
2756 public function getTokenFromOption( $oname ) {
2757 global $wgHiddenPrefs;
2759 $id = $this->getId();
2760 if ( !$id ||
in_array( $oname, $wgHiddenPrefs ) ) {
2764 $token = $this->getOption( $oname );
2766 // Default to a value based on the user token to avoid space
2767 // wasted on storing tokens for all users. When this option
2768 // is set manually by the user, only then is it stored.
2769 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
2776 * Reset a token stored in the preferences (like the watchlist one).
2777 * *Does not* save user's preferences (similarly to setOption()).
2779 * @param string $oname The option name to reset the token in
2780 * @return string|bool New token value, or false if this option is disabled.
2781 * @see getTokenFromOption()
2784 public function resetTokenFromOption( $oname ) {
2785 global $wgHiddenPrefs;
2786 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2790 $token = MWCryptRand
::generateHex( 40 );
2791 $this->setOption( $oname, $token );
2796 * Return a list of the types of user options currently returned by
2797 * User::getOptionKinds().
2799 * Currently, the option kinds are:
2800 * - 'registered' - preferences which are registered in core MediaWiki or
2801 * by extensions using the UserGetDefaultOptions hook.
2802 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2803 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2804 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2805 * be used by user scripts.
2806 * - 'special' - "preferences" that are not accessible via User::getOptions
2807 * or User::setOptions.
2808 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2809 * These are usually legacy options, removed in newer versions.
2811 * The API (and possibly others) use this function to determine the possible
2812 * option types for validation purposes, so make sure to update this when a
2813 * new option kind is added.
2815 * @see User::getOptionKinds
2816 * @return array Option kinds
2818 public static function listOptionKinds() {
2821 'registered-multiselect',
2822 'registered-checkmatrix',
2830 * Return an associative array mapping preferences keys to the kind of a preference they're
2831 * used for. Different kinds are handled differently when setting or reading preferences.
2833 * See User::listOptionKinds for the list of valid option types that can be provided.
2835 * @see User::listOptionKinds
2836 * @param IContextSource $context
2837 * @param array $options Assoc. array with options keys to check as keys.
2838 * Defaults to $this->mOptions.
2839 * @return array The key => kind mapping data
2841 public function getOptionKinds( IContextSource
$context, $options = null ) {
2842 $this->loadOptions();
2843 if ( $options === null ) {
2844 $options = $this->mOptions
;
2847 $prefs = Preferences
::getPreferences( $this, $context );
2850 // Pull out the "special" options, so they don't get converted as
2851 // multiselect or checkmatrix.
2852 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2853 foreach ( $specialOptions as $name => $value ) {
2854 unset( $prefs[$name] );
2857 // Multiselect and checkmatrix options are stored in the database with
2858 // one key per option, each having a boolean value. Extract those keys.
2859 $multiselectOptions = array();
2860 foreach ( $prefs as $name => $info ) {
2861 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2862 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2863 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2864 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2866 foreach ( $opts as $value ) {
2867 $multiselectOptions["$prefix$value"] = true;
2870 unset( $prefs[$name] );
2873 $checkmatrixOptions = array();
2874 foreach ( $prefs as $name => $info ) {
2875 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2876 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2877 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2878 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2879 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2881 foreach ( $columns as $column ) {
2882 foreach ( $rows as $row ) {
2883 $checkmatrixOptions["$prefix$column-$row"] = true;
2887 unset( $prefs[$name] );
2891 // $value is ignored
2892 foreach ( $options as $key => $value ) {
2893 if ( isset( $prefs[$key] ) ) {
2894 $mapping[$key] = 'registered';
2895 } elseif ( isset( $multiselectOptions[$key] ) ) {
2896 $mapping[$key] = 'registered-multiselect';
2897 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2898 $mapping[$key] = 'registered-checkmatrix';
2899 } elseif ( isset( $specialOptions[$key] ) ) {
2900 $mapping[$key] = 'special';
2901 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2902 $mapping[$key] = 'userjs';
2904 $mapping[$key] = 'unused';
2912 * Reset certain (or all) options to the site defaults
2914 * The optional parameter determines which kinds of preferences will be reset.
2915 * Supported values are everything that can be reported by getOptionKinds()
2916 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2918 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
2919 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2920 * for backwards-compatibility.
2921 * @param IContextSource|null $context Context source used when $resetKinds
2922 * does not contain 'all', passed to getOptionKinds().
2923 * Defaults to RequestContext::getMain() when null.
2925 public function resetOptions(
2926 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2927 IContextSource
$context = null
2930 $defaultOptions = self
::getDefaultOptions();
2932 if ( !is_array( $resetKinds ) ) {
2933 $resetKinds = array( $resetKinds );
2936 if ( in_array( 'all', $resetKinds ) ) {
2937 $newOptions = $defaultOptions;
2939 if ( $context === null ) {
2940 $context = RequestContext
::getMain();
2943 $optionKinds = $this->getOptionKinds( $context );
2944 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
2945 $newOptions = array();
2947 // Use default values for the options that should be deleted, and
2948 // copy old values for the ones that shouldn't.
2949 foreach ( $this->mOptions
as $key => $value ) {
2950 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2951 if ( array_key_exists( $key, $defaultOptions ) ) {
2952 $newOptions[$key] = $defaultOptions[$key];
2955 $newOptions[$key] = $value;
2960 Hooks
::run( 'UserResetAllOptions', array( $this, &$newOptions, $this->mOptions
, $resetKinds ) );
2962 $this->mOptions
= $newOptions;
2963 $this->mOptionsLoaded
= true;
2967 * Get the user's preferred date format.
2968 * @return string User's preferred date format
2970 public function getDatePreference() {
2971 // Important migration for old data rows
2972 if ( is_null( $this->mDatePreference
) ) {
2974 $value = $this->getOption( 'date' );
2975 $map = $wgLang->getDatePreferenceMigrationMap();
2976 if ( isset( $map[$value] ) ) {
2977 $value = $map[$value];
2979 $this->mDatePreference
= $value;
2981 return $this->mDatePreference
;
2985 * Determine based on the wiki configuration and the user's options,
2986 * whether this user must be over HTTPS no matter what.
2990 public function requiresHTTPS() {
2991 global $wgSecureLogin;
2992 if ( !$wgSecureLogin ) {
2995 $https = $this->getBoolOption( 'prefershttps' );
2996 Hooks
::run( 'UserRequiresHTTPS', array( $this, &$https ) );
2998 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3005 * Get the user preferred stub threshold
3009 public function getStubThreshold() {
3010 global $wgMaxArticleSize; # Maximum article size, in Kb
3011 $threshold = $this->getIntOption( 'stubthreshold' );
3012 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3013 // If they have set an impossible value, disable the preference
3014 // so we can use the parser cache again.
3021 * Get the permissions this user has.
3022 * @return array Array of String permission names
3024 public function getRights() {
3025 if ( is_null( $this->mRights
) ) {
3026 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
3028 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3029 if ( $allowedRights !== null ) {
3030 $this->mRights
= array_intersect( $this->mRights
, $allowedRights );
3033 Hooks
::run( 'UserGetRights', array( $this, &$this->mRights
) );
3034 // Force reindexation of rights when a hook has unset one of them
3035 $this->mRights
= array_values( array_unique( $this->mRights
) );
3037 return $this->mRights
;
3041 * Get the list of explicit group memberships this user has.
3042 * The implicit * and user groups are not included.
3043 * @return array Array of String internal group names
3045 public function getGroups() {
3047 $this->loadGroups();
3048 return $this->mGroups
;
3052 * Get the list of implicit group memberships this user has.
3053 * This includes all explicit groups, plus 'user' if logged in,
3054 * '*' for all accounts, and autopromoted groups
3055 * @param bool $recache Whether to avoid the cache
3056 * @return array Array of String internal group names
3058 public function getEffectiveGroups( $recache = false ) {
3059 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
3060 $this->mEffectiveGroups
= array_unique( array_merge(
3061 $this->getGroups(), // explicit groups
3062 $this->getAutomaticGroups( $recache ) // implicit groups
3064 // Hook for additional groups
3065 Hooks
::run( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
3066 // Force reindexation of groups when a hook has unset one of them
3067 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3069 return $this->mEffectiveGroups
;
3073 * Get the list of implicit group memberships this user has.
3074 * This includes 'user' if logged in, '*' for all accounts,
3075 * and autopromoted groups
3076 * @param bool $recache Whether to avoid the cache
3077 * @return array Array of String internal group names
3079 public function getAutomaticGroups( $recache = false ) {
3080 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3081 $this->mImplicitGroups
= array( '*' );
3082 if ( $this->getId() ) {
3083 $this->mImplicitGroups
[] = 'user';
3085 $this->mImplicitGroups
= array_unique( array_merge(
3086 $this->mImplicitGroups
,
3087 Autopromote
::getAutopromoteGroups( $this )
3091 // Assure data consistency with rights/groups,
3092 // as getEffectiveGroups() depends on this function
3093 $this->mEffectiveGroups
= null;
3096 return $this->mImplicitGroups
;
3100 * Returns the groups the user has belonged to.
3102 * The user may still belong to the returned groups. Compare with getGroups().
3104 * The function will not return groups the user had belonged to before MW 1.17
3106 * @return array Names of the groups the user has belonged to.
3108 public function getFormerGroups() {
3111 if ( is_null( $this->mFormerGroups
) ) {
3112 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
3113 ?
wfGetDB( DB_MASTER
)
3114 : wfGetDB( DB_SLAVE
);
3115 $res = $db->select( 'user_former_groups',
3116 array( 'ufg_group' ),
3117 array( 'ufg_user' => $this->mId
),
3119 $this->mFormerGroups
= array();
3120 foreach ( $res as $row ) {
3121 $this->mFormerGroups
[] = $row->ufg_group
;
3125 return $this->mFormerGroups
;
3129 * Get the user's edit count.
3130 * @return int|null Null for anonymous users
3132 public function getEditCount() {
3133 if ( !$this->getId() ) {
3137 if ( $this->mEditCount
=== null ) {
3138 /* Populate the count, if it has not been populated yet */
3139 $dbr = wfGetDB( DB_SLAVE
);
3140 // check if the user_editcount field has been initialized
3141 $count = $dbr->selectField(
3142 'user', 'user_editcount',
3143 array( 'user_id' => $this->mId
),
3147 if ( $count === null ) {
3148 // it has not been initialized. do so.
3149 $count = $this->initEditCount();
3151 $this->mEditCount
= $count;
3153 return (int)$this->mEditCount
;
3157 * Add the user to the given group.
3158 * This takes immediate effect.
3159 * @param string $group Name of the group to add
3162 public function addGroup( $group ) {
3165 if ( !Hooks
::run( 'UserAddGroup', array( $this, &$group ) ) ) {
3169 $dbw = wfGetDB( DB_MASTER
);
3170 if ( $this->getId() ) {
3171 $dbw->insert( 'user_groups',
3173 'ug_user' => $this->getID(),
3174 'ug_group' => $group,
3177 array( 'IGNORE' ) );
3180 $this->loadGroups();
3181 $this->mGroups
[] = $group;
3182 // In case loadGroups was not called before, we now have the right twice.
3183 // Get rid of the duplicate.
3184 $this->mGroups
= array_unique( $this->mGroups
);
3186 // Refresh the groups caches, and clear the rights cache so it will be
3187 // refreshed on the next call to $this->getRights().
3188 $this->getEffectiveGroups( true );
3189 $this->mRights
= null;
3191 $this->invalidateCache();
3197 * Remove the user from the given group.
3198 * This takes immediate effect.
3199 * @param string $group Name of the group to remove
3202 public function removeGroup( $group ) {
3204 if ( !Hooks
::run( 'UserRemoveGroup', array( $this, &$group ) ) ) {
3208 $dbw = wfGetDB( DB_MASTER
);
3209 $dbw->delete( 'user_groups',
3211 'ug_user' => $this->getID(),
3212 'ug_group' => $group,
3215 // Remember that the user was in this group
3216 $dbw->insert( 'user_former_groups',
3218 'ufg_user' => $this->getID(),
3219 'ufg_group' => $group,
3225 $this->loadGroups();
3226 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
3228 // Refresh the groups caches, and clear the rights cache so it will be
3229 // refreshed on the next call to $this->getRights().
3230 $this->getEffectiveGroups( true );
3231 $this->mRights
= null;
3233 $this->invalidateCache();
3239 * Get whether the user is logged in
3242 public function isLoggedIn() {
3243 return $this->getID() != 0;
3247 * Get whether the user is anonymous
3250 public function isAnon() {
3251 return !$this->isLoggedIn();
3255 * Check if user is allowed to access a feature / make an action
3257 * @param string ... Permissions to test
3258 * @return bool True if user is allowed to perform *any* of the given actions
3260 public function isAllowedAny() {
3261 $permissions = func_get_args();
3262 foreach ( $permissions as $permission ) {
3263 if ( $this->isAllowed( $permission ) ) {
3272 * @param string ... Permissions to test
3273 * @return bool True if the user is allowed to perform *all* of the given actions
3275 public function isAllowedAll() {
3276 $permissions = func_get_args();
3277 foreach ( $permissions as $permission ) {
3278 if ( !$this->isAllowed( $permission ) ) {
3286 * Internal mechanics of testing a permission
3287 * @param string $action
3290 public function isAllowed( $action = '' ) {
3291 if ( $action === '' ) {
3292 return true; // In the spirit of DWIM
3294 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3295 // by misconfiguration: 0 == 'foo'
3296 return in_array( $action, $this->getRights(), true );
3300 * Check whether to enable recent changes patrol features for this user
3301 * @return bool True or false
3303 public function useRCPatrol() {
3304 global $wgUseRCPatrol;
3305 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3309 * Check whether to enable new pages patrol features for this user
3310 * @return bool True or false
3312 public function useNPPatrol() {
3313 global $wgUseRCPatrol, $wgUseNPPatrol;
3315 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3316 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3321 * Check whether to enable new files patrol features for this user
3322 * @return bool True or false
3324 public function useFilePatrol() {
3325 global $wgUseRCPatrol, $wgUseFilePatrol;
3327 ( $wgUseRCPatrol ||
$wgUseFilePatrol )
3328 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3333 * Get the WebRequest object to use with this object
3335 * @return WebRequest
3337 public function getRequest() {
3338 if ( $this->mRequest
) {
3339 return $this->mRequest
;
3347 * Get a WatchedItem for this user and $title.
3349 * @since 1.22 $checkRights parameter added
3350 * @param Title $title
3351 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3352 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3353 * @return WatchedItem
3355 public function getWatchedItem( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3356 $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey();
3358 if ( isset( $this->mWatchedItems
[$key] ) ) {
3359 return $this->mWatchedItems
[$key];
3362 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
3363 $this->mWatchedItems
= array();
3366 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title, $checkRights );
3367 return $this->mWatchedItems
[$key];
3371 * Check the watched status of an article.
3372 * @since 1.22 $checkRights parameter added
3373 * @param Title $title Title of the article to look at
3374 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3375 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3378 public function isWatched( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3379 return $this->getWatchedItem( $title, $checkRights )->isWatched();
3384 * @since 1.22 $checkRights parameter added
3385 * @param Title $title Title of the article to look at
3386 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3387 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3389 public function addWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3390 $this->getWatchedItem( $title, $checkRights )->addWatch();
3391 $this->invalidateCache();
3395 * Stop watching an article.
3396 * @since 1.22 $checkRights parameter added
3397 * @param Title $title Title of the article to look at
3398 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3399 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3401 public function removeWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3402 $this->getWatchedItem( $title, $checkRights )->removeWatch();
3403 $this->invalidateCache();
3407 * Clear the user's notification timestamp for the given title.
3408 * If e-notif e-mails are on, they will receive notification mails on
3409 * the next change of the page if it's watched etc.
3410 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3411 * @param Title $title Title of the article to look at
3412 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3414 public function clearNotification( &$title, $oldid = 0 ) {
3415 global $wgUseEnotif, $wgShowUpdatedMarker;
3417 // Do nothing if the database is locked to writes
3418 if ( wfReadOnly() ) {
3422 // Do nothing if not allowed to edit the watchlist
3423 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3427 // If we're working on user's talk page, we should update the talk page message indicator
3428 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3429 if ( !Hooks
::run( 'UserClearNewTalkNotification', array( &$this, $oldid ) ) ) {
3434 // Try to update the DB post-send and only if needed...
3435 DeferredUpdates
::addCallableUpdate( function() use ( $that, $title, $oldid ) {
3436 if ( !$that->getNewtalk() ) {
3437 return; // no notifications to clear
3440 // Delete the last notifications (they stack up)
3441 $that->setNewtalk( false );
3443 // If there is a new, unseen, revision, use its timestamp
3445 ?
$title->getNextRevisionID( $oldid, Title
::GAID_FOR_UPDATE
)
3448 $that->setNewtalk( true, Revision
::newFromId( $nextid ) );
3453 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3457 if ( $this->isAnon() ) {
3458 // Nothing else to do...
3462 // Only update the timestamp if the page is being watched.
3463 // The query to find out if it is watched is cached both in memcached and per-invocation,
3464 // and when it does have to be executed, it can be on a slave
3465 // If this is the user's newtalk page, we always update the timestamp
3467 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3471 $this->getWatchedItem( $title )->resetNotificationTimestamp(
3477 * Resets all of the given user's page-change notification timestamps.
3478 * If e-notif e-mails are on, they will receive notification mails on
3479 * the next change of any watched page.
3480 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3482 public function clearAllNotifications() {
3483 if ( wfReadOnly() ) {
3487 // Do nothing if not allowed to edit the watchlist
3488 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3492 global $wgUseEnotif, $wgShowUpdatedMarker;
3493 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3494 $this->setNewtalk( false );
3497 $id = $this->getId();
3499 $dbw = wfGetDB( DB_MASTER
);
3500 $dbw->update( 'watchlist',
3501 array( /* SET */ 'wl_notificationtimestamp' => null ),
3502 array( /* WHERE */ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ),
3505 // We also need to clear here the "you have new message" notification for the own user_talk page;
3506 // it's cleared one page view later in WikiPage::doViewUpdates().
3511 * Set a cookie on the user's client. Wrapper for
3512 * WebResponse::setCookie
3513 * @deprecated since 1.27
3514 * @param string $name Name of the cookie to set
3515 * @param string $value Value to set
3516 * @param int $exp Expiration time, as a UNIX time value;
3517 * if 0 or not specified, use the default $wgCookieExpiration
3518 * @param bool $secure
3519 * true: Force setting the secure attribute when setting the cookie
3520 * false: Force NOT setting the secure attribute when setting the cookie
3521 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3522 * @param array $params Array of options sent passed to WebResponse::setcookie()
3523 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3526 protected function setCookie(
3527 $name, $value, $exp = 0, $secure = null, $params = array(), $request = null
3529 wfDeprecated( __METHOD__
, '1.27' );
3530 if ( $request === null ) {
3531 $request = $this->getRequest();
3533 $params['secure'] = $secure;
3534 $request->response()->setCookie( $name, $value, $exp, $params );
3538 * Clear a cookie on the user's client
3539 * @deprecated since 1.27
3540 * @param string $name Name of the cookie to clear
3541 * @param bool $secure
3542 * true: Force setting the secure attribute when setting the cookie
3543 * false: Force NOT setting the secure attribute when setting the cookie
3544 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3545 * @param array $params Array of options sent passed to WebResponse::setcookie()
3547 protected function clearCookie( $name, $secure = null, $params = array() ) {
3548 wfDeprecated( __METHOD__
, '1.27' );
3549 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3553 * Set an extended login cookie on the user's client. The expiry of the cookie
3554 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3557 * @see User::setCookie
3559 * @deprecated since 1.27
3560 * @param string $name Name of the cookie to set
3561 * @param string $value Value to set
3562 * @param bool $secure
3563 * true: Force setting the secure attribute when setting the cookie
3564 * false: Force NOT setting the secure attribute when setting the cookie
3565 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3567 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3568 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3570 wfDeprecated( __METHOD__
, '1.27' );
3573 $exp +
= $wgExtendedLoginCookieExpiration !== null
3574 ?
$wgExtendedLoginCookieExpiration
3575 : $wgCookieExpiration;
3577 $this->setCookie( $name, $value, $exp, $secure );
3581 * Persist this user's session (e.g. set cookies)
3583 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3585 * @param bool $secure Whether to force secure/insecure cookies or use default
3586 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3588 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3590 if ( 0 == $this->mId
) {
3594 $session = $this->getRequest()->getSession();
3595 if ( $request && $session->getRequest() !== $request ) {
3596 $session = $session->sessionWithRequest( $request );
3598 $delay = $session->delaySave();
3600 if ( !$session->getUser()->equals( $this ) ) {
3601 if ( !$session->canSetUser() ) {
3602 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3603 ->warning( __METHOD__
.
3604 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3608 $session->setUser( $this );
3611 $session->setRememberUser( $rememberMe );
3612 if ( $secure !== null ) {
3613 $session->setForceHTTPS( $secure );
3616 $session->persist();
3618 ScopedCallback
::consume( $delay );
3622 * Log this user out.
3624 public function logout() {
3625 if ( Hooks
::run( 'UserLogout', array( &$this ) ) ) {
3631 * Clear the user's session, and reset the instance cache.
3634 public function doLogout() {
3635 $session = $this->getRequest()->getSession();
3636 if ( !$session->canSetUser() ) {
3637 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3638 ->warning( __METHOD__
. ": Cannot log out of an immutable session" );
3639 } elseif ( !$session->getUser()->equals( $this ) ) {
3640 \MediaWiki\Logger\LoggerFactory
::getInstance( 'session' )
3641 ->warning( __METHOD__
.
3642 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3644 // But we still may as well make this user object anon
3645 $this->clearInstanceCache( 'defaults' );
3647 $this->clearInstanceCache( 'defaults' );
3648 $delay = $session->delaySave();
3649 $session->setLoggedOutTimestamp( time() );
3650 $session->setUser( new User
);
3651 $session->set( 'wsUserID', 0 ); // Other code expects this
3652 ScopedCallback
::consume( $delay );
3657 * Save this user's settings into the database.
3658 * @todo Only rarely do all these fields need to be set!
3660 public function saveSettings() {
3661 if ( wfReadOnly() ) {
3662 // @TODO: caller should deal with this instead!
3663 // This should really just be an exception.
3664 MWExceptionHandler
::logException( new DBExpectedError(
3666 "Could not update user with ID '{$this->mId}'; DB is read-only."
3672 if ( 0 == $this->mId
) {
3676 // Get a new user_touched that is higher than the old one.
3677 // This will be used for a CAS check as a last-resort safety
3678 // check against race conditions and slave lag.
3679 $oldTouched = $this->mTouched
;
3680 $newTouched = $this->newTouchedTimestamp();
3682 $dbw = wfGetDB( DB_MASTER
);
3683 $dbw->update( 'user',
3685 'user_name' => $this->mName
,
3686 'user_real_name' => $this->mRealName
,
3687 'user_email' => $this->mEmail
,
3688 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3689 'user_touched' => $dbw->timestamp( $newTouched ),
3690 'user_token' => strval( $this->mToken
),
3691 'user_email_token' => $this->mEmailToken
,
3692 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3693 ), array( /* WHERE */
3694 'user_id' => $this->mId
,
3695 'user_touched' => $dbw->timestamp( $oldTouched ) // CAS check
3699 if ( !$dbw->affectedRows() ) {
3700 // Maybe the problem was a missed cache update; clear it to be safe
3701 $this->clearSharedCache( 'refresh' );
3702 // User was changed in the meantime or loaded with stale data
3703 $from = ( $this->queryFlagsUsed
& self
::READ_LATEST
) ?
'master' : 'slave';
3704 throw new MWException(
3705 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3706 " the version of the user to be saved is older than the current version."
3710 $this->mTouched
= $newTouched;
3711 $this->saveOptions();
3713 Hooks
::run( 'UserSaveSettings', array( $this ) );
3714 $this->clearSharedCache();
3715 $this->getUserPage()->invalidateCache();
3719 * If only this user's username is known, and it exists, return the user ID.
3721 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3724 public function idForName( $flags = 0 ) {
3725 $s = trim( $this->getName() );
3730 $db = ( ( $flags & self
::READ_LATEST
) == self
::READ_LATEST
)
3731 ?
wfGetDB( DB_MASTER
)
3732 : wfGetDB( DB_SLAVE
);
3734 $options = ( ( $flags & self
::READ_LOCKING
) == self
::READ_LOCKING
)
3735 ?
array( 'LOCK IN SHARE MODE' )
3738 $id = $db->selectField( 'user',
3739 'user_id', array( 'user_name' => $s ), __METHOD__
, $options );
3745 * Add a user to the database, return the user object
3747 * @param string $name Username to add
3748 * @param array $params Array of Strings Non-default parameters to save to
3749 * the database as user_* fields:
3750 * - email: The user's email address.
3751 * - email_authenticated: The email authentication timestamp.
3752 * - real_name: The user's real name.
3753 * - options: An associative array of non-default options.
3754 * - token: Random authentication token. Do not set.
3755 * - registration: Registration timestamp. Do not set.
3757 * @return User|null User object, or null if the username already exists.
3759 public static function createNew( $name, $params = array() ) {
3760 foreach ( array( 'password', 'newpassword', 'newpass_time', 'password_expires' ) as $field ) {
3761 if ( isset( $params[$field] ) ) {
3762 wfDeprecated( __METHOD__
. " with param '$field'", '1.27' );
3763 unset( $params[$field] );
3769 $user->setToken(); // init token
3770 if ( isset( $params['options'] ) ) {
3771 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3772 unset( $params['options'] );
3774 $dbw = wfGetDB( DB_MASTER
);
3775 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3777 $noPass = PasswordFactory
::newInvalidPassword()->toString();
3780 'user_id' => $seqVal,
3781 'user_name' => $name,
3782 'user_password' => $noPass,
3783 'user_newpassword' => $noPass,
3784 'user_email' => $user->mEmail
,
3785 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3786 'user_real_name' => $user->mRealName
,
3787 'user_token' => strval( $user->mToken
),
3788 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3789 'user_editcount' => 0,
3790 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3792 foreach ( $params as $name => $value ) {
3793 $fields["user_$name"] = $value;
3795 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3796 if ( $dbw->affectedRows() ) {
3797 $newUser = User
::newFromId( $dbw->insertId() );
3805 * Add this existing user object to the database. If the user already
3806 * exists, a fatal status object is returned, and the user object is
3807 * initialised with the data from the database.
3809 * Previously, this function generated a DB error due to a key conflict
3810 * if the user already existed. Many extension callers use this function
3811 * in code along the lines of:
3813 * $user = User::newFromName( $name );
3814 * if ( !$user->isLoggedIn() ) {
3815 * $user->addToDatabase();
3817 * // do something with $user...
3819 * However, this was vulnerable to a race condition (bug 16020). By
3820 * initialising the user object if the user exists, we aim to support this
3821 * calling sequence as far as possible.
3823 * Note that if the user exists, this function will acquire a write lock,
3824 * so it is still advisable to make the call conditional on isLoggedIn(),
3825 * and to commit the transaction after calling.
3827 * @throws MWException
3830 public function addToDatabase() {
3832 if ( !$this->mToken
) {
3833 $this->setToken(); // init token
3836 $this->mTouched
= $this->newTouchedTimestamp();
3838 $noPass = PasswordFactory
::newInvalidPassword()->toString();
3840 $dbw = wfGetDB( DB_MASTER
);
3841 $inWrite = $dbw->writesOrCallbacksPending();
3842 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3843 $dbw->insert( 'user',
3845 'user_id' => $seqVal,
3846 'user_name' => $this->mName
,
3847 'user_password' => $noPass,
3848 'user_newpassword' => $noPass,
3849 'user_email' => $this->mEmail
,
3850 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3851 'user_real_name' => $this->mRealName
,
3852 'user_token' => strval( $this->mToken
),
3853 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3854 'user_editcount' => 0,
3855 'user_touched' => $dbw->timestamp( $this->mTouched
),
3859 if ( !$dbw->affectedRows() ) {
3860 // The queries below cannot happen in the same REPEATABLE-READ snapshot.
3861 // Handle this by COMMIT, if possible, or by LOCK IN SHARE MODE otherwise.
3863 // Can't commit due to pending writes that may need atomicity.
3864 // This may cause some lock contention unlike the case below.
3865 $options = array( 'LOCK IN SHARE MODE' );
3866 $flags = self
::READ_LOCKING
;
3868 // Often, this case happens early in views before any writes when
3869 // using CentralAuth. It's should be OK to commit and break the snapshot.
3870 $dbw->commit( __METHOD__
, 'flush' );
3872 $flags = self
::READ_LATEST
;
3874 $this->mId
= $dbw->selectField( 'user', 'user_id',
3875 array( 'user_name' => $this->mName
), __METHOD__
, $options );
3878 if ( $this->loadFromDatabase( $flags ) ) {
3883 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3884 "to insert user '{$this->mName}' row, but it was not present in select!" );
3886 return Status
::newFatal( 'userexists' );
3888 $this->mId
= $dbw->insertId();
3889 self
::$idCacheByName[$this->mName
] = $this->mId
;
3891 // Clear instance cache other than user table data, which is already accurate
3892 $this->clearInstanceCache();
3894 $this->saveOptions();
3895 return Status
::newGood();
3899 * If this user is logged-in and blocked,
3900 * block any IP address they've successfully logged in from.
3901 * @return bool A block was spread
3903 public function spreadAnyEditBlock() {
3904 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3905 return $this->spreadBlock();
3911 * If this (non-anonymous) user is blocked,
3912 * block the IP address they've successfully logged in from.
3913 * @return bool A block was spread
3915 protected function spreadBlock() {
3916 wfDebug( __METHOD__
. "()\n" );
3918 if ( $this->mId
== 0 ) {
3922 $userblock = Block
::newFromTarget( $this->getName() );
3923 if ( !$userblock ) {
3927 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3931 * Get whether the user is explicitly blocked from account creation.
3932 * @return bool|Block
3934 public function isBlockedFromCreateAccount() {
3935 $this->getBlockedStatus();
3936 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
3937 return $this->mBlock
;
3940 # bug 13611: if the IP address the user is trying to create an account from is
3941 # blocked with createaccount disabled, prevent new account creation there even
3942 # when the user is logged in
3943 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3944 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3946 return $this->mBlockedFromCreateAccount
instanceof Block
3947 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3948 ?
$this->mBlockedFromCreateAccount
3953 * Get whether the user is blocked from using Special:Emailuser.
3956 public function isBlockedFromEmailuser() {
3957 $this->getBlockedStatus();
3958 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3962 * Get whether the user is allowed to create an account.
3965 public function isAllowedToCreateAccount() {
3966 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3970 * Get this user's personal page title.
3972 * @return Title User's personal page title
3974 public function getUserPage() {
3975 return Title
::makeTitle( NS_USER
, $this->getName() );
3979 * Get this user's talk page title.
3981 * @return Title User's talk page title
3983 public function getTalkPage() {
3984 $title = $this->getUserPage();
3985 return $title->getTalkPage();
3989 * Determine whether the user is a newbie. Newbies are either
3990 * anonymous IPs, or the most recently created accounts.
3993 public function isNewbie() {
3994 return !$this->isAllowed( 'autoconfirmed' );
3998 * Check to see if the given clear-text password is one of the accepted passwords
3999 * @deprecated since 1.27. AuthManager is coming.
4000 * @param string $password User password
4001 * @return bool True if the given password is correct, otherwise False
4003 public function checkPassword( $password ) {
4004 global $wgAuth, $wgLegacyEncoding;
4008 // Some passwords will give a fatal Status, which means there is
4009 // some sort of technical or security reason for this password to
4010 // be completely invalid and should never be checked (e.g., T64685)
4011 if ( !$this->checkPasswordValidity( $password )->isOK() ) {
4015 // Certain authentication plugins do NOT want to save
4016 // domain passwords in a mysql database, so we should
4017 // check this (in case $wgAuth->strict() is false).
4018 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
4020 } elseif ( $wgAuth->strict() ) {
4021 // Auth plugin doesn't allow local authentication
4023 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
4024 // Auth plugin doesn't allow local authentication for this user name
4028 $passwordFactory = new PasswordFactory();
4029 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
4030 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
4031 ?
wfGetDB( DB_MASTER
)
4032 : wfGetDB( DB_SLAVE
);
4035 $mPassword = $passwordFactory->newFromCiphertext( $db->selectField(
4036 'user', 'user_password', array( 'user_id' => $this->getId() ), __METHOD__
4038 } catch ( PasswordError
$e ) {
4039 wfDebug( 'Invalid password hash found in database.' );
4040 $mPassword = PasswordFactory
::newInvalidPassword();
4043 if ( !$mPassword->equals( $password ) ) {
4044 if ( $wgLegacyEncoding ) {
4045 // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
4046 // Check for this with iconv
4047 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
4048 if ( $cp1252Password === $password ||
!$mPassword->equals( $cp1252Password ) ) {
4056 if ( $passwordFactory->needsUpdate( $mPassword ) && !wfReadOnly() ) {
4057 $this->setPasswordInternal( $password );
4064 * Check if the given clear-text password matches the temporary password
4065 * sent by e-mail for password reset operations.
4067 * @deprecated since 1.27. AuthManager is coming.
4068 * @param string $plaintext
4069 * @return bool True if matches, false otherwise
4071 public function checkTemporaryPassword( $plaintext ) {
4072 global $wgNewPasswordExpiry;
4076 $passwordFactory = new PasswordFactory();
4077 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
4078 $db = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
4079 ?
wfGetDB( DB_MASTER
)
4080 : wfGetDB( DB_SLAVE
);
4082 $row = $db->selectRow(
4084 array( 'user_newpassword', 'user_newpass_time' ),
4085 array( 'user_id' => $this->getId() ),
4089 $newPassword = $passwordFactory->newFromCiphertext( $row->user_newpassword
);
4090 } catch ( PasswordError
$e ) {
4091 wfDebug( 'Invalid password hash found in database.' );
4092 $newPassword = PasswordFactory
::newInvalidPassword();
4095 if ( $newPassword->equals( $plaintext ) ) {
4096 if ( is_null( $row->user_newpass_time
) ) {
4099 $expiry = wfTimestamp( TS_UNIX
, $row->user_newpass_time
) +
$wgNewPasswordExpiry;
4100 return ( time() < $expiry );
4107 * Initialize (if necessary) and return a session token value
4108 * which can be used in edit forms to show that the user's
4109 * login credentials aren't being hijacked with a foreign form
4113 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4114 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4115 * @return MediaWiki\\Session\\Token The new edit token
4117 public function getEditTokenObject( $salt = '', $request = null ) {
4118 if ( $this->isAnon() ) {
4119 return new LoggedOutEditToken();
4123 $request = $this->getRequest();
4125 return $request->getSession()->getToken( $salt );
4129 * Initialize (if necessary) and return a session token value
4130 * which can be used in edit forms to show that the user's
4131 * login credentials aren't being hijacked with a foreign form
4135 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4136 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4137 * @return string The new edit token
4139 public function getEditToken( $salt = '', $request = null ) {
4140 return $this->getEditTokenObject( $salt, $request )->toString();
4144 * Get the embedded timestamp from a token.
4145 * @deprecated since 1.27, use \\MediaWiki\\Session\\Token::getTimestamp instead.
4146 * @param string $val Input token
4149 public static function getEditTokenTimestamp( $val ) {
4150 wfDeprecated( __METHOD__
, '1.27' );
4151 return MediaWiki\Session\Token
::getTimestamp( $val );
4155 * Check given value against the token value stored in the session.
4156 * A match should confirm that the form was submitted from the
4157 * user's own login session, not a form submission from a third-party
4160 * @param string $val Input value to compare
4161 * @param string $salt Optional function-specific data for hashing
4162 * @param WebRequest|null $request Object to use or null to use $wgRequest
4163 * @param int $maxage Fail tokens older than this, in seconds
4164 * @return bool Whether the token matches
4166 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4167 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4171 * Check given value against the token value stored in the session,
4172 * ignoring the suffix.
4174 * @param string $val Input value to compare
4175 * @param string $salt Optional function-specific data for hashing
4176 * @param WebRequest|null $request Object to use or null to use $wgRequest
4177 * @param int $maxage Fail tokens older than this, in seconds
4178 * @return bool Whether the token matches
4180 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4181 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . self
::EDIT_TOKEN_SUFFIX
;
4182 return $this->matchEditToken( $val, $salt, $request, $maxage );
4186 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4187 * mail to the user's given address.
4189 * @param string $type Message to send, either "created", "changed" or "set"
4192 public function sendConfirmationMail( $type = 'created' ) {
4194 $expiration = null; // gets passed-by-ref and defined in next line.
4195 $token = $this->confirmationToken( $expiration );
4196 $url = $this->confirmationTokenUrl( $token );
4197 $invalidateURL = $this->invalidationTokenUrl( $token );
4198 $this->saveSettings();
4200 if ( $type == 'created' ||
$type === false ) {
4201 $message = 'confirmemail_body';
4202 } elseif ( $type === true ) {
4203 $message = 'confirmemail_body_changed';
4205 // Messages: confirmemail_body_changed, confirmemail_body_set
4206 $message = 'confirmemail_body_' . $type;
4209 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4210 wfMessage( $message,
4211 $this->getRequest()->getIP(),
4214 $wgLang->userTimeAndDate( $expiration, $this ),
4216 $wgLang->userDate( $expiration, $this ),
4217 $wgLang->userTime( $expiration, $this ) )->text() );
4221 * Send an e-mail to this user's account. Does not check for
4222 * confirmed status or validity.
4224 * @param string $subject Message subject
4225 * @param string $body Message body
4226 * @param User|null $from Optional sending user; if unspecified, default
4227 * $wgPasswordSender will be used.
4228 * @param string $replyto Reply-To address
4231 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4232 global $wgPasswordSender;
4234 if ( $from instanceof User
) {
4235 $sender = MailAddress
::newFromUser( $from );
4237 $sender = new MailAddress( $wgPasswordSender,
4238 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4240 $to = MailAddress
::newFromUser( $this );
4242 return UserMailer
::send( $to, $sender, $subject, $body, array(
4243 'replyTo' => $replyto,
4248 * Generate, store, and return a new e-mail confirmation code.
4249 * A hash (unsalted, since it's used as a key) is stored.
4251 * @note Call saveSettings() after calling this function to commit
4252 * this change to the database.
4254 * @param string &$expiration Accepts the expiration time
4255 * @return string New token
4257 protected function confirmationToken( &$expiration ) {
4258 global $wgUserEmailConfirmationTokenExpiry;
4260 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4261 $expiration = wfTimestamp( TS_MW
, $expires );
4263 $token = MWCryptRand
::generateHex( 32 );
4264 $hash = md5( $token );
4265 $this->mEmailToken
= $hash;
4266 $this->mEmailTokenExpires
= $expiration;
4271 * Return a URL the user can use to confirm their email address.
4272 * @param string $token Accepts the email confirmation token
4273 * @return string New token URL
4275 protected function confirmationTokenUrl( $token ) {
4276 return $this->getTokenUrl( 'ConfirmEmail', $token );
4280 * Return a URL the user can use to invalidate their email address.
4281 * @param string $token Accepts the email confirmation token
4282 * @return string New token URL
4284 protected function invalidationTokenUrl( $token ) {
4285 return $this->getTokenUrl( 'InvalidateEmail', $token );
4289 * Internal function to format the e-mail validation/invalidation URLs.
4290 * This uses a quickie hack to use the
4291 * hardcoded English names of the Special: pages, for ASCII safety.
4293 * @note Since these URLs get dropped directly into emails, using the
4294 * short English names avoids insanely long URL-encoded links, which
4295 * also sometimes can get corrupted in some browsers/mailers
4296 * (bug 6957 with Gmail and Internet Explorer).
4298 * @param string $page Special page
4299 * @param string $token Token
4300 * @return string Formatted URL
4302 protected function getTokenUrl( $page, $token ) {
4303 // Hack to bypass localization of 'Special:'
4304 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4305 return $title->getCanonicalURL();
4309 * Mark the e-mail address confirmed.
4311 * @note Call saveSettings() after calling this function to commit the change.
4315 public function confirmEmail() {
4316 // Check if it's already confirmed, so we don't touch the database
4317 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4318 if ( !$this->isEmailConfirmed() ) {
4319 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4320 Hooks
::run( 'ConfirmEmailComplete', array( $this ) );
4326 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4327 * address if it was already confirmed.
4329 * @note Call saveSettings() after calling this function to commit the change.
4330 * @return bool Returns true
4332 public function invalidateEmail() {
4334 $this->mEmailToken
= null;
4335 $this->mEmailTokenExpires
= null;
4336 $this->setEmailAuthenticationTimestamp( null );
4338 Hooks
::run( 'InvalidateEmailComplete', array( $this ) );
4343 * Set the e-mail authentication timestamp.
4344 * @param string $timestamp TS_MW timestamp
4346 public function setEmailAuthenticationTimestamp( $timestamp ) {
4348 $this->mEmailAuthenticated
= $timestamp;
4349 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
4353 * Is this user allowed to send e-mails within limits of current
4354 * site configuration?
4357 public function canSendEmail() {
4358 global $wgEnableEmail, $wgEnableUserEmail;
4359 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4362 $canSend = $this->isEmailConfirmed();
4363 Hooks
::run( 'UserCanSendEmail', array( &$this, &$canSend ) );
4368 * Is this user allowed to receive e-mails within limits of current
4369 * site configuration?
4372 public function canReceiveEmail() {
4373 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4377 * Is this user's e-mail address valid-looking and confirmed within
4378 * limits of the current site configuration?
4380 * @note If $wgEmailAuthentication is on, this may require the user to have
4381 * confirmed their address by returning a code or using a password
4382 * sent to the address from the wiki.
4386 public function isEmailConfirmed() {
4387 global $wgEmailAuthentication;
4390 if ( Hooks
::run( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
4391 if ( $this->isAnon() ) {
4394 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4397 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4407 * Check whether there is an outstanding request for e-mail confirmation.
4410 public function isEmailConfirmationPending() {
4411 global $wgEmailAuthentication;
4412 return $wgEmailAuthentication &&
4413 !$this->isEmailConfirmed() &&
4414 $this->mEmailToken
&&
4415 $this->mEmailTokenExpires
> wfTimestamp();
4419 * Get the timestamp of account creation.
4421 * @return string|bool|null Timestamp of account creation, false for
4422 * non-existent/anonymous user accounts, or null if existing account
4423 * but information is not in database.
4425 public function getRegistration() {
4426 if ( $this->isAnon() ) {
4430 return $this->mRegistration
;
4434 * Get the timestamp of the first edit
4436 * @return string|bool Timestamp of first edit, or false for
4437 * non-existent/anonymous user accounts.
4439 public function getFirstEditTimestamp() {
4440 if ( $this->getId() == 0 ) {
4441 return false; // anons
4443 $dbr = wfGetDB( DB_SLAVE
);
4444 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4445 array( 'rev_user' => $this->getId() ),
4447 array( 'ORDER BY' => 'rev_timestamp ASC' )
4450 return false; // no edits
4452 return wfTimestamp( TS_MW
, $time );
4456 * Get the permissions associated with a given list of groups
4458 * @param array $groups Array of Strings List of internal group names
4459 * @return array Array of Strings List of permission key names for given groups combined
4461 public static function getGroupPermissions( $groups ) {
4462 global $wgGroupPermissions, $wgRevokePermissions;
4464 // grant every granted permission first
4465 foreach ( $groups as $group ) {
4466 if ( isset( $wgGroupPermissions[$group] ) ) {
4467 $rights = array_merge( $rights,
4468 // array_filter removes empty items
4469 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4472 // now revoke the revoked permissions
4473 foreach ( $groups as $group ) {
4474 if ( isset( $wgRevokePermissions[$group] ) ) {
4475 $rights = array_diff( $rights,
4476 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4479 return array_unique( $rights );
4483 * Get all the groups who have a given permission
4485 * @param string $role Role to check
4486 * @return array Array of Strings List of internal group names with the given permission
4488 public static function getGroupsWithPermission( $role ) {
4489 global $wgGroupPermissions;
4490 $allowedGroups = array();
4491 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4492 if ( self
::groupHasPermission( $group, $role ) ) {
4493 $allowedGroups[] = $group;
4496 return $allowedGroups;
4500 * Check, if the given group has the given permission
4502 * If you're wanting to check whether all users have a permission, use
4503 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4507 * @param string $group Group to check
4508 * @param string $role Role to check
4511 public static function groupHasPermission( $group, $role ) {
4512 global $wgGroupPermissions, $wgRevokePermissions;
4513 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4514 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4518 * Check if all users may be assumed to have the given permission
4520 * We generally assume so if the right is granted to '*' and isn't revoked
4521 * on any group. It doesn't attempt to take grants or other extension
4522 * limitations on rights into account in the general case, though, as that
4523 * would require it to always return false and defeat the purpose.
4524 * Specifically, session-based rights restrictions (such as OAuth or bot
4525 * passwords) are applied based on the current session.
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 // Remove any rights that aren't allowed to the global-session user
4555 $allowedRights = SessionManager
::getGlobalSession()->getAllowedUserRights();
4556 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4557 $cache[$right] = false;
4561 // Allow extensions to say false
4562 if ( !Hooks
::run( 'UserIsEveryoneAllowed', array( $right ) ) ) {
4563 $cache[$right] = false;
4567 $cache[$right] = true;
4572 * Get the localized descriptive name for a group, if it exists
4574 * @param string $group Internal group name
4575 * @return string Localized descriptive group name
4577 public static function getGroupName( $group ) {
4578 $msg = wfMessage( "group-$group" );
4579 return $msg->isBlank() ?
$group : $msg->text();
4583 * Get the localized descriptive name for a member of a group, if it exists
4585 * @param string $group Internal group name
4586 * @param string $username Username for gender (since 1.19)
4587 * @return string Localized name for group member
4589 public static function getGroupMember( $group, $username = '#' ) {
4590 $msg = wfMessage( "group-$group-member", $username );
4591 return $msg->isBlank() ?
$group : $msg->text();
4595 * Return the set of defined explicit groups.
4596 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4597 * are not included, as they are defined automatically, not in the database.
4598 * @return array Array of internal group names
4600 public static function getAllGroups() {
4601 global $wgGroupPermissions, $wgRevokePermissions;
4603 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4604 self
::getImplicitGroups()
4609 * Get a list of all available permissions.
4610 * @return string[] Array of permission names
4612 public static function getAllRights() {
4613 if ( self
::$mAllRights === false ) {
4614 global $wgAvailableRights;
4615 if ( count( $wgAvailableRights ) ) {
4616 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4618 self
::$mAllRights = self
::$mCoreRights;
4620 Hooks
::run( 'UserGetAllRights', array( &self
::$mAllRights ) );
4622 return self
::$mAllRights;
4626 * Get a list of implicit groups
4627 * @return array Array of Strings Array of internal group names
4629 public static function getImplicitGroups() {
4630 global $wgImplicitGroups;
4632 $groups = $wgImplicitGroups;
4633 # Deprecated, use $wgImplicitGroups instead
4634 Hooks
::run( 'UserGetImplicitGroups', array( &$groups ), '1.25' );
4640 * Get the title of a page describing a particular group
4642 * @param string $group Internal group name
4643 * @return Title|bool Title of the page if it exists, false otherwise
4645 public static function getGroupPage( $group ) {
4646 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4647 if ( $msg->exists() ) {
4648 $title = Title
::newFromText( $msg->text() );
4649 if ( is_object( $title ) ) {
4657 * Create a link to the group in HTML, if available;
4658 * else return the group name.
4660 * @param string $group Internal name of the group
4661 * @param string $text The text of the link
4662 * @return string HTML link to the group
4664 public static function makeGroupLinkHTML( $group, $text = '' ) {
4665 if ( $text == '' ) {
4666 $text = self
::getGroupName( $group );
4668 $title = self
::getGroupPage( $group );
4670 return Linker
::link( $title, htmlspecialchars( $text ) );
4672 return htmlspecialchars( $text );
4677 * Create a link to the group in Wikitext, if available;
4678 * else return the group name.
4680 * @param string $group Internal name of the group
4681 * @param string $text The text of the link
4682 * @return string Wikilink to the group
4684 public static function makeGroupLinkWiki( $group, $text = '' ) {
4685 if ( $text == '' ) {
4686 $text = self
::getGroupName( $group );
4688 $title = self
::getGroupPage( $group );
4690 $page = $title->getFullText();
4691 return "[[$page|$text]]";
4698 * Returns an array of the groups that a particular group can add/remove.
4700 * @param string $group The group to check for whether it can add/remove
4701 * @return array Array( 'add' => array( addablegroups ),
4702 * 'remove' => array( removablegroups ),
4703 * 'add-self' => array( addablegroups to self),
4704 * 'remove-self' => array( removable groups from self) )
4706 public static function changeableByGroup( $group ) {
4707 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4711 'remove' => array(),
4712 'add-self' => array(),
4713 'remove-self' => array()
4716 if ( empty( $wgAddGroups[$group] ) ) {
4717 // Don't add anything to $groups
4718 } elseif ( $wgAddGroups[$group] === true ) {
4719 // You get everything
4720 $groups['add'] = self
::getAllGroups();
4721 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4722 $groups['add'] = $wgAddGroups[$group];
4725 // Same thing for remove
4726 if ( empty( $wgRemoveGroups[$group] ) ) {
4728 } elseif ( $wgRemoveGroups[$group] === true ) {
4729 $groups['remove'] = self
::getAllGroups();
4730 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4731 $groups['remove'] = $wgRemoveGroups[$group];
4734 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4735 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4736 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4737 if ( is_int( $key ) ) {
4738 $wgGroupsAddToSelf['user'][] = $value;
4743 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4744 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4745 if ( is_int( $key ) ) {
4746 $wgGroupsRemoveFromSelf['user'][] = $value;
4751 // Now figure out what groups the user can add to him/herself
4752 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4754 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4755 // No idea WHY this would be used, but it's there
4756 $groups['add-self'] = User
::getAllGroups();
4757 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4758 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4761 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4763 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4764 $groups['remove-self'] = User
::getAllGroups();
4765 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4766 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4773 * Returns an array of groups that this user can add and remove
4774 * @return array Array( 'add' => array( addablegroups ),
4775 * 'remove' => array( removablegroups ),
4776 * 'add-self' => array( addablegroups to self),
4777 * 'remove-self' => array( removable groups from self) )
4779 public function changeableGroups() {
4780 if ( $this->isAllowed( 'userrights' ) ) {
4781 // This group gives the right to modify everything (reverse-
4782 // compatibility with old "userrights lets you change
4784 // Using array_merge to make the groups reindexed
4785 $all = array_merge( User
::getAllGroups() );
4789 'add-self' => array(),
4790 'remove-self' => array()
4794 // Okay, it's not so simple, we will have to go through the arrays
4797 'remove' => array(),
4798 'add-self' => array(),
4799 'remove-self' => array()
4801 $addergroups = $this->getEffectiveGroups();
4803 foreach ( $addergroups as $addergroup ) {
4804 $groups = array_merge_recursive(
4805 $groups, $this->changeableByGroup( $addergroup )
4807 $groups['add'] = array_unique( $groups['add'] );
4808 $groups['remove'] = array_unique( $groups['remove'] );
4809 $groups['add-self'] = array_unique( $groups['add-self'] );
4810 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4816 * Deferred version of incEditCountImmediate()
4818 public function incEditCount() {
4820 wfGetDB( DB_MASTER
)->onTransactionPreCommitOrIdle( function() use ( $that ) {
4821 $that->incEditCountImmediate();
4826 * Increment the user's edit-count field.
4827 * Will have no effect for anonymous users.
4830 public function incEditCountImmediate() {
4831 if ( $this->isAnon() ) {
4835 $dbw = wfGetDB( DB_MASTER
);
4836 // No rows will be "affected" if user_editcount is NULL
4839 array( 'user_editcount=user_editcount+1' ),
4840 array( 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ),
4843 // Lazy initialization check...
4844 if ( $dbw->affectedRows() == 0 ) {
4845 // Now here's a goddamn hack...
4846 $dbr = wfGetDB( DB_SLAVE
);
4847 if ( $dbr !== $dbw ) {
4848 // If we actually have a slave server, the count is
4849 // at least one behind because the current transaction
4850 // has not been committed and replicated.
4851 $this->initEditCount( 1 );
4853 // But if DB_SLAVE is selecting the master, then the
4854 // count we just read includes the revision that was
4855 // just added in the working transaction.
4856 $this->initEditCount();
4859 // Edit count in user cache too
4860 $this->invalidateCache();
4864 * Initialize user_editcount from data out of the revision table
4866 * @param int $add Edits to add to the count from the revision table
4867 * @return int Number of edits
4869 protected function initEditCount( $add = 0 ) {
4870 // Pull from a slave to be less cruel to servers
4871 // Accuracy isn't the point anyway here
4872 $dbr = wfGetDB( DB_SLAVE
);
4873 $count = (int)$dbr->selectField(
4876 array( 'rev_user' => $this->getId() ),
4879 $count = $count +
$add;
4881 $dbw = wfGetDB( DB_MASTER
);
4884 array( 'user_editcount' => $count ),
4885 array( 'user_id' => $this->getId() ),
4893 * Get the description of a given right
4895 * @param string $right Right to query
4896 * @return string Localized description of the right
4898 public static function getRightDescription( $right ) {
4899 $key = "right-$right";
4900 $msg = wfMessage( $key );
4901 return $msg->isBlank() ?
$right : $msg->text();
4905 * Make a new-style password hash
4907 * @param string $password Plain-text password
4908 * @param bool|string $salt Optional salt, may be random or the user ID.
4909 * If unspecified or false, will generate one automatically
4910 * @return string Password hash
4911 * @deprecated since 1.24, use Password class
4913 public static function crypt( $password, $salt = false ) {
4914 wfDeprecated( __METHOD__
, '1.24' );
4915 $passwordFactory = new PasswordFactory();
4916 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
4917 $hash = $passwordFactory->newFromPlaintext( $password );
4918 return $hash->toString();
4922 * Compare a password hash with a plain-text password. Requires the user
4923 * ID if there's a chance that the hash is an old-style hash.
4925 * @param string $hash Password hash
4926 * @param string $password Plain-text password to compare
4927 * @param string|bool $userId User ID for old-style password salt
4930 * @deprecated since 1.24, use Password class
4932 public static function comparePasswords( $hash, $password, $userId = false ) {
4933 wfDeprecated( __METHOD__
, '1.24' );
4935 // Check for *really* old password hashes that don't even have a type
4936 // The old hash format was just an md5 hex hash, with no type information
4937 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
4938 global $wgPasswordSalt;
4939 if ( $wgPasswordSalt ) {
4940 $password = ":B:{$userId}:{$hash}";
4942 $password = ":A:{$hash}";
4946 $passwordFactory = new PasswordFactory();
4947 $passwordFactory->init( RequestContext
::getMain()->getConfig() );
4948 $hash = $passwordFactory->newFromCiphertext( $hash );
4949 return $hash->equals( $password );
4953 * Add a newuser log entry for this user.
4954 * Before 1.19 the return value was always true.
4956 * @param string|bool $action Account creation type.
4957 * - String, one of the following values:
4958 * - 'create' for an anonymous user creating an account for himself.
4959 * This will force the action's performer to be the created user itself,
4960 * no matter the value of $wgUser
4961 * - 'create2' for a logged in user creating an account for someone else
4962 * - 'byemail' when the created user will receive its password by e-mail
4963 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4964 * - Boolean means whether the account was created by e-mail (deprecated):
4965 * - true will be converted to 'byemail'
4966 * - false will be converted to 'create' if this object is the same as
4967 * $wgUser and to 'create2' otherwise
4969 * @param string $reason User supplied reason
4971 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4973 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4974 global $wgUser, $wgNewUserLog;
4975 if ( empty( $wgNewUserLog ) ) {
4976 return true; // disabled
4979 if ( $action === true ) {
4980 $action = 'byemail';
4981 } elseif ( $action === false ) {
4982 if ( $this->equals( $wgUser ) ) {
4985 $action = 'create2';
4989 if ( $action === 'create' ||
$action === 'autocreate' ) {
4992 $performer = $wgUser;
4995 $logEntry = new ManualLogEntry( 'newusers', $action );
4996 $logEntry->setPerformer( $performer );
4997 $logEntry->setTarget( $this->getUserPage() );
4998 $logEntry->setComment( $reason );
4999 $logEntry->setParameters( array(
5000 '4::userid' => $this->getId(),
5002 $logid = $logEntry->insert();
5004 if ( $action !== 'autocreate' ) {
5005 $logEntry->publish( $logid );
5012 * Add an autocreate newuser log entry for this user
5013 * Used by things like CentralAuth and perhaps other authplugins.
5014 * Consider calling addNewUserLogEntry() directly instead.
5018 public function addNewUserLogEntryAutoCreate() {
5019 $this->addNewUserLogEntry( 'autocreate' );
5025 * Load the user options either from cache, the database or an array
5027 * @param array $data Rows for the current user out of the user_properties table
5029 protected function loadOptions( $data = null ) {
5034 if ( $this->mOptionsLoaded
) {
5038 $this->mOptions
= self
::getDefaultOptions();
5040 if ( !$this->getId() ) {
5041 // For unlogged-in users, load language/variant options from request.
5042 // There's no need to do it for logged-in users: they can set preferences,
5043 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5044 // so don't override user's choice (especially when the user chooses site default).
5045 $variant = $wgContLang->getDefaultVariant();
5046 $this->mOptions
['variant'] = $variant;
5047 $this->mOptions
['language'] = $variant;
5048 $this->mOptionsLoaded
= true;
5052 // Maybe load from the object
5053 if ( !is_null( $this->mOptionOverrides
) ) {
5054 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5055 foreach ( $this->mOptionOverrides
as $key => $value ) {
5056 $this->mOptions
[$key] = $value;
5059 if ( !is_array( $data ) ) {
5060 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5061 // Load from database
5062 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
5063 ?
wfGetDB( DB_MASTER
)
5064 : wfGetDB( DB_SLAVE
);
5066 $res = $dbr->select(
5068 array( 'up_property', 'up_value' ),
5069 array( 'up_user' => $this->getId() ),
5073 $this->mOptionOverrides
= array();
5075 foreach ( $res as $row ) {
5076 $data[$row->up_property
] = $row->up_value
;
5079 foreach ( $data as $property => $value ) {
5080 $this->mOptionOverrides
[$property] = $value;
5081 $this->mOptions
[$property] = $value;
5085 $this->mOptionsLoaded
= true;
5087 Hooks
::run( 'UserLoadOptions', array( $this, &$this->mOptions
) );
5091 * Saves the non-default options for this user, as previously set e.g. via
5092 * setOption(), in the database's "user_properties" (preferences) table.
5093 * Usually used via saveSettings().
5095 protected function saveOptions() {
5096 $this->loadOptions();
5098 // Not using getOptions(), to keep hidden preferences in database
5099 $saveOptions = $this->mOptions
;
5101 // Allow hooks to abort, for instance to save to a global profile.
5102 // Reset options to default state before saving.
5103 if ( !Hooks
::run( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
5107 $userId = $this->getId();
5109 $insert_rows = array(); // all the new preference rows
5110 foreach ( $saveOptions as $key => $value ) {
5111 // Don't bother storing default values
5112 $defaultOption = self
::getDefaultOption( $key );
5113 if ( ( $defaultOption === null && $value !== false && $value !== null )
5114 ||
$value != $defaultOption
5116 $insert_rows[] = array(
5117 'up_user' => $userId,
5118 'up_property' => $key,
5119 'up_value' => $value,
5124 $dbw = wfGetDB( DB_MASTER
);
5126 $res = $dbw->select( 'user_properties',
5127 array( 'up_property', 'up_value' ), array( 'up_user' => $userId ), __METHOD__
);
5129 // Find prior rows that need to be removed or updated. These rows will
5130 // all be deleted (the later so that INSERT IGNORE applies the new values).
5131 $keysDelete = array();
5132 foreach ( $res as $row ) {
5133 if ( !isset( $saveOptions[$row->up_property
] )
5134 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5136 $keysDelete[] = $row->up_property
;
5140 if ( count( $keysDelete ) ) {
5141 // Do the DELETE by PRIMARY KEY for prior rows.
5142 // In the past a very large portion of calls to this function are for setting
5143 // 'rememberpassword' for new accounts (a preference that has since been removed).
5144 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5145 // caused gap locks on [max user ID,+infinity) which caused high contention since
5146 // updates would pile up on each other as they are for higher (newer) user IDs.
5147 // It might not be necessary these days, but it shouldn't hurt either.
5148 $dbw->delete( 'user_properties',
5149 array( 'up_user' => $userId, 'up_property' => $keysDelete ), __METHOD__
);
5151 // Insert the new preference rows
5152 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, array( 'IGNORE' ) );
5156 * Lazily instantiate and return a factory object for making passwords
5158 * @deprecated since 1.27, create a PasswordFactory directly instead
5159 * @return PasswordFactory
5161 public static function getPasswordFactory() {
5162 wfDeprecated( __METHOD__
, '1.27' );
5163 $ret = new PasswordFactory();
5164 $ret->init( RequestContext
::getMain()->getConfig() );
5169 * Provide an array of HTML5 attributes to put on an input element
5170 * intended for the user to enter a new password. This may include
5171 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5173 * Do *not* use this when asking the user to enter his current password!
5174 * Regardless of configuration, users may have invalid passwords for whatever
5175 * reason (e.g., they were set before requirements were tightened up).
5176 * Only use it when asking for a new password, like on account creation or
5179 * Obviously, you still need to do server-side checking.
5181 * NOTE: A combination of bugs in various browsers means that this function
5182 * actually just returns array() unconditionally at the moment. May as
5183 * well keep it around for when the browser bugs get fixed, though.
5185 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5187 * @deprecated since 1.27
5188 * @return array Array of HTML attributes suitable for feeding to
5189 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5190 * That will get confused by the boolean attribute syntax used.)
5192 public static function passwordChangeInputAttribs() {
5193 global $wgMinimalPasswordLength;
5195 if ( $wgMinimalPasswordLength == 0 ) {
5199 # Note that the pattern requirement will always be satisfied if the
5200 # input is empty, so we need required in all cases.
5202 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5203 # if e-mail confirmation is being used. Since HTML5 input validation
5204 # is b0rked anyway in some browsers, just return nothing. When it's
5205 # re-enabled, fix this code to not output required for e-mail
5207 # $ret = array( 'required' );
5210 # We can't actually do this right now, because Opera 9.6 will print out
5211 # the entered password visibly in its error message! When other
5212 # browsers add support for this attribute, or Opera fixes its support,
5213 # we can add support with a version check to avoid doing this on Opera
5214 # versions where it will be a problem. Reported to Opera as
5215 # DSK-262266, but they don't have a public bug tracker for us to follow.
5217 if ( $wgMinimalPasswordLength > 1 ) {
5218 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5219 $ret['title'] = wfMessage( 'passwordtooshort' )
5220 ->numParams( $wgMinimalPasswordLength )->text();
5228 * Return the list of user fields that should be selected to create
5229 * a new user object.
5232 public static function selectFields() {
5240 'user_email_authenticated',
5242 'user_email_token_expires',
5243 'user_registration',
5249 * Factory function for fatal permission-denied errors
5252 * @param string $permission User right required
5255 static function newFatalPermissionDeniedStatus( $permission ) {
5258 $groups = array_map(
5259 array( 'User', 'makeGroupLinkWiki' ),
5260 User
::getGroupsWithPermission( $permission )
5264 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5266 return Status
::newFatal( 'badaccess-group0' );
5271 * Get a new instance of this user that was loaded from the master via a locking read
5273 * Use this instead of the main context User when updating that user. This avoids races
5274 * where that user was loaded from a slave or even the master but without proper locks.
5276 * @return User|null Returns null if the user was not found in the DB
5279 public function getInstanceForUpdate() {
5280 if ( !$this->getId() ) {
5281 return null; // anon
5284 $user = self
::newFromId( $this->getId() );
5285 if ( !$user->loadFromId( self
::READ_EXCLUSIVE
) ) {
5293 * Checks if two user objects point to the same user.
5299 public function equals( User
$user ) {
5300 return $this->getName() === $user->getName();