3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * String Some punctuation to prevent editing from broken text-mangling proxies.
27 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
30 * The User object encapsulates all of the user-specific settings (user_id,
31 * name, rights, password, email address, options, last login time). Client
32 * classes use the getXXX() functions to access these fields. These functions
33 * do all the work of determining whether the user is logged in,
34 * whether the requested option can be satisfied from cookies or
35 * whether a database query is needed. Most of the settings needed
36 * for rendering normal pages are set in the cookie to minimize use
39 class User
implements IDBAccessObject
{
41 * @const int Number of characters in user_token field.
43 const TOKEN_LENGTH
= 32;
46 * Global constant made accessible as class constants so that autoloader
49 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
52 * @const int Serialized record version.
57 * Maximum items in $mWatchedItems
59 const MAX_WATCHED_ITEMS_CACHE
= 100;
62 * Exclude user options that are set to their default value.
65 const GETOPTIONS_EXCLUDE_DEFAULTS
= 1;
68 * @var PasswordFactory Lazily loaded factory object for passwords
70 private static $mPasswordFactory = null;
73 * Array of Strings List of member variables which are saved to the
74 * shared cache (memcached). Any operation which changes the
75 * corresponding database fields must call a cache-clearing function.
78 protected static $mCacheVars = array(
86 'mEmailAuthenticated',
93 // user_properties table
98 * Array of Strings Core rights.
99 * Each of these should have a corresponding message of the form
103 protected static $mCoreRights = array(
130 'editusercssjs', #deprecated
143 'move-categorypages',
144 'move-rootuserpages',
148 'override-export-depth',
172 'userrights-interwiki',
180 * String Cached results of getAllRights()
182 protected static $mAllRights = false;
184 /** @name Cache variables */
193 * @todo Make this actually private
199 * @todo Make this actually private
202 public $mNewpassword;
204 public $mNewpassTime;
207 /** @var string TS_MW timestamp from the DB */
209 /** @var string TS_MW timestamp from cache */
210 protected $mQuickTouched;
214 public $mEmailAuthenticated;
216 protected $mEmailToken;
218 protected $mEmailTokenExpires;
220 protected $mRegistration;
222 protected $mEditCount;
226 protected $mOptionOverrides;
228 protected $mPasswordExpires;
232 * Bool Whether the cache variables have been loaded.
235 public $mOptionsLoaded;
238 * Array with already loaded items or true if all items have been loaded.
240 protected $mLoadedItems = array();
244 * String Initialization data source if mLoadedItems!==true. May be one of:
245 * - 'defaults' anonymous user initialised from class defaults
246 * - 'name' initialise from mName
247 * - 'id' initialise from mId
248 * - 'session' log in from cookies or session if possible
250 * Use the User::newFrom*() family of functions to set this.
255 * Lazy-initialized variables, invalidated with clearInstanceCache
259 protected $mDatePreference;
267 protected $mBlockreason;
269 protected $mEffectiveGroups;
271 protected $mImplicitGroups;
273 protected $mFormerGroups;
275 protected $mBlockedGlobally;
292 protected $mAllowUsertalk;
295 private $mBlockedFromCreateAccount = false;
298 private $mWatchedItems = array();
300 /** @var integer User::READ_* constant bitfield used to load data */
301 protected $queryFlagsUsed = self
::READ_NORMAL
;
303 public static $idCacheByName = array();
306 * Lightweight constructor for an anonymous user.
307 * Use the User::newFrom* factory functions for other kinds of users.
311 * @see newFromConfirmationCode()
312 * @see newFromSession()
315 public function __construct() {
316 $this->clearInstanceCache( 'defaults' );
322 public function __toString() {
323 return $this->getName();
327 * Load the user table data for this object from the source given by mFrom.
329 * @param integer $flags User::READ_* constant bitfield
331 public function load( $flags = self
::READ_LATEST
) {
332 if ( $this->mLoadedItems
=== true ) {
336 // Set it now to avoid infinite recursion in accessors
337 $this->mLoadedItems
= true;
338 $this->queryFlagsUsed
= $flags;
340 switch ( $this->mFrom
) {
342 $this->loadDefaults();
345 // @TODO: this gets the ID from a slave, assuming renames
346 // are rare. This should be controllable and more consistent.
347 $this->mId
= self
::idFromName( $this->mName
);
349 // Nonexistent user placeholder object
350 $this->loadDefaults( $this->mName
);
352 $this->loadFromId( $flags );
356 $this->loadFromId( $flags );
359 if ( !$this->loadFromSession() ) {
360 // Loading from session failed. Load defaults.
361 $this->loadDefaults();
363 Hooks
::run( 'UserLoadAfterLoadFromSession', array( $this ) );
366 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
371 * Load user table data, given mId has already been set.
372 * @param integer $flags User::READ_* constant bitfield
373 * @return bool False if the ID does not exist, true otherwise
375 public function loadFromId( $flags = self
::READ_LATEST
) {
376 if ( $this->mId
== 0 ) {
377 $this->loadDefaults();
382 $cache = $this->loadFromCache();
384 wfDebug( "User: cache miss for user {$this->mId}\n" );
386 if ( !$this->loadFromDatabase( $flags ) ) {
387 // Can't load from ID, user is anonymous
390 if ( $flags & self
::READ_LATEST
) {
391 // Only save master data back to the cache to keep it consistent.
392 // @TODO: save it anyway and have callers specifiy $flags and have
393 // load() called as needed. That requires updating MANY callers...
394 $this->saveToCache();
398 $this->mLoadedItems
= true;
399 $this->queryFlagsUsed
= $flags;
405 * Load user data from shared cache, given mId has already been set.
407 * @return bool false if the ID does not exist or data is invalid, true otherwise
410 protected function loadFromCache() {
413 if ( $this->mId
== 0 ) {
414 $this->loadDefaults();
418 $key = wfMemcKey( 'user', 'id', $this->mId
);
419 $data = $wgMemc->get( $key );
420 if ( !is_array( $data ) ||
$data['mVersion'] < self
::VERSION
) {
425 wfDebug( "User: got user {$this->mId} from cache\n" );
427 // Restore from cache
428 foreach ( self
::$mCacheVars as $name ) {
429 $this->$name = $data[$name];
436 * Save user data to the shared cache
438 * This method should not be called outside the User class
440 public function saveToCache() {
445 $this->loadOptions();
447 if ( $this->isAnon() ) {
448 // Anonymous users are uncached
452 // The cache needs good consistency due to its high TTL, so the user
453 // should have been loaded from the master to avoid lag amplification.
454 if ( !( $this->queryFlagsUsed
& self
::READ_LATEST
) ) {
455 wfWarn( "Cannot save slave-loaded User object data to cache." );
460 foreach ( self
::$mCacheVars as $name ) {
461 $data[$name] = $this->$name;
463 $data['mVersion'] = self
::VERSION
;
464 $key = wfMemcKey( 'user', 'id', $this->mId
);
466 $wgMemc->set( $key, $data );
469 /** @name newFrom*() static factory methods */
473 * Static factory method for creation from username.
475 * This is slightly less efficient than newFromId(), so use newFromId() if
476 * you have both an ID and a name handy.
478 * @param string $name Username, validated by Title::newFromText()
479 * @param string|bool $validate Validate username. Takes the same parameters as
480 * User::getCanonicalName(), except that true is accepted as an alias
481 * for 'valid', for BC.
483 * @return User|bool User object, or false if the username is invalid
484 * (e.g. if it contains illegal characters or is an IP address). If the
485 * username is not present in the database, the result will be a user object
486 * with a name, zero user ID and default settings.
488 public static function newFromName( $name, $validate = 'valid' ) {
489 if ( $validate === true ) {
492 $name = self
::getCanonicalName( $name, $validate );
493 if ( $name === false ) {
496 // Create unloaded user object
500 $u->setItemLoaded( 'name' );
506 * Static factory method for creation from a given user ID.
508 * @param int $id Valid user ID
509 * @return User The corresponding User object
511 public static function newFromId( $id ) {
515 $u->setItemLoaded( 'id' );
520 * Factory method to fetch whichever user has a given email confirmation code.
521 * This code is generated when an account is created or its e-mail address
524 * If the code is invalid or has expired, returns NULL.
526 * @param string $code Confirmation code
529 public static function newFromConfirmationCode( $code ) {
530 $dbr = wfGetDB( DB_SLAVE
);
531 $id = $dbr->selectField( 'user', 'user_id', array(
532 'user_email_token' => md5( $code ),
533 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
535 if ( $id !== false ) {
536 return User
::newFromId( $id );
543 * Create a new user object using data from session or cookies. If the
544 * login credentials are invalid, the result is an anonymous user.
546 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
549 public static function newFromSession( WebRequest
$request = null ) {
551 $user->mFrom
= 'session';
552 $user->mRequest
= $request;
557 * Create a new user object from a user row.
558 * The row should have the following fields from the user table in it:
559 * - either user_name or user_id to load further data if needed (or both)
561 * - all other fields (email, password, etc.)
562 * It is useless to provide the remaining fields if either user_id,
563 * user_name and user_real_name are not provided because the whole row
564 * will be loaded once more from the database when accessing them.
566 * @param stdClass $row A row from the user table
567 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
570 public static function newFromRow( $row, $data = null ) {
572 $user->loadFromRow( $row, $data );
579 * Get the username corresponding to a given user ID
580 * @param int $id User ID
581 * @return string|bool The corresponding username
583 public static function whoIs( $id ) {
584 return UserCache
::singleton()->getProp( $id, 'name' );
588 * Get the real name of a user given their user ID
590 * @param int $id User ID
591 * @return string|bool The corresponding user's real name
593 public static function whoIsReal( $id ) {
594 return UserCache
::singleton()->getProp( $id, 'real_name' );
598 * Get database id given a user name
599 * @param string $name Username
600 * @return int|null The corresponding user's ID, or null if user is nonexistent
602 public static function idFromName( $name ) {
603 $nt = Title
::makeTitleSafe( NS_USER
, $name );
604 if ( is_null( $nt ) ) {
609 if ( isset( self
::$idCacheByName[$name] ) ) {
610 return self
::$idCacheByName[$name];
613 $dbr = wfGetDB( DB_SLAVE
);
614 $s = $dbr->selectRow(
617 array( 'user_name' => $nt->getText() ),
621 if ( $s === false ) {
624 $result = $s->user_id
;
627 self
::$idCacheByName[$name] = $result;
629 if ( count( self
::$idCacheByName ) > 1000 ) {
630 self
::$idCacheByName = array();
637 * Reset the cache used in idFromName(). For use in tests.
639 public static function resetIdByNameCache() {
640 self
::$idCacheByName = array();
644 * Does the string match an anonymous IPv4 address?
646 * This function exists for username validation, in order to reject
647 * usernames which are similar in form to IP addresses. Strings such
648 * as 300.300.300.300 will return true because it looks like an IP
649 * address, despite not being strictly valid.
651 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
652 * address because the usemod software would "cloak" anonymous IP
653 * addresses like this, if we allowed accounts like this to be created
654 * new users could get the old edits of these anonymous users.
656 * @param string $name Name to match
659 public static function isIP( $name ) {
660 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
661 || IP
::isIPv6( $name );
665 * Is the input a valid username?
667 * Checks if the input is a valid username, we don't want an empty string,
668 * an IP address, anything that contains slashes (would mess up subpages),
669 * is longer than the maximum allowed username size or doesn't begin with
672 * @param string $name Name to match
675 public static function isValidUserName( $name ) {
676 global $wgContLang, $wgMaxNameChars;
679 || User
::isIP( $name )
680 ||
strpos( $name, '/' ) !== false
681 ||
strlen( $name ) > $wgMaxNameChars
682 ||
$name != $wgContLang->ucfirst( $name )
684 wfDebugLog( 'username', __METHOD__
.
685 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
689 // Ensure that the name can't be misresolved as a different title,
690 // such as with extra namespace keys at the start.
691 $parsed = Title
::newFromText( $name );
692 if ( is_null( $parsed )
693 ||
$parsed->getNamespace()
694 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
695 wfDebugLog( 'username', __METHOD__
.
696 ": '$name' invalid due to ambiguous prefixes" );
700 // Check an additional blacklist of troublemaker characters.
701 // Should these be merged into the title char list?
702 $unicodeBlacklist = '/[' .
703 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
704 '\x{00a0}' . # non-breaking space
705 '\x{2000}-\x{200f}' . # various whitespace
706 '\x{2028}-\x{202f}' . # breaks and control chars
707 '\x{3000}' . # ideographic space
708 '\x{e000}-\x{f8ff}' . # private use
710 if ( preg_match( $unicodeBlacklist, $name ) ) {
711 wfDebugLog( 'username', __METHOD__
.
712 ": '$name' invalid due to blacklisted characters" );
720 * Usernames which fail to pass this function will be blocked
721 * from user login and new account registrations, but may be used
722 * internally by batch processes.
724 * If an account already exists in this form, login will be blocked
725 * by a failure to pass this function.
727 * @param string $name Name to match
730 public static function isUsableName( $name ) {
731 global $wgReservedUsernames;
732 // Must be a valid username, obviously ;)
733 if ( !self
::isValidUserName( $name ) ) {
737 static $reservedUsernames = false;
738 if ( !$reservedUsernames ) {
739 $reservedUsernames = $wgReservedUsernames;
740 Hooks
::run( 'UserGetReservedNames', array( &$reservedUsernames ) );
743 // Certain names may be reserved for batch processes.
744 foreach ( $reservedUsernames as $reserved ) {
745 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
746 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
748 if ( $reserved == $name ) {
756 * Usernames which fail to pass this function will be blocked
757 * from new account registrations, but may be used internally
758 * either by batch processes or by user accounts which have
759 * already been created.
761 * Additional blacklisting may be added here rather than in
762 * isValidUserName() to avoid disrupting existing accounts.
764 * @param string $name String to match
767 public static function isCreatableName( $name ) {
768 global $wgInvalidUsernameCharacters;
770 // Ensure that the username isn't longer than 235 bytes, so that
771 // (at least for the builtin skins) user javascript and css files
772 // will work. (bug 23080)
773 if ( strlen( $name ) > 235 ) {
774 wfDebugLog( 'username', __METHOD__
.
775 ": '$name' invalid due to length" );
779 // Preg yells if you try to give it an empty string
780 if ( $wgInvalidUsernameCharacters !== '' ) {
781 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
782 wfDebugLog( 'username', __METHOD__
.
783 ": '$name' invalid due to wgInvalidUsernameCharacters" );
788 return self
::isUsableName( $name );
792 * Is the input a valid password for this user?
794 * @param string $password Desired password
797 public function isValidPassword( $password ) {
798 //simple boolean wrapper for getPasswordValidity
799 return $this->getPasswordValidity( $password ) === true;
804 * Given unvalidated password input, return error message on failure.
806 * @param string $password Desired password
807 * @return bool|string|array True on success, string or array of error message on failure
809 public function getPasswordValidity( $password ) {
810 $result = $this->checkPasswordValidity( $password );
811 if ( $result->isGood() ) {
815 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
816 $messages[] = $error['message'];
818 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
819 $messages[] = $warning['message'];
821 if ( count( $messages ) === 1 ) {
829 * Check if this is a valid password for this user. Status will be good if
830 * the password is valid, or have an array of error messages if not.
832 * @param string $password Desired password
836 public function checkPasswordValidity( $password ) {
837 global $wgMinimalPasswordLength, $wgContLang;
839 static $blockedLogins = array(
840 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
841 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
844 $status = Status
::newGood();
846 $result = false; //init $result to false for the internal checks
848 if ( !Hooks
::run( 'isValidPassword', array( $password, &$result, $this ) ) ) {
849 $status->error( $result );
853 if ( $result === false ) {
854 if ( strlen( $password ) < $wgMinimalPasswordLength ) {
855 $status->error( 'passwordtooshort', $wgMinimalPasswordLength );
857 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
858 $status->error( 'password-name-match' );
860 } elseif ( isset( $blockedLogins[$this->getName()] )
861 && $password == $blockedLogins[$this->getName()]
863 $status->error( 'password-login-forbidden' );
866 //it seems weird returning a Good status here, but this is because of the
867 //initialization of $result to false above. If the hook is never run or it
868 //doesn't modify $result, then we will likely get down into this if with
872 } elseif ( $result === true ) {
875 $status->error( $result );
876 return $status; //the isValidPassword hook set a string $result and returned true
881 * Expire a user's password
883 * @param int $ts Optional timestamp to convert, default 0 for the current time
885 public function expirePassword( $ts = 0 ) {
886 $this->loadPasswords();
887 $timestamp = wfTimestamp( TS_MW
, $ts );
888 $this->mPasswordExpires
= $timestamp;
889 $this->saveSettings();
893 * Clear the password expiration for a user
895 * @param bool $load Ensure user object is loaded first
897 public function resetPasswordExpiration( $load = true ) {
898 global $wgPasswordExpirationDays;
903 if ( $wgPasswordExpirationDays ) {
904 $newExpire = wfTimestamp(
906 time() +
( $wgPasswordExpirationDays * 24 * 3600 )
909 // Give extensions a chance to force an expiration
910 Hooks
::run( 'ResetPasswordExpiration', array( $this, &$newExpire ) );
911 $this->mPasswordExpires
= $newExpire;
915 * Check if the user's password is expired.
916 * TODO: Put this and password length into a PasswordPolicy object
918 * @return string|bool The expiration type, or false if not expired
919 * hard: A password change is required to login
920 * soft: Allow login, but encourage password change
921 * false: Password is not expired
923 public function getPasswordExpired() {
924 global $wgPasswordExpireGrace;
926 $now = wfTimestamp();
927 $expiration = $this->getPasswordExpireDate();
928 $expUnix = wfTimestamp( TS_UNIX
, $expiration );
929 if ( $expiration !== null && $expUnix < $now ) {
930 $expired = ( $expUnix +
$wgPasswordExpireGrace < $now ) ?
'hard' : 'soft';
936 * Get this user's password expiration date. Since this may be using
937 * the cached User object, we assume that whatever mechanism is setting
938 * the expiration date is also expiring the User cache.
940 * @return string|bool The datestamp of the expiration, or null if not set
942 public function getPasswordExpireDate() {
944 return $this->mPasswordExpires
;
948 * Given unvalidated user input, return a canonical username, or false if
949 * the username is invalid.
950 * @param string $name User input
951 * @param string|bool $validate Type of validation to use:
952 * - false No validation
953 * - 'valid' Valid for batch processes
954 * - 'usable' Valid for batch processes and login
955 * - 'creatable' Valid for batch processes, login and account creation
957 * @throws MWException
958 * @return bool|string
960 public static function getCanonicalName( $name, $validate = 'valid' ) {
961 // Force usernames to capital
963 $name = $wgContLang->ucfirst( $name );
965 # Reject names containing '#'; these will be cleaned up
966 # with title normalisation, but then it's too late to
968 if ( strpos( $name, '#' ) !== false ) {
972 // Clean up name according to title rules,
973 // but only when validation is requested (bug 12654)
974 $t = ( $validate !== false ) ?
975 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
976 // Check for invalid titles
977 if ( is_null( $t ) ) {
981 // Reject various classes of invalid names
983 $name = $wgAuth->getCanonicalName( $t->getText() );
985 switch ( $validate ) {
989 if ( !User
::isValidUserName( $name ) ) {
994 if ( !User
::isUsableName( $name ) ) {
999 if ( !User
::isCreatableName( $name ) ) {
1004 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
1010 * Count the number of edits of a user
1012 * @param int $uid User ID to check
1013 * @return int The user's edit count
1015 * @deprecated since 1.21 in favour of User::getEditCount
1017 public static function edits( $uid ) {
1018 wfDeprecated( __METHOD__
, '1.21' );
1019 $user = self
::newFromId( $uid );
1020 return $user->getEditCount();
1024 * Return a random password.
1026 * @return string New random password
1028 public static function randomPassword() {
1029 global $wgMinimalPasswordLength;
1030 // Decide the final password length based on our min password length,
1031 // stopping at a minimum of 10 chars.
1032 $length = max( 10, $wgMinimalPasswordLength );
1033 // Multiply by 1.25 to get the number of hex characters we need
1034 $length = $length * 1.25;
1035 // Generate random hex chars
1036 $hex = MWCryptRand
::generateHex( $length );
1037 // Convert from base 16 to base 32 to get a proper password like string
1038 return wfBaseConvert( $hex, 16, 32 );
1042 * Set cached properties to default.
1044 * @note This no longer clears uncached lazy-initialised properties;
1045 * the constructor does that instead.
1047 * @param string|bool $name
1049 public function loadDefaults( $name = false ) {
1051 $passwordFactory = self
::getPasswordFactory();
1054 $this->mName
= $name;
1055 $this->mRealName
= '';
1056 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1057 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1058 $this->mNewpassTime
= null;
1060 $this->mOptionOverrides
= null;
1061 $this->mOptionsLoaded
= false;
1063 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
1064 if ( $loggedOut !== null ) {
1065 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
1067 $this->mTouched
= '1'; # Allow any pages to be cached
1070 $this->mToken
= null; // Don't run cryptographic functions till we need a token
1071 $this->mEmailAuthenticated
= null;
1072 $this->mEmailToken
= '';
1073 $this->mEmailTokenExpires
= null;
1074 $this->mPasswordExpires
= null;
1075 $this->resetPasswordExpiration( false );
1076 $this->mRegistration
= wfTimestamp( TS_MW
);
1077 $this->mGroups
= array();
1079 Hooks
::run( 'UserLoadDefaults', array( $this, $name ) );
1083 * Return whether an item has been loaded.
1085 * @param string $item Item to check. Current possibilities:
1089 * @param string $all 'all' to check if the whole object has been loaded
1090 * or any other string to check if only the item is available (e.g.
1094 public function isItemLoaded( $item, $all = 'all' ) {
1095 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
1096 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
1100 * Set that an item has been loaded
1102 * @param string $item
1104 protected function setItemLoaded( $item ) {
1105 if ( is_array( $this->mLoadedItems
) ) {
1106 $this->mLoadedItems
[$item] = true;
1111 * Load user data from the session or login cookie.
1113 * @return bool True if the user is logged in, false otherwise.
1115 private function loadFromSession() {
1117 Hooks
::run( 'UserLoadFromSession', array( $this, &$result ) );
1118 if ( $result !== null ) {
1122 $request = $this->getRequest();
1124 $cookieId = $request->getCookie( 'UserID' );
1125 $sessId = $request->getSessionData( 'wsUserID' );
1127 if ( $cookieId !== null ) {
1128 $sId = intval( $cookieId );
1129 if ( $sessId !== null && $cookieId != $sessId ) {
1130 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
1131 cookie user ID ($sId) don't match!" );
1134 $request->setSessionData( 'wsUserID', $sId );
1135 } elseif ( $sessId !== null && $sessId != 0 ) {
1141 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
1142 $sName = $request->getSessionData( 'wsUserName' );
1143 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
1144 $sName = $request->getCookie( 'UserName' );
1145 $request->setSessionData( 'wsUserName', $sName );
1150 $proposedUser = User
::newFromId( $sId );
1151 $proposedUser->load( self
::READ_LATEST
);
1152 if ( !$proposedUser->isLoggedIn() ) {
1157 global $wgBlockDisablesLogin;
1158 if ( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
1159 // User blocked and we've disabled blocked user logins
1163 if ( $request->getSessionData( 'wsToken' ) ) {
1165 ( $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ) );
1167 } elseif ( $request->getCookie( 'Token' ) ) {
1168 # Get the token from DB/cache and clean it up to remove garbage padding.
1169 # This deals with historical problems with bugs and the default column value.
1170 $token = rtrim( $proposedUser->getToken( false ) ); // correct token
1171 // Make comparison in constant time (bug 61346)
1172 $passwordCorrect = strlen( $token )
1173 && hash_equals( $token, $request->getCookie( 'Token' ) );
1176 // No session or persistent login cookie
1180 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1181 $this->loadFromUserObject( $proposedUser );
1182 $request->setSessionData( 'wsToken', $this->mToken
);
1183 wfDebug( "User: logged in from $from\n" );
1186 // Invalid credentials
1187 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1193 * Load user and user_group data from the database.
1194 * $this->mId must be set, this is how the user is identified.
1196 * @param integer $flags User::READ_* constant bitfield
1197 * @return bool True if the user exists, false if the user is anonymous
1199 public function loadFromDatabase( $flags = self
::READ_LATEST
) {
1201 $this->mId
= intval( $this->mId
);
1204 if ( !$this->mId
) {
1205 $this->loadDefaults();
1209 $db = ( $flags & self
::READ_LATEST
)
1210 ?
wfGetDB( DB_MASTER
)
1211 : wfGetDB( DB_SLAVE
);
1213 $s = $db->selectRow(
1215 self
::selectFields(),
1216 array( 'user_id' => $this->mId
),
1218 ( $flags & self
::READ_LOCKING
== self
::READ_LOCKING
)
1219 ?
array( 'LOCK IN SHARE MODE' )
1223 $this->queryFlagsUsed
= $flags;
1224 Hooks
::run( 'UserLoadFromDatabase', array( $this, &$s ) );
1226 if ( $s !== false ) {
1227 // Initialise user table data
1228 $this->loadFromRow( $s );
1229 $this->mGroups
= null; // deferred
1230 $this->getEditCount(); // revalidation for nulls
1235 $this->loadDefaults();
1241 * Initialize this object from a row from the user table.
1243 * @param stdClass $row Row from the user table to load.
1244 * @param array $data Further user data to load into the object
1246 * user_groups Array with groups out of the user_groups table
1247 * user_properties Array with properties out of the user_properties table
1249 protected function loadFromRow( $row, $data = null ) {
1251 $passwordFactory = self
::getPasswordFactory();
1253 $this->mGroups
= null; // deferred
1255 if ( isset( $row->user_name
) ) {
1256 $this->mName
= $row->user_name
;
1257 $this->mFrom
= 'name';
1258 $this->setItemLoaded( 'name' );
1263 if ( isset( $row->user_real_name
) ) {
1264 $this->mRealName
= $row->user_real_name
;
1265 $this->setItemLoaded( 'realname' );
1270 if ( isset( $row->user_id
) ) {
1271 $this->mId
= intval( $row->user_id
);
1272 $this->mFrom
= 'id';
1273 $this->setItemLoaded( 'id' );
1278 if ( isset( $row->user_id
) && isset( $row->user_name
) ) {
1279 self
::$idCacheByName[$row->user_name
] = $row->user_id
;
1282 if ( isset( $row->user_editcount
) ) {
1283 $this->mEditCount
= $row->user_editcount
;
1288 if ( isset( $row->user_password
) ) {
1289 // Check for *really* old password hashes that don't even have a type
1290 // The old hash format was just an md5 hex hash, with no type information
1291 if ( preg_match( '/^[0-9a-f]{32}$/', $row->user_password
) ) {
1292 $row->user_password
= ":A:{$this->mId}:{$row->user_password}";
1296 $this->mPassword
= $passwordFactory->newFromCiphertext( $row->user_password
);
1297 } catch ( PasswordError
$e ) {
1298 wfDebug( 'Invalid password hash found in database.' );
1299 $this->mPassword
= $passwordFactory->newFromCiphertext( null );
1303 $this->mNewpassword
= $passwordFactory->newFromCiphertext( $row->user_newpassword
);
1304 } catch ( PasswordError
$e ) {
1305 wfDebug( 'Invalid password hash found in database.' );
1306 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
1309 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1310 $this->mPasswordExpires
= wfTimestampOrNull( TS_MW
, $row->user_password_expires
);
1313 if ( isset( $row->user_email
) ) {
1314 $this->mEmail
= $row->user_email
;
1315 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1316 $this->mToken
= $row->user_token
;
1317 if ( $this->mToken
== '' ) {
1318 $this->mToken
= null;
1320 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1321 $this->mEmailToken
= $row->user_email_token
;
1322 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1323 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1329 $this->mLoadedItems
= true;
1332 if ( is_array( $data ) ) {
1333 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1334 $this->mGroups
= $data['user_groups'];
1336 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1337 $this->loadOptions( $data['user_properties'] );
1343 * Load the data for this user object from another user object.
1347 protected function loadFromUserObject( $user ) {
1349 $user->loadGroups();
1350 $user->loadOptions();
1351 foreach ( self
::$mCacheVars as $var ) {
1352 $this->$var = $user->$var;
1357 * Load the groups from the database if they aren't already loaded.
1359 private function loadGroups() {
1360 if ( is_null( $this->mGroups
) ) {
1361 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
1362 ?
wfGetDB( DB_MASTER
)
1363 : wfGetDB( DB_SLAVE
);
1364 $res = $dbr->select( 'user_groups',
1365 array( 'ug_group' ),
1366 array( 'ug_user' => $this->mId
),
1368 $this->mGroups
= array();
1369 foreach ( $res as $row ) {
1370 $this->mGroups
[] = $row->ug_group
;
1376 * Load the user's password hashes from the database
1378 * This is usually called in a scenario where the actual User object was
1379 * loaded from the cache, and then password comparison needs to be performed.
1380 * Password hashes are not stored in memcached.
1384 private function loadPasswords() {
1385 if ( $this->getId() !== 0 && ( $this->mPassword
=== null ||
$this->mNewpassword
=== null ) ) {
1386 $this->loadFromRow( wfGetDB( DB_MASTER
)->selectRow(
1388 array( 'user_password', 'user_newpassword', 'user_newpass_time', 'user_password_expires' ),
1389 array( 'user_id' => $this->getId() ),
1396 * Add the user to the group if he/she meets given criteria.
1398 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1399 * possible to remove manually via Special:UserRights. In such case it
1400 * will not be re-added automatically. The user will also not lose the
1401 * group if they no longer meet the criteria.
1403 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1405 * @return array Array of groups the user has been promoted to.
1407 * @see $wgAutopromoteOnce
1409 public function addAutopromoteOnceGroups( $event ) {
1410 global $wgAutopromoteOnceLogInRC, $wgAuth;
1412 $toPromote = array();
1413 if ( !wfReadOnly() && $this->getId() ) {
1414 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1415 if ( count( $toPromote ) ) {
1416 $oldGroups = $this->getGroups(); // previous groups
1418 foreach ( $toPromote as $group ) {
1419 $this->addGroup( $group );
1421 // update groups in external authentication database
1422 $wgAuth->updateExternalDBGroups( $this, $toPromote );
1424 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1426 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1427 $logEntry->setPerformer( $this );
1428 $logEntry->setTarget( $this->getUserPage() );
1429 $logEntry->setParameters( array(
1430 '4::oldgroups' => $oldGroups,
1431 '5::newgroups' => $newGroups,
1433 $logid = $logEntry->insert();
1434 if ( $wgAutopromoteOnceLogInRC ) {
1435 $logEntry->publish( $logid );
1444 * Clear various cached data stored in this object. The cache of the user table
1445 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1447 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1448 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1450 public function clearInstanceCache( $reloadFrom = false ) {
1451 $this->mNewtalk
= -1;
1452 $this->mDatePreference
= null;
1453 $this->mBlockedby
= -1; # Unset
1454 $this->mHash
= false;
1455 $this->mRights
= null;
1456 $this->mEffectiveGroups
= null;
1457 $this->mImplicitGroups
= null;
1458 $this->mGroups
= null;
1459 $this->mOptions
= null;
1460 $this->mOptionsLoaded
= false;
1461 $this->mEditCount
= null;
1463 if ( $reloadFrom ) {
1464 $this->mLoadedItems
= array();
1465 $this->mFrom
= $reloadFrom;
1470 * Combine the language default options with any site-specific options
1471 * and add the default language variants.
1473 * @return array Array of String options
1475 public static function getDefaultOptions() {
1476 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1478 static $defOpt = null;
1479 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1480 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1481 // mid-request and see that change reflected in the return value of this function.
1482 // Which is insane and would never happen during normal MW operation
1486 $defOpt = $wgDefaultUserOptions;
1487 // Default language setting
1488 $defOpt['language'] = $wgContLang->getCode();
1489 foreach ( LanguageConverter
::$languagesWithVariants as $langCode ) {
1490 $defOpt[$langCode == $wgContLang->getCode() ?
'variant' : "variant-$langCode"] = $langCode;
1492 foreach ( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1493 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1495 $defOpt['skin'] = Skin
::normalizeKey( $wgDefaultSkin );
1497 Hooks
::run( 'UserGetDefaultOptions', array( &$defOpt ) );
1503 * Get a given default option value.
1505 * @param string $opt Name of option to retrieve
1506 * @return string Default option value
1508 public static function getDefaultOption( $opt ) {
1509 $defOpts = self
::getDefaultOptions();
1510 if ( isset( $defOpts[$opt] ) ) {
1511 return $defOpts[$opt];
1518 * Get blocking information
1519 * @param bool $bFromSlave Whether to check the slave database first.
1520 * To improve performance, non-critical checks are done against slaves.
1521 * Check when actually saving should be done against master.
1523 private function getBlockedStatus( $bFromSlave = true ) {
1524 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1526 if ( -1 != $this->mBlockedby
) {
1530 wfDebug( __METHOD__
. ": checking...\n" );
1532 // Initialize data...
1533 // Otherwise something ends up stomping on $this->mBlockedby when
1534 // things get lazy-loaded later, causing false positive block hits
1535 // due to -1 !== 0. Probably session-related... Nothing should be
1536 // overwriting mBlockedby, surely?
1539 # We only need to worry about passing the IP address to the Block generator if the
1540 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1541 # know which IP address they're actually coming from
1542 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1543 $ip = $this->getRequest()->getIP();
1549 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1552 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1553 && !in_array( $ip, $wgProxyWhitelist )
1556 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1558 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1559 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1560 $block->setTarget( $ip );
1561 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1563 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1564 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1565 $block->setTarget( $ip );
1569 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1570 if ( !$block instanceof Block
1571 && $wgApplyIpBlocksToXff
1573 && !$this->isAllowed( 'proxyunbannable' )
1574 && !in_array( $ip, $wgProxyWhitelist )
1576 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1577 $xff = array_map( 'trim', explode( ',', $xff ) );
1578 $xff = array_diff( $xff, array( $ip ) );
1579 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1580 $block = Block
::chooseBlock( $xffblocks, $xff );
1581 if ( $block instanceof Block
) {
1582 # Mangle the reason to alert the user that the block
1583 # originated from matching the X-Forwarded-For header.
1584 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1588 if ( $block instanceof Block
) {
1589 wfDebug( __METHOD__
. ": Found block.\n" );
1590 $this->mBlock
= $block;
1591 $this->mBlockedby
= $block->getByName();
1592 $this->mBlockreason
= $block->mReason
;
1593 $this->mHideName
= $block->mHideName
;
1594 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1596 $this->mBlockedby
= '';
1597 $this->mHideName
= 0;
1598 $this->mAllowUsertalk
= false;
1602 Hooks
::run( 'GetBlockedStatus', array( &$this ) );
1607 * Whether the given IP is in a DNS blacklist.
1609 * @param string $ip IP to check
1610 * @param bool $checkWhitelist Whether to check the whitelist first
1611 * @return bool True if blacklisted.
1613 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1614 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1616 if ( !$wgEnableDnsBlacklist ) {
1620 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1624 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1628 * Whether the given IP is in a given DNS blacklist.
1630 * @param string $ip IP to check
1631 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1632 * @return bool True if blacklisted.
1634 public function inDnsBlacklist( $ip, $bases ) {
1637 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1638 if ( IP
::isIPv4( $ip ) ) {
1639 // Reverse IP, bug 21255
1640 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1642 foreach ( (array)$bases as $base ) {
1644 // If we have an access key, use that too (ProjectHoneypot, etc.)
1645 if ( is_array( $base ) ) {
1646 if ( count( $base ) >= 2 ) {
1647 // Access key is 1, base URL is 0
1648 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1650 $host = "$ipReversed.{$base[0]}";
1653 $host = "$ipReversed.$base";
1657 $ipList = gethostbynamel( $host );
1660 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!" );
1664 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base." );
1673 * Check if an IP address is in the local proxy list
1679 public static function isLocallyBlockedProxy( $ip ) {
1680 global $wgProxyList;
1682 if ( !$wgProxyList ) {
1686 if ( !is_array( $wgProxyList ) ) {
1687 // Load from the specified file
1688 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1691 if ( !is_array( $wgProxyList ) ) {
1693 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1695 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1696 // Old-style flipped proxy list
1705 * Is this user subject to rate limiting?
1707 * @return bool True if rate limited
1709 public function isPingLimitable() {
1710 global $wgRateLimitsExcludedIPs;
1711 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1712 // No other good way currently to disable rate limits
1713 // for specific IPs. :P
1714 // But this is a crappy hack and should die.
1717 return !$this->isAllowed( 'noratelimit' );
1721 * Primitive rate limits: enforce maximum actions per time period
1722 * to put a brake on flooding.
1724 * The method generates both a generic profiling point and a per action one
1725 * (suffix being "-$action".
1727 * @note When using a shared cache like memcached, IP-address
1728 * last-hit counters will be shared across wikis.
1730 * @param string $action Action to enforce; 'edit' if unspecified
1731 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1732 * @return bool True if a rate limiter was tripped
1734 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1735 // Call the 'PingLimiter' hook
1737 if ( !Hooks
::run( 'PingLimiter', array( &$this, $action, &$result, $incrBy ) ) ) {
1741 global $wgRateLimits;
1742 if ( !isset( $wgRateLimits[$action] ) ) {
1746 // Some groups shouldn't trigger the ping limiter, ever
1747 if ( !$this->isPingLimitable() ) {
1753 $limits = $wgRateLimits[$action];
1755 $id = $this->getId();
1758 if ( isset( $limits['anon'] ) && $id == 0 ) {
1759 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1762 if ( isset( $limits['user'] ) && $id != 0 ) {
1763 $userLimit = $limits['user'];
1765 if ( $this->isNewbie() ) {
1766 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1767 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1769 if ( isset( $limits['ip'] ) ) {
1770 $ip = $this->getRequest()->getIP();
1771 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1773 if ( isset( $limits['subnet'] ) ) {
1774 $ip = $this->getRequest()->getIP();
1777 if ( IP
::isIPv6( $ip ) ) {
1778 $parts = IP
::parseRange( "$ip/64" );
1779 $subnet = $parts[0];
1780 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1782 $subnet = $matches[1];
1784 if ( $subnet !== false ) {
1785 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1789 // Check for group-specific permissions
1790 // If more than one group applies, use the group with the highest limit
1791 foreach ( $this->getGroups() as $group ) {
1792 if ( isset( $limits[$group] ) ) {
1793 if ( $userLimit === false
1794 ||
$limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1796 $userLimit = $limits[$group];
1800 // Set the user limit key
1801 if ( $userLimit !== false ) {
1802 list( $max, $period ) = $userLimit;
1803 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1804 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1808 foreach ( $keys as $key => $limit ) {
1809 list( $max, $period ) = $limit;
1810 $summary = "(limit $max in {$period}s)";
1811 $count = $wgMemc->get( $key );
1814 if ( $count >= $max ) {
1815 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1816 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1819 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1822 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1823 if ( $incrBy > 0 ) {
1824 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1827 if ( $incrBy > 0 ) {
1828 $wgMemc->incr( $key, $incrBy );
1836 * Check if user is blocked
1838 * @param bool $bFromSlave Whether to check the slave database instead of
1839 * the master. Hacked from false due to horrible probs on site.
1840 * @return bool True if blocked, false otherwise
1842 public function isBlocked( $bFromSlave = true ) {
1843 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1847 * Get the block affecting the user, or null if the user is not blocked
1849 * @param bool $bFromSlave Whether to check the slave database instead of the master
1850 * @return Block|null
1852 public function getBlock( $bFromSlave = true ) {
1853 $this->getBlockedStatus( $bFromSlave );
1854 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1858 * Check if user is blocked from editing a particular article
1860 * @param Title $title Title to check
1861 * @param bool $bFromSlave Whether to check the slave database instead of the master
1864 public function isBlockedFrom( $title, $bFromSlave = false ) {
1865 global $wgBlockAllowsUTEdit;
1867 $blocked = $this->isBlocked( $bFromSlave );
1868 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1869 // If a user's name is suppressed, they cannot make edits anywhere
1870 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName()
1871 && $title->getNamespace() == NS_USER_TALK
) {
1873 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1876 Hooks
::run( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1882 * If user is blocked, return the name of the user who placed the block
1883 * @return string Name of blocker
1885 public function blockedBy() {
1886 $this->getBlockedStatus();
1887 return $this->mBlockedby
;
1891 * If user is blocked, return the specified reason for the block
1892 * @return string Blocking reason
1894 public function blockedFor() {
1895 $this->getBlockedStatus();
1896 return $this->mBlockreason
;
1900 * If user is blocked, return the ID for the block
1901 * @return int Block ID
1903 public function getBlockId() {
1904 $this->getBlockedStatus();
1905 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1909 * Check if user is blocked on all wikis.
1910 * Do not use for actual edit permission checks!
1911 * This is intended for quick UI checks.
1913 * @param string $ip IP address, uses current client if none given
1914 * @return bool True if blocked, false otherwise
1916 public function isBlockedGlobally( $ip = '' ) {
1917 if ( $this->mBlockedGlobally
!== null ) {
1918 return $this->mBlockedGlobally
;
1920 // User is already an IP?
1921 if ( IP
::isIPAddress( $this->getName() ) ) {
1922 $ip = $this->getName();
1924 $ip = $this->getRequest()->getIP();
1927 Hooks
::run( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1928 $this->mBlockedGlobally
= (bool)$blocked;
1929 return $this->mBlockedGlobally
;
1933 * Check if user account is locked
1935 * @return bool True if locked, false otherwise
1937 public function isLocked() {
1938 if ( $this->mLocked
!== null ) {
1939 return $this->mLocked
;
1942 $authUser = $wgAuth->getUserInstance( $this );
1943 $this->mLocked
= (bool)$authUser->isLocked();
1944 return $this->mLocked
;
1948 * Check if user account is hidden
1950 * @return bool True if hidden, false otherwise
1952 public function isHidden() {
1953 if ( $this->mHideName
!== null ) {
1954 return $this->mHideName
;
1956 $this->getBlockedStatus();
1957 if ( !$this->mHideName
) {
1959 $authUser = $wgAuth->getUserInstance( $this );
1960 $this->mHideName
= (bool)$authUser->isHidden();
1962 return $this->mHideName
;
1966 * Get the user's ID.
1967 * @return int The user's ID; 0 if the user is anonymous or nonexistent
1969 public function getId() {
1970 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
1971 // Special case, we know the user is anonymous
1973 } elseif ( !$this->isItemLoaded( 'id' ) ) {
1974 // Don't load if this was initialized from an ID
1981 * Set the user and reload all fields according to a given ID
1982 * @param int $v User ID to reload
1984 public function setId( $v ) {
1986 $this->clearInstanceCache( 'id' );
1990 * Get the user name, or the IP of an anonymous user
1991 * @return string User's name or IP address
1993 public function getName() {
1994 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1995 // Special case optimisation
1996 return $this->mName
;
1999 if ( $this->mName
=== false ) {
2001 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
2003 return $this->mName
;
2008 * Set the user name.
2010 * This does not reload fields from the database according to the given
2011 * name. Rather, it is used to create a temporary "nonexistent user" for
2012 * later addition to the database. It can also be used to set the IP
2013 * address for an anonymous user to something other than the current
2016 * @note User::newFromName() has roughly the same function, when the named user
2018 * @param string $str New user name to set
2020 public function setName( $str ) {
2022 $this->mName
= $str;
2026 * Get the user's name escaped by underscores.
2027 * @return string Username escaped by underscores.
2029 public function getTitleKey() {
2030 return str_replace( ' ', '_', $this->getName() );
2034 * Check if the user has new messages.
2035 * @return bool True if the user has new messages
2037 public function getNewtalk() {
2040 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2041 if ( $this->mNewtalk
=== -1 ) {
2042 $this->mNewtalk
= false; # reset talk page status
2044 // Check memcached separately for anons, who have no
2045 // entire User object stored in there.
2046 if ( !$this->mId
) {
2047 global $wgDisableAnonTalk;
2048 if ( $wgDisableAnonTalk ) {
2049 // Anon newtalk disabled by configuration.
2050 $this->mNewtalk
= false;
2052 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
2055 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
2059 return (bool)$this->mNewtalk
;
2063 * Return the data needed to construct links for new talk page message
2064 * alerts. If there are new messages, this will return an associative array
2065 * with the following data:
2066 * wiki: The database name of the wiki
2067 * link: Root-relative link to the user's talk page
2068 * rev: The last talk page revision that the user has seen or null. This
2069 * is useful for building diff links.
2070 * If there are no new messages, it returns an empty array.
2071 * @note This function was designed to accomodate multiple talk pages, but
2072 * currently only returns a single link and revision.
2075 public function getNewMessageLinks() {
2077 if ( !Hooks
::run( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
2079 } elseif ( !$this->getNewtalk() ) {
2082 $utp = $this->getTalkPage();
2083 $dbr = wfGetDB( DB_SLAVE
);
2084 // Get the "last viewed rev" timestamp from the oldest message notification
2085 $timestamp = $dbr->selectField( 'user_newtalk',
2086 'MIN(user_last_timestamp)',
2087 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
2089 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2090 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
2094 * Get the revision ID for the last talk page revision viewed by the talk
2096 * @return int|null Revision ID or null
2098 public function getNewMessageRevisionId() {
2099 $newMessageRevisionId = null;
2100 $newMessageLinks = $this->getNewMessageLinks();
2101 if ( $newMessageLinks ) {
2102 // Note: getNewMessageLinks() never returns more than a single link
2103 // and it is always for the same wiki, but we double-check here in
2104 // case that changes some time in the future.
2105 if ( count( $newMessageLinks ) === 1
2106 && $newMessageLinks[0]['wiki'] === wfWikiID()
2107 && $newMessageLinks[0]['rev']
2109 $newMessageRevision = $newMessageLinks[0]['rev'];
2110 $newMessageRevisionId = $newMessageRevision->getId();
2113 return $newMessageRevisionId;
2117 * Internal uncached check for new messages
2120 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2121 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2122 * @param bool $fromMaster True to fetch from the master, false for a slave
2123 * @return bool True if the user has new messages
2125 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
2126 if ( $fromMaster ) {
2127 $db = wfGetDB( DB_MASTER
);
2129 $db = wfGetDB( DB_SLAVE
);
2131 $ok = $db->selectField( 'user_newtalk', $field,
2132 array( $field => $id ), __METHOD__
);
2133 return $ok !== false;
2137 * Add or update the new messages flag
2138 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2139 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2140 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2141 * @return bool True if successful, false otherwise
2143 protected function updateNewtalk( $field, $id, $curRev = null ) {
2144 // Get timestamp of the talk page revision prior to the current one
2145 $prevRev = $curRev ?
$curRev->getPrevious() : false;
2146 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
2147 // Mark the user as having new messages since this revision
2148 $dbw = wfGetDB( DB_MASTER
);
2149 $dbw->insert( 'user_newtalk',
2150 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
2153 if ( $dbw->affectedRows() ) {
2154 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
2157 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
2163 * Clear the new messages flag for the given user
2164 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2165 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2166 * @return bool True if successful, false otherwise
2168 protected function deleteNewtalk( $field, $id ) {
2169 $dbw = wfGetDB( DB_MASTER
);
2170 $dbw->delete( 'user_newtalk',
2171 array( $field => $id ),
2173 if ( $dbw->affectedRows() ) {
2174 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
2177 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
2183 * Update the 'You have new messages!' status.
2184 * @param bool $val Whether the user has new messages
2185 * @param Revision $curRev New, as yet unseen revision of the user talk
2186 * page. Ignored if null or !$val.
2188 public function setNewtalk( $val, $curRev = null ) {
2189 if ( wfReadOnly() ) {
2194 $this->mNewtalk
= $val;
2196 if ( $this->isAnon() ) {
2198 $id = $this->getName();
2201 $id = $this->getId();
2206 $changed = $this->updateNewtalk( $field, $id, $curRev );
2208 $changed = $this->deleteNewtalk( $field, $id );
2211 if ( $this->isAnon() ) {
2212 // Anons have a separate memcached space, since
2213 // user records aren't kept for them.
2214 $key = wfMemcKey( 'newtalk', 'ip', $id );
2215 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
2218 $this->invalidateCache();
2223 * Generate a current or new-future timestamp to be stored in the
2224 * user_touched field when we update things.
2225 * @return string Timestamp in TS_MW format
2227 private static function newTouchedTimestamp() {
2228 global $wgClockSkewFudge;
2229 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
2233 * Clear user data from memcached.
2234 * Use after applying fun updates to the database; caller's
2235 * responsibility to update user_touched if appropriate.
2237 * Called implicitly from invalidateCache() and saveSettings().
2239 public function clearSharedCache() {
2244 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
2249 * Immediately touch the user data cache for this account.
2250 * Updates user_touched field, and removes account data from memcached
2251 * for reload on the next hit.
2253 public function invalidateCache() {
2254 if ( wfReadOnly() ) {
2259 $this->mTouched
= self
::newTouchedTimestamp();
2261 $dbw = wfGetDB( DB_MASTER
);
2262 $userid = $this->mId
;
2263 $touched = $this->mTouched
;
2264 $method = __METHOD__
;
2265 $dbw->onTransactionIdle( function () use ( $dbw, $userid, $touched, $method ) {
2266 // Prevent contention slams by checking user_touched first
2267 $encTouched = $dbw->addQuotes( $dbw->timestamp( $touched ) );
2268 $needsPurge = $dbw->selectField( 'user', '1',
2269 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ) );
2270 if ( $needsPurge ) {
2271 $dbw->update( 'user',
2272 array( 'user_touched' => $dbw->timestamp( $touched ) ),
2273 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ),
2278 $this->clearSharedCache();
2283 * Update the "touched" timestamp for the user
2285 * This is useful on various login/logout events when making sure that
2286 * a browser or proxy that has multiple tenants does not suffer cache
2287 * pollution where the new user sees the old users content. The value
2288 * of getTouched() is checked when determining 304 vs 200 responses.
2289 * Unlike invalidateCache(), this preserves the User object cache and
2290 * avoids database writes.
2294 public function touch() {
2300 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2301 $timestamp = self
::newTouchedTimestamp();
2302 $wgMemc->set( $key, $timestamp );
2303 $this->mQuickTouched
= $timestamp;
2308 * Validate the cache for this account.
2309 * @param string $timestamp A timestamp in TS_MW format
2312 public function validateCache( $timestamp ) {
2313 return ( $timestamp >= $this->getTouched() );
2317 * Get the user touched timestamp
2318 * @return string TS_MW Timestamp
2320 public function getTouched() {
2326 if ( $this->mQuickTouched
=== null ) {
2327 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId
);
2328 $timestamp = $wgMemc->get( $key );
2330 $this->mQuickTouched
= $timestamp;
2332 # Set the timestamp to get HTTP 304 cache hits
2337 return max( $this->mTouched
, $this->mQuickTouched
);
2340 return $this->mTouched
;
2347 public function getPassword() {
2348 $this->loadPasswords();
2350 return $this->mPassword
;
2357 public function getTemporaryPassword() {
2358 $this->loadPasswords();
2360 return $this->mNewpassword
;
2364 * Set the password and reset the random token.
2365 * Calls through to authentication plugin if necessary;
2366 * will have no effect if the auth plugin refuses to
2367 * pass the change through or if the legal password
2370 * As a special case, setting the password to null
2371 * wipes it, so the account cannot be logged in until
2372 * a new password is set, for instance via e-mail.
2374 * @param string $str New password to set
2375 * @throws PasswordError On failure
2379 public function setPassword( $str ) {
2382 $this->loadPasswords();
2384 if ( $str !== null ) {
2385 if ( !$wgAuth->allowPasswordChange() ) {
2386 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2389 if ( !$this->isValidPassword( $str ) ) {
2390 global $wgMinimalPasswordLength;
2391 $valid = $this->getPasswordValidity( $str );
2392 if ( is_array( $valid ) ) {
2393 $message = array_shift( $valid );
2397 $params = array( $wgMinimalPasswordLength );
2399 throw new PasswordError( wfMessage( $message, $params )->text() );
2403 if ( !$wgAuth->setPassword( $this, $str ) ) {
2404 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2407 $this->setInternalPassword( $str );
2413 * Set the password and reset the random token unconditionally.
2415 * @param string|null $str New password to set or null to set an invalid
2416 * password hash meaning that the user will not be able to log in
2417 * through the web interface.
2419 public function setInternalPassword( $str ) {
2422 $passwordFactory = self
::getPasswordFactory();
2423 $this->mPassword
= $passwordFactory->newFromPlaintext( $str );
2425 $this->mNewpassword
= $passwordFactory->newFromCiphertext( null );
2426 $this->mNewpassTime
= null;
2430 * Get the user's current token.
2431 * @param bool $forceCreation Force the generation of a new token if the
2432 * user doesn't have one (default=true for backwards compatibility).
2433 * @return string Token
2435 public function getToken( $forceCreation = true ) {
2437 if ( !$this->mToken
&& $forceCreation ) {
2440 return $this->mToken
;
2444 * Set the random token (used for persistent authentication)
2445 * Called from loadDefaults() among other places.
2447 * @param string|bool $token If specified, set the token to this value
2449 public function setToken( $token = false ) {
2452 $this->mToken
= MWCryptRand
::generateHex( self
::TOKEN_LENGTH
);
2454 $this->mToken
= $token;
2459 * Set the password for a password reminder or new account email
2461 * @param string $str New password to set or null to set an invalid
2462 * password hash meaning that the user will not be able to use it
2463 * @param bool $throttle If true, reset the throttle timestamp to the present
2465 public function setNewpassword( $str, $throttle = true ) {
2466 $this->loadPasswords();
2468 $this->mNewpassword
= self
::getPasswordFactory()->newFromPlaintext( $str );
2469 if ( $str === null ) {
2470 $this->mNewpassTime
= null;
2471 } elseif ( $throttle ) {
2472 $this->mNewpassTime
= wfTimestampNow();
2477 * Has password reminder email been sent within the last
2478 * $wgPasswordReminderResendTime hours?
2481 public function isPasswordReminderThrottled() {
2482 global $wgPasswordReminderResendTime;
2484 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2487 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2488 return time() < $expiry;
2492 * Get the user's e-mail address
2493 * @return string User's email address
2495 public function getEmail() {
2497 Hooks
::run( 'UserGetEmail', array( $this, &$this->mEmail
) );
2498 return $this->mEmail
;
2502 * Get the timestamp of the user's e-mail authentication
2503 * @return string TS_MW timestamp
2505 public function getEmailAuthenticationTimestamp() {
2507 Hooks
::run( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2508 return $this->mEmailAuthenticated
;
2512 * Set the user's e-mail address
2513 * @param string $str New e-mail address
2515 public function setEmail( $str ) {
2517 if ( $str == $this->mEmail
) {
2520 $this->invalidateEmail();
2521 $this->mEmail
= $str;
2522 Hooks
::run( 'UserSetEmail', array( $this, &$this->mEmail
) );
2526 * Set the user's e-mail address and a confirmation mail if needed.
2529 * @param string $str New e-mail address
2532 public function setEmailWithConfirmation( $str ) {
2533 global $wgEnableEmail, $wgEmailAuthentication;
2535 if ( !$wgEnableEmail ) {
2536 return Status
::newFatal( 'emaildisabled' );
2539 $oldaddr = $this->getEmail();
2540 if ( $str === $oldaddr ) {
2541 return Status
::newGood( true );
2544 $this->setEmail( $str );
2546 if ( $str !== '' && $wgEmailAuthentication ) {
2547 // Send a confirmation request to the new address if needed
2548 $type = $oldaddr != '' ?
'changed' : 'set';
2549 $result = $this->sendConfirmationMail( $type );
2550 if ( $result->isGood() ) {
2551 // Say to the caller that a confirmation mail has been sent
2552 $result->value
= 'eauth';
2555 $result = Status
::newGood( true );
2562 * Get the user's real name
2563 * @return string User's real name
2565 public function getRealName() {
2566 if ( !$this->isItemLoaded( 'realname' ) ) {
2570 return $this->mRealName
;
2574 * Set the user's real name
2575 * @param string $str New real name
2577 public function setRealName( $str ) {
2579 $this->mRealName
= $str;
2583 * Get the user's current setting for a given option.
2585 * @param string $oname The option to check
2586 * @param string $defaultOverride A default value returned if the option does not exist
2587 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2588 * @return string User's current value for the option
2589 * @see getBoolOption()
2590 * @see getIntOption()
2592 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2593 global $wgHiddenPrefs;
2594 $this->loadOptions();
2596 # We want 'disabled' preferences to always behave as the default value for
2597 # users, even if they have set the option explicitly in their settings (ie they
2598 # set it, and then it was disabled removing their ability to change it). But
2599 # we don't want to erase the preferences in the database in case the preference
2600 # is re-enabled again. So don't touch $mOptions, just override the returned value
2601 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2602 return self
::getDefaultOption( $oname );
2605 if ( array_key_exists( $oname, $this->mOptions
) ) {
2606 return $this->mOptions
[$oname];
2608 return $defaultOverride;
2613 * Get all user's options
2615 * @param int $flags Bitwise combination of:
2616 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2617 * to the default value. (Since 1.25)
2620 public function getOptions( $flags = 0 ) {
2621 global $wgHiddenPrefs;
2622 $this->loadOptions();
2623 $options = $this->mOptions
;
2625 # We want 'disabled' preferences to always behave as the default value for
2626 # users, even if they have set the option explicitly in their settings (ie they
2627 # set it, and then it was disabled removing their ability to change it). But
2628 # we don't want to erase the preferences in the database in case the preference
2629 # is re-enabled again. So don't touch $mOptions, just override the returned value
2630 foreach ( $wgHiddenPrefs as $pref ) {
2631 $default = self
::getDefaultOption( $pref );
2632 if ( $default !== null ) {
2633 $options[$pref] = $default;
2637 if ( $flags & self
::GETOPTIONS_EXCLUDE_DEFAULTS
) {
2638 $options = array_diff_assoc( $options, self
::getDefaultOptions() );
2645 * Get the user's current setting for a given option, as a boolean value.
2647 * @param string $oname The option to check
2648 * @return bool User's current value for the option
2651 public function getBoolOption( $oname ) {
2652 return (bool)$this->getOption( $oname );
2656 * Get the user's current setting for a given option, as an integer value.
2658 * @param string $oname The option to check
2659 * @param int $defaultOverride A default value returned if the option does not exist
2660 * @return int User's current value for the option
2663 public function getIntOption( $oname, $defaultOverride = 0 ) {
2664 $val = $this->getOption( $oname );
2666 $val = $defaultOverride;
2668 return intval( $val );
2672 * Set the given option for a user.
2674 * You need to call saveSettings() to actually write to the database.
2676 * @param string $oname The option to set
2677 * @param mixed $val New value to set
2679 public function setOption( $oname, $val ) {
2680 $this->loadOptions();
2682 // Explicitly NULL values should refer to defaults
2683 if ( is_null( $val ) ) {
2684 $val = self
::getDefaultOption( $oname );
2687 $this->mOptions
[$oname] = $val;
2691 * Get a token stored in the preferences (like the watchlist one),
2692 * resetting it if it's empty (and saving changes).
2694 * @param string $oname The option name to retrieve the token from
2695 * @return string|bool User's current value for the option, or false if this option is disabled.
2696 * @see resetTokenFromOption()
2699 public function getTokenFromOption( $oname ) {
2700 global $wgHiddenPrefs;
2701 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2705 $token = $this->getOption( $oname );
2707 $token = $this->resetTokenFromOption( $oname );
2708 $this->saveSettings();
2714 * Reset a token stored in the preferences (like the watchlist one).
2715 * *Does not* save user's preferences (similarly to setOption()).
2717 * @param string $oname The option name to reset the token in
2718 * @return string|bool New token value, or false if this option is disabled.
2719 * @see getTokenFromOption()
2722 public function resetTokenFromOption( $oname ) {
2723 global $wgHiddenPrefs;
2724 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2728 $token = MWCryptRand
::generateHex( 40 );
2729 $this->setOption( $oname, $token );
2734 * Return a list of the types of user options currently returned by
2735 * User::getOptionKinds().
2737 * Currently, the option kinds are:
2738 * - 'registered' - preferences which are registered in core MediaWiki or
2739 * by extensions using the UserGetDefaultOptions hook.
2740 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2741 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2742 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2743 * be used by user scripts.
2744 * - 'special' - "preferences" that are not accessible via User::getOptions
2745 * or User::setOptions.
2746 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2747 * These are usually legacy options, removed in newer versions.
2749 * The API (and possibly others) use this function to determine the possible
2750 * option types for validation purposes, so make sure to update this when a
2751 * new option kind is added.
2753 * @see User::getOptionKinds
2754 * @return array Option kinds
2756 public static function listOptionKinds() {
2759 'registered-multiselect',
2760 'registered-checkmatrix',
2768 * Return an associative array mapping preferences keys to the kind of a preference they're
2769 * used for. Different kinds are handled differently when setting or reading preferences.
2771 * See User::listOptionKinds for the list of valid option types that can be provided.
2773 * @see User::listOptionKinds
2774 * @param IContextSource $context
2775 * @param array $options Assoc. array with options keys to check as keys.
2776 * Defaults to $this->mOptions.
2777 * @return array The key => kind mapping data
2779 public function getOptionKinds( IContextSource
$context, $options = null ) {
2780 $this->loadOptions();
2781 if ( $options === null ) {
2782 $options = $this->mOptions
;
2785 $prefs = Preferences
::getPreferences( $this, $context );
2788 // Pull out the "special" options, so they don't get converted as
2789 // multiselect or checkmatrix.
2790 $specialOptions = array_fill_keys( Preferences
::getSaveBlacklist(), true );
2791 foreach ( $specialOptions as $name => $value ) {
2792 unset( $prefs[$name] );
2795 // Multiselect and checkmatrix options are stored in the database with
2796 // one key per option, each having a boolean value. Extract those keys.
2797 $multiselectOptions = array();
2798 foreach ( $prefs as $name => $info ) {
2799 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2800 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2801 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2802 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2804 foreach ( $opts as $value ) {
2805 $multiselectOptions["$prefix$value"] = true;
2808 unset( $prefs[$name] );
2811 $checkmatrixOptions = array();
2812 foreach ( $prefs as $name => $info ) {
2813 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2814 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2815 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2816 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2817 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2819 foreach ( $columns as $column ) {
2820 foreach ( $rows as $row ) {
2821 $checkmatrixOptions["$prefix$column-$row"] = true;
2825 unset( $prefs[$name] );
2829 // $value is ignored
2830 foreach ( $options as $key => $value ) {
2831 if ( isset( $prefs[$key] ) ) {
2832 $mapping[$key] = 'registered';
2833 } elseif ( isset( $multiselectOptions[$key] ) ) {
2834 $mapping[$key] = 'registered-multiselect';
2835 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2836 $mapping[$key] = 'registered-checkmatrix';
2837 } elseif ( isset( $specialOptions[$key] ) ) {
2838 $mapping[$key] = 'special';
2839 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2840 $mapping[$key] = 'userjs';
2842 $mapping[$key] = 'unused';
2850 * Reset certain (or all) options to the site defaults
2852 * The optional parameter determines which kinds of preferences will be reset.
2853 * Supported values are everything that can be reported by getOptionKinds()
2854 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2856 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
2857 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2858 * for backwards-compatibility.
2859 * @param IContextSource|null $context Context source used when $resetKinds
2860 * does not contain 'all', passed to getOptionKinds().
2861 * Defaults to RequestContext::getMain() when null.
2863 public function resetOptions(
2864 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2865 IContextSource
$context = null
2868 $defaultOptions = self
::getDefaultOptions();
2870 if ( !is_array( $resetKinds ) ) {
2871 $resetKinds = array( $resetKinds );
2874 if ( in_array( 'all', $resetKinds ) ) {
2875 $newOptions = $defaultOptions;
2877 if ( $context === null ) {
2878 $context = RequestContext
::getMain();
2881 $optionKinds = $this->getOptionKinds( $context );
2882 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
2883 $newOptions = array();
2885 // Use default values for the options that should be deleted, and
2886 // copy old values for the ones that shouldn't.
2887 foreach ( $this->mOptions
as $key => $value ) {
2888 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2889 if ( array_key_exists( $key, $defaultOptions ) ) {
2890 $newOptions[$key] = $defaultOptions[$key];
2893 $newOptions[$key] = $value;
2898 Hooks
::run( 'UserResetAllOptions', array( $this, &$newOptions, $this->mOptions
, $resetKinds ) );
2900 $this->mOptions
= $newOptions;
2901 $this->mOptionsLoaded
= true;
2905 * Get the user's preferred date format.
2906 * @return string User's preferred date format
2908 public function getDatePreference() {
2909 // Important migration for old data rows
2910 if ( is_null( $this->mDatePreference
) ) {
2912 $value = $this->getOption( 'date' );
2913 $map = $wgLang->getDatePreferenceMigrationMap();
2914 if ( isset( $map[$value] ) ) {
2915 $value = $map[$value];
2917 $this->mDatePreference
= $value;
2919 return $this->mDatePreference
;
2923 * Determine based on the wiki configuration and the user's options,
2924 * whether this user must be over HTTPS no matter what.
2928 public function requiresHTTPS() {
2929 global $wgSecureLogin;
2930 if ( !$wgSecureLogin ) {
2933 $https = $this->getBoolOption( 'prefershttps' );
2934 Hooks
::run( 'UserRequiresHTTPS', array( $this, &$https ) );
2936 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
2943 * Get the user preferred stub threshold
2947 public function getStubThreshold() {
2948 global $wgMaxArticleSize; # Maximum article size, in Kb
2949 $threshold = $this->getIntOption( 'stubthreshold' );
2950 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2951 // If they have set an impossible value, disable the preference
2952 // so we can use the parser cache again.
2959 * Get the permissions this user has.
2960 * @return array Array of String permission names
2962 public function getRights() {
2963 if ( is_null( $this->mRights
) ) {
2964 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2965 Hooks
::run( 'UserGetRights', array( $this, &$this->mRights
) );
2966 // Force reindexation of rights when a hook has unset one of them
2967 $this->mRights
= array_values( array_unique( $this->mRights
) );
2969 return $this->mRights
;
2973 * Get the list of explicit group memberships this user has.
2974 * The implicit * and user groups are not included.
2975 * @return array Array of String internal group names
2977 public function getGroups() {
2979 $this->loadGroups();
2980 return $this->mGroups
;
2984 * Get the list of implicit group memberships this user has.
2985 * This includes all explicit groups, plus 'user' if logged in,
2986 * '*' for all accounts, and autopromoted groups
2987 * @param bool $recache Whether to avoid the cache
2988 * @return array Array of String internal group names
2990 public function getEffectiveGroups( $recache = false ) {
2991 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2992 $this->mEffectiveGroups
= array_unique( array_merge(
2993 $this->getGroups(), // explicit groups
2994 $this->getAutomaticGroups( $recache ) // implicit groups
2996 // Hook for additional groups
2997 Hooks
::run( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2998 // Force reindexation of groups when a hook has unset one of them
2999 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
3001 return $this->mEffectiveGroups
;
3005 * Get the list of implicit group memberships this user has.
3006 * This includes 'user' if logged in, '*' for all accounts,
3007 * and autopromoted groups
3008 * @param bool $recache Whether to avoid the cache
3009 * @return array Array of String internal group names
3011 public function getAutomaticGroups( $recache = false ) {
3012 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
3013 $this->mImplicitGroups
= array( '*' );
3014 if ( $this->getId() ) {
3015 $this->mImplicitGroups
[] = 'user';
3017 $this->mImplicitGroups
= array_unique( array_merge(
3018 $this->mImplicitGroups
,
3019 Autopromote
::getAutopromoteGroups( $this )
3023 // Assure data consistency with rights/groups,
3024 // as getEffectiveGroups() depends on this function
3025 $this->mEffectiveGroups
= null;
3028 return $this->mImplicitGroups
;
3032 * Returns the groups the user has belonged to.
3034 * The user may still belong to the returned groups. Compare with getGroups().
3036 * The function will not return groups the user had belonged to before MW 1.17
3038 * @return array Names of the groups the user has belonged to.
3040 public function getFormerGroups() {
3041 if ( is_null( $this->mFormerGroups
) ) {
3042 $dbr = wfGetDB( DB_MASTER
);
3043 $res = $dbr->select( 'user_former_groups',
3044 array( 'ufg_group' ),
3045 array( 'ufg_user' => $this->mId
),
3047 $this->mFormerGroups
= array();
3048 foreach ( $res as $row ) {
3049 $this->mFormerGroups
[] = $row->ufg_group
;
3052 return $this->mFormerGroups
;
3056 * Get the user's edit count.
3057 * @return int|null Null for anonymous users
3059 public function getEditCount() {
3060 if ( !$this->getId() ) {
3064 if ( $this->mEditCount
=== null ) {
3065 /* Populate the count, if it has not been populated yet */
3066 $dbr = wfGetDB( DB_SLAVE
);
3067 // check if the user_editcount field has been initialized
3068 $count = $dbr->selectField(
3069 'user', 'user_editcount',
3070 array( 'user_id' => $this->mId
),
3074 if ( $count === null ) {
3075 // it has not been initialized. do so.
3076 $count = $this->initEditCount();
3078 $this->mEditCount
= $count;
3080 return (int)$this->mEditCount
;
3084 * Add the user to the given group.
3085 * This takes immediate effect.
3086 * @param string $group Name of the group to add
3089 public function addGroup( $group ) {
3092 if ( !Hooks
::run( 'UserAddGroup', array( $this, &$group ) ) ) {
3096 $dbw = wfGetDB( DB_MASTER
);
3097 if ( $this->getId() ) {
3098 $dbw->insert( 'user_groups',
3100 'ug_user' => $this->getID(),
3101 'ug_group' => $group,
3104 array( 'IGNORE' ) );
3107 $this->loadGroups();
3108 $this->mGroups
[] = $group;
3109 // In case loadGroups was not called before, we now have the right twice.
3110 // Get rid of the duplicate.
3111 $this->mGroups
= array_unique( $this->mGroups
);
3113 // Refresh the groups caches, and clear the rights cache so it will be
3114 // refreshed on the next call to $this->getRights().
3115 $this->getEffectiveGroups( true );
3116 $this->mRights
= null;
3118 $this->invalidateCache();
3124 * Remove the user from the given group.
3125 * This takes immediate effect.
3126 * @param string $group Name of the group to remove
3129 public function removeGroup( $group ) {
3131 if ( !Hooks
::run( 'UserRemoveGroup', array( $this, &$group ) ) ) {
3135 $dbw = wfGetDB( DB_MASTER
);
3136 $dbw->delete( 'user_groups',
3138 'ug_user' => $this->getID(),
3139 'ug_group' => $group,
3142 // Remember that the user was in this group
3143 $dbw->insert( 'user_former_groups',
3145 'ufg_user' => $this->getID(),
3146 'ufg_group' => $group,
3152 $this->loadGroups();
3153 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
3155 // Refresh the groups caches, and clear the rights cache so it will be
3156 // refreshed on the next call to $this->getRights().
3157 $this->getEffectiveGroups( true );
3158 $this->mRights
= null;
3160 $this->invalidateCache();
3166 * Get whether the user is logged in
3169 public function isLoggedIn() {
3170 return $this->getID() != 0;
3174 * Get whether the user is anonymous
3177 public function isAnon() {
3178 return !$this->isLoggedIn();
3182 * Check if user is allowed to access a feature / make an action
3184 * @param string $permissions,... Permissions to test
3185 * @return bool True if user is allowed to perform *any* of the given actions
3187 public function isAllowedAny( /*...*/ ) {
3188 $permissions = func_get_args();
3189 foreach ( $permissions as $permission ) {
3190 if ( $this->isAllowed( $permission ) ) {
3199 * @param string $permissions,... Permissions to test
3200 * @return bool True if the user is allowed to perform *all* of the given actions
3202 public function isAllowedAll( /*...*/ ) {
3203 $permissions = func_get_args();
3204 foreach ( $permissions as $permission ) {
3205 if ( !$this->isAllowed( $permission ) ) {
3213 * Internal mechanics of testing a permission
3214 * @param string $action
3217 public function isAllowed( $action = '' ) {
3218 if ( $action === '' ) {
3219 return true; // In the spirit of DWIM
3221 // Patrolling may not be enabled
3222 if ( $action === 'patrol' ||
$action === 'autopatrol' ) {
3223 global $wgUseRCPatrol, $wgUseNPPatrol;
3224 if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) {
3228 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3229 // by misconfiguration: 0 == 'foo'
3230 return in_array( $action, $this->getRights(), true );
3234 * Check whether to enable recent changes patrol features for this user
3235 * @return bool True or false
3237 public function useRCPatrol() {
3238 global $wgUseRCPatrol;
3239 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3243 * Check whether to enable new pages patrol features for this user
3244 * @return bool True or false
3246 public function useNPPatrol() {
3247 global $wgUseRCPatrol, $wgUseNPPatrol;
3249 ( $wgUseRCPatrol ||
$wgUseNPPatrol )
3250 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3255 * Get the WebRequest object to use with this object
3257 * @return WebRequest
3259 public function getRequest() {
3260 if ( $this->mRequest
) {
3261 return $this->mRequest
;
3269 * Get the current skin, loading it if required
3270 * @return Skin The current skin
3271 * @todo FIXME: Need to check the old failback system [AV]
3272 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
3274 public function getSkin() {
3275 wfDeprecated( __METHOD__
, '1.18' );
3276 return RequestContext
::getMain()->getSkin();
3280 * Get a WatchedItem for this user and $title.
3282 * @since 1.22 $checkRights parameter added
3283 * @param Title $title
3284 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3285 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3286 * @return WatchedItem
3288 public function getWatchedItem( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3289 $key = $checkRights . ':' . $title->getNamespace() . ':' . $title->getDBkey();
3291 if ( isset( $this->mWatchedItems
[$key] ) ) {
3292 return $this->mWatchedItems
[$key];
3295 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
3296 $this->mWatchedItems
= array();
3299 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title, $checkRights );
3300 return $this->mWatchedItems
[$key];
3304 * Check the watched status of an article.
3305 * @since 1.22 $checkRights parameter added
3306 * @param Title $title Title of the article to look at
3307 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3308 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3311 public function isWatched( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3312 return $this->getWatchedItem( $title, $checkRights )->isWatched();
3317 * @since 1.22 $checkRights parameter added
3318 * @param Title $title Title of the article to look at
3319 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3320 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3322 public function addWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3323 $this->getWatchedItem( $title, $checkRights )->addWatch();
3324 $this->invalidateCache();
3328 * Stop watching an article.
3329 * @since 1.22 $checkRights parameter added
3330 * @param Title $title Title of the article to look at
3331 * @param int $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3332 * Pass WatchedItem::CHECK_USER_RIGHTS or WatchedItem::IGNORE_USER_RIGHTS.
3334 public function removeWatch( $title, $checkRights = WatchedItem
::CHECK_USER_RIGHTS
) {
3335 $this->getWatchedItem( $title, $checkRights )->removeWatch();
3336 $this->invalidateCache();
3340 * Clear the user's notification timestamp for the given title.
3341 * If e-notif e-mails are on, they will receive notification mails on
3342 * the next change of the page if it's watched etc.
3343 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3344 * @param Title $title Title of the article to look at
3345 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3347 public function clearNotification( &$title, $oldid = 0 ) {
3348 global $wgUseEnotif, $wgShowUpdatedMarker;
3350 // Do nothing if the database is locked to writes
3351 if ( wfReadOnly() ) {
3355 // Do nothing if not allowed to edit the watchlist
3356 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3360 // If we're working on user's talk page, we should update the talk page message indicator
3361 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3362 if ( !Hooks
::run( 'UserClearNewTalkNotification', array( &$this, $oldid ) ) ) {
3366 $nextid = $oldid ?
$title->getNextRevisionID( $oldid ) : null;
3368 if ( !$oldid ||
!$nextid ) {
3369 // If we're looking at the latest revision, we should definitely clear it
3370 $this->setNewtalk( false );
3372 // Otherwise we should update its revision, if it's present
3373 if ( $this->getNewtalk() ) {
3374 // Naturally the other one won't clear by itself
3375 $this->setNewtalk( false );
3376 $this->setNewtalk( true, Revision
::newFromId( $nextid ) );
3381 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3385 if ( $this->isAnon() ) {
3386 // Nothing else to do...
3390 // Only update the timestamp if the page is being watched.
3391 // The query to find out if it is watched is cached both in memcached and per-invocation,
3392 // and when it does have to be executed, it can be on a slave
3393 // If this is the user's newtalk page, we always update the timestamp
3395 if ( $title->getNamespace() == NS_USER_TALK
&& $title->getText() == $this->getName() ) {
3399 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force, $oldid );
3403 * Resets all of the given user's page-change notification timestamps.
3404 * If e-notif e-mails are on, they will receive notification mails on
3405 * the next change of any watched page.
3406 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3408 public function clearAllNotifications() {
3409 if ( wfReadOnly() ) {
3413 // Do nothing if not allowed to edit the watchlist
3414 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3418 global $wgUseEnotif, $wgShowUpdatedMarker;
3419 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3420 $this->setNewtalk( false );
3423 $id = $this->getId();
3425 $dbw = wfGetDB( DB_MASTER
);
3426 $dbw->update( 'watchlist',
3427 array( /* SET */ 'wl_notificationtimestamp' => null ),
3428 array( /* WHERE */ 'wl_user' => $id ),
3431 // We also need to clear here the "you have new message" notification for the own user_talk page;
3432 // it's cleared one page view later in WikiPage::doViewUpdates().
3437 * Set a cookie on the user's client. Wrapper for
3438 * WebResponse::setCookie
3439 * @param string $name Name of the cookie to set
3440 * @param string $value Value to set
3441 * @param int $exp Expiration time, as a UNIX time value;
3442 * if 0 or not specified, use the default $wgCookieExpiration
3443 * @param bool $secure
3444 * true: Force setting the secure attribute when setting the cookie
3445 * false: Force NOT setting the secure attribute when setting the cookie
3446 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3447 * @param array $params Array of options sent passed to WebResponse::setcookie()
3448 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3451 protected function setCookie(
3452 $name, $value, $exp = 0, $secure = null, $params = array(), $request = null
3454 if ( $request === null ) {
3455 $request = $this->getRequest();
3457 $params['secure'] = $secure;
3458 $request->response()->setcookie( $name, $value, $exp, $params );
3462 * Clear a cookie on the user's client
3463 * @param string $name Name of the cookie to clear
3464 * @param bool $secure
3465 * true: Force setting the secure attribute when setting the cookie
3466 * false: Force NOT setting the secure attribute when setting the cookie
3467 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3468 * @param array $params Array of options sent passed to WebResponse::setcookie()
3470 protected function clearCookie( $name, $secure = null, $params = array() ) {
3471 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3475 * Set the default cookies for this session on the user's client.
3477 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3479 * @param bool $secure Whether to force secure/insecure cookies or use default
3480 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3482 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3483 if ( $request === null ) {
3484 $request = $this->getRequest();
3488 if ( 0 == $this->mId
) {
3491 if ( !$this->mToken
) {
3492 // When token is empty or NULL generate a new one and then save it to the database
3493 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
3494 // Simply by setting every cell in the user_token column to NULL and letting them be
3495 // regenerated as users log back into the wiki.
3497 $this->saveSettings();
3500 'wsUserID' => $this->mId
,
3501 'wsToken' => $this->mToken
,
3502 'wsUserName' => $this->getName()
3505 'UserID' => $this->mId
,
3506 'UserName' => $this->getName(),
3508 if ( $rememberMe ) {
3509 $cookies['Token'] = $this->mToken
;
3511 $cookies['Token'] = false;
3514 Hooks
::run( 'UserSetCookies', array( $this, &$session, &$cookies ) );
3516 foreach ( $session as $name => $value ) {
3517 $request->setSessionData( $name, $value );
3519 foreach ( $cookies as $name => $value ) {
3520 if ( $value === false ) {
3521 $this->clearCookie( $name );
3523 $this->setCookie( $name, $value, 0, $secure, array(), $request );
3528 * If wpStickHTTPS was selected, also set an insecure cookie that
3529 * will cause the site to redirect the user to HTTPS, if they access
3530 * it over HTTP. Bug 29898. Use an un-prefixed cookie, so it's the same
3531 * as the one set by centralauth (bug 53538). Also set it to session, or
3532 * standard time setting, based on if rememberme was set.
3534 if ( $request->getCheck( 'wpStickHTTPS' ) ||
$this->requiresHTTPS() ) {
3538 $rememberMe ?
0 : null,
3540 array( 'prefix' => '' ) // no prefix
3546 * Log this user out.
3548 public function logout() {
3549 if ( Hooks
::run( 'UserLogout', array( &$this ) ) ) {
3555 * Clear the user's cookies and session, and reset the instance cache.
3558 public function doLogout() {
3559 $this->clearInstanceCache( 'defaults' );
3561 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3563 $this->clearCookie( 'UserID' );
3564 $this->clearCookie( 'Token' );
3565 $this->clearCookie( 'forceHTTPS', false, array( 'prefix' => '' ) );
3567 // Remember when user logged out, to prevent seeing cached pages
3568 $this->setCookie( 'LoggedOut', time(), time() +
86400 );
3572 * Save this user's settings into the database.
3573 * @todo Only rarely do all these fields need to be set!
3575 public function saveSettings() {
3579 $this->loadPasswords();
3580 if ( wfReadOnly() ) {
3581 return; // @TODO: caller should deal with this instead!
3583 if ( 0 == $this->mId
) {
3587 // This method is for updating existing users, so the user should
3588 // have been loaded from the master to begin with to avoid problems.
3589 if ( !( $this->queryFlagsUsed
& self
::READ_LATEST
) ) {
3590 wfWarn( "Attempting to save slave-loaded User object data." );
3593 $this->mTouched
= self
::newTouchedTimestamp();
3594 if ( !$wgAuth->allowSetLocalPassword() ) {
3595 $this->mPassword
= self
::getPasswordFactory()->newFromCiphertext( null );
3598 $dbw = wfGetDB( DB_MASTER
);
3599 $dbw->update( 'user',
3601 'user_name' => $this->mName
,
3602 'user_password' => $this->mPassword
->toString(),
3603 'user_newpassword' => $this->mNewpassword
->toString(),
3604 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3605 'user_real_name' => $this->mRealName
,
3606 'user_email' => $this->mEmail
,
3607 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3608 'user_touched' => $dbw->timestamp( $this->mTouched
),
3609 'user_token' => strval( $this->mToken
),
3610 'user_email_token' => $this->mEmailToken
,
3611 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3612 'user_password_expires' => $dbw->timestampOrNull( $this->mPasswordExpires
),
3613 ), array( /* WHERE */
3614 'user_id' => $this->mId
3618 $this->saveOptions();
3620 Hooks
::run( 'UserSaveSettings', array( $this ) );
3621 $this->clearSharedCache();
3622 $this->getUserPage()->invalidateCache();
3626 * If only this user's username is known, and it exists, return the user ID.
3629 public function idForName() {
3630 $s = trim( $this->getName() );
3635 $dbr = wfGetDB( DB_SLAVE
);
3636 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
3637 if ( $id === false ) {
3644 * Add a user to the database, return the user object
3646 * @param string $name Username to add
3647 * @param array $params Array of Strings Non-default parameters to save to
3648 * the database as user_* fields:
3649 * - password: The user's password hash. Password logins will be disabled
3650 * if this is omitted.
3651 * - newpassword: Hash for a temporary password that has been mailed to
3653 * - email: The user's email address.
3654 * - email_authenticated: The email authentication timestamp.
3655 * - real_name: The user's real name.
3656 * - options: An associative array of non-default options.
3657 * - token: Random authentication token. Do not set.
3658 * - registration: Registration timestamp. Do not set.
3660 * @return User|null User object, or null if the username already exists.
3662 public static function createNew( $name, $params = array() ) {
3665 $user->loadPasswords();
3666 $user->setToken(); // init token
3667 if ( isset( $params['options'] ) ) {
3668 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3669 unset( $params['options'] );
3671 $dbw = wfGetDB( DB_MASTER
);
3672 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3675 'user_id' => $seqVal,
3676 'user_name' => $name,
3677 'user_password' => $user->mPassword
->toString(),
3678 'user_newpassword' => $user->mNewpassword
->toString(),
3679 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
3680 'user_email' => $user->mEmail
,
3681 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3682 'user_real_name' => $user->mRealName
,
3683 'user_token' => strval( $user->mToken
),
3684 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3685 'user_editcount' => 0,
3686 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3688 foreach ( $params as $name => $value ) {
3689 $fields["user_$name"] = $value;
3691 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3692 if ( $dbw->affectedRows() ) {
3693 $newUser = User
::newFromId( $dbw->insertId() );
3701 * Add this existing user object to the database. If the user already
3702 * exists, a fatal status object is returned, and the user object is
3703 * initialised with the data from the database.
3705 * Previously, this function generated a DB error due to a key conflict
3706 * if the user already existed. Many extension callers use this function
3707 * in code along the lines of:
3709 * $user = User::newFromName( $name );
3710 * if ( !$user->isLoggedIn() ) {
3711 * $user->addToDatabase();
3713 * // do something with $user...
3715 * However, this was vulnerable to a race condition (bug 16020). By
3716 * initialising the user object if the user exists, we aim to support this
3717 * calling sequence as far as possible.
3719 * Note that if the user exists, this function will acquire a write lock,
3720 * so it is still advisable to make the call conditional on isLoggedIn(),
3721 * and to commit the transaction after calling.
3723 * @throws MWException
3726 public function addToDatabase() {
3728 $this->loadPasswords();
3729 if ( !$this->mToken
) {
3730 $this->setToken(); // init token
3733 $this->mTouched
= self
::newTouchedTimestamp();
3735 $dbw = wfGetDB( DB_MASTER
);
3736 $inWrite = $dbw->writesOrCallbacksPending();
3737 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3738 $dbw->insert( 'user',
3740 'user_id' => $seqVal,
3741 'user_name' => $this->mName
,
3742 'user_password' => $this->mPassword
->toString(),
3743 'user_newpassword' => $this->mNewpassword
->toString(),
3744 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3745 'user_email' => $this->mEmail
,
3746 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3747 'user_real_name' => $this->mRealName
,
3748 'user_token' => strval( $this->mToken
),
3749 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3750 'user_editcount' => 0,
3751 'user_touched' => $dbw->timestamp( $this->mTouched
),
3755 if ( !$dbw->affectedRows() ) {
3756 // The queries below cannot happen in the same REPEATABLE-READ snapshot.
3757 // Handle this by COMMIT, if possible, or by LOCK IN SHARE MODE otherwise.
3759 // Can't commit due to pending writes that may need atomicity.
3760 // This may cause some lock contention unlike the case below.
3761 $options = array( 'LOCK IN SHARE MODE' );
3762 $flags = self
::READ_LOCKING
;
3764 // Often, this case happens early in views before any writes when
3765 // using CentralAuth. It's should be OK to commit and break the snapshot.
3766 $dbw->commit( __METHOD__
, 'flush' );
3768 $flags = self
::READ_LATEST
;
3770 $this->mId
= $dbw->selectField( 'user', 'user_id',
3771 array( 'user_name' => $this->mName
), __METHOD__
, $options );
3774 if ( $this->loadFromDatabase( $flags ) ) {
3779 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3780 "to insert user '{$this->mName}' row, but it was not present in select!" );
3782 return Status
::newFatal( 'userexists' );
3784 $this->mId
= $dbw->insertId();
3786 // Clear instance cache other than user table data, which is already accurate
3787 $this->clearInstanceCache();
3789 $this->saveOptions();
3790 return Status
::newGood();
3794 * If this user is logged-in and blocked,
3795 * block any IP address they've successfully logged in from.
3796 * @return bool A block was spread
3798 public function spreadAnyEditBlock() {
3799 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3800 return $this->spreadBlock();
3806 * If this (non-anonymous) user is blocked,
3807 * block the IP address they've successfully logged in from.
3808 * @return bool A block was spread
3810 protected function spreadBlock() {
3811 wfDebug( __METHOD__
. "()\n" );
3813 if ( $this->mId
== 0 ) {
3817 $userblock = Block
::newFromTarget( $this->getName() );
3818 if ( !$userblock ) {
3822 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3826 * Get whether the user is explicitly blocked from account creation.
3827 * @return bool|Block
3829 public function isBlockedFromCreateAccount() {
3830 $this->getBlockedStatus();
3831 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
3832 return $this->mBlock
;
3835 # bug 13611: if the IP address the user is trying to create an account from is
3836 # blocked with createaccount disabled, prevent new account creation there even
3837 # when the user is logged in
3838 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3839 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3841 return $this->mBlockedFromCreateAccount
instanceof Block
3842 && $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3843 ?
$this->mBlockedFromCreateAccount
3848 * Get whether the user is blocked from using Special:Emailuser.
3851 public function isBlockedFromEmailuser() {
3852 $this->getBlockedStatus();
3853 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3857 * Get whether the user is allowed to create an account.
3860 public function isAllowedToCreateAccount() {
3861 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3865 * Get this user's personal page title.
3867 * @return Title User's personal page title
3869 public function getUserPage() {
3870 return Title
::makeTitle( NS_USER
, $this->getName() );
3874 * Get this user's talk page title.
3876 * @return Title User's talk page title
3878 public function getTalkPage() {
3879 $title = $this->getUserPage();
3880 return $title->getTalkPage();
3884 * Determine whether the user is a newbie. Newbies are either
3885 * anonymous IPs, or the most recently created accounts.
3888 public function isNewbie() {
3889 return !$this->isAllowed( 'autoconfirmed' );
3893 * Check to see if the given clear-text password is one of the accepted passwords
3894 * @param string $password User password
3895 * @return bool True if the given password is correct, otherwise False
3897 public function checkPassword( $password ) {
3898 global $wgAuth, $wgLegacyEncoding;
3900 $this->loadPasswords();
3902 // Certain authentication plugins do NOT want to save
3903 // domain passwords in a mysql database, so we should
3904 // check this (in case $wgAuth->strict() is false).
3905 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
3907 } elseif ( $wgAuth->strict() ) {
3908 // Auth plugin doesn't allow local authentication
3910 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
3911 // Auth plugin doesn't allow local authentication for this user name
3915 if ( !$this->mPassword
->equals( $password ) ) {
3916 if ( $wgLegacyEncoding ) {
3917 // Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3918 // Check for this with iconv
3919 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3920 if ( $cp1252Password === $password ||
!$this->mPassword
->equals( $cp1252Password ) ) {
3928 $passwordFactory = self
::getPasswordFactory();
3929 if ( $passwordFactory->needsUpdate( $this->mPassword
) ) {
3930 $this->mPassword
= $passwordFactory->newFromPlaintext( $password );
3931 $this->saveSettings();
3938 * Check if the given clear-text password matches the temporary password
3939 * sent by e-mail for password reset operations.
3941 * @param string $plaintext
3943 * @return bool True if matches, false otherwise
3945 public function checkTemporaryPassword( $plaintext ) {
3946 global $wgNewPasswordExpiry;
3949 $this->loadPasswords();
3950 if ( $this->mNewpassword
->equals( $plaintext ) ) {
3951 if ( is_null( $this->mNewpassTime
) ) {
3954 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3955 return ( time() < $expiry );
3962 * Alias for getEditToken.
3963 * @deprecated since 1.19, use getEditToken instead.
3965 * @param string|array $salt Array of Strings Optional function-specific data for hashing
3966 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
3967 * @return string The new edit token
3969 public function editToken( $salt = '', $request = null ) {
3970 wfDeprecated( __METHOD__
, '1.19' );
3971 return $this->getEditToken( $salt, $request );
3975 * Internal implementation for self::getEditToken() and
3976 * self::matchEditToken().
3978 * @param string|array $salt
3979 * @param WebRequest $request
3980 * @param string|int $timestamp
3983 private function getEditTokenAtTimestamp( $salt, $request, $timestamp ) {
3984 if ( $this->isAnon() ) {
3985 return self
::EDIT_TOKEN_SUFFIX
;
3987 $token = $request->getSessionData( 'wsEditToken' );
3988 if ( $token === null ) {
3989 $token = MWCryptRand
::generateHex( 32 );
3990 $request->setSessionData( 'wsEditToken', $token );
3992 if ( is_array( $salt ) ) {
3993 $salt = implode( '|', $salt );
3995 return hash_hmac( 'md5', $timestamp . $salt, $token, false ) .
3996 dechex( $timestamp ) .
3997 self
::EDIT_TOKEN_SUFFIX
;
4002 * Initialize (if necessary) and return a session token value
4003 * which can be used in edit forms to show that the user's
4004 * login credentials aren't being hijacked with a foreign form
4009 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4010 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4011 * @return string The new edit token
4013 public function getEditToken( $salt = '', $request = null ) {
4014 return $this->getEditTokenAtTimestamp(
4015 $salt, $request ?
: $this->getRequest(), wfTimestamp()
4020 * Generate a looking random token for various uses.
4022 * @return string The new random token
4023 * @deprecated since 1.20: Use MWCryptRand for secure purposes or
4024 * wfRandomString for pseudo-randomness.
4026 public static function generateToken() {
4027 return MWCryptRand
::generateHex( 32 );
4031 * Get the embedded timestamp from a token.
4032 * @param string $val Input token
4035 public static function getEditTokenTimestamp( $val ) {
4036 $suffixLen = strlen( self
::EDIT_TOKEN_SUFFIX
);
4037 if ( strlen( $val ) <= 32 +
$suffixLen ) {
4041 return hexdec( substr( $val, 32, -$suffixLen ) );
4045 * Check given value against the token value stored in the session.
4046 * A match should confirm that the form was submitted from the
4047 * user's own login session, not a form submission from a third-party
4050 * @param string $val Input value to compare
4051 * @param string $salt Optional function-specific data for hashing
4052 * @param WebRequest|null $request Object to use or null to use $wgRequest
4053 * @param int $maxage Fail tokens older than this, in seconds
4054 * @return bool Whether the token matches
4056 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4057 if ( $this->isAnon() ) {
4058 return $val === self
::EDIT_TOKEN_SUFFIX
;
4061 $timestamp = self
::getEditTokenTimestamp( $val );
4062 if ( $timestamp === null ) {
4065 if ( $maxage !== null && $timestamp < wfTimestamp() - $maxage ) {
4070 $sessionToken = $this->getEditTokenAtTimestamp(
4071 $salt, $request ?
: $this->getRequest(), $timestamp
4074 if ( $val != $sessionToken ) {
4075 wfDebug( "User::matchEditToken: broken session data\n" );
4078 return hash_equals( $sessionToken, $val );
4082 * Check given value against the token value stored in the session,
4083 * ignoring the suffix.
4085 * @param string $val Input value to compare
4086 * @param string $salt Optional function-specific data for hashing
4087 * @param WebRequest|null $request Object to use or null to use $wgRequest
4088 * @param int $maxage Fail tokens older than this, in seconds
4089 * @return bool Whether the token matches
4091 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4092 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . self
::EDIT_TOKEN_SUFFIX
;
4093 return $this->matchEditToken( $val, $salt, $request, $maxage );
4097 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4098 * mail to the user's given address.
4100 * @param string $type Message to send, either "created", "changed" or "set"
4103 public function sendConfirmationMail( $type = 'created' ) {
4105 $expiration = null; // gets passed-by-ref and defined in next line.
4106 $token = $this->confirmationToken( $expiration );
4107 $url = $this->confirmationTokenUrl( $token );
4108 $invalidateURL = $this->invalidationTokenUrl( $token );
4109 $this->saveSettings();
4111 if ( $type == 'created' ||
$type === false ) {
4112 $message = 'confirmemail_body';
4113 } elseif ( $type === true ) {
4114 $message = 'confirmemail_body_changed';
4116 // Messages: confirmemail_body_changed, confirmemail_body_set
4117 $message = 'confirmemail_body_' . $type;
4120 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4121 wfMessage( $message,
4122 $this->getRequest()->getIP(),
4125 $wgLang->timeanddate( $expiration, false ),
4127 $wgLang->date( $expiration, false ),
4128 $wgLang->time( $expiration, false ) )->text() );
4132 * Send an e-mail to this user's account. Does not check for
4133 * confirmed status or validity.
4135 * @param string $subject Message subject
4136 * @param string $body Message body
4137 * @param string $from Optional From address; if unspecified, default
4138 * $wgPasswordSender will be used.
4139 * @param string $replyto Reply-To address
4142 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4143 if ( is_null( $from ) ) {
4144 global $wgPasswordSender;
4145 $sender = new MailAddress( $wgPasswordSender,
4146 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4148 $sender = MailAddress
::newFromUser( $from );
4151 $to = MailAddress
::newFromUser( $this );
4152 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
4156 * Generate, store, and return a new e-mail confirmation code.
4157 * A hash (unsalted, since it's used as a key) is stored.
4159 * @note Call saveSettings() after calling this function to commit
4160 * this change to the database.
4162 * @param string &$expiration Accepts the expiration time
4163 * @return string New token
4165 protected function confirmationToken( &$expiration ) {
4166 global $wgUserEmailConfirmationTokenExpiry;
4168 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
4169 $expiration = wfTimestamp( TS_MW
, $expires );
4171 $token = MWCryptRand
::generateHex( 32 );
4172 $hash = md5( $token );
4173 $this->mEmailToken
= $hash;
4174 $this->mEmailTokenExpires
= $expiration;
4179 * Return a URL the user can use to confirm their email address.
4180 * @param string $token Accepts the email confirmation token
4181 * @return string New token URL
4183 protected function confirmationTokenUrl( $token ) {
4184 return $this->getTokenUrl( 'ConfirmEmail', $token );
4188 * Return a URL the user can use to invalidate their email address.
4189 * @param string $token Accepts the email confirmation token
4190 * @return string New token URL
4192 protected function invalidationTokenUrl( $token ) {
4193 return $this->getTokenUrl( 'InvalidateEmail', $token );
4197 * Internal function to format the e-mail validation/invalidation URLs.
4198 * This uses a quickie hack to use the
4199 * hardcoded English names of the Special: pages, for ASCII safety.
4201 * @note Since these URLs get dropped directly into emails, using the
4202 * short English names avoids insanely long URL-encoded links, which
4203 * also sometimes can get corrupted in some browsers/mailers
4204 * (bug 6957 with Gmail and Internet Explorer).
4206 * @param string $page Special page
4207 * @param string $token Token
4208 * @return string Formatted URL
4210 protected function getTokenUrl( $page, $token ) {
4211 // Hack to bypass localization of 'Special:'
4212 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
4213 return $title->getCanonicalURL();
4217 * Mark the e-mail address confirmed.
4219 * @note Call saveSettings() after calling this function to commit the change.
4223 public function confirmEmail() {
4224 // Check if it's already confirmed, so we don't touch the database
4225 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4226 if ( !$this->isEmailConfirmed() ) {
4227 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4228 Hooks
::run( 'ConfirmEmailComplete', array( $this ) );
4234 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4235 * address if it was already confirmed.
4237 * @note Call saveSettings() after calling this function to commit the change.
4238 * @return bool Returns true
4240 public function invalidateEmail() {
4242 $this->mEmailToken
= null;
4243 $this->mEmailTokenExpires
= null;
4244 $this->setEmailAuthenticationTimestamp( null );
4246 Hooks
::run( 'InvalidateEmailComplete', array( $this ) );
4251 * Set the e-mail authentication timestamp.
4252 * @param string $timestamp TS_MW timestamp
4254 public function setEmailAuthenticationTimestamp( $timestamp ) {
4256 $this->mEmailAuthenticated
= $timestamp;
4257 Hooks
::run( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
4261 * Is this user allowed to send e-mails within limits of current
4262 * site configuration?
4265 public function canSendEmail() {
4266 global $wgEnableEmail, $wgEnableUserEmail;
4267 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
4270 $canSend = $this->isEmailConfirmed();
4271 Hooks
::run( 'UserCanSendEmail', array( &$this, &$canSend ) );
4276 * Is this user allowed to receive e-mails within limits of current
4277 * site configuration?
4280 public function canReceiveEmail() {
4281 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4285 * Is this user's e-mail address valid-looking and confirmed within
4286 * limits of the current site configuration?
4288 * @note If $wgEmailAuthentication is on, this may require the user to have
4289 * confirmed their address by returning a code or using a password
4290 * sent to the address from the wiki.
4294 public function isEmailConfirmed() {
4295 global $wgEmailAuthentication;
4298 if ( Hooks
::run( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
4299 if ( $this->isAnon() ) {
4302 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
4305 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4315 * Check whether there is an outstanding request for e-mail confirmation.
4318 public function isEmailConfirmationPending() {
4319 global $wgEmailAuthentication;
4320 return $wgEmailAuthentication &&
4321 !$this->isEmailConfirmed() &&
4322 $this->mEmailToken
&&
4323 $this->mEmailTokenExpires
> wfTimestamp();
4327 * Get the timestamp of account creation.
4329 * @return string|bool|null Timestamp of account creation, false for
4330 * non-existent/anonymous user accounts, or null if existing account
4331 * but information is not in database.
4333 public function getRegistration() {
4334 if ( $this->isAnon() ) {
4338 return $this->mRegistration
;
4342 * Get the timestamp of the first edit
4344 * @return string|bool Timestamp of first edit, or false for
4345 * non-existent/anonymous user accounts.
4347 public function getFirstEditTimestamp() {
4348 if ( $this->getId() == 0 ) {
4349 return false; // anons
4351 $dbr = wfGetDB( DB_SLAVE
);
4352 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4353 array( 'rev_user' => $this->getId() ),
4355 array( 'ORDER BY' => 'rev_timestamp ASC' )
4358 return false; // no edits
4360 return wfTimestamp( TS_MW
, $time );
4364 * Get the permissions associated with a given list of groups
4366 * @param array $groups Array of Strings List of internal group names
4367 * @return array Array of Strings List of permission key names for given groups combined
4369 public static function getGroupPermissions( $groups ) {
4370 global $wgGroupPermissions, $wgRevokePermissions;
4372 // grant every granted permission first
4373 foreach ( $groups as $group ) {
4374 if ( isset( $wgGroupPermissions[$group] ) ) {
4375 $rights = array_merge( $rights,
4376 // array_filter removes empty items
4377 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4380 // now revoke the revoked permissions
4381 foreach ( $groups as $group ) {
4382 if ( isset( $wgRevokePermissions[$group] ) ) {
4383 $rights = array_diff( $rights,
4384 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4387 return array_unique( $rights );
4391 * Get all the groups who have a given permission
4393 * @param string $role Role to check
4394 * @return array Array of Strings List of internal group names with the given permission
4396 public static function getGroupsWithPermission( $role ) {
4397 global $wgGroupPermissions;
4398 $allowedGroups = array();
4399 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4400 if ( self
::groupHasPermission( $group, $role ) ) {
4401 $allowedGroups[] = $group;
4404 return $allowedGroups;
4408 * Check, if the given group has the given permission
4410 * If you're wanting to check whether all users have a permission, use
4411 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4415 * @param string $group Group to check
4416 * @param string $role Role to check
4419 public static function groupHasPermission( $group, $role ) {
4420 global $wgGroupPermissions, $wgRevokePermissions;
4421 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4422 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4426 * Check if all users have the given permission
4429 * @param string $right Right to check
4432 public static function isEveryoneAllowed( $right ) {
4433 global $wgGroupPermissions, $wgRevokePermissions;
4434 static $cache = array();
4436 // Use the cached results, except in unit tests which rely on
4437 // being able change the permission mid-request
4438 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4439 return $cache[$right];
4442 if ( !isset( $wgGroupPermissions['*'][$right] ) ||
!$wgGroupPermissions['*'][$right] ) {
4443 $cache[$right] = false;
4447 // If it's revoked anywhere, then everyone doesn't have it
4448 foreach ( $wgRevokePermissions as $rights ) {
4449 if ( isset( $rights[$right] ) && $rights[$right] ) {
4450 $cache[$right] = false;
4455 // Allow extensions (e.g. OAuth) to say false
4456 if ( !Hooks
::run( 'UserIsEveryoneAllowed', array( $right ) ) ) {
4457 $cache[$right] = false;
4461 $cache[$right] = true;
4466 * Get the localized descriptive name for a group, if it exists
4468 * @param string $group Internal group name
4469 * @return string Localized descriptive group name
4471 public static function getGroupName( $group ) {
4472 $msg = wfMessage( "group-$group" );
4473 return $msg->isBlank() ?
$group : $msg->text();
4477 * Get the localized descriptive name for a member of a group, if it exists
4479 * @param string $group Internal group name
4480 * @param string $username Username for gender (since 1.19)
4481 * @return string Localized name for group member
4483 public static function getGroupMember( $group, $username = '#' ) {
4484 $msg = wfMessage( "group-$group-member", $username );
4485 return $msg->isBlank() ?
$group : $msg->text();
4489 * Return the set of defined explicit groups.
4490 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4491 * are not included, as they are defined automatically, not in the database.
4492 * @return array Array of internal group names
4494 public static function getAllGroups() {
4495 global $wgGroupPermissions, $wgRevokePermissions;
4497 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4498 self
::getImplicitGroups()
4503 * Get a list of all available permissions.
4504 * @return string[] Array of permission names
4506 public static function getAllRights() {
4507 if ( self
::$mAllRights === false ) {
4508 global $wgAvailableRights;
4509 if ( count( $wgAvailableRights ) ) {
4510 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
4512 self
::$mAllRights = self
::$mCoreRights;
4514 Hooks
::run( 'UserGetAllRights', array( &self
::$mAllRights ) );
4516 return self
::$mAllRights;
4520 * Get a list of implicit groups
4521 * @return array Array of Strings Array of internal group names
4523 public static function getImplicitGroups() {
4524 global $wgImplicitGroups;
4526 $groups = $wgImplicitGroups;
4527 # Deprecated, use $wgImplicitGroups instead
4528 Hooks
::run( 'UserGetImplicitGroups', array( &$groups ), '1.25' );
4534 * Get the title of a page describing a particular group
4536 * @param string $group Internal group name
4537 * @return Title|bool Title of the page if it exists, false otherwise
4539 public static function getGroupPage( $group ) {
4540 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4541 if ( $msg->exists() ) {
4542 $title = Title
::newFromText( $msg->text() );
4543 if ( is_object( $title ) ) {
4551 * Create a link to the group in HTML, if available;
4552 * else return the group name.
4554 * @param string $group Internal name of the group
4555 * @param string $text The text of the link
4556 * @return string HTML link to the group
4558 public static function makeGroupLinkHTML( $group, $text = '' ) {
4559 if ( $text == '' ) {
4560 $text = self
::getGroupName( $group );
4562 $title = self
::getGroupPage( $group );
4564 return Linker
::link( $title, htmlspecialchars( $text ) );
4566 return htmlspecialchars( $text );
4571 * Create a link to the group in Wikitext, if available;
4572 * else return the group name.
4574 * @param string $group Internal name of the group
4575 * @param string $text The text of the link
4576 * @return string Wikilink to the group
4578 public static function makeGroupLinkWiki( $group, $text = '' ) {
4579 if ( $text == '' ) {
4580 $text = self
::getGroupName( $group );
4582 $title = self
::getGroupPage( $group );
4584 $page = $title->getFullText();
4585 return "[[$page|$text]]";
4592 * Returns an array of the groups that a particular group can add/remove.
4594 * @param string $group The group to check for whether it can add/remove
4595 * @return array Array( 'add' => array( addablegroups ),
4596 * 'remove' => array( removablegroups ),
4597 * 'add-self' => array( addablegroups to self),
4598 * 'remove-self' => array( removable groups from self) )
4600 public static function changeableByGroup( $group ) {
4601 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4605 'remove' => array(),
4606 'add-self' => array(),
4607 'remove-self' => array()
4610 if ( empty( $wgAddGroups[$group] ) ) {
4611 // Don't add anything to $groups
4612 } elseif ( $wgAddGroups[$group] === true ) {
4613 // You get everything
4614 $groups['add'] = self
::getAllGroups();
4615 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4616 $groups['add'] = $wgAddGroups[$group];
4619 // Same thing for remove
4620 if ( empty( $wgRemoveGroups[$group] ) ) {
4622 } elseif ( $wgRemoveGroups[$group] === true ) {
4623 $groups['remove'] = self
::getAllGroups();
4624 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4625 $groups['remove'] = $wgRemoveGroups[$group];
4628 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4629 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4630 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4631 if ( is_int( $key ) ) {
4632 $wgGroupsAddToSelf['user'][] = $value;
4637 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4638 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4639 if ( is_int( $key ) ) {
4640 $wgGroupsRemoveFromSelf['user'][] = $value;
4645 // Now figure out what groups the user can add to him/herself
4646 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4648 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4649 // No idea WHY this would be used, but it's there
4650 $groups['add-self'] = User
::getAllGroups();
4651 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4652 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4655 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4657 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4658 $groups['remove-self'] = User
::getAllGroups();
4659 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4660 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4667 * Returns an array of groups that this user can add and remove
4668 * @return array Array( 'add' => array( addablegroups ),
4669 * 'remove' => array( removablegroups ),
4670 * 'add-self' => array( addablegroups to self),
4671 * 'remove-self' => array( removable groups from self) )
4673 public function changeableGroups() {
4674 if ( $this->isAllowed( 'userrights' ) ) {
4675 // This group gives the right to modify everything (reverse-
4676 // compatibility with old "userrights lets you change
4678 // Using array_merge to make the groups reindexed
4679 $all = array_merge( User
::getAllGroups() );
4683 'add-self' => array(),
4684 'remove-self' => array()
4688 // Okay, it's not so simple, we will have to go through the arrays
4691 'remove' => array(),
4692 'add-self' => array(),
4693 'remove-self' => array()
4695 $addergroups = $this->getEffectiveGroups();
4697 foreach ( $addergroups as $addergroup ) {
4698 $groups = array_merge_recursive(
4699 $groups, $this->changeableByGroup( $addergroup )
4701 $groups['add'] = array_unique( $groups['add'] );
4702 $groups['remove'] = array_unique( $groups['remove'] );
4703 $groups['add-self'] = array_unique( $groups['add-self'] );
4704 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4710 * Increment the user's edit-count field.
4711 * Will have no effect for anonymous users.
4713 public function incEditCount() {
4714 if ( !$this->isAnon() ) {
4715 $dbw = wfGetDB( DB_MASTER
);
4718 array( 'user_editcount=user_editcount+1' ),
4719 array( 'user_id' => $this->getId() ),
4723 // Lazy initialization check...
4724 if ( $dbw->affectedRows() == 0 ) {
4725 // Now here's a goddamn hack...
4726 $dbr = wfGetDB( DB_SLAVE
);
4727 if ( $dbr !== $dbw ) {
4728 // If we actually have a slave server, the count is
4729 // at least one behind because the current transaction
4730 // has not been committed and replicated.
4731 $this->initEditCount( 1 );
4733 // But if DB_SLAVE is selecting the master, then the
4734 // count we just read includes the revision that was
4735 // just added in the working transaction.
4736 $this->initEditCount();
4740 // edit count in user cache too
4741 $this->invalidateCache();
4745 * Initialize user_editcount from data out of the revision table
4747 * @param int $add Edits to add to the count from the revision table
4748 * @return int Number of edits
4750 protected function initEditCount( $add = 0 ) {
4751 // Pull from a slave to be less cruel to servers
4752 // Accuracy isn't the point anyway here
4753 $dbr = wfGetDB( DB_SLAVE
);
4754 $count = (int)$dbr->selectField(
4757 array( 'rev_user' => $this->getId() ),
4760 $count = $count +
$add;
4762 $dbw = wfGetDB( DB_MASTER
);
4765 array( 'user_editcount' => $count ),
4766 array( 'user_id' => $this->getId() ),
4774 * Get the description of a given right
4776 * @param string $right Right to query
4777 * @return string Localized description of the right
4779 public static function getRightDescription( $right ) {
4780 $key = "right-$right";
4781 $msg = wfMessage( $key );
4782 return $msg->isBlank() ?
$right : $msg->text();
4786 * Make a new-style password hash
4788 * @param string $password Plain-text password
4789 * @param bool|string $salt Optional salt, may be random or the user ID.
4790 * If unspecified or false, will generate one automatically
4791 * @return string Password hash
4792 * @deprecated since 1.24, use Password class
4794 public static function crypt( $password, $salt = false ) {
4795 wfDeprecated( __METHOD__
, '1.24' );
4796 $hash = self
::getPasswordFactory()->newFromPlaintext( $password );
4797 return $hash->toString();
4801 * Compare a password hash with a plain-text password. Requires the user
4802 * ID if there's a chance that the hash is an old-style hash.
4804 * @param string $hash Password hash
4805 * @param string $password Plain-text password to compare
4806 * @param string|bool $userId User ID for old-style password salt
4809 * @deprecated since 1.24, use Password class
4811 public static function comparePasswords( $hash, $password, $userId = false ) {
4812 wfDeprecated( __METHOD__
, '1.24' );
4814 // Check for *really* old password hashes that don't even have a type
4815 // The old hash format was just an md5 hex hash, with no type information
4816 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
4817 global $wgPasswordSalt;
4818 if ( $wgPasswordSalt ) {
4819 $password = ":B:{$userId}:{$hash}";
4821 $password = ":A:{$hash}";
4825 $hash = self
::getPasswordFactory()->newFromCiphertext( $hash );
4826 return $hash->equals( $password );
4830 * Add a newuser log entry for this user.
4831 * Before 1.19 the return value was always true.
4833 * @param string|bool $action Account creation type.
4834 * - String, one of the following values:
4835 * - 'create' for an anonymous user creating an account for himself.
4836 * This will force the action's performer to be the created user itself,
4837 * no matter the value of $wgUser
4838 * - 'create2' for a logged in user creating an account for someone else
4839 * - 'byemail' when the created user will receive its password by e-mail
4840 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4841 * - Boolean means whether the account was created by e-mail (deprecated):
4842 * - true will be converted to 'byemail'
4843 * - false will be converted to 'create' if this object is the same as
4844 * $wgUser and to 'create2' otherwise
4846 * @param string $reason User supplied reason
4848 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4850 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4851 global $wgUser, $wgNewUserLog;
4852 if ( empty( $wgNewUserLog ) ) {
4853 return true; // disabled
4856 if ( $action === true ) {
4857 $action = 'byemail';
4858 } elseif ( $action === false ) {
4859 if ( $this->equals( $wgUser ) ) {
4862 $action = 'create2';
4866 if ( $action === 'create' ||
$action === 'autocreate' ) {
4869 $performer = $wgUser;
4872 $logEntry = new ManualLogEntry( 'newusers', $action );
4873 $logEntry->setPerformer( $performer );
4874 $logEntry->setTarget( $this->getUserPage() );
4875 $logEntry->setComment( $reason );
4876 $logEntry->setParameters( array(
4877 '4::userid' => $this->getId(),
4879 $logid = $logEntry->insert();
4881 if ( $action !== 'autocreate' ) {
4882 $logEntry->publish( $logid );
4889 * Add an autocreate newuser log entry for this user
4890 * Used by things like CentralAuth and perhaps other authplugins.
4891 * Consider calling addNewUserLogEntry() directly instead.
4895 public function addNewUserLogEntryAutoCreate() {
4896 $this->addNewUserLogEntry( 'autocreate' );
4902 * Load the user options either from cache, the database or an array
4904 * @param array $data Rows for the current user out of the user_properties table
4906 protected function loadOptions( $data = null ) {
4911 if ( $this->mOptionsLoaded
) {
4915 $this->mOptions
= self
::getDefaultOptions();
4917 if ( !$this->getId() ) {
4918 // For unlogged-in users, load language/variant options from request.
4919 // There's no need to do it for logged-in users: they can set preferences,
4920 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4921 // so don't override user's choice (especially when the user chooses site default).
4922 $variant = $wgContLang->getDefaultVariant();
4923 $this->mOptions
['variant'] = $variant;
4924 $this->mOptions
['language'] = $variant;
4925 $this->mOptionsLoaded
= true;
4929 // Maybe load from the object
4930 if ( !is_null( $this->mOptionOverrides
) ) {
4931 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4932 foreach ( $this->mOptionOverrides
as $key => $value ) {
4933 $this->mOptions
[$key] = $value;
4936 if ( !is_array( $data ) ) {
4937 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4938 // Load from database
4939 $dbr = ( $this->queryFlagsUsed
& self
::READ_LATEST
)
4940 ?
wfGetDB( DB_MASTER
)
4941 : wfGetDB( DB_SLAVE
);
4943 $res = $dbr->select(
4945 array( 'up_property', 'up_value' ),
4946 array( 'up_user' => $this->getId() ),
4950 $this->mOptionOverrides
= array();
4952 foreach ( $res as $row ) {
4953 $data[$row->up_property
] = $row->up_value
;
4956 foreach ( $data as $property => $value ) {
4957 $this->mOptionOverrides
[$property] = $value;
4958 $this->mOptions
[$property] = $value;
4962 $this->mOptionsLoaded
= true;
4964 Hooks
::run( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4968 * Saves the non-default options for this user, as previously set e.g. via
4969 * setOption(), in the database's "user_properties" (preferences) table.
4970 * Usually used via saveSettings().
4972 protected function saveOptions() {
4973 $this->loadOptions();
4975 // Not using getOptions(), to keep hidden preferences in database
4976 $saveOptions = $this->mOptions
;
4978 // Allow hooks to abort, for instance to save to a global profile.
4979 // Reset options to default state before saving.
4980 if ( !Hooks
::run( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4984 $userId = $this->getId();
4986 $insert_rows = array(); // all the new preference rows
4987 foreach ( $saveOptions as $key => $value ) {
4988 // Don't bother storing default values
4989 $defaultOption = self
::getDefaultOption( $key );
4990 if ( ( $defaultOption === null && $value !== false && $value !== null )
4991 ||
$value != $defaultOption
4993 $insert_rows[] = array(
4994 'up_user' => $userId,
4995 'up_property' => $key,
4996 'up_value' => $value,
5001 $dbw = wfGetDB( DB_MASTER
);
5003 $res = $dbw->select( 'user_properties',
5004 array( 'up_property', 'up_value' ), array( 'up_user' => $userId ), __METHOD__
);
5006 // Find prior rows that need to be removed or updated. These rows will
5007 // all be deleted (the later so that INSERT IGNORE applies the new values).
5008 $keysDelete = array();
5009 foreach ( $res as $row ) {
5010 if ( !isset( $saveOptions[$row->up_property
] )
5011 ||
strcmp( $saveOptions[$row->up_property
], $row->up_value
) != 0
5013 $keysDelete[] = $row->up_property
;
5017 if ( count( $keysDelete ) ) {
5018 // Do the DELETE by PRIMARY KEY for prior rows.
5019 // In the past a very large portion of calls to this function are for setting
5020 // 'rememberpassword' for new accounts (a preference that has since been removed).
5021 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5022 // caused gap locks on [max user ID,+infinity) which caused high contention since
5023 // updates would pile up on each other as they are for higher (newer) user IDs.
5024 // It might not be necessary these days, but it shouldn't hurt either.
5025 $dbw->delete( 'user_properties',
5026 array( 'up_user' => $userId, 'up_property' => $keysDelete ), __METHOD__
);
5028 // Insert the new preference rows
5029 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, array( 'IGNORE' ) );
5033 * Lazily instantiate and return a factory object for making passwords
5035 * @return PasswordFactory
5037 public static function getPasswordFactory() {
5038 if ( self
::$mPasswordFactory === null ) {
5039 self
::$mPasswordFactory = new PasswordFactory();
5040 self
::$mPasswordFactory->init( RequestContext
::getMain()->getConfig() );
5043 return self
::$mPasswordFactory;
5047 * Provide an array of HTML5 attributes to put on an input element
5048 * intended for the user to enter a new password. This may include
5049 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5051 * Do *not* use this when asking the user to enter his current password!
5052 * Regardless of configuration, users may have invalid passwords for whatever
5053 * reason (e.g., they were set before requirements were tightened up).
5054 * Only use it when asking for a new password, like on account creation or
5057 * Obviously, you still need to do server-side checking.
5059 * NOTE: A combination of bugs in various browsers means that this function
5060 * actually just returns array() unconditionally at the moment. May as
5061 * well keep it around for when the browser bugs get fixed, though.
5063 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5065 * @return array Array of HTML attributes suitable for feeding to
5066 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5067 * That will get confused by the boolean attribute syntax used.)
5069 public static function passwordChangeInputAttribs() {
5070 global $wgMinimalPasswordLength;
5072 if ( $wgMinimalPasswordLength == 0 ) {
5076 # Note that the pattern requirement will always be satisfied if the
5077 # input is empty, so we need required in all cases.
5079 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5080 # if e-mail confirmation is being used. Since HTML5 input validation
5081 # is b0rked anyway in some browsers, just return nothing. When it's
5082 # re-enabled, fix this code to not output required for e-mail
5084 #$ret = array( 'required' );
5087 # We can't actually do this right now, because Opera 9.6 will print out
5088 # the entered password visibly in its error message! When other
5089 # browsers add support for this attribute, or Opera fixes its support,
5090 # we can add support with a version check to avoid doing this on Opera
5091 # versions where it will be a problem. Reported to Opera as
5092 # DSK-262266, but they don't have a public bug tracker for us to follow.
5094 if ( $wgMinimalPasswordLength > 1 ) {
5095 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5096 $ret['title'] = wfMessage( 'passwordtooshort' )
5097 ->numParams( $wgMinimalPasswordLength )->text();
5105 * Return the list of user fields that should be selected to create
5106 * a new user object.
5109 public static function selectFields() {
5117 'user_email_authenticated',
5119 'user_email_token_expires',
5120 'user_registration',
5126 * Factory function for fatal permission-denied errors
5129 * @param string $permission User right required
5132 static function newFatalPermissionDeniedStatus( $permission ) {
5135 $groups = array_map(
5136 array( 'User', 'makeGroupLinkWiki' ),
5137 User
::getGroupsWithPermission( $permission )
5141 return Status
::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5143 return Status
::newFatal( 'badaccess-group0' );
5148 * Checks if two user objects point to the same user.
5154 public function equals( User
$user ) {
5155 return $this->getName() === $user->getName();