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 * Int Number of characters in user_token field.
27 define( 'USER_TOKEN_LENGTH', 32 );
30 * Int Serialized record version.
33 define( 'MW_USER_VERSION', 8 );
36 * String Some punctuation to prevent editing from broken text-mangling proxies.
39 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
42 * Thrown by User::setPassword() on error.
45 class PasswordError
extends MWException
{
50 * The User object encapsulates all of the user-specific settings (user_id,
51 * name, rights, password, email address, options, last login time). Client
52 * classes use the getXXX() functions to access these fields. These functions
53 * do all the work of determining whether the user is logged in,
54 * whether the requested option can be satisfied from cookies or
55 * whether a database query is needed. Most of the settings needed
56 * for rendering normal pages are set in the cookie to minimize use
61 * Global constants made accessible as class constants so that autoloader
64 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
65 const MW_USER_VERSION
= MW_USER_VERSION
;
66 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
69 * Maximum items in $mWatchedItems
71 const MAX_WATCHED_ITEMS_CACHE
= 100;
74 * Array of Strings List of member variables which are saved to the
75 * shared cache (memcached). Any operation which changes the
76 * corresponding database fields must call a cache-clearing function.
79 static $mCacheVars = array(
90 'mEmailAuthenticated',
97 // user_properties table
102 * Array of Strings Core rights.
103 * Each of these should have a corresponding message of the form
107 static $mCoreRights = array(
127 'editusercssjs', #deprecated
139 'move-rootuserpages',
143 'override-export-depth',
166 'userrights-interwiki',
170 * String Cached results of getAllRights()
172 static $mAllRights = false;
174 /** @name Cache variables */
176 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
177 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
178 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
179 $mGroups, $mOptionOverrides;
183 * Bool Whether the cache variables have been loaded.
189 * Array with already loaded items or true if all items have been loaded.
191 private $mLoadedItems = array();
195 * String Initialization data source if mLoadedItems!==true. May be one of:
196 * - 'defaults' anonymous user initialised from class defaults
197 * - 'name' initialise from mName
198 * - 'id' initialise from mId
199 * - 'session' log in from cookies or session if possible
201 * Use the User::newFrom*() family of functions to set this.
206 * Lazy-initialized variables, invalidated with clearInstanceCache
208 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
209 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
210 $mLocked, $mHideName, $mOptions;
230 private $mBlockedFromCreateAccount = false;
235 private $mWatchedItems = array();
237 static $idCacheByName = array();
240 * Lightweight constructor for an anonymous user.
241 * Use the User::newFrom* factory functions for other kinds of users.
245 * @see newFromConfirmationCode()
246 * @see newFromSession()
249 function __construct() {
250 $this->clearInstanceCache( 'defaults' );
256 function __toString() {
257 return $this->getName();
261 * Load the user table data for this object from the source given by mFrom.
263 public function load() {
264 if ( $this->mLoadedItems
=== true ) {
267 wfProfileIn( __METHOD__
);
269 # Set it now to avoid infinite recursion in accessors
270 $this->mLoadedItems
= true;
272 switch ( $this->mFrom
) {
274 $this->loadDefaults();
277 $this->mId
= self
::idFromName( $this->mName
);
279 # Nonexistent user placeholder object
280 $this->loadDefaults( $this->mName
);
289 if ( !$this->loadFromSession() ) {
290 // Loading from session failed. Load defaults.
291 $this->loadDefaults();
293 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
296 wfProfileOut( __METHOD__
);
297 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
299 wfProfileOut( __METHOD__
);
303 * Load user table data, given mId has already been set.
304 * @return Bool false if the ID does not exist, true otherwise
306 public function loadFromId() {
308 if ( $this->mId
== 0 ) {
309 $this->loadDefaults();
314 $key = wfMemcKey( 'user', 'id', $this->mId
);
315 $data = $wgMemc->get( $key );
316 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
317 # Object is expired, load from DB
322 wfDebug( "User: cache miss for user {$this->mId}\n" );
324 if ( !$this->loadFromDatabase() ) {
325 # Can't load from ID, user is anonymous
328 $this->saveToCache();
330 wfDebug( "User: got user {$this->mId} from cache\n" );
332 foreach ( self
::$mCacheVars as $name ) {
333 $this->$name = $data[$name];
337 $this->mLoadedItems
= true;
343 * Save user data to the shared cache
345 public function saveToCache() {
348 $this->loadOptions();
349 if ( $this->isAnon() ) {
350 // Anonymous users are uncached
354 foreach ( self
::$mCacheVars as $name ) {
355 $data[$name] = $this->$name;
357 $data['mVersion'] = MW_USER_VERSION
;
358 $key = wfMemcKey( 'user', 'id', $this->mId
);
360 $wgMemc->set( $key, $data );
363 /** @name newFrom*() static factory methods */
367 * Static factory method for creation from username.
369 * This is slightly less efficient than newFromId(), so use newFromId() if
370 * you have both an ID and a name handy.
372 * @param string $name Username, validated by Title::newFromText()
373 * @param string|Bool $validate Validate username. Takes the same parameters as
374 * User::getCanonicalName(), except that true is accepted as an alias
375 * for 'valid', for BC.
377 * @return User|bool User object, or false if the username is invalid
378 * (e.g. if it contains illegal characters or is an IP address). If the
379 * username is not present in the database, the result will be a user object
380 * with a name, zero user ID and default settings.
382 public static function newFromName( $name, $validate = 'valid' ) {
383 if ( $validate === true ) {
386 $name = self
::getCanonicalName( $name, $validate );
387 if ( $name === false ) {
390 # Create unloaded user object
394 $u->setItemLoaded( 'name' );
400 * Static factory method for creation from a given user ID.
402 * @param int $id Valid user ID
403 * @return User The corresponding User object
405 public static function newFromId( $id ) {
409 $u->setItemLoaded( 'id' );
414 * Factory method to fetch whichever user has a given email confirmation code.
415 * This code is generated when an account is created or its e-mail address
418 * If the code is invalid or has expired, returns NULL.
420 * @param string $code Confirmation code
421 * @return User object, or null
423 public static function newFromConfirmationCode( $code ) {
424 $dbr = wfGetDB( DB_SLAVE
);
425 $id = $dbr->selectField( 'user', 'user_id', array(
426 'user_email_token' => md5( $code ),
427 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
429 if ( $id !== false ) {
430 return User
::newFromId( $id );
437 * Create a new user object using data from session or cookies. If the
438 * login credentials are invalid, the result is an anonymous user.
440 * @param $request WebRequest object to use; $wgRequest will be used if omitted.
441 * @return User object
443 public static function newFromSession( WebRequest
$request = null ) {
445 $user->mFrom
= 'session';
446 $user->mRequest
= $request;
451 * Create a new user object from a user row.
452 * The row should have the following fields from the user table in it:
453 * - either user_name or user_id to load further data if needed (or both)
455 * - all other fields (email, password, etc.)
456 * It is useless to provide the remaining fields if either user_id,
457 * user_name and user_real_name are not provided because the whole row
458 * will be loaded once more from the database when accessing them.
460 * @param array $row A row from the user table
461 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
464 public static function newFromRow( $row, $data = null ) {
466 $user->loadFromRow( $row, $data );
473 * Get the username corresponding to a given user ID
474 * @param int $id User ID
475 * @return String|bool The corresponding username
477 public static function whoIs( $id ) {
478 return UserCache
::singleton()->getProp( $id, 'name' );
482 * Get the real name of a user given their user ID
484 * @param int $id User ID
485 * @return String|bool The corresponding user's real name
487 public static function whoIsReal( $id ) {
488 return UserCache
::singleton()->getProp( $id, 'real_name' );
492 * Get database id given a user name
493 * @param string $name Username
494 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
496 public static function idFromName( $name ) {
497 $nt = Title
::makeTitleSafe( NS_USER
, $name );
498 if ( is_null( $nt ) ) {
503 if ( isset( self
::$idCacheByName[$name] ) ) {
504 return self
::$idCacheByName[$name];
507 $dbr = wfGetDB( DB_SLAVE
);
508 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
510 if ( $s === false ) {
513 $result = $s->user_id
;
516 self
::$idCacheByName[$name] = $result;
518 if ( count( self
::$idCacheByName ) > 1000 ) {
519 self
::$idCacheByName = array();
526 * Reset the cache used in idFromName(). For use in tests.
528 public static function resetIdByNameCache() {
529 self
::$idCacheByName = array();
533 * Does the string match an anonymous IPv4 address?
535 * This function exists for username validation, in order to reject
536 * usernames which are similar in form to IP addresses. Strings such
537 * as 300.300.300.300 will return true because it looks like an IP
538 * address, despite not being strictly valid.
540 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
541 * address because the usemod software would "cloak" anonymous IP
542 * addresses like this, if we allowed accounts like this to be created
543 * new users could get the old edits of these anonymous users.
545 * @param string $name to match
548 public static function isIP( $name ) {
549 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name ) || IP
::isIPv6( $name );
553 * Is the input a valid username?
555 * Checks if the input is a valid username, we don't want an empty string,
556 * an IP address, anything that contains slashes (would mess up subpages),
557 * is longer than the maximum allowed username size or doesn't begin with
560 * @param string $name to match
563 public static function isValidUserName( $name ) {
564 global $wgContLang, $wgMaxNameChars;
567 || User
::isIP( $name )
568 ||
strpos( $name, '/' ) !== false
569 ||
strlen( $name ) > $wgMaxNameChars
570 ||
$name != $wgContLang->ucfirst( $name ) ) {
571 wfDebugLog( 'username', __METHOD__
.
572 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
576 // Ensure that the name can't be misresolved as a different title,
577 // such as with extra namespace keys at the start.
578 $parsed = Title
::newFromText( $name );
579 if ( is_null( $parsed )
580 ||
$parsed->getNamespace()
581 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
582 wfDebugLog( 'username', __METHOD__
.
583 ": '$name' invalid due to ambiguous prefixes" );
587 // Check an additional blacklist of troublemaker characters.
588 // Should these be merged into the title char list?
589 $unicodeBlacklist = '/[' .
590 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
591 '\x{00a0}' . # non-breaking space
592 '\x{2000}-\x{200f}' . # various whitespace
593 '\x{2028}-\x{202f}' . # breaks and control chars
594 '\x{3000}' . # ideographic space
595 '\x{e000}-\x{f8ff}' . # private use
597 if ( preg_match( $unicodeBlacklist, $name ) ) {
598 wfDebugLog( 'username', __METHOD__
.
599 ": '$name' invalid due to blacklisted characters" );
607 * Usernames which fail to pass this function will be blocked
608 * from user login and new account registrations, but may be used
609 * internally by batch processes.
611 * If an account already exists in this form, login will be blocked
612 * by a failure to pass this function.
614 * @param string $name to match
617 public static function isUsableName( $name ) {
618 global $wgReservedUsernames;
619 // Must be a valid username, obviously ;)
620 if ( !self
::isValidUserName( $name ) ) {
624 static $reservedUsernames = false;
625 if ( !$reservedUsernames ) {
626 $reservedUsernames = $wgReservedUsernames;
627 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
630 // Certain names may be reserved for batch processes.
631 foreach ( $reservedUsernames as $reserved ) {
632 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
633 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
635 if ( $reserved == $name ) {
643 * Usernames which fail to pass this function will be blocked
644 * from new account registrations, but may be used internally
645 * either by batch processes or by user accounts which have
646 * already been created.
648 * Additional blacklisting may be added here rather than in
649 * isValidUserName() to avoid disrupting existing accounts.
651 * @param string $name to match
654 public static function isCreatableName( $name ) {
655 global $wgInvalidUsernameCharacters;
657 // Ensure that the username isn't longer than 235 bytes, so that
658 // (at least for the builtin skins) user javascript and css files
659 // will work. (bug 23080)
660 if ( strlen( $name ) > 235 ) {
661 wfDebugLog( 'username', __METHOD__
.
662 ": '$name' invalid due to length" );
666 // Preg yells if you try to give it an empty string
667 if ( $wgInvalidUsernameCharacters !== '' ) {
668 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
669 wfDebugLog( 'username', __METHOD__
.
670 ": '$name' invalid due to wgInvalidUsernameCharacters" );
675 return self
::isUsableName( $name );
679 * Is the input a valid password for this user?
681 * @param string $password Desired password
684 public function isValidPassword( $password ) {
685 //simple boolean wrapper for getPasswordValidity
686 return $this->getPasswordValidity( $password ) === true;
690 * Given unvalidated password input, return error message on failure.
692 * @param string $password Desired password
693 * @return mixed: true on success, string or array of error message on failure
695 public function getPasswordValidity( $password ) {
696 global $wgMinimalPasswordLength, $wgContLang;
698 static $blockedLogins = array(
699 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
700 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
703 $result = false; //init $result to false for the internal checks
705 if ( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) ) {
709 if ( $result === false ) {
710 if ( strlen( $password ) < $wgMinimalPasswordLength ) {
711 return 'passwordtooshort';
712 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
713 return 'password-name-match';
714 } elseif ( isset( $blockedLogins[$this->getName()] ) && $password == $blockedLogins[$this->getName()] ) {
715 return 'password-login-forbidden';
717 //it seems weird returning true here, but this is because of the
718 //initialization of $result to false above. If the hook is never run or it
719 //doesn't modify $result, then we will likely get down into this if with
723 } elseif ( $result === true ) {
726 return $result; //the isValidPassword hook set a string $result and returned true
731 * Does a string look like an e-mail address?
733 * This validates an email address using an HTML5 specification found at:
734 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
735 * Which as of 2011-01-24 says:
737 * A valid e-mail address is a string that matches the ABNF production
738 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
739 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
742 * This function is an implementation of the specification as requested in
745 * Client-side forms will use the same standard validation rules via JS or
746 * HTML 5 validation; additional restrictions can be enforced server-side
747 * by extensions via the 'isValidEmailAddr' hook.
749 * Note that this validation doesn't 100% match RFC 2822, but is believed
750 * to be liberal enough for wide use. Some invalid addresses will still
751 * pass validation here.
753 * @param string $addr E-mail address
755 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
757 public static function isValidEmailAddr( $addr ) {
758 wfDeprecated( __METHOD__
, '1.18' );
759 return Sanitizer
::validateEmail( $addr );
763 * Given unvalidated user input, return a canonical username, or false if
764 * the username is invalid.
765 * @param string $name User input
766 * @param string|Bool $validate type of validation to use:
767 * - false No validation
768 * - 'valid' Valid for batch processes
769 * - 'usable' Valid for batch processes and login
770 * - 'creatable' Valid for batch processes, login and account creation
772 * @throws MWException
773 * @return bool|string
775 public static function getCanonicalName( $name, $validate = 'valid' ) {
776 # Force usernames to capital
778 $name = $wgContLang->ucfirst( $name );
780 # Reject names containing '#'; these will be cleaned up
781 # with title normalisation, but then it's too late to
783 if ( strpos( $name, '#' ) !== false ) {
787 # Clean up name according to title rules
788 $t = ( $validate === 'valid' ) ?
789 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
790 # Check for invalid titles
791 if ( is_null( $t ) ) {
795 # Reject various classes of invalid names
797 $name = $wgAuth->getCanonicalName( $t->getText() );
799 switch ( $validate ) {
803 if ( !User
::isValidUserName( $name ) ) {
808 if ( !User
::isUsableName( $name ) ) {
813 if ( !User
::isCreatableName( $name ) ) {
818 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
824 * Count the number of edits of a user
826 * @param int $uid User ID to check
827 * @return Int the user's edit count
829 * @deprecated since 1.21 in favour of User::getEditCount
831 public static function edits( $uid ) {
832 wfDeprecated( __METHOD__
, '1.21' );
833 $user = self
::newFromId( $uid );
834 return $user->getEditCount();
838 * Return a random password.
840 * @return String new random password
842 public static function randomPassword() {
843 global $wgMinimalPasswordLength;
844 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
845 $length = max( 10, $wgMinimalPasswordLength );
846 // Multiply by 1.25 to get the number of hex characters we need
847 $length = $length * 1.25;
848 // Generate random hex chars
849 $hex = MWCryptRand
::generateHex( $length );
850 // Convert from base 16 to base 32 to get a proper password like string
851 return wfBaseConvert( $hex, 16, 32 );
855 * Set cached properties to default.
857 * @note This no longer clears uncached lazy-initialised properties;
858 * the constructor does that instead.
860 * @param $name string|bool
862 public function loadDefaults( $name = false ) {
863 wfProfileIn( __METHOD__
);
866 $this->mName
= $name;
867 $this->mRealName
= '';
868 $this->mPassword
= $this->mNewpassword
= '';
869 $this->mNewpassTime
= null;
871 $this->mOptionOverrides
= null;
872 $this->mOptionsLoaded
= false;
874 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
875 if ( $loggedOut !== null ) {
876 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
878 $this->mTouched
= '1'; # Allow any pages to be cached
881 $this->mToken
= null; // Don't run cryptographic functions till we need a token
882 $this->mEmailAuthenticated
= null;
883 $this->mEmailToken
= '';
884 $this->mEmailTokenExpires
= null;
885 $this->mRegistration
= wfTimestamp( TS_MW
);
886 $this->mGroups
= array();
888 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
890 wfProfileOut( __METHOD__
);
894 * Return whether an item has been loaded.
896 * @param string $item item to check. Current possibilities:
900 * @param string $all 'all' to check if the whole object has been loaded
901 * or any other string to check if only the item is available (e.g.
905 public function isItemLoaded( $item, $all = 'all' ) {
906 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
907 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
911 * Set that an item has been loaded
913 * @param $item String
915 protected function setItemLoaded( $item ) {
916 if ( is_array( $this->mLoadedItems
) ) {
917 $this->mLoadedItems
[$item] = true;
922 * Load user data from the session or login cookie.
923 * @return Bool True if the user is logged in, false otherwise.
925 private function loadFromSession() {
927 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
928 if ( $result !== null ) {
932 $request = $this->getRequest();
934 $cookieId = $request->getCookie( 'UserID' );
935 $sessId = $request->getSessionData( 'wsUserID' );
937 if ( $cookieId !== null ) {
938 $sId = intval( $cookieId );
939 if ( $sessId !== null && $cookieId != $sessId ) {
940 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
941 cookie user ID ($sId) don't match!" );
944 $request->setSessionData( 'wsUserID', $sId );
945 } elseif ( $sessId !== null && $sessId != 0 ) {
951 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
952 $sName = $request->getSessionData( 'wsUserName' );
953 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
954 $sName = $request->getCookie( 'UserName' );
955 $request->setSessionData( 'wsUserName', $sName );
960 $proposedUser = User
::newFromId( $sId );
961 if ( !$proposedUser->isLoggedIn() ) {
966 global $wgBlockDisablesLogin;
967 if ( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
968 # User blocked and we've disabled blocked user logins
972 if ( $request->getSessionData( 'wsToken' ) ) {
973 $passwordCorrect = ( $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ) );
975 } elseif ( $request->getCookie( 'Token' ) ) {
976 # Get the token from DB/cache and clean it up to remove garbage padding.
977 # This deals with historical problems with bugs and the default column value.
978 $token = rtrim( $proposedUser->getToken( false ) ); // correct token
979 $passwordCorrect = ( strlen( $token ) && $token === $request->getCookie( 'Token' ) );
982 # No session or persistent login cookie
986 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
987 $this->loadFromUserObject( $proposedUser );
988 $request->setSessionData( 'wsToken', $this->mToken
);
989 wfDebug( "User: logged in from $from\n" );
992 # Invalid credentials
993 wfDebug( "User: can't log in from $from, invalid credentials\n" );
999 * Load user and user_group data from the database.
1000 * $this->mId must be set, this is how the user is identified.
1002 * @return Bool True if the user exists, false if the user is anonymous
1004 public function loadFromDatabase() {
1006 $this->mId
= intval( $this->mId
);
1008 /** Anonymous user */
1009 if ( !$this->mId
) {
1010 $this->loadDefaults();
1014 $dbr = wfGetDB( DB_MASTER
);
1015 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1017 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1019 if ( $s !== false ) {
1020 # Initialise user table data
1021 $this->loadFromRow( $s );
1022 $this->mGroups
= null; // deferred
1023 $this->getEditCount(); // revalidation for nulls
1028 $this->loadDefaults();
1034 * Initialize this object from a row from the user table.
1036 * @param array $row Row from the user table to load.
1037 * @param array $data Further user data to load into the object
1039 * user_groups Array with groups out of the user_groups table
1040 * user_properties Array with properties out of the user_properties table
1042 public function loadFromRow( $row, $data = null ) {
1045 $this->mGroups
= null; // deferred
1047 if ( isset( $row->user_name
) ) {
1048 $this->mName
= $row->user_name
;
1049 $this->mFrom
= 'name';
1050 $this->setItemLoaded( 'name' );
1055 if ( isset( $row->user_real_name
) ) {
1056 $this->mRealName
= $row->user_real_name
;
1057 $this->setItemLoaded( 'realname' );
1062 if ( isset( $row->user_id
) ) {
1063 $this->mId
= intval( $row->user_id
);
1064 $this->mFrom
= 'id';
1065 $this->setItemLoaded( 'id' );
1070 if ( isset( $row->user_editcount
) ) {
1071 $this->mEditCount
= $row->user_editcount
;
1076 if ( isset( $row->user_password
) ) {
1077 $this->mPassword
= $row->user_password
;
1078 $this->mNewpassword
= $row->user_newpassword
;
1079 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1080 $this->mEmail
= $row->user_email
;
1081 if ( isset( $row->user_options
) ) {
1082 $this->decodeOptions( $row->user_options
);
1084 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1085 $this->mToken
= $row->user_token
;
1086 if ( $this->mToken
== '' ) {
1087 $this->mToken
= null;
1089 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1090 $this->mEmailToken
= $row->user_email_token
;
1091 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1092 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1098 $this->mLoadedItems
= true;
1101 if ( is_array( $data ) ) {
1102 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1103 $this->mGroups
= $data['user_groups'];
1105 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1106 $this->loadOptions( $data['user_properties'] );
1112 * Load the data for this user object from another user object.
1116 protected function loadFromUserObject( $user ) {
1118 $user->loadGroups();
1119 $user->loadOptions();
1120 foreach ( self
::$mCacheVars as $var ) {
1121 $this->$var = $user->$var;
1126 * Load the groups from the database if they aren't already loaded.
1128 private function loadGroups() {
1129 if ( is_null( $this->mGroups
) ) {
1130 $dbr = wfGetDB( DB_MASTER
);
1131 $res = $dbr->select( 'user_groups',
1132 array( 'ug_group' ),
1133 array( 'ug_user' => $this->mId
),
1135 $this->mGroups
= array();
1136 foreach ( $res as $row ) {
1137 $this->mGroups
[] = $row->ug_group
;
1143 * Add the user to the group if he/she meets given criteria.
1145 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1146 * possible to remove manually via Special:UserRights. In such case it
1147 * will not be re-added automatically. The user will also not lose the
1148 * group if they no longer meet the criteria.
1150 * @param string $event key in $wgAutopromoteOnce (each one has groups/criteria)
1152 * @return array Array of groups the user has been promoted to.
1154 * @see $wgAutopromoteOnce
1156 public function addAutopromoteOnceGroups( $event ) {
1157 global $wgAutopromoteOnceLogInRC;
1159 $toPromote = array();
1160 if ( $this->getId() ) {
1161 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1162 if ( count( $toPromote ) ) {
1163 $oldGroups = $this->getGroups(); // previous groups
1164 foreach ( $toPromote as $group ) {
1165 $this->addGroup( $group );
1167 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1169 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1170 $logEntry->setPerformer( $this );
1171 $logEntry->setTarget( $this->getUserPage() );
1172 $logEntry->setParameters( array(
1173 '4::oldgroups' => $oldGroups,
1174 '5::newgroups' => $newGroups,
1176 $logid = $logEntry->insert();
1177 if ( $wgAutopromoteOnceLogInRC ) {
1178 $logEntry->publish( $logid );
1186 * Clear various cached data stored in this object. The cache of the user table
1187 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1189 * @param bool|String $reloadFrom Reload user and user_groups table data from a
1190 * given source. May be "name", "id", "defaults", "session", or false for
1193 public function clearInstanceCache( $reloadFrom = false ) {
1194 $this->mNewtalk
= -1;
1195 $this->mDatePreference
= null;
1196 $this->mBlockedby
= -1; # Unset
1197 $this->mHash
= false;
1198 $this->mRights
= null;
1199 $this->mEffectiveGroups
= null;
1200 $this->mImplicitGroups
= null;
1201 $this->mGroups
= null;
1202 $this->mOptions
= null;
1203 $this->mOptionsLoaded
= false;
1204 $this->mEditCount
= null;
1206 if ( $reloadFrom ) {
1207 $this->mLoadedItems
= array();
1208 $this->mFrom
= $reloadFrom;
1213 * Combine the language default options with any site-specific options
1214 * and add the default language variants.
1216 * @return Array of String options
1218 public static function getDefaultOptions() {
1219 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1221 static $defOpt = null;
1222 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1223 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1224 // mid-request and see that change reflected in the return value of this function.
1225 // Which is insane and would never happen during normal MW operation
1229 $defOpt = $wgDefaultUserOptions;
1230 # default language setting
1231 $defOpt['language'] = $defOpt['variant'] = $wgContLang->getCode();
1232 foreach ( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1233 $defOpt['searchNs' . $nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1235 $defOpt['skin'] = $wgDefaultSkin;
1237 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1243 * Get a given default option value.
1245 * @param string $opt Name of option to retrieve
1246 * @return String Default option value
1248 public static function getDefaultOption( $opt ) {
1249 $defOpts = self
::getDefaultOptions();
1250 if ( isset( $defOpts[$opt] ) ) {
1251 return $defOpts[$opt];
1258 * Get blocking information
1259 * @param bool $bFromSlave Whether to check the slave database first. To
1260 * improve performance, non-critical checks are done
1261 * against slaves. Check when actually saving should be
1262 * done against master.
1264 private function getBlockedStatus( $bFromSlave = true ) {
1265 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1267 if ( -1 != $this->mBlockedby
) {
1271 wfProfileIn( __METHOD__
);
1272 wfDebug( __METHOD__
. ": checking...\n" );
1274 // Initialize data...
1275 // Otherwise something ends up stomping on $this->mBlockedby when
1276 // things get lazy-loaded later, causing false positive block hits
1277 // due to -1 !== 0. Probably session-related... Nothing should be
1278 // overwriting mBlockedby, surely?
1281 # We only need to worry about passing the IP address to the Block generator if the
1282 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1283 # know which IP address they're actually coming from
1284 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1285 $ip = $this->getRequest()->getIP();
1291 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1294 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1295 && !in_array( $ip, $wgProxyWhitelist ) )
1298 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1300 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1301 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1302 $block->setTarget( $ip );
1303 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1305 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1306 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1307 $block->setTarget( $ip );
1311 # (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1312 if ( !$block instanceof Block
1313 && $wgApplyIpBlocksToXff
1315 && !$this->isAllowed( 'proxyunbannable' )
1316 && !in_array( $ip, $wgProxyWhitelist )
1318 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1319 $xff = array_map( 'trim', explode( ',', $xff ) );
1320 $xff = array_diff( $xff, array( $ip ) );
1321 $xffblocks = Block
::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1322 $block = Block
::chooseBlock( $xffblocks, $xff );
1323 if ( $block instanceof Block
) {
1324 # Mangle the reason to alert the user that the block
1325 # originated from matching the X-Forwarded-For header.
1326 $block->mReason
= wfMessage( 'xffblockreason', $block->mReason
)->text();
1330 if ( $block instanceof Block
) {
1331 wfDebug( __METHOD__
. ": Found block.\n" );
1332 $this->mBlock
= $block;
1333 $this->mBlockedby
= $block->getByName();
1334 $this->mBlockreason
= $block->mReason
;
1335 $this->mHideName
= $block->mHideName
;
1336 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1338 $this->mBlockedby
= '';
1339 $this->mHideName
= 0;
1340 $this->mAllowUsertalk
= false;
1344 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1346 wfProfileOut( __METHOD__
);
1350 * Whether the given IP is in a DNS blacklist.
1352 * @param string $ip IP to check
1353 * @param bool $checkWhitelist whether to check the whitelist first
1354 * @return Bool True if blacklisted.
1356 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1357 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1358 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1360 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs ) {
1364 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1368 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1369 return $this->inDnsBlacklist( $ip, $urls );
1373 * Whether the given IP is in a given DNS blacklist.
1375 * @param string $ip IP to check
1376 * @param string|array $bases of Strings: URL of the DNS blacklist
1377 * @return Bool True if blacklisted.
1379 public function inDnsBlacklist( $ip, $bases ) {
1380 wfProfileIn( __METHOD__
);
1383 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1384 if ( IP
::isIPv4( $ip ) ) {
1385 # Reverse IP, bug 21255
1386 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1388 foreach ( (array)$bases as $base ) {
1390 # If we have an access key, use that too (ProjectHoneypot, etc.)
1391 if ( is_array( $base ) ) {
1392 if ( count( $base ) >= 2 ) {
1393 # Access key is 1, base URL is 0
1394 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1396 $host = "$ipReversed.{$base[0]}";
1399 $host = "$ipReversed.$base";
1403 $ipList = gethostbynamel( $host );
1406 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1410 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1415 wfProfileOut( __METHOD__
);
1420 * Check if an IP address is in the local proxy list
1426 public static function isLocallyBlockedProxy( $ip ) {
1427 global $wgProxyList;
1429 if ( !$wgProxyList ) {
1432 wfProfileIn( __METHOD__
);
1434 if ( !is_array( $wgProxyList ) ) {
1435 # Load from the specified file
1436 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1439 if ( !is_array( $wgProxyList ) ) {
1441 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1443 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1444 # Old-style flipped proxy list
1449 wfProfileOut( __METHOD__
);
1454 * Is this user subject to rate limiting?
1456 * @return Bool True if rate limited
1458 public function isPingLimitable() {
1459 global $wgRateLimitsExcludedIPs;
1460 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1461 // No other good way currently to disable rate limits
1462 // for specific IPs. :P
1463 // But this is a crappy hack and should die.
1466 return !$this->isAllowed( 'noratelimit' );
1470 * Primitive rate limits: enforce maximum actions per time period
1471 * to put a brake on flooding.
1473 * @note When using a shared cache like memcached, IP-address
1474 * last-hit counters will be shared across wikis.
1476 * @param string $action Action to enforce; 'edit' if unspecified
1477 * @return Bool True if a rate limiter was tripped
1479 public function pingLimiter( $action = 'edit' ) {
1480 # Call the 'PingLimiter' hook
1482 if ( !wfRunHooks( 'PingLimiter', array( &$this, $action, &$result ) ) ) {
1486 global $wgRateLimits;
1487 if ( !isset( $wgRateLimits[$action] ) ) {
1491 # Some groups shouldn't trigger the ping limiter, ever
1492 if ( !$this->isPingLimitable() ) {
1496 global $wgMemc, $wgRateLimitLog;
1497 wfProfileIn( __METHOD__
);
1499 $limits = $wgRateLimits[$action];
1501 $id = $this->getId();
1504 if ( isset( $limits['anon'] ) && $id == 0 ) {
1505 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1508 if ( isset( $limits['user'] ) && $id != 0 ) {
1509 $userLimit = $limits['user'];
1511 if ( $this->isNewbie() ) {
1512 if ( isset( $limits['newbie'] ) && $id != 0 ) {
1513 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1515 if ( isset( $limits['ip'] ) ) {
1516 $ip = $this->getRequest()->getIP();
1517 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1519 if ( isset( $limits['subnet'] ) ) {
1520 $ip = $this->getRequest()->getIP();
1523 if ( IP
::isIPv6( $ip ) ) {
1524 $parts = IP
::parseRange( "$ip/64" );
1525 $subnet = $parts[0];
1526 } elseif ( preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1528 $subnet = $matches[1];
1530 if ( $subnet !== false ) {
1531 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1535 // Check for group-specific permissions
1536 // If more than one group applies, use the group with the highest limit
1537 foreach ( $this->getGroups() as $group ) {
1538 if ( isset( $limits[$group] ) ) {
1539 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1540 $userLimit = $limits[$group];
1544 // Set the user limit key
1545 if ( $userLimit !== false ) {
1546 list( $max, $period ) = $userLimit;
1547 wfDebug( __METHOD__
. ": effective user limit: $max in {$period}s\n" );
1548 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1552 foreach ( $keys as $key => $limit ) {
1553 list( $max, $period ) = $limit;
1554 $summary = "(limit $max in {$period}s)";
1555 $count = $wgMemc->get( $key );
1558 if ( $count >= $max ) {
1559 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1560 if ( $wgRateLimitLog ) {
1561 wfSuppressWarnings();
1562 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1563 wfRestoreWarnings();
1567 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1570 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1571 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1573 $wgMemc->incr( $key );
1576 wfProfileOut( __METHOD__
);
1581 * Check if user is blocked
1583 * @param bool $bFromSlave Whether to check the slave database instead of the master
1584 * @return Bool True if blocked, false otherwise
1586 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1587 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1591 * Get the block affecting the user, or null if the user is not blocked
1593 * @param bool $bFromSlave Whether to check the slave database instead of the master
1594 * @return Block|null
1596 public function getBlock( $bFromSlave = true ) {
1597 $this->getBlockedStatus( $bFromSlave );
1598 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1602 * Check if user is blocked from editing a particular article
1604 * @param $title Title to check
1605 * @param bool $bFromSlave whether to check the slave database instead of the master
1608 function isBlockedFrom( $title, $bFromSlave = false ) {
1609 global $wgBlockAllowsUTEdit;
1610 wfProfileIn( __METHOD__
);
1612 $blocked = $this->isBlocked( $bFromSlave );
1613 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1614 # If a user's name is suppressed, they cannot make edits anywhere
1615 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1616 $title->getNamespace() == NS_USER_TALK
) {
1618 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1621 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1623 wfProfileOut( __METHOD__
);
1628 * If user is blocked, return the name of the user who placed the block
1629 * @return String name of blocker
1631 public function blockedBy() {
1632 $this->getBlockedStatus();
1633 return $this->mBlockedby
;
1637 * If user is blocked, return the specified reason for the block
1638 * @return String Blocking reason
1640 public function blockedFor() {
1641 $this->getBlockedStatus();
1642 return $this->mBlockreason
;
1646 * If user is blocked, return the ID for the block
1647 * @return Int Block ID
1649 public function getBlockId() {
1650 $this->getBlockedStatus();
1651 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1655 * Check if user is blocked on all wikis.
1656 * Do not use for actual edit permission checks!
1657 * This is intended for quick UI checks.
1659 * @param string $ip IP address, uses current client if none given
1660 * @return Bool True if blocked, false otherwise
1662 public function isBlockedGlobally( $ip = '' ) {
1663 if ( $this->mBlockedGlobally
!== null ) {
1664 return $this->mBlockedGlobally
;
1666 // User is already an IP?
1667 if ( IP
::isIPAddress( $this->getName() ) ) {
1668 $ip = $this->getName();
1670 $ip = $this->getRequest()->getIP();
1673 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1674 $this->mBlockedGlobally
= (bool)$blocked;
1675 return $this->mBlockedGlobally
;
1679 * Check if user account is locked
1681 * @return Bool True if locked, false otherwise
1683 public function isLocked() {
1684 if ( $this->mLocked
!== null ) {
1685 return $this->mLocked
;
1688 $authUser = $wgAuth->getUserInstance( $this );
1689 $this->mLocked
= (bool)$authUser->isLocked();
1690 return $this->mLocked
;
1694 * Check if user account is hidden
1696 * @return Bool True if hidden, false otherwise
1698 public function isHidden() {
1699 if ( $this->mHideName
!== null ) {
1700 return $this->mHideName
;
1702 $this->getBlockedStatus();
1703 if ( !$this->mHideName
) {
1705 $authUser = $wgAuth->getUserInstance( $this );
1706 $this->mHideName
= (bool)$authUser->isHidden();
1708 return $this->mHideName
;
1712 * Get the user's ID.
1713 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1715 public function getId() {
1716 if ( $this->mId
=== null && $this->mName
!== null && User
::isIP( $this->mName
) ) {
1717 // Special case, we know the user is anonymous
1719 } elseif ( !$this->isItemLoaded( 'id' ) ) {
1720 // Don't load if this was initialized from an ID
1727 * Set the user and reload all fields according to a given ID
1728 * @param int $v User ID to reload
1730 public function setId( $v ) {
1732 $this->clearInstanceCache( 'id' );
1736 * Get the user name, or the IP of an anonymous user
1737 * @return String User's name or IP address
1739 public function getName() {
1740 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1741 # Special case optimisation
1742 return $this->mName
;
1745 if ( $this->mName
=== false ) {
1747 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1749 return $this->mName
;
1754 * Set the user name.
1756 * This does not reload fields from the database according to the given
1757 * name. Rather, it is used to create a temporary "nonexistent user" for
1758 * later addition to the database. It can also be used to set the IP
1759 * address for an anonymous user to something other than the current
1762 * @note User::newFromName() has roughly the same function, when the named user
1764 * @param string $str New user name to set
1766 public function setName( $str ) {
1768 $this->mName
= $str;
1772 * Get the user's name escaped by underscores.
1773 * @return String Username escaped by underscores.
1775 public function getTitleKey() {
1776 return str_replace( ' ', '_', $this->getName() );
1780 * Check if the user has new messages.
1781 * @return Bool True if the user has new messages
1783 public function getNewtalk() {
1786 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1787 if ( $this->mNewtalk
=== -1 ) {
1788 $this->mNewtalk
= false; # reset talk page status
1790 # Check memcached separately for anons, who have no
1791 # entire User object stored in there.
1792 if ( !$this->mId
) {
1793 global $wgDisableAnonTalk;
1794 if ( $wgDisableAnonTalk ) {
1795 // Anon newtalk disabled by configuration.
1796 $this->mNewtalk
= false;
1799 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1800 $newtalk = $wgMemc->get( $key );
1801 if ( strval( $newtalk ) !== '' ) {
1802 $this->mNewtalk
= (bool)$newtalk;
1804 // Since we are caching this, make sure it is up to date by getting it
1806 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1807 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1811 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1815 return (bool)$this->mNewtalk
;
1819 * Return the revision and link for the oldest new talk page message for
1821 * Note: This function was designed to accomodate multiple talk pages, but
1822 * currently only returns a single link and revision.
1825 public function getNewMessageLinks() {
1827 if ( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1829 } elseif ( !$this->getNewtalk() ) {
1832 $utp = $this->getTalkPage();
1833 $dbr = wfGetDB( DB_SLAVE
);
1834 // Get the "last viewed rev" timestamp from the oldest message notification
1835 $timestamp = $dbr->selectField( 'user_newtalk',
1836 'MIN(user_last_timestamp)',
1837 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1839 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1840 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1844 * Get the revision ID for the oldest new talk page message for this user
1845 * @return Integer or null if there are no new messages
1847 public function getNewMessageRevisionId() {
1848 $newMessageRevisionId = null;
1849 $newMessageLinks = $this->getNewMessageLinks();
1850 if ( $newMessageLinks ) {
1851 // Note: getNewMessageLinks() never returns more than a single link
1852 // and it is always for the same wiki, but we double-check here in
1853 // case that changes some time in the future.
1854 if ( count( $newMessageLinks ) === 1
1855 && $newMessageLinks[0]['wiki'] === wfWikiID()
1856 && $newMessageLinks[0]['rev']
1858 $newMessageRevision = $newMessageLinks[0]['rev'];
1859 $newMessageRevisionId = $newMessageRevision->getId();
1862 return $newMessageRevisionId;
1866 * Internal uncached check for new messages
1869 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
1870 * @param string|Int $id User's IP address for anonymous users, User ID otherwise
1871 * @param bool $fromMaster true to fetch from the master, false for a slave
1872 * @return Bool True if the user has new messages
1874 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1875 if ( $fromMaster ) {
1876 $db = wfGetDB( DB_MASTER
);
1878 $db = wfGetDB( DB_SLAVE
);
1880 $ok = $db->selectField( 'user_newtalk', $field,
1881 array( $field => $id ), __METHOD__
);
1882 return $ok !== false;
1886 * Add or update the new messages flag
1887 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
1888 * @param string|Int $id User's IP address for anonymous users, User ID otherwise
1889 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1890 * @return Bool True if successful, false otherwise
1892 protected function updateNewtalk( $field, $id, $curRev = null ) {
1893 // Get timestamp of the talk page revision prior to the current one
1894 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1895 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1896 // Mark the user as having new messages since this revision
1897 $dbw = wfGetDB( DB_MASTER
);
1898 $dbw->insert( 'user_newtalk',
1899 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1902 if ( $dbw->affectedRows() ) {
1903 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1906 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1912 * Clear the new messages flag for the given user
1913 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
1914 * @param string|Int $id User's IP address for anonymous users, User ID otherwise
1915 * @return Bool True if successful, false otherwise
1917 protected function deleteNewtalk( $field, $id ) {
1918 $dbw = wfGetDB( DB_MASTER
);
1919 $dbw->delete( 'user_newtalk',
1920 array( $field => $id ),
1922 if ( $dbw->affectedRows() ) {
1923 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1926 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1932 * Update the 'You have new messages!' status.
1933 * @param bool $val Whether the user has new messages
1934 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1936 public function setNewtalk( $val, $curRev = null ) {
1937 if ( wfReadOnly() ) {
1942 $this->mNewtalk
= $val;
1944 if ( $this->isAnon() ) {
1946 $id = $this->getName();
1949 $id = $this->getId();
1954 $changed = $this->updateNewtalk( $field, $id, $curRev );
1956 $changed = $this->deleteNewtalk( $field, $id );
1959 if ( $this->isAnon() ) {
1960 // Anons have a separate memcached space, since
1961 // user records aren't kept for them.
1962 $key = wfMemcKey( 'newtalk', 'ip', $id );
1963 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1966 $this->invalidateCache();
1971 * Generate a current or new-future timestamp to be stored in the
1972 * user_touched field when we update things.
1973 * @return String Timestamp in TS_MW format
1975 private static function newTouchedTimestamp() {
1976 global $wgClockSkewFudge;
1977 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1981 * Clear user data from memcached.
1982 * Use after applying fun updates to the database; caller's
1983 * responsibility to update user_touched if appropriate.
1985 * Called implicitly from invalidateCache() and saveSettings().
1987 private function clearSharedCache() {
1991 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1996 * Immediately touch the user data cache for this account.
1997 * Updates user_touched field, and removes account data from memcached
1998 * for reload on the next hit.
2000 public function invalidateCache() {
2001 if ( wfReadOnly() ) {
2006 $this->mTouched
= self
::newTouchedTimestamp();
2008 $dbw = wfGetDB( DB_MASTER
);
2009 $userid = $this->mId
;
2010 $touched = $this->mTouched
;
2011 $method = __METHOD__
;
2012 $dbw->onTransactionIdle( function() use ( $dbw, $userid, $touched, $method ) {
2013 // Prevent contention slams by checking user_touched first
2014 $encTouched = $dbw->addQuotes( $dbw->timestamp( $touched ) );
2015 $needsPurge = $dbw->selectField( 'user', '1',
2016 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ) );
2017 if ( $needsPurge ) {
2018 $dbw->update( 'user',
2019 array( 'user_touched' => $dbw->timestamp( $touched ) ),
2020 array( 'user_id' => $userid, 'user_touched < ' . $encTouched ),
2025 $this->clearSharedCache();
2030 * Validate the cache for this account.
2031 * @param string $timestamp A timestamp in TS_MW format
2035 public function validateCache( $timestamp ) {
2037 return ( $timestamp >= $this->mTouched
);
2041 * Get the user touched timestamp
2042 * @return String timestamp
2044 public function getTouched() {
2046 return $this->mTouched
;
2050 * Set the password and reset the random token.
2051 * Calls through to authentication plugin if necessary;
2052 * will have no effect if the auth plugin refuses to
2053 * pass the change through or if the legal password
2056 * As a special case, setting the password to null
2057 * wipes it, so the account cannot be logged in until
2058 * a new password is set, for instance via e-mail.
2060 * @param string $str New password to set
2061 * @throws PasswordError on failure
2065 public function setPassword( $str ) {
2068 if ( $str !== null ) {
2069 if ( !$wgAuth->allowPasswordChange() ) {
2070 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2073 if ( !$this->isValidPassword( $str ) ) {
2074 global $wgMinimalPasswordLength;
2075 $valid = $this->getPasswordValidity( $str );
2076 if ( is_array( $valid ) ) {
2077 $message = array_shift( $valid );
2081 $params = array( $wgMinimalPasswordLength );
2083 throw new PasswordError( wfMessage( $message, $params )->text() );
2087 if ( !$wgAuth->setPassword( $this, $str ) ) {
2088 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2091 $this->setInternalPassword( $str );
2097 * Set the password and reset the random token unconditionally.
2099 * @param string|null $str New password to set or null to set an invalid
2100 * password hash meaning that the user will not be able to log in
2101 * through the web interface.
2103 public function setInternalPassword( $str ) {
2107 if ( $str === null ) {
2108 // Save an invalid hash...
2109 $this->mPassword
= '';
2111 $this->mPassword
= self
::crypt( $str );
2113 $this->mNewpassword
= '';
2114 $this->mNewpassTime
= null;
2118 * Get the user's current token.
2119 * @param bool $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2120 * @return String Token
2122 public function getToken( $forceCreation = true ) {
2124 if ( !$this->mToken
&& $forceCreation ) {
2127 return $this->mToken
;
2131 * Set the random token (used for persistent authentication)
2132 * Called from loadDefaults() among other places.
2134 * @param string|bool $token If specified, set the token to this value
2136 public function setToken( $token = false ) {
2139 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2141 $this->mToken
= $token;
2146 * Set the password for a password reminder or new account email
2148 * @param string $str New password to set
2149 * @param bool $throttle If true, reset the throttle timestamp to the present
2151 public function setNewpassword( $str, $throttle = true ) {
2153 $this->mNewpassword
= self
::crypt( $str );
2155 $this->mNewpassTime
= wfTimestampNow();
2160 * Has password reminder email been sent within the last
2161 * $wgPasswordReminderResendTime hours?
2164 public function isPasswordReminderThrottled() {
2165 global $wgPasswordReminderResendTime;
2167 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2170 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2171 return time() < $expiry;
2175 * Get the user's e-mail address
2176 * @return String User's email address
2178 public function getEmail() {
2180 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2181 return $this->mEmail
;
2185 * Get the timestamp of the user's e-mail authentication
2186 * @return String TS_MW timestamp
2188 public function getEmailAuthenticationTimestamp() {
2190 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2191 return $this->mEmailAuthenticated
;
2195 * Set the user's e-mail address
2196 * @param string $str New e-mail address
2198 public function setEmail( $str ) {
2200 if ( $str == $this->mEmail
) {
2203 $this->mEmail
= $str;
2204 $this->invalidateEmail();
2205 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2209 * Set the user's e-mail address and a confirmation mail if needed.
2212 * @param string $str New e-mail address
2215 public function setEmailWithConfirmation( $str ) {
2216 global $wgEnableEmail, $wgEmailAuthentication;
2218 if ( !$wgEnableEmail ) {
2219 return Status
::newFatal( 'emaildisabled' );
2222 $oldaddr = $this->getEmail();
2223 if ( $str === $oldaddr ) {
2224 return Status
::newGood( true );
2227 $this->setEmail( $str );
2229 if ( $str !== '' && $wgEmailAuthentication ) {
2230 # Send a confirmation request to the new address if needed
2231 $type = $oldaddr != '' ?
'changed' : 'set';
2232 $result = $this->sendConfirmationMail( $type );
2233 if ( $result->isGood() ) {
2234 # Say the the caller that a confirmation mail has been sent
2235 $result->value
= 'eauth';
2238 $result = Status
::newGood( true );
2245 * Get the user's real name
2246 * @return String User's real name
2248 public function getRealName() {
2249 if ( !$this->isItemLoaded( 'realname' ) ) {
2253 return $this->mRealName
;
2257 * Set the user's real name
2258 * @param string $str New real name
2260 public function setRealName( $str ) {
2262 $this->mRealName
= $str;
2266 * Get the user's current setting for a given option.
2268 * @param string $oname The option to check
2269 * @param string $defaultOverride A default value returned if the option does not exist
2270 * @param bool $ignoreHidden = whether to ignore the effects of $wgHiddenPrefs
2271 * @return String User's current value for the option
2272 * @see getBoolOption()
2273 * @see getIntOption()
2275 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2276 global $wgHiddenPrefs;
2277 $this->loadOptions();
2279 # We want 'disabled' preferences to always behave as the default value for
2280 # users, even if they have set the option explicitly in their settings (ie they
2281 # set it, and then it was disabled removing their ability to change it). But
2282 # we don't want to erase the preferences in the database in case the preference
2283 # is re-enabled again. So don't touch $mOptions, just override the returned value
2284 if ( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ) {
2285 return self
::getDefaultOption( $oname );
2288 if ( array_key_exists( $oname, $this->mOptions
) ) {
2289 return $this->mOptions
[$oname];
2291 return $defaultOverride;
2296 * Get all user's options
2300 public function getOptions() {
2301 global $wgHiddenPrefs;
2302 $this->loadOptions();
2303 $options = $this->mOptions
;
2305 # We want 'disabled' preferences to always behave as the default value for
2306 # users, even if they have set the option explicitly in their settings (ie they
2307 # set it, and then it was disabled removing their ability to change it). But
2308 # we don't want to erase the preferences in the database in case the preference
2309 # is re-enabled again. So don't touch $mOptions, just override the returned value
2310 foreach ( $wgHiddenPrefs as $pref ) {
2311 $default = self
::getDefaultOption( $pref );
2312 if ( $default !== null ) {
2313 $options[$pref] = $default;
2321 * Get the user's current setting for a given option, as a boolean value.
2323 * @param string $oname The option to check
2324 * @return Bool User's current value for the option
2327 public function getBoolOption( $oname ) {
2328 return (bool)$this->getOption( $oname );
2332 * Get the user's current setting for a given option, as a boolean value.
2334 * @param string $oname The option to check
2335 * @param int $defaultOverride A default value returned if the option does not exist
2336 * @return Int User's current value for the option
2339 public function getIntOption( $oname, $defaultOverride = 0 ) {
2340 $val = $this->getOption( $oname );
2342 $val = $defaultOverride;
2344 return intval( $val );
2348 * Set the given option for a user.
2350 * @param string $oname The option to set
2351 * @param $val mixed New value to set
2353 public function setOption( $oname, $val ) {
2354 $this->loadOptions();
2356 // Explicitly NULL values should refer to defaults
2357 if ( is_null( $val ) ) {
2358 $val = self
::getDefaultOption( $oname );
2361 $this->mOptions
[$oname] = $val;
2365 * Return a list of the types of user options currently returned by
2366 * User::getOptionKinds().
2368 * Currently, the option kinds are:
2369 * - 'registered' - preferences which are registered in core MediaWiki or
2370 * by extensions using the UserGetDefaultOptions hook.
2371 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2372 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2373 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2374 * be used by user scripts.
2375 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2376 * These are usually legacy options, removed in newer versions.
2378 * The API (and possibly others) use this function to determine the possible
2379 * option types for validation purposes, so make sure to update this when a
2380 * new option kind is added.
2382 * @see User::getOptionKinds
2383 * @return array Option kinds
2385 public static function listOptionKinds() {
2388 'registered-multiselect',
2389 'registered-checkmatrix',
2396 * Return an associative array mapping preferences keys to the kind of a preference they're
2397 * used for. Different kinds are handled differently when setting or reading preferences.
2399 * See User::listOptionKinds for the list of valid option types that can be provided.
2401 * @see User::listOptionKinds
2402 * @param $context IContextSource
2403 * @param array $options assoc. array with options keys to check as keys. Defaults to $this->mOptions.
2404 * @return array the key => kind mapping data
2406 public function getOptionKinds( IContextSource
$context, $options = null ) {
2407 $this->loadOptions();
2408 if ( $options === null ) {
2409 $options = $this->mOptions
;
2412 $prefs = Preferences
::getPreferences( $this, $context );
2415 // Multiselect and checkmatrix options are stored in the database with
2416 // one key per option, each having a boolean value. Extract those keys.
2417 $multiselectOptions = array();
2418 foreach ( $prefs as $name => $info ) {
2419 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2420 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2421 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2422 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2424 foreach ( $opts as $value ) {
2425 $multiselectOptions["$prefix$value"] = true;
2428 unset( $prefs[$name] );
2431 $checkmatrixOptions = array();
2432 foreach ( $prefs as $name => $info ) {
2433 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2434 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2435 $columns = HTMLFormField
::flattenOptions( $info['columns'] );
2436 $rows = HTMLFormField
::flattenOptions( $info['rows'] );
2437 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2439 foreach ( $columns as $column ) {
2440 foreach ( $rows as $row ) {
2441 $checkmatrixOptions["$prefix-$column-$row"] = true;
2445 unset( $prefs[$name] );
2449 // $value is ignored
2450 foreach ( $options as $key => $value ) {
2451 if ( isset( $prefs[$key] ) ) {
2452 $mapping[$key] = 'registered';
2453 } elseif ( isset( $multiselectOptions[$key] ) ) {
2454 $mapping[$key] = 'registered-multiselect';
2455 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
2456 $mapping[$key] = 'registered-checkmatrix';
2457 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2458 $mapping[$key] = 'userjs';
2460 $mapping[$key] = 'unused';
2468 * Reset certain (or all) options to the site defaults
2470 * The optional parameter determines which kinds of preferences will be reset.
2471 * Supported values are everything that can be reported by getOptionKinds()
2472 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2474 * @param array|string $resetKinds which kinds of preferences to reset. Defaults to
2475 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
2476 * for backwards-compatibility.
2477 * @param $context IContextSource|null context source used when $resetKinds
2478 * does not contain 'all', passed to getOptionKinds().
2479 * Defaults to RequestContext::getMain() when null.
2481 public function resetOptions(
2482 $resetKinds = array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ),
2483 IContextSource
$context = null
2486 $defaultOptions = self
::getDefaultOptions();
2488 if ( !is_array( $resetKinds ) ) {
2489 $resetKinds = array( $resetKinds );
2492 if ( in_array( 'all', $resetKinds ) ) {
2493 $newOptions = $defaultOptions;
2495 if ( $context === null ) {
2496 $context = RequestContext
::getMain();
2499 $optionKinds = $this->getOptionKinds( $context );
2500 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
2501 $newOptions = array();
2503 // Use default values for the options that should be deleted, and
2504 // copy old values for the ones that shouldn't.
2505 foreach ( $this->mOptions
as $key => $value ) {
2506 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2507 if ( array_key_exists( $key, $defaultOptions ) ) {
2508 $newOptions[$key] = $defaultOptions[$key];
2511 $newOptions[$key] = $value;
2516 $this->mOptions
= $newOptions;
2517 $this->mOptionsLoaded
= true;
2521 * Get the user's preferred date format.
2522 * @return String User's preferred date format
2524 public function getDatePreference() {
2525 // Important migration for old data rows
2526 if ( is_null( $this->mDatePreference
) ) {
2528 $value = $this->getOption( 'date' );
2529 $map = $wgLang->getDatePreferenceMigrationMap();
2530 if ( isset( $map[$value] ) ) {
2531 $value = $map[$value];
2533 $this->mDatePreference
= $value;
2535 return $this->mDatePreference
;
2539 * Get the user preferred stub threshold
2543 public function getStubThreshold() {
2544 global $wgMaxArticleSize; # Maximum article size, in Kb
2545 $threshold = $this->getIntOption( 'stubthreshold' );
2546 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2547 # If they have set an impossible value, disable the preference
2548 # so we can use the parser cache again.
2555 * Get the permissions this user has.
2556 * @return Array of String permission names
2558 public function getRights() {
2559 if ( is_null( $this->mRights
) ) {
2560 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2561 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2562 // Force reindexation of rights when a hook has unset one of them
2563 $this->mRights
= array_values( array_unique( $this->mRights
) );
2565 return $this->mRights
;
2569 * Get the list of explicit group memberships this user has.
2570 * The implicit * and user groups are not included.
2571 * @return Array of String internal group names
2573 public function getGroups() {
2575 $this->loadGroups();
2576 return $this->mGroups
;
2580 * Get the list of implicit group memberships this user has.
2581 * This includes all explicit groups, plus 'user' if logged in,
2582 * '*' for all accounts, and autopromoted groups
2583 * @param bool $recache Whether to avoid the cache
2584 * @return Array of String internal group names
2586 public function getEffectiveGroups( $recache = false ) {
2587 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2588 wfProfileIn( __METHOD__
);
2589 $this->mEffectiveGroups
= array_unique( array_merge(
2590 $this->getGroups(), // explicit groups
2591 $this->getAutomaticGroups( $recache ) // implicit groups
2593 # Hook for additional groups
2594 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2595 // Force reindexation of groups when a hook has unset one of them
2596 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
2597 wfProfileOut( __METHOD__
);
2599 return $this->mEffectiveGroups
;
2603 * Get the list of implicit group memberships this user has.
2604 * This includes 'user' if logged in, '*' for all accounts,
2605 * and autopromoted groups
2606 * @param bool $recache Whether to avoid the cache
2607 * @return Array of String internal group names
2609 public function getAutomaticGroups( $recache = false ) {
2610 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2611 wfProfileIn( __METHOD__
);
2612 $this->mImplicitGroups
= array( '*' );
2613 if ( $this->getId() ) {
2614 $this->mImplicitGroups
[] = 'user';
2616 $this->mImplicitGroups
= array_unique( array_merge(
2617 $this->mImplicitGroups
,
2618 Autopromote
::getAutopromoteGroups( $this )
2622 # Assure data consistency with rights/groups,
2623 # as getEffectiveGroups() depends on this function
2624 $this->mEffectiveGroups
= null;
2626 wfProfileOut( __METHOD__
);
2628 return $this->mImplicitGroups
;
2632 * Returns the groups the user has belonged to.
2634 * The user may still belong to the returned groups. Compare with getGroups().
2636 * The function will not return groups the user had belonged to before MW 1.17
2638 * @return array Names of the groups the user has belonged to.
2640 public function getFormerGroups() {
2641 if ( is_null( $this->mFormerGroups
) ) {
2642 $dbr = wfGetDB( DB_MASTER
);
2643 $res = $dbr->select( 'user_former_groups',
2644 array( 'ufg_group' ),
2645 array( 'ufg_user' => $this->mId
),
2647 $this->mFormerGroups
= array();
2648 foreach ( $res as $row ) {
2649 $this->mFormerGroups
[] = $row->ufg_group
;
2652 return $this->mFormerGroups
;
2656 * Get the user's edit count.
2659 public function getEditCount() {
2660 if ( !$this->getId() ) {
2664 if ( !isset( $this->mEditCount
) ) {
2665 /* Populate the count, if it has not been populated yet */
2666 wfProfileIn( __METHOD__
);
2667 $dbr = wfGetDB( DB_SLAVE
);
2668 // check if the user_editcount field has been initialized
2669 $count = $dbr->selectField(
2670 'user', 'user_editcount',
2671 array( 'user_id' => $this->mId
),
2675 if ( $count === null ) {
2676 // it has not been initialized. do so.
2677 $count = $this->initEditCount();
2679 $this->mEditCount
= intval( $count );
2680 wfProfileOut( __METHOD__
);
2682 return $this->mEditCount
;
2686 * Add the user to the given group.
2687 * This takes immediate effect.
2688 * @param string $group Name of the group to add
2690 public function addGroup( $group ) {
2691 if ( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2692 $dbw = wfGetDB( DB_MASTER
);
2693 if ( $this->getId() ) {
2694 $dbw->insert( 'user_groups',
2696 'ug_user' => $this->getID(),
2697 'ug_group' => $group,
2700 array( 'IGNORE' ) );
2703 $this->loadGroups();
2704 $this->mGroups
[] = $group;
2705 // In case loadGroups was not called before, we now have the right twice.
2706 // Get rid of the duplicate.
2707 $this->mGroups
= array_unique( $this->mGroups
);
2708 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2710 $this->invalidateCache();
2714 * Remove the user from the given group.
2715 * This takes immediate effect.
2716 * @param string $group Name of the group to remove
2718 public function removeGroup( $group ) {
2720 if ( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2721 $dbw = wfGetDB( DB_MASTER
);
2722 $dbw->delete( 'user_groups',
2724 'ug_user' => $this->getID(),
2725 'ug_group' => $group,
2727 // Remember that the user was in this group
2728 $dbw->insert( 'user_former_groups',
2730 'ufg_user' => $this->getID(),
2731 'ufg_group' => $group,
2734 array( 'IGNORE' ) );
2736 $this->loadGroups();
2737 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2738 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2740 $this->invalidateCache();
2744 * Get whether the user is logged in
2747 public function isLoggedIn() {
2748 return $this->getID() != 0;
2752 * Get whether the user is anonymous
2755 public function isAnon() {
2756 return !$this->isLoggedIn();
2760 * Check if user is allowed to access a feature / make an action
2762 * @internal param \String $varargs permissions to test
2763 * @return Boolean: True if user is allowed to perform *any* of the given actions
2767 public function isAllowedAny( /*...*/ ) {
2768 $permissions = func_get_args();
2769 foreach ( $permissions as $permission ) {
2770 if ( $this->isAllowed( $permission ) ) {
2779 * @internal param $varargs string
2780 * @return bool True if the user is allowed to perform *all* of the given actions
2782 public function isAllowedAll( /*...*/ ) {
2783 $permissions = func_get_args();
2784 foreach ( $permissions as $permission ) {
2785 if ( !$this->isAllowed( $permission ) ) {
2793 * Internal mechanics of testing a permission
2794 * @param $action String
2797 public function isAllowed( $action = '' ) {
2798 if ( $action === '' ) {
2799 return true; // In the spirit of DWIM
2801 # Patrolling may not be enabled
2802 if ( $action === 'patrol' ||
$action === 'autopatrol' ) {
2803 global $wgUseRCPatrol, $wgUseNPPatrol;
2804 if ( !$wgUseRCPatrol && !$wgUseNPPatrol ) {
2808 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2809 # by misconfiguration: 0 == 'foo'
2810 return in_array( $action, $this->getRights(), true );
2814 * Check whether to enable recent changes patrol features for this user
2815 * @return Boolean: True or false
2817 public function useRCPatrol() {
2818 global $wgUseRCPatrol;
2819 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2823 * Check whether to enable new pages patrol features for this user
2824 * @return Bool True or false
2826 public function useNPPatrol() {
2827 global $wgUseRCPatrol, $wgUseNPPatrol;
2828 return ( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2832 * Get the WebRequest object to use with this object
2834 * @return WebRequest
2836 public function getRequest() {
2837 if ( $this->mRequest
) {
2838 return $this->mRequest
;
2846 * Get the current skin, loading it if required
2847 * @return Skin The current skin
2848 * @todo FIXME: Need to check the old failback system [AV]
2849 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2851 public function getSkin() {
2852 wfDeprecated( __METHOD__
, '1.18' );
2853 return RequestContext
::getMain()->getSkin();
2857 * Get a WatchedItem for this user and $title.
2859 * @param $title Title
2860 * @return WatchedItem
2862 public function getWatchedItem( $title ) {
2863 $key = $title->getNamespace() . ':' . $title->getDBkey();
2865 if ( isset( $this->mWatchedItems
[$key] ) ) {
2866 return $this->mWatchedItems
[$key];
2869 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2870 $this->mWatchedItems
= array();
2873 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2874 return $this->mWatchedItems
[$key];
2878 * Check the watched status of an article.
2879 * @param $title Title of the article to look at
2882 public function isWatched( $title ) {
2883 return $this->getWatchedItem( $title )->isWatched();
2888 * @param $title Title of the article to look at
2890 public function addWatch( $title ) {
2891 $this->getWatchedItem( $title )->addWatch();
2892 $this->invalidateCache();
2896 * Stop watching an article.
2897 * @param $title Title of the article to look at
2899 public function removeWatch( $title ) {
2900 $this->getWatchedItem( $title )->removeWatch();
2901 $this->invalidateCache();
2905 * Clear the user's notification timestamp for the given title.
2906 * If e-notif e-mails are on, they will receive notification mails on
2907 * the next change of the page if it's watched etc.
2908 * @param $title Title of the article to look at
2910 public function clearNotification( &$title ) {
2911 global $wgUseEnotif, $wgShowUpdatedMarker;
2913 # Do nothing if the database is locked to writes
2914 if ( wfReadOnly() ) {
2918 if ( $title->getNamespace() == NS_USER_TALK
&&
2919 $title->getText() == $this->getName() ) {
2920 if ( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) ) {
2923 $this->setNewtalk( false );
2926 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2930 if ( $this->isAnon() ) {
2931 // Nothing else to do...
2935 // Only update the timestamp if the page is being watched.
2936 // The query to find out if it is watched is cached both in memcached and per-invocation,
2937 // and when it does have to be executed, it can be on a slave
2938 // If this is the user's newtalk page, we always update the timestamp
2940 if ( $title->getNamespace() == NS_USER_TALK
&&
2941 $title->getText() == $this->getName() )
2946 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2950 * Resets all of the given user's page-change notification timestamps.
2951 * If e-notif e-mails are on, they will receive notification mails on
2952 * the next change of any watched page.
2954 public function clearAllNotifications() {
2955 if ( wfReadOnly() ) {
2959 global $wgUseEnotif, $wgShowUpdatedMarker;
2960 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2961 $this->setNewtalk( false );
2964 $id = $this->getId();
2966 $dbw = wfGetDB( DB_MASTER
);
2967 $dbw->update( 'watchlist',
2969 'wl_notificationtimestamp' => null
2970 ), array( /* WHERE */
2974 # We also need to clear here the "you have new message" notification for the own user_talk page
2975 # This is cleared one page view later in Article::viewUpdates();
2980 * Set this user's options from an encoded string
2981 * @param string $str Encoded options to import
2983 * @deprecated in 1.19 due to removal of user_options from the user table
2985 private function decodeOptions( $str ) {
2986 wfDeprecated( __METHOD__
, '1.19' );
2991 $this->mOptionsLoaded
= true;
2992 $this->mOptionOverrides
= array();
2994 // If an option is not set in $str, use the default value
2995 $this->mOptions
= self
::getDefaultOptions();
2997 $a = explode( "\n", $str );
2998 foreach ( $a as $s ) {
3000 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
3001 $this->mOptions
[$m[1]] = $m[2];
3002 $this->mOptionOverrides
[$m[1]] = $m[2];
3008 * Set a cookie on the user's client. Wrapper for
3009 * WebResponse::setCookie
3010 * @param string $name Name of the cookie to set
3011 * @param string $value Value to set
3012 * @param int $exp Expiration time, as a UNIX time value;
3013 * if 0 or not specified, use the default $wgCookieExpiration
3014 * @param $secure Bool
3015 * true: Force setting the secure attribute when setting the cookie
3016 * false: Force NOT setting the secure attribute when setting the cookie
3017 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3019 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
3020 $this->getRequest()->response()->setcookie( $name, $value, $exp, null, null, $secure );
3024 * Clear a cookie on the user's client
3025 * @param string $name Name of the cookie to clear
3027 protected function clearCookie( $name ) {
3028 $this->setCookie( $name, '', time() - 86400 );
3032 * Set the default cookies for this session on the user's client.
3034 * @param $request WebRequest object to use; $wgRequest will be used if null
3036 * @param bool $secure Whether to force secure/insecure cookies or use default
3038 public function setCookies( $request = null, $secure = null ) {
3039 if ( $request === null ) {
3040 $request = $this->getRequest();
3044 if ( 0 == $this->mId
) {
3047 if ( !$this->mToken
) {
3048 // When token is empty or NULL generate a new one and then save it to the database
3049 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
3050 // Simply by setting every cell in the user_token column to NULL and letting them be
3051 // regenerated as users log back into the wiki.
3053 $this->saveSettings();
3056 'wsUserID' => $this->mId
,
3057 'wsToken' => $this->mToken
,
3058 'wsUserName' => $this->getName()
3061 'UserID' => $this->mId
,
3062 'UserName' => $this->getName(),
3064 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
3065 $cookies['Token'] = $this->mToken
;
3067 $cookies['Token'] = false;
3070 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
3072 foreach ( $session as $name => $value ) {
3073 $request->setSessionData( $name, $value );
3075 foreach ( $cookies as $name => $value ) {
3076 if ( $value === false ) {
3077 $this->clearCookie( $name );
3079 $this->setCookie( $name, $value, 0, $secure );
3084 * If wpStickHTTPS was selected, also set an insecure cookie that
3085 * will cause the site to redirect the user to HTTPS, if they access
3086 * it over HTTP. Bug 29898.
3088 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
3089 $this->setCookie( 'forceHTTPS', 'true', time() +
2592000, false ); //30 days
3094 * Log this user out.
3096 public function logout() {
3097 if ( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
3103 * Clear the user's cookies and session, and reset the instance cache.
3106 public function doLogout() {
3107 $this->clearInstanceCache( 'defaults' );
3109 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3111 $this->clearCookie( 'UserID' );
3112 $this->clearCookie( 'Token' );
3113 $this->clearCookie( 'forceHTTPS' );
3115 # Remember when user logged out, to prevent seeing cached pages
3116 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
3120 * Save this user's settings into the database.
3121 * @todo Only rarely do all these fields need to be set!
3123 public function saveSettings() {
3127 if ( wfReadOnly() ) {
3130 if ( 0 == $this->mId
) {
3134 $this->mTouched
= self
::newTouchedTimestamp();
3135 if ( !$wgAuth->allowSetLocalPassword() ) {
3136 $this->mPassword
= '';
3139 $dbw = wfGetDB( DB_MASTER
);
3140 $dbw->update( 'user',
3142 'user_name' => $this->mName
,
3143 'user_password' => $this->mPassword
,
3144 'user_newpassword' => $this->mNewpassword
,
3145 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3146 'user_real_name' => $this->mRealName
,
3147 'user_email' => $this->mEmail
,
3148 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3149 'user_touched' => $dbw->timestamp( $this->mTouched
),
3150 'user_token' => strval( $this->mToken
),
3151 'user_email_token' => $this->mEmailToken
,
3152 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3153 ), array( /* WHERE */
3154 'user_id' => $this->mId
3158 $this->saveOptions();
3160 wfRunHooks( 'UserSaveSettings', array( $this ) );
3161 $this->clearSharedCache();
3162 $this->getUserPage()->invalidateCache();
3166 * If only this user's username is known, and it exists, return the user ID.
3169 public function idForName() {
3170 $s = trim( $this->getName() );
3175 $dbr = wfGetDB( DB_SLAVE
);
3176 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
3177 if ( $id === false ) {
3184 * Add a user to the database, return the user object
3186 * @param string $name Username to add
3187 * @param array $params of Strings Non-default parameters to save to the database as user_* fields:
3188 * - password The user's password hash. Password logins will be disabled if this is omitted.
3189 * - newpassword Hash for a temporary password that has been mailed to the user
3190 * - email The user's email address
3191 * - email_authenticated The email authentication timestamp
3192 * - real_name The user's real name
3193 * - options An associative array of non-default options
3194 * - token Random authentication token. Do not set.
3195 * - registration Registration timestamp. Do not set.
3197 * @return User object, or null if the username already exists
3199 public static function createNew( $name, $params = array() ) {
3202 $user->setToken(); // init token
3203 if ( isset( $params['options'] ) ) {
3204 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3205 unset( $params['options'] );
3207 $dbw = wfGetDB( DB_MASTER
);
3208 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3211 'user_id' => $seqVal,
3212 'user_name' => $name,
3213 'user_password' => $user->mPassword
,
3214 'user_newpassword' => $user->mNewpassword
,
3215 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
3216 'user_email' => $user->mEmail
,
3217 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3218 'user_real_name' => $user->mRealName
,
3219 'user_token' => strval( $user->mToken
),
3220 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3221 'user_editcount' => 0,
3222 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3224 foreach ( $params as $name => $value ) {
3225 $fields["user_$name"] = $value;
3227 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3228 if ( $dbw->affectedRows() ) {
3229 $newUser = User
::newFromId( $dbw->insertId() );
3237 * Add this existing user object to the database. If the user already
3238 * exists, a fatal status object is returned, and the user object is
3239 * initialised with the data from the database.
3241 * Previously, this function generated a DB error due to a key conflict
3242 * if the user already existed. Many extension callers use this function
3243 * in code along the lines of:
3245 * $user = User::newFromName( $name );
3246 * if ( !$user->isLoggedIn() ) {
3247 * $user->addToDatabase();
3249 * // do something with $user...
3251 * However, this was vulnerable to a race condition (bug 16020). By
3252 * initialising the user object if the user exists, we aim to support this
3253 * calling sequence as far as possible.
3255 * Note that if the user exists, this function will acquire a write lock,
3256 * so it is still advisable to make the call conditional on isLoggedIn(),
3257 * and to commit the transaction after calling.
3259 * @throws MWException
3262 public function addToDatabase() {
3264 if ( !$this->mToken
) {
3265 $this->setToken(); // init token
3268 $this->mTouched
= self
::newTouchedTimestamp();
3270 $dbw = wfGetDB( DB_MASTER
);
3271 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3272 $dbw->insert( 'user',
3274 'user_id' => $seqVal,
3275 'user_name' => $this->mName
,
3276 'user_password' => $this->mPassword
,
3277 'user_newpassword' => $this->mNewpassword
,
3278 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3279 'user_email' => $this->mEmail
,
3280 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3281 'user_real_name' => $this->mRealName
,
3282 'user_token' => strval( $this->mToken
),
3283 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3284 'user_editcount' => 0,
3285 'user_touched' => $dbw->timestamp( $this->mTouched
),
3289 if ( !$dbw->affectedRows() ) {
3290 $this->mId
= $dbw->selectField( 'user', 'user_id',
3291 array( 'user_name' => $this->mName
), __METHOD__
);
3294 if ( $this->loadFromDatabase() ) {
3299 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3300 "to insert user '{$this->mName}' row, but it was not present in select!" );
3302 return Status
::newFatal( 'userexists' );
3304 $this->mId
= $dbw->insertId();
3306 // Clear instance cache other than user table data, which is already accurate
3307 $this->clearInstanceCache();
3309 $this->saveOptions();
3310 return Status
::newGood();
3314 * If this user is logged-in and blocked,
3315 * block any IP address they've successfully logged in from.
3316 * @return bool A block was spread
3318 public function spreadAnyEditBlock() {
3319 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3320 return $this->spreadBlock();
3326 * If this (non-anonymous) user is blocked,
3327 * block the IP address they've successfully logged in from.
3328 * @return bool A block was spread
3330 protected function spreadBlock() {
3331 wfDebug( __METHOD__
. "()\n" );
3333 if ( $this->mId
== 0 ) {
3337 $userblock = Block
::newFromTarget( $this->getName() );
3338 if ( !$userblock ) {
3342 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3346 * Generate a string which will be different for any combination of
3347 * user options which would produce different parser output.
3348 * This will be used as part of the hash key for the parser cache,
3349 * so users with the same options can share the same cached data
3352 * Extensions which require it should install 'PageRenderingHash' hook,
3353 * which will give them a chance to modify this key based on their own
3356 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3357 * @return String Page rendering hash
3359 public function getPageRenderingHash() {
3360 wfDeprecated( __METHOD__
, '1.17' );
3362 global $wgRenderHashAppend, $wgLang, $wgContLang;
3363 if ( $this->mHash
) {
3364 return $this->mHash
;
3367 // stubthreshold is only included below for completeness,
3368 // since it disables the parser cache, its value will always
3369 // be 0 when this function is called by parsercache.
3371 $confstr = $this->getOption( 'math' );
3372 $confstr .= '!' . $this->getStubThreshold();
3373 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3374 $confstr .= '!' . $wgLang->getCode();
3375 $confstr .= '!' . $this->getOption( 'thumbsize' );
3376 // add in language specific options, if any
3377 $extra = $wgContLang->getExtraHashOptions();
3380 // Since the skin could be overloading link(), it should be
3381 // included here but in practice, none of our skins do that.
3383 $confstr .= $wgRenderHashAppend;
3385 // Give a chance for extensions to modify the hash, if they have
3386 // extra options or other effects on the parser cache.
3387 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3389 // Make it a valid memcached key fragment
3390 $confstr = str_replace( ' ', '_', $confstr );
3391 $this->mHash
= $confstr;
3396 * Get whether the user is explicitly blocked from account creation.
3397 * @return Bool|Block
3399 public function isBlockedFromCreateAccount() {
3400 $this->getBlockedStatus();
3401 if ( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
3402 return $this->mBlock
;
3405 # bug 13611: if the IP address the user is trying to create an account from is
3406 # blocked with createaccount disabled, prevent new account creation there even
3407 # when the user is logged in
3408 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3409 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3411 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3412 ?
$this->mBlockedFromCreateAccount
3417 * Get whether the user is blocked from using Special:Emailuser.
3420 public function isBlockedFromEmailuser() {
3421 $this->getBlockedStatus();
3422 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3426 * Get whether the user is allowed to create an account.
3429 function isAllowedToCreateAccount() {
3430 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3434 * Get this user's personal page title.
3436 * @return Title: User's personal page title
3438 public function getUserPage() {
3439 return Title
::makeTitle( NS_USER
, $this->getName() );
3443 * Get this user's talk page title.
3445 * @return Title: User's talk page title
3447 public function getTalkPage() {
3448 $title = $this->getUserPage();
3449 return $title->getTalkPage();
3453 * Determine whether the user is a newbie. Newbies are either
3454 * anonymous IPs, or the most recently created accounts.
3457 public function isNewbie() {
3458 return !$this->isAllowed( 'autoconfirmed' );
3462 * Check to see if the given clear-text password is one of the accepted passwords
3463 * @param string $password user password.
3464 * @return Boolean: True if the given password is correct, otherwise False.
3466 public function checkPassword( $password ) {
3467 global $wgAuth, $wgLegacyEncoding;
3470 // Even though we stop people from creating passwords that
3471 // are shorter than this, doesn't mean people wont be able
3472 // to. Certain authentication plugins do NOT want to save
3473 // domain passwords in a mysql database, so we should
3474 // check this (in case $wgAuth->strict() is false).
3475 if ( !$this->isValidPassword( $password ) ) {
3479 if ( $wgAuth->authenticate( $this->getName(), $password ) ) {
3481 } elseif ( $wgAuth->strict() ) {
3482 /* Auth plugin doesn't allow local authentication */
3484 } elseif ( $wgAuth->strictUserAuth( $this->getName() ) ) {
3485 /* Auth plugin doesn't allow local authentication for this user name */
3488 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3490 } elseif ( $wgLegacyEncoding ) {
3491 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3492 # Check for this with iconv
3493 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3494 if ( $cp1252Password != $password &&
3495 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3504 * Check if the given clear-text password matches the temporary password
3505 * sent by e-mail for password reset operations.
3507 * @param $plaintext string
3509 * @return Boolean: True if matches, false otherwise
3511 public function checkTemporaryPassword( $plaintext ) {
3512 global $wgNewPasswordExpiry;
3515 if ( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3516 if ( is_null( $this->mNewpassTime
) ) {
3519 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3520 return ( time() < $expiry );
3527 * Alias for getEditToken.
3528 * @deprecated since 1.19, use getEditToken instead.
3530 * @param string|array $salt of Strings Optional function-specific data for hashing
3531 * @param $request WebRequest object to use or null to use $wgRequest
3532 * @return String The new edit token
3534 public function editToken( $salt = '', $request = null ) {
3535 wfDeprecated( __METHOD__
, '1.19' );
3536 return $this->getEditToken( $salt, $request );
3540 * Initialize (if necessary) and return a session token value
3541 * which can be used in edit forms to show that the user's
3542 * login credentials aren't being hijacked with a foreign form
3547 * @param string|array $salt of Strings Optional function-specific data for hashing
3548 * @param $request WebRequest object to use or null to use $wgRequest
3549 * @return String The new edit token
3551 public function getEditToken( $salt = '', $request = null ) {
3552 if ( $request == null ) {
3553 $request = $this->getRequest();
3556 if ( $this->isAnon() ) {
3557 return EDIT_TOKEN_SUFFIX
;
3559 $token = $request->getSessionData( 'wsEditToken' );
3560 if ( $token === null ) {
3561 $token = MWCryptRand
::generateHex( 32 );
3562 $request->setSessionData( 'wsEditToken', $token );
3564 if ( is_array( $salt ) ) {
3565 $salt = implode( '|', $salt );
3567 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3572 * Generate a looking random token for various uses.
3574 * @return String The new random token
3575 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pseudo-randomness
3577 public static function generateToken() {
3578 return MWCryptRand
::generateHex( 32 );
3582 * Check given value against the token value stored in the session.
3583 * A match should confirm that the form was submitted from the
3584 * user's own login session, not a form submission from a third-party
3587 * @param string $val Input value to compare
3588 * @param string $salt Optional function-specific data for hashing
3589 * @param $request WebRequest object to use or null to use $wgRequest
3590 * @return Boolean: Whether the token matches
3592 public function matchEditToken( $val, $salt = '', $request = null ) {
3593 $sessionToken = $this->getEditToken( $salt, $request );
3594 if ( $val != $sessionToken ) {
3595 wfDebug( "User::matchEditToken: broken session data\n" );
3597 return $val == $sessionToken;
3601 * Check given value against the token value stored in the session,
3602 * ignoring the suffix.
3604 * @param string $val Input value to compare
3605 * @param string $salt Optional function-specific data for hashing
3606 * @param $request WebRequest object to use or null to use $wgRequest
3607 * @return Boolean: Whether the token matches
3609 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3610 $sessionToken = $this->getEditToken( $salt, $request );
3611 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3615 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3616 * mail to the user's given address.
3618 * @param string $type message to send, either "created", "changed" or "set"
3619 * @return Status object
3621 public function sendConfirmationMail( $type = 'created' ) {
3623 $expiration = null; // gets passed-by-ref and defined in next line.
3624 $token = $this->confirmationToken( $expiration );
3625 $url = $this->confirmationTokenUrl( $token );
3626 $invalidateURL = $this->invalidationTokenUrl( $token );
3627 $this->saveSettings();
3629 if ( $type == 'created' ||
$type === false ) {
3630 $message = 'confirmemail_body';
3631 } elseif ( $type === true ) {
3632 $message = 'confirmemail_body_changed';
3634 $message = 'confirmemail_body_' . $type;
3637 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3638 wfMessage( $message,
3639 $this->getRequest()->getIP(),
3642 $wgLang->timeanddate( $expiration, false ),
3644 $wgLang->date( $expiration, false ),
3645 $wgLang->time( $expiration, false ) )->text() );
3649 * Send an e-mail to this user's account. Does not check for
3650 * confirmed status or validity.
3652 * @param string $subject Message subject
3653 * @param string $body Message body
3654 * @param string $from Optional From address; if unspecified, default $wgPasswordSender will be used
3655 * @param string $replyto Reply-To address
3658 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3659 if ( is_null( $from ) ) {
3660 global $wgPasswordSender, $wgPasswordSenderName;
3661 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3663 $sender = new MailAddress( $from );
3666 $to = new MailAddress( $this );
3667 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3671 * Generate, store, and return a new e-mail confirmation code.
3672 * A hash (unsalted, since it's used as a key) is stored.
3674 * @note Call saveSettings() after calling this function to commit
3675 * this change to the database.
3677 * @param &$expiration \mixed Accepts the expiration time
3678 * @return String New token
3680 protected function confirmationToken( &$expiration ) {
3681 global $wgUserEmailConfirmationTokenExpiry;
3683 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3684 $expiration = wfTimestamp( TS_MW
, $expires );
3686 $token = MWCryptRand
::generateHex( 32 );
3687 $hash = md5( $token );
3688 $this->mEmailToken
= $hash;
3689 $this->mEmailTokenExpires
= $expiration;
3694 * Return a URL the user can use to confirm their email address.
3695 * @param string $token Accepts the email confirmation token
3696 * @return String New token URL
3698 protected function confirmationTokenUrl( $token ) {
3699 return $this->getTokenUrl( 'ConfirmEmail', $token );
3703 * Return a URL the user can use to invalidate their email address.
3704 * @param string $token Accepts the email confirmation token
3705 * @return String New token URL
3707 protected function invalidationTokenUrl( $token ) {
3708 return $this->getTokenUrl( 'InvalidateEmail', $token );
3712 * Internal function to format the e-mail validation/invalidation URLs.
3713 * This uses a quickie hack to use the
3714 * hardcoded English names of the Special: pages, for ASCII safety.
3716 * @note Since these URLs get dropped directly into emails, using the
3717 * short English names avoids insanely long URL-encoded links, which
3718 * also sometimes can get corrupted in some browsers/mailers
3719 * (bug 6957 with Gmail and Internet Explorer).
3721 * @param string $page Special page
3722 * @param string $token Token
3723 * @return String Formatted URL
3725 protected function getTokenUrl( $page, $token ) {
3726 // Hack to bypass localization of 'Special:'
3727 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3728 return $title->getCanonicalURL();
3732 * Mark the e-mail address confirmed.
3734 * @note Call saveSettings() after calling this function to commit the change.
3738 public function confirmEmail() {
3739 // Check if it's already confirmed, so we don't touch the database
3740 // and fire the ConfirmEmailComplete hook on redundant confirmations.
3741 if ( !$this->isEmailConfirmed() ) {
3742 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3743 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3749 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3750 * address if it was already confirmed.
3752 * @note Call saveSettings() after calling this function to commit the change.
3753 * @return bool Returns true
3755 function invalidateEmail() {
3757 $this->mEmailToken
= null;
3758 $this->mEmailTokenExpires
= null;
3759 $this->setEmailAuthenticationTimestamp( null );
3760 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3765 * Set the e-mail authentication timestamp.
3766 * @param string $timestamp TS_MW timestamp
3768 function setEmailAuthenticationTimestamp( $timestamp ) {
3770 $this->mEmailAuthenticated
= $timestamp;
3771 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3775 * Is this user allowed to send e-mails within limits of current
3776 * site configuration?
3779 public function canSendEmail() {
3780 global $wgEnableEmail, $wgEnableUserEmail;
3781 if ( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3784 $canSend = $this->isEmailConfirmed();
3785 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3790 * Is this user allowed to receive e-mails within limits of current
3791 * site configuration?
3794 public function canReceiveEmail() {
3795 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3799 * Is this user's e-mail address valid-looking and confirmed within
3800 * limits of the current site configuration?
3802 * @note If $wgEmailAuthentication is on, this may require the user to have
3803 * confirmed their address by returning a code or using a password
3804 * sent to the address from the wiki.
3808 public function isEmailConfirmed() {
3809 global $wgEmailAuthentication;
3812 if ( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3813 if ( $this->isAnon() ) {
3816 if ( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3819 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3829 * Check whether there is an outstanding request for e-mail confirmation.
3832 public function isEmailConfirmationPending() {
3833 global $wgEmailAuthentication;
3834 return $wgEmailAuthentication &&
3835 !$this->isEmailConfirmed() &&
3836 $this->mEmailToken
&&
3837 $this->mEmailTokenExpires
> wfTimestamp();
3841 * Get the timestamp of account creation.
3843 * @return String|Bool|Null Timestamp of account creation, false for
3844 * non-existent/anonymous user accounts, or null if existing account
3845 * but information is not in database.
3847 public function getRegistration() {
3848 if ( $this->isAnon() ) {
3852 return $this->mRegistration
;
3856 * Get the timestamp of the first edit
3858 * @return String|Bool Timestamp of first edit, or false for
3859 * non-existent/anonymous user accounts.
3861 public function getFirstEditTimestamp() {
3862 if ( $this->getId() == 0 ) {
3863 return false; // anons
3865 $dbr = wfGetDB( DB_SLAVE
);
3866 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3867 array( 'rev_user' => $this->getId() ),
3869 array( 'ORDER BY' => 'rev_timestamp ASC' )
3872 return false; // no edits
3874 return wfTimestamp( TS_MW
, $time );
3878 * Get the permissions associated with a given list of groups
3880 * @param array $groups of Strings List of internal group names
3881 * @return Array of Strings List of permission key names for given groups combined
3883 public static function getGroupPermissions( $groups ) {
3884 global $wgGroupPermissions, $wgRevokePermissions;
3886 // grant every granted permission first
3887 foreach ( $groups as $group ) {
3888 if ( isset( $wgGroupPermissions[$group] ) ) {
3889 $rights = array_merge( $rights,
3890 // array_filter removes empty items
3891 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3894 // now revoke the revoked permissions
3895 foreach ( $groups as $group ) {
3896 if ( isset( $wgRevokePermissions[$group] ) ) {
3897 $rights = array_diff( $rights,
3898 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3901 return array_unique( $rights );
3905 * Get all the groups who have a given permission
3907 * @param string $role Role to check
3908 * @return Array of Strings List of internal group names with the given permission
3910 public static function getGroupsWithPermission( $role ) {
3911 global $wgGroupPermissions;
3912 $allowedGroups = array();
3913 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
3914 if ( self
::groupHasPermission( $group, $role ) ) {
3915 $allowedGroups[] = $group;
3918 return $allowedGroups;
3922 * Check, if the given group has the given permission
3925 * @param string $group Group to check
3926 * @param string $role Role to check
3929 public static function groupHasPermission( $group, $role ) {
3930 global $wgGroupPermissions, $wgRevokePermissions;
3931 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
3932 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
3936 * Get the localized descriptive name for a group, if it exists
3938 * @param string $group Internal group name
3939 * @return String Localized descriptive group name
3941 public static function getGroupName( $group ) {
3942 $msg = wfMessage( "group-$group" );
3943 return $msg->isBlank() ?
$group : $msg->text();
3947 * Get the localized descriptive name for a member of a group, if it exists
3949 * @param string $group Internal group name
3950 * @param string $username Username for gender (since 1.19)
3951 * @return String Localized name for group member
3953 public static function getGroupMember( $group, $username = '#' ) {
3954 $msg = wfMessage( "group-$group-member", $username );
3955 return $msg->isBlank() ?
$group : $msg->text();
3959 * Return the set of defined explicit groups.
3960 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3961 * are not included, as they are defined automatically, not in the database.
3962 * @return Array of internal group names
3964 public static function getAllGroups() {
3965 global $wgGroupPermissions, $wgRevokePermissions;
3967 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3968 self
::getImplicitGroups()
3973 * Get a list of all available permissions.
3974 * @return Array of permission names
3976 public static function getAllRights() {
3977 if ( self
::$mAllRights === false ) {
3978 global $wgAvailableRights;
3979 if ( count( $wgAvailableRights ) ) {
3980 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3982 self
::$mAllRights = self
::$mCoreRights;
3984 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3986 return self
::$mAllRights;
3990 * Get a list of implicit groups
3991 * @return Array of Strings Array of internal group names
3993 public static function getImplicitGroups() {
3994 global $wgImplicitGroups;
3995 $groups = $wgImplicitGroups;
3996 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
4001 * Get the title of a page describing a particular group
4003 * @param string $group Internal group name
4004 * @return Title|Bool Title of the page if it exists, false otherwise
4006 public static function getGroupPage( $group ) {
4007 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4008 if ( $msg->exists() ) {
4009 $title = Title
::newFromText( $msg->text() );
4010 if ( is_object( $title ) ) {
4018 * Create a link to the group in HTML, if available;
4019 * else return the group name.
4021 * @param string $group Internal name of the group
4022 * @param string $text The text of the link
4023 * @return String HTML link to the group
4025 public static function makeGroupLinkHTML( $group, $text = '' ) {
4026 if ( $text == '' ) {
4027 $text = self
::getGroupName( $group );
4029 $title = self
::getGroupPage( $group );
4031 return Linker
::link( $title, htmlspecialchars( $text ) );
4038 * Create a link to the group in Wikitext, if available;
4039 * else return the group name.
4041 * @param string $group Internal name of the group
4042 * @param string $text The text of the link
4043 * @return String Wikilink to the group
4045 public static function makeGroupLinkWiki( $group, $text = '' ) {
4046 if ( $text == '' ) {
4047 $text = self
::getGroupName( $group );
4049 $title = self
::getGroupPage( $group );
4051 $page = $title->getPrefixedText();
4052 return "[[$page|$text]]";
4059 * Returns an array of the groups that a particular group can add/remove.
4061 * @param string $group the group to check for whether it can add/remove
4062 * @return Array array( 'add' => array( addablegroups ),
4063 * 'remove' => array( removablegroups ),
4064 * 'add-self' => array( addablegroups to self),
4065 * 'remove-self' => array( removable groups from self) )
4067 public static function changeableByGroup( $group ) {
4068 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4070 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
4071 if ( empty( $wgAddGroups[$group] ) ) {
4072 // Don't add anything to $groups
4073 } elseif ( $wgAddGroups[$group] === true ) {
4074 // You get everything
4075 $groups['add'] = self
::getAllGroups();
4076 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4077 $groups['add'] = $wgAddGroups[$group];
4080 // Same thing for remove
4081 if ( empty( $wgRemoveGroups[$group] ) ) {
4082 } elseif ( $wgRemoveGroups[$group] === true ) {
4083 $groups['remove'] = self
::getAllGroups();
4084 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4085 $groups['remove'] = $wgRemoveGroups[$group];
4088 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4089 if ( empty( $wgGroupsAddToSelf['user'] ) ||
$wgGroupsAddToSelf['user'] !== true ) {
4090 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4091 if ( is_int( $key ) ) {
4092 $wgGroupsAddToSelf['user'][] = $value;
4097 if ( empty( $wgGroupsRemoveFromSelf['user'] ) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4098 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4099 if ( is_int( $key ) ) {
4100 $wgGroupsRemoveFromSelf['user'][] = $value;
4105 // Now figure out what groups the user can add to him/herself
4106 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4107 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4108 // No idea WHY this would be used, but it's there
4109 $groups['add-self'] = User
::getAllGroups();
4110 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4111 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4114 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4115 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4116 $groups['remove-self'] = User
::getAllGroups();
4117 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4118 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4125 * Returns an array of groups that this user can add and remove
4126 * @return Array array( 'add' => array( addablegroups ),
4127 * 'remove' => array( removablegroups ),
4128 * 'add-self' => array( addablegroups to self),
4129 * 'remove-self' => array( removable groups from self) )
4131 public function changeableGroups() {
4132 if ( $this->isAllowed( 'userrights' ) ) {
4133 // This group gives the right to modify everything (reverse-
4134 // compatibility with old "userrights lets you change
4136 // Using array_merge to make the groups reindexed
4137 $all = array_merge( User
::getAllGroups() );
4141 'add-self' => array(),
4142 'remove-self' => array()
4146 // Okay, it's not so simple, we will have to go through the arrays
4149 'remove' => array(),
4150 'add-self' => array(),
4151 'remove-self' => array()
4153 $addergroups = $this->getEffectiveGroups();
4155 foreach ( $addergroups as $addergroup ) {
4156 $groups = array_merge_recursive(
4157 $groups, $this->changeableByGroup( $addergroup )
4159 $groups['add'] = array_unique( $groups['add'] );
4160 $groups['remove'] = array_unique( $groups['remove'] );
4161 $groups['add-self'] = array_unique( $groups['add-self'] );
4162 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4168 * Increment the user's edit-count field.
4169 * Will have no effect for anonymous users.
4171 public function incEditCount() {
4172 if ( !$this->isAnon() ) {
4173 $dbw = wfGetDB( DB_MASTER
);
4176 array( 'user_editcount=user_editcount+1' ),
4177 array( 'user_id' => $this->getId() ),
4181 // Lazy initialization check...
4182 if ( $dbw->affectedRows() == 0 ) {
4183 // Now here's a goddamn hack...
4184 $dbr = wfGetDB( DB_SLAVE
);
4185 if ( $dbr !== $dbw ) {
4186 // If we actually have a slave server, the count is
4187 // at least one behind because the current transaction
4188 // has not been committed and replicated.
4189 $this->initEditCount( 1 );
4191 // But if DB_SLAVE is selecting the master, then the
4192 // count we just read includes the revision that was
4193 // just added in the working transaction.
4194 $this->initEditCount();
4198 // edit count in user cache too
4199 $this->invalidateCache();
4203 * Initialize user_editcount from data out of the revision table
4205 * @param $add Integer Edits to add to the count from the revision table
4206 * @return Integer Number of edits
4208 protected function initEditCount( $add = 0 ) {
4209 // Pull from a slave to be less cruel to servers
4210 // Accuracy isn't the point anyway here
4211 $dbr = wfGetDB( DB_SLAVE
);
4212 $count = (int) $dbr->selectField(
4215 array( 'rev_user' => $this->getId() ),
4218 $count = $count +
$add;
4220 $dbw = wfGetDB( DB_MASTER
);
4223 array( 'user_editcount' => $count ),
4224 array( 'user_id' => $this->getId() ),
4232 * Get the description of a given right
4234 * @param string $right Right to query
4235 * @return String Localized description of the right
4237 public static function getRightDescription( $right ) {
4238 $key = "right-$right";
4239 $msg = wfMessage( $key );
4240 return $msg->isBlank() ?
$right : $msg->text();
4244 * Make an old-style password hash
4246 * @param string $password Plain-text password
4247 * @param string $userId User ID
4248 * @return String Password hash
4250 public static function oldCrypt( $password, $userId ) {
4251 global $wgPasswordSalt;
4252 if ( $wgPasswordSalt ) {
4253 return md5( $userId . '-' . md5( $password ) );
4255 return md5( $password );
4260 * Make a new-style password hash
4262 * @param string $password Plain-text password
4263 * @param bool|string $salt Optional salt, may be random or the user ID.
4265 * If unspecified or false, will generate one automatically
4266 * @return String Password hash
4268 public static function crypt( $password, $salt = false ) {
4269 global $wgPasswordSalt;
4272 if ( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
4276 if ( $wgPasswordSalt ) {
4277 if ( $salt === false ) {
4278 $salt = MWCryptRand
::generateHex( 8 );
4280 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
4282 return ':A:' . md5( $password );
4287 * Compare a password hash with a plain-text password. Requires the user
4288 * ID if there's a chance that the hash is an old-style hash.
4290 * @param string $hash Password hash
4291 * @param string $password Plain-text password to compare
4292 * @param string|bool $userId User ID for old-style password salt
4296 public static function comparePasswords( $hash, $password, $userId = false ) {
4297 $type = substr( $hash, 0, 3 );
4300 if ( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4304 if ( $type == ':A:' ) {
4306 return md5( $password ) === substr( $hash, 3 );
4307 } elseif ( $type == ':B:' ) {
4309 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4310 return md5( $salt . '-' . md5( $password ) ) === $realHash;
4313 return self
::oldCrypt( $password, $userId ) === $hash;
4318 * Add a newuser log entry for this user.
4319 * Before 1.19 the return value was always true.
4321 * @param string|bool $action account creation type.
4322 * - String, one of the following values:
4323 * - 'create' for an anonymous user creating an account for himself.
4324 * This will force the action's performer to be the created user itself,
4325 * no matter the value of $wgUser
4326 * - 'create2' for a logged in user creating an account for someone else
4327 * - 'byemail' when the created user will receive its password by e-mail
4328 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
4329 * - Boolean means whether the account was created by e-mail (deprecated):
4330 * - true will be converted to 'byemail'
4331 * - false will be converted to 'create' if this object is the same as
4332 * $wgUser and to 'create2' otherwise
4334 * @param string $reason user supplied reason
4336 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4338 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4339 global $wgUser, $wgNewUserLog;
4340 if ( empty( $wgNewUserLog ) ) {
4341 return true; // disabled
4344 if ( $action === true ) {
4345 $action = 'byemail';
4346 } elseif ( $action === false ) {
4347 if ( $this->getName() == $wgUser->getName() ) {
4350 $action = 'create2';
4354 if ( $action === 'create' ||
$action === 'autocreate' ) {
4357 $performer = $wgUser;
4360 $logEntry = new ManualLogEntry( 'newusers', $action );
4361 $logEntry->setPerformer( $performer );
4362 $logEntry->setTarget( $this->getUserPage() );
4363 $logEntry->setComment( $reason );
4364 $logEntry->setParameters( array(
4365 '4::userid' => $this->getId(),
4367 $logid = $logEntry->insert();
4369 if ( $action !== 'autocreate' ) {
4370 $logEntry->publish( $logid );
4377 * Add an autocreate newuser log entry for this user
4378 * Used by things like CentralAuth and perhaps other authplugins.
4379 * Consider calling addNewUserLogEntry() directly instead.
4383 public function addNewUserLogEntryAutoCreate() {
4384 $this->addNewUserLogEntry( 'autocreate' );
4390 * Load the user options either from cache, the database or an array
4392 * @param array $data Rows for the current user out of the user_properties table
4394 protected function loadOptions( $data = null ) {
4399 if ( $this->mOptionsLoaded
) {
4403 $this->mOptions
= self
::getDefaultOptions();
4405 if ( !$this->getId() ) {
4406 // For unlogged-in users, load language/variant options from request.
4407 // There's no need to do it for logged-in users: they can set preferences,
4408 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4409 // so don't override user's choice (especially when the user chooses site default).
4410 $variant = $wgContLang->getDefaultVariant();
4411 $this->mOptions
['variant'] = $variant;
4412 $this->mOptions
['language'] = $variant;
4413 $this->mOptionsLoaded
= true;
4417 // Maybe load from the object
4418 if ( !is_null( $this->mOptionOverrides
) ) {
4419 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4420 foreach ( $this->mOptionOverrides
as $key => $value ) {
4421 $this->mOptions
[$key] = $value;
4424 if ( !is_array( $data ) ) {
4425 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4426 // Load from database
4427 $dbr = wfGetDB( DB_SLAVE
);
4429 $res = $dbr->select(
4431 array( 'up_property', 'up_value' ),
4432 array( 'up_user' => $this->getId() ),
4436 $this->mOptionOverrides
= array();
4438 foreach ( $res as $row ) {
4439 $data[$row->up_property
] = $row->up_value
;
4442 foreach ( $data as $property => $value ) {
4443 $this->mOptionOverrides
[$property] = $value;
4444 $this->mOptions
[$property] = $value;
4448 $this->mOptionsLoaded
= true;
4450 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4456 protected function saveOptions() {
4457 $this->loadOptions();
4459 // Not using getOptions(), to keep hidden preferences in database
4460 $saveOptions = $this->mOptions
;
4462 // Allow hooks to abort, for instance to save to a global profile.
4463 // Reset options to default state before saving.
4464 if ( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4468 $userId = $this->getId();
4469 $insert_rows = array();
4470 foreach ( $saveOptions as $key => $value ) {
4471 # Don't bother storing default values
4472 $defaultOption = self
::getDefaultOption( $key );
4473 if ( ( is_null( $defaultOption ) &&
4474 !( $value === false ||
is_null( $value ) ) ) ||
4475 $value != $defaultOption ) {
4476 $insert_rows[] = array(
4477 'up_user' => $userId,
4478 'up_property' => $key,
4479 'up_value' => $value,
4484 $dbw = wfGetDB( DB_MASTER
);
4485 $hasRows = $dbw->selectField( 'user_properties', '1',
4486 array( 'up_user' => $userId ), __METHOD__
);
4489 // Only do this delete if there is something there. A very large portion of
4490 // calls to this function are for setting 'rememberpassword' for new accounts.
4491 // Doing this delete for new accounts with no rows in the table rougly causes
4492 // gap locks on [max user ID,+infinity) which causes high contention since many
4493 // updates will pile up on each other since they are for higher (newer) user IDs.
4494 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4496 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
, array( 'IGNORE' ) );
4500 * Provide an array of HTML5 attributes to put on an input element
4501 * intended for the user to enter a new password. This may include
4502 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4504 * Do *not* use this when asking the user to enter his current password!
4505 * Regardless of configuration, users may have invalid passwords for whatever
4506 * reason (e.g., they were set before requirements were tightened up).
4507 * Only use it when asking for a new password, like on account creation or
4510 * Obviously, you still need to do server-side checking.
4512 * NOTE: A combination of bugs in various browsers means that this function
4513 * actually just returns array() unconditionally at the moment. May as
4514 * well keep it around for when the browser bugs get fixed, though.
4516 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4518 * @return array Array of HTML attributes suitable for feeding to
4519 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4520 * That will get confused by the boolean attribute syntax used.)
4522 public static function passwordChangeInputAttribs() {
4523 global $wgMinimalPasswordLength;
4525 if ( $wgMinimalPasswordLength == 0 ) {
4529 # Note that the pattern requirement will always be satisfied if the
4530 # input is empty, so we need required in all cases.
4532 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4533 # if e-mail confirmation is being used. Since HTML5 input validation
4534 # is b0rked anyway in some browsers, just return nothing. When it's
4535 # re-enabled, fix this code to not output required for e-mail
4537 #$ret = array( 'required' );
4540 # We can't actually do this right now, because Opera 9.6 will print out
4541 # the entered password visibly in its error message! When other
4542 # browsers add support for this attribute, or Opera fixes its support,
4543 # we can add support with a version check to avoid doing this on Opera
4544 # versions where it will be a problem. Reported to Opera as
4545 # DSK-262266, but they don't have a public bug tracker for us to follow.
4547 if ( $wgMinimalPasswordLength > 1 ) {
4548 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4549 $ret['title'] = wfMessage( 'passwordtooshort' )
4550 ->numParams( $wgMinimalPasswordLength )->text();
4558 * Return the list of user fields that should be selected to create
4559 * a new user object.
4562 public static function selectFields() {
4569 'user_newpass_time',
4573 'user_email_authenticated',
4575 'user_email_token_expires',
4576 'user_registration',