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 * Array of Strings List of member variables which are saved to the
70 * shared cache (memcached). Any operation which changes the
71 * corresponding database fields must call a cache-clearing function.
74 static $mCacheVars = array(
85 'mEmailAuthenticated',
92 // user_properties table
97 * Array of Strings Core rights.
98 * Each of these should have a corresponding message of the form
102 static $mCoreRights = array(
120 'editusercssjs', #deprecated
132 'move-rootuserpages',
136 'override-export-depth',
156 'userrights-interwiki',
160 * String Cached results of getAllRights()
162 static $mAllRights = false;
164 /** @name Cache variables */
166 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
167 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
168 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
169 $mGroups, $mOptionOverrides;
173 * Bool Whether the cache variables have been loaded.
179 * Array with already loaded items or true if all items have been loaded.
181 private $mLoadedItems = array();
185 * String Initialization data source if mLoadedItems!==true. May be one of:
186 * - 'defaults' anonymous user initialised from class defaults
187 * - 'name' initialise from mName
188 * - 'id' initialise from mId
189 * - 'session' log in from cookies or session if possible
191 * Use the User::newFrom*() family of functions to set this.
196 * Lazy-initialized variables, invalidated with clearInstanceCache
198 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
199 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
200 $mLocked, $mHideName, $mOptions;
220 private $mBlockedFromCreateAccount = false;
222 static $idCacheByName = array();
225 * Lightweight constructor for an anonymous user.
226 * Use the User::newFrom* factory functions for other kinds of users.
230 * @see newFromConfirmationCode()
231 * @see newFromSession()
234 function __construct() {
235 $this->clearInstanceCache( 'defaults' );
241 function __toString(){
242 return $this->getName();
246 * Load the user table data for this object from the source given by mFrom.
248 public function load() {
249 if ( $this->mLoadedItems
=== true ) {
252 wfProfileIn( __METHOD__
);
254 # Set it now to avoid infinite recursion in accessors
255 $this->mLoadedItems
= true;
257 switch ( $this->mFrom
) {
259 $this->loadDefaults();
262 $this->mId
= self
::idFromName( $this->mName
);
264 # Nonexistent user placeholder object
265 $this->loadDefaults( $this->mName
);
274 $this->loadFromSession();
275 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
278 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
280 wfProfileOut( __METHOD__
);
284 * Load user table data, given mId has already been set.
285 * @return Bool false if the ID does not exist, true otherwise
287 public function loadFromId() {
289 if ( $this->mId
== 0 ) {
290 $this->loadDefaults();
295 $key = wfMemcKey( 'user', 'id', $this->mId
);
296 $data = $wgMemc->get( $key );
297 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
298 # Object is expired, load from DB
303 wfDebug( "User: cache miss for user {$this->mId}\n" );
305 if ( !$this->loadFromDatabase() ) {
306 # Can't load from ID, user is anonymous
309 $this->saveToCache();
311 wfDebug( "User: got user {$this->mId} from cache\n" );
313 foreach ( self
::$mCacheVars as $name ) {
314 $this->$name = $data[$name];
321 * Save user data to the shared cache
323 public function saveToCache() {
326 $this->loadOptions();
327 if ( $this->isAnon() ) {
328 // Anonymous users are uncached
332 foreach ( self
::$mCacheVars as $name ) {
333 $data[$name] = $this->$name;
335 $data['mVersion'] = MW_USER_VERSION
;
336 $key = wfMemcKey( 'user', 'id', $this->mId
);
338 $wgMemc->set( $key, $data );
341 /** @name newFrom*() static factory methods */
345 * Static factory method for creation from username.
347 * This is slightly less efficient than newFromId(), so use newFromId() if
348 * you have both an ID and a name handy.
350 * @param $name String Username, validated by Title::newFromText()
351 * @param $validate String|Bool Validate username. Takes the same parameters as
352 * User::getCanonicalName(), except that true is accepted as an alias
353 * for 'valid', for BC.
355 * @return User object, or false if the username is invalid
356 * (e.g. if it contains illegal characters or is an IP address). If the
357 * username is not present in the database, the result will be a user object
358 * with a name, zero user ID and default settings.
360 public static function newFromName( $name, $validate = 'valid' ) {
361 if ( $validate === true ) {
364 $name = self
::getCanonicalName( $name, $validate );
365 if ( $name === false ) {
368 # Create unloaded user object
372 $u->setItemLoaded( 'name' );
378 * Static factory method for creation from a given user ID.
380 * @param $id Int Valid user ID
381 * @return User The corresponding User object
383 public static function newFromId( $id ) {
387 $u->setItemLoaded( 'id' );
392 * Factory method to fetch whichever user has a given email confirmation code.
393 * This code is generated when an account is created or its e-mail address
396 * If the code is invalid or has expired, returns NULL.
398 * @param $code String Confirmation code
399 * @return User object, or null
401 public static function newFromConfirmationCode( $code ) {
402 $dbr = wfGetDB( DB_SLAVE
);
403 $id = $dbr->selectField( 'user', 'user_id', array(
404 'user_email_token' => md5( $code ),
405 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
407 if( $id !== false ) {
408 return User
::newFromId( $id );
415 * Create a new user object using data from session or cookies. If the
416 * login credentials are invalid, the result is an anonymous user.
418 * @param $request WebRequest object to use; $wgRequest will be used if
420 * @return User object
422 public static function newFromSession( WebRequest
$request = null ) {
424 $user->mFrom
= 'session';
425 $user->mRequest
= $request;
430 * Create a new user object from a user row.
431 * The row should have the following fields from the user table in it:
432 * - either user_name or user_id to load further data if needed (or both)
434 * - all other fields (email, password, etc.)
435 * It is useless to provide the remaining fields if either user_id,
436 * user_name and user_real_name are not provided because the whole row
437 * will be loaded once more from the database when accessing them.
439 * @param $row Array A row from the user table
442 public static function newFromRow( $row ) {
444 $user->loadFromRow( $row );
451 * Get the username corresponding to a given user ID
452 * @param $id Int User ID
453 * @return String|bool The corresponding username
455 public static function whoIs( $id ) {
456 $dbr = wfGetDB( DB_SLAVE
);
457 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
461 * Get the real name of a user given their user ID
463 * @param $id Int User ID
464 * @return String|bool The corresponding user's real name
466 public static function whoIsReal( $id ) {
467 $dbr = wfGetDB( DB_SLAVE
);
468 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
472 * Get database id given a user name
473 * @param $name String Username
474 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
476 public static function idFromName( $name ) {
477 $nt = Title
::makeTitleSafe( NS_USER
, $name );
478 if( is_null( $nt ) ) {
483 if ( isset( self
::$idCacheByName[$name] ) ) {
484 return self
::$idCacheByName[$name];
487 $dbr = wfGetDB( DB_SLAVE
);
488 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
490 if ( $s === false ) {
493 $result = $s->user_id
;
496 self
::$idCacheByName[$name] = $result;
498 if ( count( self
::$idCacheByName ) > 1000 ) {
499 self
::$idCacheByName = array();
506 * Reset the cache used in idFromName(). For use in tests.
508 public static function resetIdByNameCache() {
509 self
::$idCacheByName = array();
513 * Does the string match an anonymous IPv4 address?
515 * This function exists for username validation, in order to reject
516 * usernames which are similar in form to IP addresses. Strings such
517 * as 300.300.300.300 will return true because it looks like an IP
518 * address, despite not being strictly valid.
520 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
521 * address because the usemod software would "cloak" anonymous IP
522 * addresses like this, if we allowed accounts like this to be created
523 * new users could get the old edits of these anonymous users.
525 * @param $name String to match
528 public static function isIP( $name ) {
529 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
533 * Is the input a valid username?
535 * Checks if the input is a valid username, we don't want an empty string,
536 * an IP address, anything that containins slashes (would mess up subpages),
537 * is longer than the maximum allowed username size or doesn't begin with
540 * @param $name String to match
543 public static function isValidUserName( $name ) {
544 global $wgContLang, $wgMaxNameChars;
547 || User
::isIP( $name )
548 ||
strpos( $name, '/' ) !== false
549 ||
strlen( $name ) > $wgMaxNameChars
550 ||
$name != $wgContLang->ucfirst( $name ) ) {
551 wfDebugLog( 'username', __METHOD__
.
552 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
557 // Ensure that the name can't be misresolved as a different title,
558 // such as with extra namespace keys at the start.
559 $parsed = Title
::newFromText( $name );
560 if( is_null( $parsed )
561 ||
$parsed->getNamespace()
562 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
563 wfDebugLog( 'username', __METHOD__
.
564 ": '$name' invalid due to ambiguous prefixes" );
568 // Check an additional blacklist of troublemaker characters.
569 // Should these be merged into the title char list?
570 $unicodeBlacklist = '/[' .
571 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
572 '\x{00a0}' . # non-breaking space
573 '\x{2000}-\x{200f}' . # various whitespace
574 '\x{2028}-\x{202f}' . # breaks and control chars
575 '\x{3000}' . # ideographic space
576 '\x{e000}-\x{f8ff}' . # private use
578 if( preg_match( $unicodeBlacklist, $name ) ) {
579 wfDebugLog( 'username', __METHOD__
.
580 ": '$name' invalid due to blacklisted characters" );
588 * Usernames which fail to pass this function will be blocked
589 * from user login and new account registrations, but may be used
590 * internally by batch processes.
592 * If an account already exists in this form, login will be blocked
593 * by a failure to pass this function.
595 * @param $name String to match
598 public static function isUsableName( $name ) {
599 global $wgReservedUsernames;
600 // Must be a valid username, obviously ;)
601 if ( !self
::isValidUserName( $name ) ) {
605 static $reservedUsernames = false;
606 if ( !$reservedUsernames ) {
607 $reservedUsernames = $wgReservedUsernames;
608 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
611 // Certain names may be reserved for batch processes.
612 foreach ( $reservedUsernames as $reserved ) {
613 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
614 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
616 if ( $reserved == $name ) {
624 * Usernames which fail to pass this function will be blocked
625 * from new account registrations, but may be used internally
626 * either by batch processes or by user accounts which have
627 * already been created.
629 * Additional blacklisting may be added here rather than in
630 * isValidUserName() to avoid disrupting existing accounts.
632 * @param $name String to match
635 public static function isCreatableName( $name ) {
636 global $wgInvalidUsernameCharacters;
638 // Ensure that the username isn't longer than 235 bytes, so that
639 // (at least for the builtin skins) user javascript and css files
640 // will work. (bug 23080)
641 if( strlen( $name ) > 235 ) {
642 wfDebugLog( 'username', __METHOD__
.
643 ": '$name' invalid due to length" );
647 // Preg yells if you try to give it an empty string
648 if( $wgInvalidUsernameCharacters !== '' ) {
649 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
650 wfDebugLog( 'username', __METHOD__
.
651 ": '$name' invalid due to wgInvalidUsernameCharacters" );
656 return self
::isUsableName( $name );
660 * Is the input a valid password for this user?
662 * @param $password String Desired password
665 public function isValidPassword( $password ) {
666 //simple boolean wrapper for getPasswordValidity
667 return $this->getPasswordValidity( $password ) === true;
671 * Given unvalidated password input, return error message on failure.
673 * @param $password String Desired password
674 * @return mixed: true on success, string or array of error message on failure
676 public function getPasswordValidity( $password ) {
677 global $wgMinimalPasswordLength, $wgContLang;
679 static $blockedLogins = array(
680 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
681 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
684 $result = false; //init $result to false for the internal checks
686 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
689 if ( $result === false ) {
690 if( strlen( $password ) < $wgMinimalPasswordLength ) {
691 return 'passwordtooshort';
692 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
693 return 'password-name-match';
694 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
695 return 'password-login-forbidden';
697 //it seems weird returning true here, but this is because of the
698 //initialization of $result to false above. If the hook is never run or it
699 //doesn't modify $result, then we will likely get down into this if with
703 } elseif( $result === true ) {
706 return $result; //the isValidPassword hook set a string $result and returned true
711 * Does a string look like an e-mail address?
713 * This validates an email address using an HTML5 specification found at:
714 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
715 * Which as of 2011-01-24 says:
717 * A valid e-mail address is a string that matches the ABNF production
718 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
719 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
722 * This function is an implementation of the specification as requested in
725 * Client-side forms will use the same standard validation rules via JS or
726 * HTML 5 validation; additional restrictions can be enforced server-side
727 * by extensions via the 'isValidEmailAddr' hook.
729 * Note that this validation doesn't 100% match RFC 2822, but is believed
730 * to be liberal enough for wide use. Some invalid addresses will still
731 * pass validation here.
733 * @param $addr String E-mail address
735 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
737 public static function isValidEmailAddr( $addr ) {
738 wfDeprecated( __METHOD__
, '1.18' );
739 return Sanitizer
::validateEmail( $addr );
743 * Given unvalidated user input, return a canonical username, or false if
744 * the username is invalid.
745 * @param $name String User input
746 * @param $validate String|Bool type of validation to use:
747 * - false No validation
748 * - 'valid' Valid for batch processes
749 * - 'usable' Valid for batch processes and login
750 * - 'creatable' Valid for batch processes, login and account creation
752 * @return bool|string
754 public static function getCanonicalName( $name, $validate = 'valid' ) {
755 # Force usernames to capital
757 $name = $wgContLang->ucfirst( $name );
759 # Reject names containing '#'; these will be cleaned up
760 # with title normalisation, but then it's too late to
762 if( strpos( $name, '#' ) !== false )
765 # Clean up name according to title rules
766 $t = ( $validate === 'valid' ) ?
767 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
768 # Check for invalid titles
769 if( is_null( $t ) ) {
773 # Reject various classes of invalid names
775 $name = $wgAuth->getCanonicalName( $t->getText() );
777 switch ( $validate ) {
781 if ( !User
::isValidUserName( $name ) ) {
786 if ( !User
::isUsableName( $name ) ) {
791 if ( !User
::isCreatableName( $name ) ) {
796 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
802 * Count the number of edits of a user
803 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
805 * @param $uid Int User ID to check
806 * @return Int the user's edit count
808 public static function edits( $uid ) {
809 wfProfileIn( __METHOD__
);
810 $dbr = wfGetDB( DB_SLAVE
);
811 // check if the user_editcount field has been initialized
812 $field = $dbr->selectField(
813 'user', 'user_editcount',
814 array( 'user_id' => $uid ),
818 if( $field === null ) { // it has not been initialized. do so.
819 $dbw = wfGetDB( DB_MASTER
);
820 $count = $dbr->selectField(
821 'revision', 'count(*)',
822 array( 'rev_user' => $uid ),
827 array( 'user_editcount' => $count ),
828 array( 'user_id' => $uid ),
834 wfProfileOut( __METHOD__
);
839 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
840 * @todo hash random numbers to improve security, like generateToken()
842 * @return String new random password
844 public static function randomPassword() {
845 global $wgMinimalPasswordLength;
846 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
847 $l = strlen( $pwchars ) - 1;
849 $pwlength = max( 7, $wgMinimalPasswordLength );
850 $digit = mt_rand( 0, $pwlength - 1 );
852 for ( $i = 0; $i < $pwlength; $i++
) {
853 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars[ mt_rand( 0, $l ) ];
859 * Set cached properties to default.
861 * @note This no longer clears uncached lazy-initialised properties;
862 * the constructor does that instead.
864 * @param $name string
866 public function loadDefaults( $name = false ) {
867 wfProfileIn( __METHOD__
);
870 $this->mName
= $name;
871 $this->mRealName
= '';
872 $this->mPassword
= $this->mNewpassword
= '';
873 $this->mNewpassTime
= null;
875 $this->mOptionOverrides
= null;
876 $this->mOptionsLoaded
= false;
878 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
879 if( $loggedOut !== null ) {
880 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
882 $this->mTouched
= '0'; # Allow any pages to be cached
885 $this->setToken(); # Random
886 $this->mEmailAuthenticated
= null;
887 $this->mEmailToken
= '';
888 $this->mEmailTokenExpires
= null;
889 $this->mRegistration
= wfTimestamp( TS_MW
);
890 $this->mGroups
= array();
892 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
894 wfProfileOut( __METHOD__
);
898 * Return whether an item has been loaded.
900 * @param $item String: item to check. Current possibilities:
904 * @param $all String: 'all' to check if the whole object has been loaded
905 * or any other string to check if only the item is available (e.g.
909 public function isItemLoaded( $item, $all = 'all' ) {
910 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
911 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
915 * Set that an item has been loaded
917 * @param $item String
919 private function setItemLoaded( $item ) {
920 if ( is_array( $this->mLoadedItems
) ) {
921 $this->mLoadedItems
[$item] = true;
926 * Load user data from the session or login cookie. If there are no valid
927 * credentials, initialises the user as an anonymous user.
928 * @return Bool True if the user is logged in, false otherwise.
930 private function loadFromSession() {
931 global $wgExternalAuthType, $wgAutocreatePolicy;
934 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
935 if ( $result !== null ) {
939 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
940 $extUser = ExternalUser
::newFromCookie();
942 # TODO: Automatically create the user here (or probably a bit
943 # lower down, in fact)
947 $request = $this->getRequest();
949 $cookieId = $request->getCookie( 'UserID' );
950 $sessId = $request->getSessionData( 'wsUserID' );
952 if ( $cookieId !== null ) {
953 $sId = intval( $cookieId );
954 if( $sessId !== null && $cookieId != $sessId ) {
955 $this->loadDefaults(); // Possible collision!
956 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
957 cookie user ID ($sId) don't match!" );
960 $request->setSessionData( 'wsUserID', $sId );
961 } elseif ( $sessId !== null && $sessId != 0 ) {
964 $this->loadDefaults();
968 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
969 $sName = $request->getSessionData( 'wsUserName' );
970 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
971 $sName = $request->getCookie( 'UserName' );
972 $request->setSessionData( 'wsUserName', $sName );
974 $this->loadDefaults();
978 $proposedUser = User
::newFromId( $sId );
979 if ( !$proposedUser->isLoggedIn() ) {
981 $this->loadDefaults();
985 global $wgBlockDisablesLogin;
986 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
987 # User blocked and we've disabled blocked user logins
988 $this->loadDefaults();
992 if ( $request->getSessionData( 'wsToken' ) !== null ) {
993 $passwordCorrect = $proposedUser->getToken() === $request->getSessionData( 'wsToken' );
995 } elseif ( $request->getCookie( 'Token' ) !== null ) {
996 $passwordCorrect = $proposedUser->getToken() === $request->getCookie( 'Token' );
999 # No session or persistent login cookie
1000 $this->loadDefaults();
1004 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1005 $this->loadFromUserObject( $proposedUser );
1006 $request->setSessionData( 'wsToken', $this->mToken
);
1007 wfDebug( "User: logged in from $from\n" );
1010 # Invalid credentials
1011 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1012 $this->loadDefaults();
1018 * Load user and user_group data from the database.
1019 * $this->mId must be set, this is how the user is identified.
1021 * @return Bool True if the user exists, false if the user is anonymous
1023 public function loadFromDatabase() {
1025 $this->mId
= intval( $this->mId
);
1027 /** Anonymous user */
1029 $this->loadDefaults();
1033 $dbr = wfGetDB( DB_MASTER
);
1034 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
1036 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1038 if ( $s !== false ) {
1039 # Initialise user table data
1040 $this->loadFromRow( $s );
1041 $this->mGroups
= null; // deferred
1042 $this->getEditCount(); // revalidation for nulls
1047 $this->loadDefaults();
1053 * Initialize this object from a row from the user table.
1055 * @param $row Array Row from the user table to load.
1057 public function loadFromRow( $row ) {
1060 $this->mGroups
= null; // deferred
1062 if ( isset( $row->user_name
) ) {
1063 $this->mName
= $row->user_name
;
1064 $this->mFrom
= 'name';
1065 $this->setItemLoaded( 'name' );
1070 if ( isset( $row->user_real_name
) ) {
1071 $this->mRealName
= $row->user_real_name
;
1072 $this->setItemLoaded( 'realname' );
1077 if ( isset( $row->user_id
) ) {
1078 $this->mId
= intval( $row->user_id
);
1079 $this->mFrom
= 'id';
1080 $this->setItemLoaded( 'id' );
1085 if ( isset( $row->user_editcount
) ) {
1086 $this->mEditCount
= $row->user_editcount
;
1091 if ( isset( $row->user_password
) ) {
1092 $this->mPassword
= $row->user_password
;
1093 $this->mNewpassword
= $row->user_newpassword
;
1094 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1095 $this->mEmail
= $row->user_email
;
1096 if ( isset( $row->user_options
) ) {
1097 $this->decodeOptions( $row->user_options
);
1099 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1100 $this->mToken
= $row->user_token
;
1101 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1102 $this->mEmailToken
= $row->user_email_token
;
1103 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1104 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1110 $this->mLoadedItems
= true;
1115 * Load the data for this user object from another user object.
1119 protected function loadFromUserObject( $user ) {
1121 $user->loadGroups();
1122 $user->loadOptions();
1123 foreach ( self
::$mCacheVars as $var ) {
1124 $this->$var = $user->$var;
1129 * Load the groups from the database if they aren't already loaded.
1131 private function loadGroups() {
1132 if ( is_null( $this->mGroups
) ) {
1133 $dbr = wfGetDB( DB_MASTER
);
1134 $res = $dbr->select( 'user_groups',
1135 array( 'ug_group' ),
1136 array( 'ug_user' => $this->mId
),
1138 $this->mGroups
= array();
1139 foreach ( $res as $row ) {
1140 $this->mGroups
[] = $row->ug_group
;
1146 * Add the user to the group if he/she meets given criteria.
1148 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1149 * possible to remove manually via Special:UserRights. In such case it
1150 * will not be re-added automatically. The user will also not lose the
1151 * group if they no longer meet the criteria.
1153 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1155 * @return array Array of groups the user has been promoted to.
1157 * @see $wgAutopromoteOnce
1159 public function addAutopromoteOnceGroups( $event ) {
1160 global $wgAutopromoteOnceLogInRC;
1162 $toPromote = array();
1163 if ( $this->getId() ) {
1164 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1165 if ( count( $toPromote ) ) {
1166 $oldGroups = $this->getGroups(); // previous groups
1167 foreach ( $toPromote as $group ) {
1168 $this->addGroup( $group );
1170 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1172 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1173 $log->addEntry( 'autopromote',
1174 $this->getUserPage(),
1176 // These group names are "list to texted"-ed in class LogPage.
1177 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1185 * Clear various cached data stored in this object.
1186 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1187 * given source. May be "name", "id", "defaults", "session", or false for
1190 public function clearInstanceCache( $reloadFrom = false ) {
1191 $this->mNewtalk
= -1;
1192 $this->mDatePreference
= null;
1193 $this->mBlockedby
= -1; # Unset
1194 $this->mHash
= false;
1195 $this->mRights
= null;
1196 $this->mEffectiveGroups
= null;
1197 $this->mImplicitGroups
= null;
1198 $this->mOptions
= null;
1200 if ( $reloadFrom ) {
1201 $this->mLoadedItems
= array();
1202 $this->mFrom
= $reloadFrom;
1207 * Combine the language default options with any site-specific options
1208 * and add the default language variants.
1210 * @return Array of String options
1212 public static function getDefaultOptions() {
1213 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1215 $defOpt = $wgDefaultUserOptions;
1216 # default language setting
1217 $variant = $wgContLang->getDefaultVariant();
1218 $defOpt['variant'] = $variant;
1219 $defOpt['language'] = $variant;
1220 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1221 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1223 $defOpt['skin'] = $wgDefaultSkin;
1225 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1226 // but that breaks the parser tests because they rely on being able to change $wgContLang
1227 // mid-request and see that change reflected in the return value of this function.
1228 // Which is insane and would never happen during normal MW operation, but is also not
1229 // likely to get fixed unless and until we context-ify everything.
1230 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1231 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1237 * Get a given default option value.
1239 * @param $opt String Name of option to retrieve
1240 * @return String Default option value
1242 public static function getDefaultOption( $opt ) {
1243 $defOpts = self
::getDefaultOptions();
1244 if( isset( $defOpts[$opt] ) ) {
1245 return $defOpts[$opt];
1253 * Get blocking information
1254 * @param $bFromSlave Bool Whether to check the slave database first. To
1255 * improve performance, non-critical checks are done
1256 * against slaves. Check when actually saving should be
1257 * done against master.
1259 private function getBlockedStatus( $bFromSlave = true ) {
1260 global $wgProxyWhitelist, $wgUser;
1262 if ( -1 != $this->mBlockedby
) {
1266 wfProfileIn( __METHOD__
);
1267 wfDebug( __METHOD__
.": checking...\n" );
1269 // Initialize data...
1270 // Otherwise something ends up stomping on $this->mBlockedby when
1271 // things get lazy-loaded later, causing false positive block hits
1272 // due to -1 !== 0. Probably session-related... Nothing should be
1273 // overwriting mBlockedby, surely?
1276 # We only need to worry about passing the IP address to the Block generator if the
1277 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1278 # know which IP address they're actually coming from
1279 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1280 $ip = $this->getRequest()->getIP();
1286 $block = Block
::newFromTarget( $this->getName(), $ip, !$bFromSlave );
1289 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1290 && !in_array( $ip, $wgProxyWhitelist ) )
1293 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1295 $block->setBlocker( wfMsg( 'proxyblocker' ) );
1296 $block->mReason
= wfMsg( 'proxyblockreason' );
1297 $block->setTarget( $ip );
1298 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1300 $block->setBlocker( wfMsg( 'sorbs' ) );
1301 $block->mReason
= wfMsg( 'sorbsreason' );
1302 $block->setTarget( $ip );
1306 if ( $block instanceof Block
) {
1307 wfDebug( __METHOD__
. ": Found block.\n" );
1308 $this->mBlock
= $block;
1309 $this->mBlockedby
= $block->getByName();
1310 $this->mBlockreason
= $block->mReason
;
1311 $this->mHideName
= $block->mHideName
;
1312 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1314 $this->mBlockedby
= '';
1315 $this->mHideName
= 0;
1316 $this->mAllowUsertalk
= false;
1320 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1322 wfProfileOut( __METHOD__
);
1326 * Whether the given IP is in a DNS blacklist.
1328 * @param $ip String IP to check
1329 * @param $checkWhitelist Bool: whether to check the whitelist first
1330 * @return Bool True if blacklisted.
1332 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1333 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1334 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1336 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1339 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1342 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1343 return $this->inDnsBlacklist( $ip, $urls );
1347 * Whether the given IP is in a given DNS blacklist.
1349 * @param $ip String IP to check
1350 * @param $bases String|Array of Strings: URL of the DNS blacklist
1351 * @return Bool True if blacklisted.
1353 public function inDnsBlacklist( $ip, $bases ) {
1354 wfProfileIn( __METHOD__
);
1357 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1358 if( IP
::isIPv4( $ip ) ) {
1359 # Reverse IP, bug 21255
1360 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1362 foreach( (array)$bases as $base ) {
1364 # If we have an access key, use that too (ProjectHoneypot, etc.)
1365 if( is_array( $base ) ) {
1366 if( count( $base ) >= 2 ) {
1367 # Access key is 1, base URL is 0
1368 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1370 $host = "$ipReversed.{$base[0]}";
1373 $host = "$ipReversed.$base";
1377 $ipList = gethostbynamel( $host );
1380 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1384 wfDebug( "Requested $host, not found in $base.\n" );
1389 wfProfileOut( __METHOD__
);
1394 * Check if an IP address is in the local proxy list
1400 public static function isLocallyBlockedProxy( $ip ) {
1401 global $wgProxyList;
1403 if ( !$wgProxyList ) {
1406 wfProfileIn( __METHOD__
);
1408 if ( !is_array( $wgProxyList ) ) {
1409 # Load from the specified file
1410 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1413 if ( !is_array( $wgProxyList ) ) {
1415 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1417 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1418 # Old-style flipped proxy list
1423 wfProfileOut( __METHOD__
);
1428 * Is this user subject to rate limiting?
1430 * @return Bool True if rate limited
1432 public function isPingLimitable() {
1433 global $wgRateLimitsExcludedIPs;
1434 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1435 // No other good way currently to disable rate limits
1436 // for specific IPs. :P
1437 // But this is a crappy hack and should die.
1440 return !$this->isAllowed('noratelimit');
1444 * Primitive rate limits: enforce maximum actions per time period
1445 * to put a brake on flooding.
1447 * @note When using a shared cache like memcached, IP-address
1448 * last-hit counters will be shared across wikis.
1450 * @param $action String Action to enforce; 'edit' if unspecified
1451 * @return Bool True if a rate limiter was tripped
1453 public function pingLimiter( $action = 'edit' ) {
1454 # Call the 'PingLimiter' hook
1456 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1460 global $wgRateLimits;
1461 if( !isset( $wgRateLimits[$action] ) ) {
1465 # Some groups shouldn't trigger the ping limiter, ever
1466 if( !$this->isPingLimitable() )
1469 global $wgMemc, $wgRateLimitLog;
1470 wfProfileIn( __METHOD__
);
1472 $limits = $wgRateLimits[$action];
1474 $id = $this->getId();
1475 $ip = $this->getRequest()->getIP();
1478 if( isset( $limits['anon'] ) && $id == 0 ) {
1479 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1482 if( isset( $limits['user'] ) && $id != 0 ) {
1483 $userLimit = $limits['user'];
1485 if( $this->isNewbie() ) {
1486 if( isset( $limits['newbie'] ) && $id != 0 ) {
1487 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1489 if( isset( $limits['ip'] ) ) {
1490 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1493 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1494 $subnet = $matches[1];
1495 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1498 // Check for group-specific permissions
1499 // If more than one group applies, use the group with the highest limit
1500 foreach ( $this->getGroups() as $group ) {
1501 if ( isset( $limits[$group] ) ) {
1502 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1503 $userLimit = $limits[$group];
1507 // Set the user limit key
1508 if ( $userLimit !== false ) {
1509 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1510 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1514 foreach( $keys as $key => $limit ) {
1515 list( $max, $period ) = $limit;
1516 $summary = "(limit $max in {$period}s)";
1517 $count = $wgMemc->get( $key );
1520 if( $count > $max ) {
1521 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1522 if( $wgRateLimitLog ) {
1523 wfSuppressWarnings();
1524 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1525 wfRestoreWarnings();
1529 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1532 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1533 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1535 $wgMemc->incr( $key );
1538 wfProfileOut( __METHOD__
);
1543 * Check if user is blocked
1545 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1546 * @return Bool True if blocked, false otherwise
1548 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1549 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1553 * Get the block affecting the user, or null if the user is not blocked
1555 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1556 * @return Block|null
1558 public function getBlock( $bFromSlave = true ){
1559 $this->getBlockedStatus( $bFromSlave );
1560 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1564 * Check if user is blocked from editing a particular article
1566 * @param $title Title to check
1567 * @param $bFromSlave Bool whether to check the slave database instead of the master
1570 function isBlockedFrom( $title, $bFromSlave = false ) {
1571 global $wgBlockAllowsUTEdit;
1572 wfProfileIn( __METHOD__
);
1574 $blocked = $this->isBlocked( $bFromSlave );
1575 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1576 # If a user's name is suppressed, they cannot make edits anywhere
1577 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1578 $title->getNamespace() == NS_USER_TALK
) {
1580 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1583 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1585 wfProfileOut( __METHOD__
);
1590 * If user is blocked, return the name of the user who placed the block
1591 * @return String name of blocker
1593 public function blockedBy() {
1594 $this->getBlockedStatus();
1595 return $this->mBlockedby
;
1599 * If user is blocked, return the specified reason for the block
1600 * @return String Blocking reason
1602 public function blockedFor() {
1603 $this->getBlockedStatus();
1604 return $this->mBlockreason
;
1608 * If user is blocked, return the ID for the block
1609 * @return Int Block ID
1611 public function getBlockId() {
1612 $this->getBlockedStatus();
1613 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1617 * Check if user is blocked on all wikis.
1618 * Do not use for actual edit permission checks!
1619 * This is intented for quick UI checks.
1621 * @param $ip String IP address, uses current client if none given
1622 * @return Bool True if blocked, false otherwise
1624 public function isBlockedGlobally( $ip = '' ) {
1625 if( $this->mBlockedGlobally
!== null ) {
1626 return $this->mBlockedGlobally
;
1628 // User is already an IP?
1629 if( IP
::isIPAddress( $this->getName() ) ) {
1630 $ip = $this->getName();
1632 $ip = $this->getRequest()->getIP();
1635 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1636 $this->mBlockedGlobally
= (bool)$blocked;
1637 return $this->mBlockedGlobally
;
1641 * Check if user account is locked
1643 * @return Bool True if locked, false otherwise
1645 public function isLocked() {
1646 if( $this->mLocked
!== null ) {
1647 return $this->mLocked
;
1650 $authUser = $wgAuth->getUserInstance( $this );
1651 $this->mLocked
= (bool)$authUser->isLocked();
1652 return $this->mLocked
;
1656 * Check if user account is hidden
1658 * @return Bool True if hidden, false otherwise
1660 public function isHidden() {
1661 if( $this->mHideName
!== null ) {
1662 return $this->mHideName
;
1664 $this->getBlockedStatus();
1665 if( !$this->mHideName
) {
1667 $authUser = $wgAuth->getUserInstance( $this );
1668 $this->mHideName
= (bool)$authUser->isHidden();
1670 return $this->mHideName
;
1674 * Get the user's ID.
1675 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1677 public function getId() {
1678 if( $this->mId
=== null && $this->mName
!== null
1679 && User
::isIP( $this->mName
) ) {
1680 // Special case, we know the user is anonymous
1682 } elseif( !$this->isItemLoaded( 'id' ) ) {
1683 // Don't load if this was initialized from an ID
1690 * Set the user and reload all fields according to a given ID
1691 * @param $v Int User ID to reload
1693 public function setId( $v ) {
1695 $this->clearInstanceCache( 'id' );
1699 * Get the user name, or the IP of an anonymous user
1700 * @return String User's name or IP address
1702 public function getName() {
1703 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1704 # Special case optimisation
1705 return $this->mName
;
1708 if ( $this->mName
=== false ) {
1710 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1712 return $this->mName
;
1717 * Set the user name.
1719 * This does not reload fields from the database according to the given
1720 * name. Rather, it is used to create a temporary "nonexistent user" for
1721 * later addition to the database. It can also be used to set the IP
1722 * address for an anonymous user to something other than the current
1725 * @note User::newFromName() has rougly the same function, when the named user
1727 * @param $str String New user name to set
1729 public function setName( $str ) {
1731 $this->mName
= $str;
1735 * Get the user's name escaped by underscores.
1736 * @return String Username escaped by underscores.
1738 public function getTitleKey() {
1739 return str_replace( ' ', '_', $this->getName() );
1743 * Check if the user has new messages.
1744 * @return Bool True if the user has new messages
1746 public function getNewtalk() {
1749 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1750 if( $this->mNewtalk
=== -1 ) {
1751 $this->mNewtalk
= false; # reset talk page status
1753 # Check memcached separately for anons, who have no
1754 # entire User object stored in there.
1757 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1758 $newtalk = $wgMemc->get( $key );
1759 if( strval( $newtalk ) !== '' ) {
1760 $this->mNewtalk
= (bool)$newtalk;
1762 // Since we are caching this, make sure it is up to date by getting it
1764 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1765 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1768 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1772 return (bool)$this->mNewtalk
;
1776 * Return the talk page(s) this user has new messages on.
1777 * @return Array of String page URLs
1779 public function getNewMessageLinks() {
1781 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1784 if( !$this->getNewtalk() )
1786 $up = $this->getUserPage();
1787 $utp = $up->getTalkPage();
1788 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1792 * Internal uncached check for new messages
1795 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1796 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1797 * @param $fromMaster Bool true to fetch from the master, false for a slave
1798 * @return Bool True if the user has new messages
1800 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1801 if ( $fromMaster ) {
1802 $db = wfGetDB( DB_MASTER
);
1804 $db = wfGetDB( DB_SLAVE
);
1806 $ok = $db->selectField( 'user_newtalk', $field,
1807 array( $field => $id ), __METHOD__
);
1808 return $ok !== false;
1812 * Add or update the new messages flag
1813 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1814 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1815 * @return Bool True if successful, false otherwise
1817 protected function updateNewtalk( $field, $id ) {
1818 $dbw = wfGetDB( DB_MASTER
);
1819 $dbw->insert( 'user_newtalk',
1820 array( $field => $id ),
1823 if ( $dbw->affectedRows() ) {
1824 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1827 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1833 * Clear the new messages flag for the given user
1834 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1835 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1836 * @return Bool True if successful, false otherwise
1838 protected function deleteNewtalk( $field, $id ) {
1839 $dbw = wfGetDB( DB_MASTER
);
1840 $dbw->delete( 'user_newtalk',
1841 array( $field => $id ),
1843 if ( $dbw->affectedRows() ) {
1844 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1847 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1853 * Update the 'You have new messages!' status.
1854 * @param $val Bool Whether the user has new messages
1856 public function setNewtalk( $val ) {
1857 if( wfReadOnly() ) {
1862 $this->mNewtalk
= $val;
1864 if( $this->isAnon() ) {
1866 $id = $this->getName();
1869 $id = $this->getId();
1874 $changed = $this->updateNewtalk( $field, $id );
1876 $changed = $this->deleteNewtalk( $field, $id );
1879 if( $this->isAnon() ) {
1880 // Anons have a separate memcached space, since
1881 // user records aren't kept for them.
1882 $key = wfMemcKey( 'newtalk', 'ip', $id );
1883 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1886 $this->invalidateCache();
1891 * Generate a current or new-future timestamp to be stored in the
1892 * user_touched field when we update things.
1893 * @return String Timestamp in TS_MW format
1895 private static function newTouchedTimestamp() {
1896 global $wgClockSkewFudge;
1897 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1901 * Clear user data from memcached.
1902 * Use after applying fun updates to the database; caller's
1903 * responsibility to update user_touched if appropriate.
1905 * Called implicitly from invalidateCache() and saveSettings().
1907 private function clearSharedCache() {
1911 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1916 * Immediately touch the user data cache for this account.
1917 * Updates user_touched field, and removes account data from memcached
1918 * for reload on the next hit.
1920 public function invalidateCache() {
1921 if( wfReadOnly() ) {
1926 $this->mTouched
= self
::newTouchedTimestamp();
1928 $dbw = wfGetDB( DB_MASTER
);
1929 $dbw->update( 'user',
1930 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1931 array( 'user_id' => $this->mId
),
1934 $this->clearSharedCache();
1939 * Validate the cache for this account.
1940 * @param $timestamp String A timestamp in TS_MW format
1944 public function validateCache( $timestamp ) {
1946 return ( $timestamp >= $this->mTouched
);
1950 * Get the user touched timestamp
1951 * @return String timestamp
1953 public function getTouched() {
1955 return $this->mTouched
;
1959 * Set the password and reset the random token.
1960 * Calls through to authentication plugin if necessary;
1961 * will have no effect if the auth plugin refuses to
1962 * pass the change through or if the legal password
1965 * As a special case, setting the password to null
1966 * wipes it, so the account cannot be logged in until
1967 * a new password is set, for instance via e-mail.
1969 * @param $str String New password to set
1970 * @throws PasswordError on failure
1974 public function setPassword( $str ) {
1977 if( $str !== null ) {
1978 if( !$wgAuth->allowPasswordChange() ) {
1979 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1982 if( !$this->isValidPassword( $str ) ) {
1983 global $wgMinimalPasswordLength;
1984 $valid = $this->getPasswordValidity( $str );
1985 if ( is_array( $valid ) ) {
1986 $message = array_shift( $valid );
1990 $params = array( $wgMinimalPasswordLength );
1992 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
1996 if( !$wgAuth->setPassword( $this, $str ) ) {
1997 throw new PasswordError( wfMsg( 'externaldberror' ) );
2000 $this->setInternalPassword( $str );
2006 * Set the password and reset the random token unconditionally.
2008 * @param $str String New password to set
2010 public function setInternalPassword( $str ) {
2014 if( $str === null ) {
2015 // Save an invalid hash...
2016 $this->mPassword
= '';
2018 $this->mPassword
= self
::crypt( $str );
2020 $this->mNewpassword
= '';
2021 $this->mNewpassTime
= null;
2025 * Get the user's current token.
2026 * @return String Token
2028 public function getToken() {
2030 return $this->mToken
;
2034 * Set the random token (used for persistent authentication)
2035 * Called from loadDefaults() among other places.
2037 * @param $token String|bool If specified, set the token to this value
2039 public function setToken( $token = false ) {
2040 global $wgSecretKey, $wgProxyKey;
2043 if ( $wgSecretKey ) {
2044 $key = $wgSecretKey;
2045 } elseif ( $wgProxyKey ) {
2050 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
2052 $this->mToken
= $token;
2057 * Set the password for a password reminder or new account email
2059 * @param $str String New password to set
2060 * @param $throttle Bool If true, reset the throttle timestamp to the present
2062 public function setNewpassword( $str, $throttle = true ) {
2064 $this->mNewpassword
= self
::crypt( $str );
2066 $this->mNewpassTime
= wfTimestampNow();
2071 * Has password reminder email been sent within the last
2072 * $wgPasswordReminderResendTime hours?
2075 public function isPasswordReminderThrottled() {
2076 global $wgPasswordReminderResendTime;
2078 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2081 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2082 return time() < $expiry;
2086 * Get the user's e-mail address
2087 * @return String User's email address
2089 public function getEmail() {
2091 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2092 return $this->mEmail
;
2096 * Get the timestamp of the user's e-mail authentication
2097 * @return String TS_MW timestamp
2099 public function getEmailAuthenticationTimestamp() {
2101 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2102 return $this->mEmailAuthenticated
;
2106 * Set the user's e-mail address
2107 * @param $str String New e-mail address
2109 public function setEmail( $str ) {
2111 if( $str == $this->mEmail
) {
2114 $this->mEmail
= $str;
2115 $this->invalidateEmail();
2116 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2120 * Get the user's real name
2121 * @return String User's real name
2123 public function getRealName() {
2124 if ( !$this->isItemLoaded( 'realname' ) ) {
2128 return $this->mRealName
;
2132 * Set the user's real name
2133 * @param $str String New real name
2135 public function setRealName( $str ) {
2137 $this->mRealName
= $str;
2141 * Get the user's current setting for a given option.
2143 * @param $oname String The option to check
2144 * @param $defaultOverride String A default value returned if the option does not exist
2145 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2146 * @return String User's current value for the option
2147 * @see getBoolOption()
2148 * @see getIntOption()
2150 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2151 global $wgHiddenPrefs;
2152 $this->loadOptions();
2154 if ( is_null( $this->mOptions
) ) {
2155 if($defaultOverride != '') {
2156 return $defaultOverride;
2158 $this->mOptions
= User
::getDefaultOptions();
2161 # We want 'disabled' preferences to always behave as the default value for
2162 # users, even if they have set the option explicitly in their settings (ie they
2163 # set it, and then it was disabled removing their ability to change it). But
2164 # we don't want to erase the preferences in the database in case the preference
2165 # is re-enabled again. So don't touch $mOptions, just override the returned value
2166 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2167 return self
::getDefaultOption( $oname );
2170 if ( array_key_exists( $oname, $this->mOptions
) ) {
2171 return $this->mOptions
[$oname];
2173 return $defaultOverride;
2178 * Get all user's options
2182 public function getOptions() {
2183 global $wgHiddenPrefs;
2184 $this->loadOptions();
2185 $options = $this->mOptions
;
2187 # We want 'disabled' preferences to always behave as the default value for
2188 # users, even if they have set the option explicitly in their settings (ie they
2189 # set it, and then it was disabled removing their ability to change it). But
2190 # we don't want to erase the preferences in the database in case the preference
2191 # is re-enabled again. So don't touch $mOptions, just override the returned value
2192 foreach( $wgHiddenPrefs as $pref ){
2193 $default = self
::getDefaultOption( $pref );
2194 if( $default !== null ){
2195 $options[$pref] = $default;
2203 * Get the user's current setting for a given option, as a boolean value.
2205 * @param $oname String The option to check
2206 * @return Bool User's current value for the option
2209 public function getBoolOption( $oname ) {
2210 return (bool)$this->getOption( $oname );
2214 * Get the user's current setting for a given option, as a boolean value.
2216 * @param $oname String The option to check
2217 * @param $defaultOverride Int A default value returned if the option does not exist
2218 * @return Int User's current value for the option
2221 public function getIntOption( $oname, $defaultOverride=0 ) {
2222 $val = $this->getOption( $oname );
2224 $val = $defaultOverride;
2226 return intval( $val );
2230 * Set the given option for a user.
2232 * @param $oname String The option to set
2233 * @param $val mixed New value to set
2235 public function setOption( $oname, $val ) {
2237 $this->loadOptions();
2239 // Explicitly NULL values should refer to defaults
2240 global $wgDefaultUserOptions;
2241 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2242 $val = $wgDefaultUserOptions[$oname];
2245 $this->mOptions
[$oname] = $val;
2249 * Reset all options to the site defaults
2251 public function resetOptions() {
2252 $this->mOptions
= self
::getDefaultOptions();
2256 * Get the user's preferred date format.
2257 * @return String User's preferred date format
2259 public function getDatePreference() {
2260 // Important migration for old data rows
2261 if ( is_null( $this->mDatePreference
) ) {
2263 $value = $this->getOption( 'date' );
2264 $map = $wgLang->getDatePreferenceMigrationMap();
2265 if ( isset( $map[$value] ) ) {
2266 $value = $map[$value];
2268 $this->mDatePreference
= $value;
2270 return $this->mDatePreference
;
2274 * Get the user preferred stub threshold
2278 public function getStubThreshold() {
2279 global $wgMaxArticleSize; # Maximum article size, in Kb
2280 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2281 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2282 # If they have set an impossible value, disable the preference
2283 # so we can use the parser cache again.
2290 * Get the permissions this user has.
2291 * @return Array of String permission names
2293 public function getRights() {
2294 if ( is_null( $this->mRights
) ) {
2295 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2296 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2297 // Force reindexation of rights when a hook has unset one of them
2298 $this->mRights
= array_values( $this->mRights
);
2300 return $this->mRights
;
2304 * Get the list of explicit group memberships this user has.
2305 * The implicit * and user groups are not included.
2306 * @return Array of String internal group names
2308 public function getGroups() {
2310 $this->loadGroups();
2311 return $this->mGroups
;
2315 * Get the list of implicit group memberships this user has.
2316 * This includes all explicit groups, plus 'user' if logged in,
2317 * '*' for all accounts, and autopromoted groups
2318 * @param $recache Bool Whether to avoid the cache
2319 * @return Array of String internal group names
2321 public function getEffectiveGroups( $recache = false ) {
2322 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2323 wfProfileIn( __METHOD__
);
2324 $this->mEffectiveGroups
= array_unique( array_merge(
2325 $this->getGroups(), // explicit groups
2326 $this->getAutomaticGroups( $recache ) // implicit groups
2328 # Hook for additional groups
2329 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2330 wfProfileOut( __METHOD__
);
2332 return $this->mEffectiveGroups
;
2336 * Get the list of implicit group memberships this user has.
2337 * This includes 'user' if logged in, '*' for all accounts,
2338 * and autopromoted groups
2339 * @param $recache Bool Whether to avoid the cache
2340 * @return Array of String internal group names
2342 public function getAutomaticGroups( $recache = false ) {
2343 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2344 wfProfileIn( __METHOD__
);
2345 $this->mImplicitGroups
= array( '*' );
2346 if ( $this->getId() ) {
2347 $this->mImplicitGroups
[] = 'user';
2349 $this->mImplicitGroups
= array_unique( array_merge(
2350 $this->mImplicitGroups
,
2351 Autopromote
::getAutopromoteGroups( $this )
2355 # Assure data consistency with rights/groups,
2356 # as getEffectiveGroups() depends on this function
2357 $this->mEffectiveGroups
= null;
2359 wfProfileOut( __METHOD__
);
2361 return $this->mImplicitGroups
;
2365 * Returns the groups the user has belonged to.
2367 * The user may still belong to the returned groups. Compare with getGroups().
2369 * The function will not return groups the user had belonged to before MW 1.17
2371 * @return array Names of the groups the user has belonged to.
2373 public function getFormerGroups() {
2374 if( is_null( $this->mFormerGroups
) ) {
2375 $dbr = wfGetDB( DB_MASTER
);
2376 $res = $dbr->select( 'user_former_groups',
2377 array( 'ufg_group' ),
2378 array( 'ufg_user' => $this->mId
),
2380 $this->mFormerGroups
= array();
2381 foreach( $res as $row ) {
2382 $this->mFormerGroups
[] = $row->ufg_group
;
2385 return $this->mFormerGroups
;
2389 * Get the user's edit count.
2392 public function getEditCount() {
2393 if( $this->getId() ) {
2394 if ( !isset( $this->mEditCount
) ) {
2395 /* Populate the count, if it has not been populated yet */
2396 $this->mEditCount
= User
::edits( $this->mId
);
2398 return $this->mEditCount
;
2406 * Add the user to the given group.
2407 * This takes immediate effect.
2408 * @param $group String Name of the group to add
2410 public function addGroup( $group ) {
2411 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2412 $dbw = wfGetDB( DB_MASTER
);
2413 if( $this->getId() ) {
2414 $dbw->insert( 'user_groups',
2416 'ug_user' => $this->getID(),
2417 'ug_group' => $group,
2420 array( 'IGNORE' ) );
2423 $this->loadGroups();
2424 $this->mGroups
[] = $group;
2425 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2427 $this->invalidateCache();
2431 * Remove the user from the given group.
2432 * This takes immediate effect.
2433 * @param $group String Name of the group to remove
2435 public function removeGroup( $group ) {
2437 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2438 $dbw = wfGetDB( DB_MASTER
);
2439 $dbw->delete( 'user_groups',
2441 'ug_user' => $this->getID(),
2442 'ug_group' => $group,
2444 // Remember that the user was in this group
2445 $dbw->insert( 'user_former_groups',
2447 'ufg_user' => $this->getID(),
2448 'ufg_group' => $group,
2451 array( 'IGNORE' ) );
2453 $this->loadGroups();
2454 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2455 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2457 $this->invalidateCache();
2461 * Get whether the user is logged in
2464 public function isLoggedIn() {
2465 return $this->getID() != 0;
2469 * Get whether the user is anonymous
2472 public function isAnon() {
2473 return !$this->isLoggedIn();
2477 * Check if user is allowed to access a feature / make an action
2479 * @internal param \String $varargs permissions to test
2480 * @return Boolean: True if user is allowed to perform *any* of the given actions
2484 public function isAllowedAny( /*...*/ ){
2485 $permissions = func_get_args();
2486 foreach( $permissions as $permission ){
2487 if( $this->isAllowed( $permission ) ){
2496 * @internal param $varargs string
2497 * @return bool True if the user is allowed to perform *all* of the given actions
2499 public function isAllowedAll( /*...*/ ){
2500 $permissions = func_get_args();
2501 foreach( $permissions as $permission ){
2502 if( !$this->isAllowed( $permission ) ){
2510 * Internal mechanics of testing a permission
2511 * @param $action String
2514 public function isAllowed( $action = '' ) {
2515 if ( $action === '' ) {
2516 return true; // In the spirit of DWIM
2518 # Patrolling may not be enabled
2519 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2520 global $wgUseRCPatrol, $wgUseNPPatrol;
2521 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2524 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2525 # by misconfiguration: 0 == 'foo'
2526 return in_array( $action, $this->getRights(), true );
2530 * Check whether to enable recent changes patrol features for this user
2531 * @return Boolean: True or false
2533 public function useRCPatrol() {
2534 global $wgUseRCPatrol;
2535 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2539 * Check whether to enable new pages patrol features for this user
2540 * @return Bool True or false
2542 public function useNPPatrol() {
2543 global $wgUseRCPatrol, $wgUseNPPatrol;
2544 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2548 * Get the WebRequest object to use with this object
2550 * @return WebRequest
2552 public function getRequest() {
2553 if ( $this->mRequest
) {
2554 return $this->mRequest
;
2562 * Get the current skin, loading it if required
2563 * @return Skin The current skin
2564 * @todo FIXME: Need to check the old failback system [AV]
2565 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2567 public function getSkin() {
2568 wfDeprecated( __METHOD__
, '1.18' );
2569 return RequestContext
::getMain()->getSkin();
2573 * Check the watched status of an article.
2574 * @param $title Title of the article to look at
2577 public function isWatched( $title ) {
2578 $wl = WatchedItem
::fromUserTitle( $this, $title );
2579 return $wl->isWatched();
2584 * @param $title Title of the article to look at
2586 public function addWatch( $title ) {
2587 $wl = WatchedItem
::fromUserTitle( $this, $title );
2589 $this->invalidateCache();
2593 * Stop watching an article.
2594 * @param $title Title of the article to look at
2596 public function removeWatch( $title ) {
2597 $wl = WatchedItem
::fromUserTitle( $this, $title );
2599 $this->invalidateCache();
2603 * Clear the user's notification timestamp for the given title.
2604 * If e-notif e-mails are on, they will receive notification mails on
2605 * the next change of the page if it's watched etc.
2606 * @param $title Title of the article to look at
2608 public function clearNotification( &$title ) {
2609 global $wgUseEnotif, $wgShowUpdatedMarker;
2611 # Do nothing if the database is locked to writes
2612 if( wfReadOnly() ) {
2616 if( $title->getNamespace() == NS_USER_TALK
&&
2617 $title->getText() == $this->getName() ) {
2618 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2620 $this->setNewtalk( false );
2623 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2627 if( $this->isAnon() ) {
2628 // Nothing else to do...
2632 // Only update the timestamp if the page is being watched.
2633 // The query to find out if it is watched is cached both in memcached and per-invocation,
2634 // and when it does have to be executed, it can be on a slave
2635 // If this is the user's newtalk page, we always update the timestamp
2637 if ( $title->getNamespace() == NS_USER_TALK
&&
2638 $title->getText() == $this->getName() )
2643 $wi = WatchedItem
::fromUserTitle( $this, $title );
2644 $wi->resetNotificationTimestamp( $force );
2648 * Resets all of the given user's page-change notification timestamps.
2649 * If e-notif e-mails are on, they will receive notification mails on
2650 * the next change of any watched page.
2652 public function clearAllNotifications() {
2653 global $wgUseEnotif, $wgShowUpdatedMarker;
2654 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2655 $this->setNewtalk( false );
2658 $id = $this->getId();
2660 $dbw = wfGetDB( DB_MASTER
);
2661 $dbw->update( 'watchlist',
2663 'wl_notificationtimestamp' => null
2664 ), array( /* WHERE */
2668 # We also need to clear here the "you have new message" notification for the own user_talk page
2669 # This is cleared one page view later in Article::viewUpdates();
2674 * Set this user's options from an encoded string
2675 * @param $str String Encoded options to import
2677 * @deprecated in 1.19 due to removal of user_options from the user table
2679 private function decodeOptions( $str ) {
2680 wfDeprecated( __METHOD__
, '1.19' );
2684 $this->mOptionsLoaded
= true;
2685 $this->mOptionOverrides
= array();
2687 // If an option is not set in $str, use the default value
2688 $this->mOptions
= self
::getDefaultOptions();
2690 $a = explode( "\n", $str );
2691 foreach ( $a as $s ) {
2693 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2694 $this->mOptions
[$m[1]] = $m[2];
2695 $this->mOptionOverrides
[$m[1]] = $m[2];
2701 * Set a cookie on the user's client. Wrapper for
2702 * WebResponse::setCookie
2703 * @param $name String Name of the cookie to set
2704 * @param $value String Value to set
2705 * @param $exp Int Expiration time, as a UNIX time value;
2706 * if 0 or not specified, use the default $wgCookieExpiration
2708 protected function setCookie( $name, $value, $exp = 0 ) {
2709 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2713 * Clear a cookie on the user's client
2714 * @param $name String Name of the cookie to clear
2716 protected function clearCookie( $name ) {
2717 $this->setCookie( $name, '', time() - 86400 );
2721 * Set the default cookies for this session on the user's client.
2723 * @param $request WebRequest object to use; $wgRequest will be used if null
2726 public function setCookies( $request = null ) {
2727 if ( $request === null ) {
2728 $request = $this->getRequest();
2732 if ( 0 == $this->mId
) return;
2733 if ( !$this->mToken
) {
2734 // When token is empty or NULL generate a new one and then save it to the database
2735 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2736 // Simply by setting every cell in the user_token column to NULL and letting them be
2737 // regenerated as users log back into the wiki.
2739 $this->saveSettings();
2742 'wsUserID' => $this->mId
,
2743 'wsToken' => $this->mToken
,
2744 'wsUserName' => $this->getName()
2747 'UserID' => $this->mId
,
2748 'UserName' => $this->getName(),
2750 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2751 $cookies['Token'] = $this->mToken
;
2753 $cookies['Token'] = false;
2756 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2758 foreach ( $session as $name => $value ) {
2759 $request->setSessionData( $name, $value );
2761 foreach ( $cookies as $name => $value ) {
2762 if ( $value === false ) {
2763 $this->clearCookie( $name );
2765 $this->setCookie( $name, $value );
2771 * Log this user out.
2773 public function logout() {
2774 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2780 * Clear the user's cookies and session, and reset the instance cache.
2783 public function doLogout() {
2784 $this->clearInstanceCache( 'defaults' );
2786 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2788 $this->clearCookie( 'UserID' );
2789 $this->clearCookie( 'Token' );
2791 # Remember when user logged out, to prevent seeing cached pages
2792 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2796 * Save this user's settings into the database.
2797 * @todo Only rarely do all these fields need to be set!
2799 public function saveSettings() {
2801 if ( wfReadOnly() ) { return; }
2802 if ( 0 == $this->mId
) { return; }
2804 $this->mTouched
= self
::newTouchedTimestamp();
2806 $dbw = wfGetDB( DB_MASTER
);
2807 $dbw->update( 'user',
2809 'user_name' => $this->mName
,
2810 'user_password' => $this->mPassword
,
2811 'user_newpassword' => $this->mNewpassword
,
2812 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2813 'user_real_name' => $this->mRealName
,
2814 'user_email' => $this->mEmail
,
2815 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2816 'user_touched' => $dbw->timestamp( $this->mTouched
),
2817 'user_token' => $this->mToken
,
2818 'user_email_token' => $this->mEmailToken
,
2819 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2820 ), array( /* WHERE */
2821 'user_id' => $this->mId
2825 $this->saveOptions();
2827 wfRunHooks( 'UserSaveSettings', array( $this ) );
2828 $this->clearSharedCache();
2829 $this->getUserPage()->invalidateCache();
2833 * If only this user's username is known, and it exists, return the user ID.
2836 public function idForName() {
2837 $s = trim( $this->getName() );
2838 if ( $s === '' ) return 0;
2840 $dbr = wfGetDB( DB_SLAVE
);
2841 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2842 if ( $id === false ) {
2849 * Add a user to the database, return the user object
2851 * @param $name String Username to add
2852 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2853 * - password The user's password hash. Password logins will be disabled if this is omitted.
2854 * - newpassword Hash for a temporary password that has been mailed to the user
2855 * - email The user's email address
2856 * - email_authenticated The email authentication timestamp
2857 * - real_name The user's real name
2858 * - options An associative array of non-default options
2859 * - token Random authentication token. Do not set.
2860 * - registration Registration timestamp. Do not set.
2862 * @return User object, or null if the username already exists
2864 public static function createNew( $name, $params = array() ) {
2867 if ( isset( $params['options'] ) ) {
2868 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2869 unset( $params['options'] );
2871 $dbw = wfGetDB( DB_MASTER
);
2872 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2875 'user_id' => $seqVal,
2876 'user_name' => $name,
2877 'user_password' => $user->mPassword
,
2878 'user_newpassword' => $user->mNewpassword
,
2879 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2880 'user_email' => $user->mEmail
,
2881 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2882 'user_real_name' => $user->mRealName
,
2883 'user_token' => $user->mToken
,
2884 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2885 'user_editcount' => 0,
2886 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
2888 foreach ( $params as $name => $value ) {
2889 $fields["user_$name"] = $value;
2891 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2892 if ( $dbw->affectedRows() ) {
2893 $newUser = User
::newFromId( $dbw->insertId() );
2901 * Add this existing user object to the database
2903 public function addToDatabase() {
2906 $this->mTouched
= self
::newTouchedTimestamp();
2908 $dbw = wfGetDB( DB_MASTER
);
2909 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2910 $dbw->insert( 'user',
2912 'user_id' => $seqVal,
2913 'user_name' => $this->mName
,
2914 'user_password' => $this->mPassword
,
2915 'user_newpassword' => $this->mNewpassword
,
2916 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2917 'user_email' => $this->mEmail
,
2918 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2919 'user_real_name' => $this->mRealName
,
2920 'user_token' => $this->mToken
,
2921 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2922 'user_editcount' => 0,
2923 'user_touched' => $dbw->timestamp( $this->mTouched
),
2926 $this->mId
= $dbw->insertId();
2928 // Clear instance cache other than user table data, which is already accurate
2929 $this->clearInstanceCache();
2931 $this->saveOptions();
2935 * If this user is logged-in and blocked,
2936 * block any IP address they've successfully logged in from.
2937 * @return bool A block was spread
2939 public function spreadAnyEditBlock() {
2940 if ( $this->isLoggedIn() && $this->isBlocked() ) {
2941 return $this->spreadBlock();
2947 * If this (non-anonymous) user is blocked,
2948 * block the IP address they've successfully logged in from.
2949 * @return bool A block was spread
2951 protected function spreadBlock() {
2952 wfDebug( __METHOD__
. "()\n" );
2954 if ( $this->mId
== 0 ) {
2958 $userblock = Block
::newFromTarget( $this->getName() );
2959 if ( !$userblock ) {
2963 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
2967 * Generate a string which will be different for any combination of
2968 * user options which would produce different parser output.
2969 * This will be used as part of the hash key for the parser cache,
2970 * so users with the same options can share the same cached data
2973 * Extensions which require it should install 'PageRenderingHash' hook,
2974 * which will give them a chance to modify this key based on their own
2977 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
2978 * @return String Page rendering hash
2980 public function getPageRenderingHash() {
2981 wfDeprecated( __METHOD__
, '1.17' );
2983 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2985 return $this->mHash
;
2988 // stubthreshold is only included below for completeness,
2989 // since it disables the parser cache, its value will always
2990 // be 0 when this function is called by parsercache.
2992 $confstr = $this->getOption( 'math' );
2993 $confstr .= '!' . $this->getStubThreshold();
2994 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2995 $confstr .= '!' . $this->getDatePreference();
2997 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2998 $confstr .= '!' . $wgLang->getCode();
2999 $confstr .= '!' . $this->getOption( 'thumbsize' );
3000 // add in language specific options, if any
3001 $extra = $wgContLang->getExtraHashOptions();
3004 // Since the skin could be overloading link(), it should be
3005 // included here but in practice, none of our skins do that.
3007 $confstr .= $wgRenderHashAppend;
3009 // Give a chance for extensions to modify the hash, if they have
3010 // extra options or other effects on the parser cache.
3011 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3013 // Make it a valid memcached key fragment
3014 $confstr = str_replace( ' ', '_', $confstr );
3015 $this->mHash
= $confstr;
3020 * Get whether the user is explicitly blocked from account creation.
3021 * @return Bool|Block
3023 public function isBlockedFromCreateAccount() {
3024 $this->getBlockedStatus();
3025 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3026 return $this->mBlock
;
3029 # bug 13611: if the IP address the user is trying to create an account from is
3030 # blocked with createaccount disabled, prevent new account creation there even
3031 # when the user is logged in
3032 if( $this->mBlockedFromCreateAccount
=== false ){
3033 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3035 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3036 ?
$this->mBlockedFromCreateAccount
3041 * Get whether the user is blocked from using Special:Emailuser.
3044 public function isBlockedFromEmailuser() {
3045 $this->getBlockedStatus();
3046 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3050 * Get whether the user is allowed to create an account.
3053 function isAllowedToCreateAccount() {
3054 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3058 * Get this user's personal page title.
3060 * @return Title: User's personal page title
3062 public function getUserPage() {
3063 return Title
::makeTitle( NS_USER
, $this->getName() );
3067 * Get this user's talk page title.
3069 * @return Title: User's talk page title
3071 public function getTalkPage() {
3072 $title = $this->getUserPage();
3073 return $title->getTalkPage();
3077 * Determine whether the user is a newbie. Newbies are either
3078 * anonymous IPs, or the most recently created accounts.
3081 public function isNewbie() {
3082 return !$this->isAllowed( 'autoconfirmed' );
3086 * Check to see if the given clear-text password is one of the accepted passwords
3087 * @param $password String: user password.
3088 * @return Boolean: True if the given password is correct, otherwise False.
3090 public function checkPassword( $password ) {
3091 global $wgAuth, $wgLegacyEncoding;
3094 // Even though we stop people from creating passwords that
3095 // are shorter than this, doesn't mean people wont be able
3096 // to. Certain authentication plugins do NOT want to save
3097 // domain passwords in a mysql database, so we should
3098 // check this (in case $wgAuth->strict() is false).
3099 if( !$this->isValidPassword( $password ) ) {
3103 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3105 } elseif( $wgAuth->strict() ) {
3106 /* Auth plugin doesn't allow local authentication */
3108 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3109 /* Auth plugin doesn't allow local authentication for this user name */
3112 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3114 } elseif ( $wgLegacyEncoding ) {
3115 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3116 # Check for this with iconv
3117 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3118 if ( $cp1252Password != $password &&
3119 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3128 * Check if the given clear-text password matches the temporary password
3129 * sent by e-mail for password reset operations.
3131 * @param $plaintext string
3133 * @return Boolean: True if matches, false otherwise
3135 public function checkTemporaryPassword( $plaintext ) {
3136 global $wgNewPasswordExpiry;
3139 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3140 if ( is_null( $this->mNewpassTime
) ) {
3143 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3144 return ( time() < $expiry );
3151 * Alias for getEditToken.
3152 * @deprecated since 1.19, use getEditToken instead.
3154 * @param $salt String|Array of Strings Optional function-specific data for hashing
3155 * @param $request WebRequest object to use or null to use $wgRequest
3156 * @return String The new edit token
3158 public function editToken( $salt = '', $request = null ) {
3159 wfDeprecated( __METHOD__
, '1.19' );
3160 return $this->getEditToken( $salt, $request );
3164 * Initialize (if necessary) and return a session token value
3165 * which can be used in edit forms to show that the user's
3166 * login credentials aren't being hijacked with a foreign form
3171 * @param $salt String|Array of Strings Optional function-specific data for hashing
3172 * @param $request WebRequest object to use or null to use $wgRequest
3173 * @return String The new edit token
3175 public function getEditToken( $salt = '', $request = null ) {
3176 if ( $request == null ) {
3177 $request = $this->getRequest();
3180 if ( $this->isAnon() ) {
3181 return EDIT_TOKEN_SUFFIX
;
3183 $token = $request->getSessionData( 'wsEditToken' );
3184 if ( $token === null ) {
3185 $token = self
::generateToken();
3186 $request->setSessionData( 'wsEditToken', $token );
3188 if( is_array( $salt ) ) {
3189 $salt = implode( '|', $salt );
3191 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3196 * Generate a looking random token for various uses.
3198 * @param $salt String Optional salt value
3199 * @return String The new random token
3201 public static function generateToken( $salt = '' ) {
3202 $token = dechex( mt_rand() ) . dechex( mt_rand() );
3203 return md5( $token . $salt );
3207 * Check given value against the token value stored in the session.
3208 * A match should confirm that the form was submitted from the
3209 * user's own login session, not a form submission from a third-party
3212 * @param $val String Input value to compare
3213 * @param $salt String Optional function-specific data for hashing
3214 * @param $request WebRequest object to use or null to use $wgRequest
3215 * @return Boolean: Whether the token matches
3217 public function matchEditToken( $val, $salt = '', $request = null ) {
3218 $sessionToken = $this->getEditToken( $salt, $request );
3219 if ( $val != $sessionToken ) {
3220 wfDebug( "User::matchEditToken: broken session data\n" );
3222 return $val == $sessionToken;
3226 * Check given value against the token value stored in the session,
3227 * ignoring the suffix.
3229 * @param $val String Input value to compare
3230 * @param $salt String Optional function-specific data for hashing
3231 * @param $request WebRequest object to use or null to use $wgRequest
3232 * @return Boolean: Whether the token matches
3234 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3235 $sessionToken = $this->getEditToken( $salt, $request );
3236 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3240 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3241 * mail to the user's given address.
3243 * @param $type String: message to send, either "created", "changed" or "set"
3244 * @return Status object
3246 public function sendConfirmationMail( $type = 'created' ) {
3248 $expiration = null; // gets passed-by-ref and defined in next line.
3249 $token = $this->confirmationToken( $expiration );
3250 $url = $this->confirmationTokenUrl( $token );
3251 $invalidateURL = $this->invalidationTokenUrl( $token );
3252 $this->saveSettings();
3254 if ( $type == 'created' ||
$type === false ) {
3255 $message = 'confirmemail_body';
3256 } elseif ( $type === true ) {
3257 $message = 'confirmemail_body_changed';
3259 $message = 'confirmemail_body_' . $type;
3262 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3264 $this->getRequest()->getIP(),
3267 $wgLang->timeanddate( $expiration, false ),
3269 $wgLang->date( $expiration, false ),
3270 $wgLang->time( $expiration, false ) ) );
3274 * Send an e-mail to this user's account. Does not check for
3275 * confirmed status or validity.
3277 * @param $subject String Message subject
3278 * @param $body String Message body
3279 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3280 * @param $replyto String Reply-To address
3283 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3284 if( is_null( $from ) ) {
3285 global $wgPasswordSender, $wgPasswordSenderName;
3286 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3288 $sender = new MailAddress( $from );
3291 $to = new MailAddress( $this );
3292 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3296 * Generate, store, and return a new e-mail confirmation code.
3297 * A hash (unsalted, since it's used as a key) is stored.
3299 * @note Call saveSettings() after calling this function to commit
3300 * this change to the database.
3302 * @param &$expiration \mixed Accepts the expiration time
3303 * @return String New token
3305 private function confirmationToken( &$expiration ) {
3306 global $wgUserEmailConfirmationTokenExpiry;
3308 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3309 $expiration = wfTimestamp( TS_MW
, $expires );
3310 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
3311 $hash = md5( $token );
3313 $this->mEmailToken
= $hash;
3314 $this->mEmailTokenExpires
= $expiration;
3319 * Return a URL the user can use to confirm their email address.
3320 * @param $token String Accepts the email confirmation token
3321 * @return String New token URL
3323 private function confirmationTokenUrl( $token ) {
3324 return $this->getTokenUrl( 'ConfirmEmail', $token );
3328 * Return a URL the user can use to invalidate their email address.
3329 * @param $token String Accepts the email confirmation token
3330 * @return String New token URL
3332 private function invalidationTokenUrl( $token ) {
3333 return $this->getTokenUrl( 'Invalidateemail', $token );
3337 * Internal function to format the e-mail validation/invalidation URLs.
3338 * This uses a quickie hack to use the
3339 * hardcoded English names of the Special: pages, for ASCII safety.
3341 * @note Since these URLs get dropped directly into emails, using the
3342 * short English names avoids insanely long URL-encoded links, which
3343 * also sometimes can get corrupted in some browsers/mailers
3344 * (bug 6957 with Gmail and Internet Explorer).
3346 * @param $page String Special page
3347 * @param $token String Token
3348 * @return String Formatted URL
3350 protected function getTokenUrl( $page, $token ) {
3351 // Hack to bypass localization of 'Special:'
3352 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3353 return $title->getCanonicalUrl();
3357 * Mark the e-mail address confirmed.
3359 * @note Call saveSettings() after calling this function to commit the change.
3363 public function confirmEmail() {
3364 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3365 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3370 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3371 * address if it was already confirmed.
3373 * @note Call saveSettings() after calling this function to commit the change.
3374 * @return bool Returns true
3376 function invalidateEmail() {
3378 $this->mEmailToken
= null;
3379 $this->mEmailTokenExpires
= null;
3380 $this->setEmailAuthenticationTimestamp( null );
3381 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3386 * Set the e-mail authentication timestamp.
3387 * @param $timestamp String TS_MW timestamp
3389 function setEmailAuthenticationTimestamp( $timestamp ) {
3391 $this->mEmailAuthenticated
= $timestamp;
3392 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3396 * Is this user allowed to send e-mails within limits of current
3397 * site configuration?
3400 public function canSendEmail() {
3401 global $wgEnableEmail, $wgEnableUserEmail;
3402 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3405 $canSend = $this->isEmailConfirmed();
3406 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3411 * Is this user allowed to receive e-mails within limits of current
3412 * site configuration?
3415 public function canReceiveEmail() {
3416 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3420 * Is this user's e-mail address valid-looking and confirmed within
3421 * limits of the current site configuration?
3423 * @note If $wgEmailAuthentication is on, this may require the user to have
3424 * confirmed their address by returning a code or using a password
3425 * sent to the address from the wiki.
3429 public function isEmailConfirmed() {
3430 global $wgEmailAuthentication;
3433 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3434 if( $this->isAnon() ) {
3437 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3440 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3450 * Check whether there is an outstanding request for e-mail confirmation.
3453 public function isEmailConfirmationPending() {
3454 global $wgEmailAuthentication;
3455 return $wgEmailAuthentication &&
3456 !$this->isEmailConfirmed() &&
3457 $this->mEmailToken
&&
3458 $this->mEmailTokenExpires
> wfTimestamp();
3462 * Get the timestamp of account creation.
3464 * @return String|Bool Timestamp of account creation, or false for
3465 * non-existent/anonymous user accounts.
3467 public function getRegistration() {
3468 if ( $this->isAnon() ) {
3472 return $this->mRegistration
;
3476 * Get the timestamp of the first edit
3478 * @return String|Bool Timestamp of first edit, or false for
3479 * non-existent/anonymous user accounts.
3481 public function getFirstEditTimestamp() {
3482 if( $this->getId() == 0 ) {
3483 return false; // anons
3485 $dbr = wfGetDB( DB_SLAVE
);
3486 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3487 array( 'rev_user' => $this->getId() ),
3489 array( 'ORDER BY' => 'rev_timestamp ASC' )
3492 return false; // no edits
3494 return wfTimestamp( TS_MW
, $time );
3498 * Get the permissions associated with a given list of groups
3500 * @param $groups Array of Strings List of internal group names
3501 * @return Array of Strings List of permission key names for given groups combined
3503 public static function getGroupPermissions( $groups ) {
3504 global $wgGroupPermissions, $wgRevokePermissions;
3506 // grant every granted permission first
3507 foreach( $groups as $group ) {
3508 if( isset( $wgGroupPermissions[$group] ) ) {
3509 $rights = array_merge( $rights,
3510 // array_filter removes empty items
3511 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3514 // now revoke the revoked permissions
3515 foreach( $groups as $group ) {
3516 if( isset( $wgRevokePermissions[$group] ) ) {
3517 $rights = array_diff( $rights,
3518 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3521 return array_unique( $rights );
3525 * Get all the groups who have a given permission
3527 * @param $role String Role to check
3528 * @return Array of Strings List of internal group names with the given permission
3530 public static function getGroupsWithPermission( $role ) {
3531 global $wgGroupPermissions;
3532 $allowedGroups = array();
3533 foreach ( $wgGroupPermissions as $group => $rights ) {
3534 if ( isset( $rights[$role] ) && $rights[$role] ) {
3535 $allowedGroups[] = $group;
3538 return $allowedGroups;
3542 * Get the localized descriptive name for a group, if it exists
3544 * @param $group String Internal group name
3545 * @return String Localized descriptive group name
3547 public static function getGroupName( $group ) {
3548 $msg = wfMessage( "group-$group" );
3549 return $msg->isBlank() ?
$group : $msg->text();
3553 * Get the localized descriptive name for a member of a group, if it exists
3555 * @param $group String Internal group name
3556 * @param $username String Username for gender (since 1.19)
3557 * @return String Localized name for group member
3559 public static function getGroupMember( $group, $username = '#' ) {
3560 $msg = wfMessage( "group-$group-member", $username );
3561 return $msg->isBlank() ?
$group : $msg->text();
3565 * Return the set of defined explicit groups.
3566 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3567 * are not included, as they are defined automatically, not in the database.
3568 * @return Array of internal group names
3570 public static function getAllGroups() {
3571 global $wgGroupPermissions, $wgRevokePermissions;
3573 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3574 self
::getImplicitGroups()
3579 * Get a list of all available permissions.
3580 * @return Array of permission names
3582 public static function getAllRights() {
3583 if ( self
::$mAllRights === false ) {
3584 global $wgAvailableRights;
3585 if ( count( $wgAvailableRights ) ) {
3586 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3588 self
::$mAllRights = self
::$mCoreRights;
3590 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3592 return self
::$mAllRights;
3596 * Get a list of implicit groups
3597 * @return Array of Strings Array of internal group names
3599 public static function getImplicitGroups() {
3600 global $wgImplicitGroups;
3601 $groups = $wgImplicitGroups;
3602 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3607 * Get the title of a page describing a particular group
3609 * @param $group String Internal group name
3610 * @return Title|Bool Title of the page if it exists, false otherwise
3612 public static function getGroupPage( $group ) {
3613 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3614 if( $msg->exists() ) {
3615 $title = Title
::newFromText( $msg->text() );
3616 if( is_object( $title ) )
3623 * Create a link to the group in HTML, if available;
3624 * else return the group name.
3626 * @param $group String Internal name of the group
3627 * @param $text String The text of the link
3628 * @return String HTML link to the group
3630 public static function makeGroupLinkHTML( $group, $text = '' ) {
3632 $text = self
::getGroupName( $group );
3634 $title = self
::getGroupPage( $group );
3636 return Linker
::link( $title, htmlspecialchars( $text ) );
3643 * Create a link to the group in Wikitext, if available;
3644 * else return the group name.
3646 * @param $group String Internal name of the group
3647 * @param $text String The text of the link
3648 * @return String Wikilink to the group
3650 public static function makeGroupLinkWiki( $group, $text = '' ) {
3652 $text = self
::getGroupName( $group );
3654 $title = self
::getGroupPage( $group );
3656 $page = $title->getPrefixedText();
3657 return "[[$page|$text]]";
3664 * Returns an array of the groups that a particular group can add/remove.
3666 * @param $group String: the group to check for whether it can add/remove
3667 * @return Array array( 'add' => array( addablegroups ),
3668 * 'remove' => array( removablegroups ),
3669 * 'add-self' => array( addablegroups to self),
3670 * 'remove-self' => array( removable groups from self) )
3672 public static function changeableByGroup( $group ) {
3673 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3675 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3676 if( empty( $wgAddGroups[$group] ) ) {
3677 // Don't add anything to $groups
3678 } elseif( $wgAddGroups[$group] === true ) {
3679 // You get everything
3680 $groups['add'] = self
::getAllGroups();
3681 } elseif( is_array( $wgAddGroups[$group] ) ) {
3682 $groups['add'] = $wgAddGroups[$group];
3685 // Same thing for remove
3686 if( empty( $wgRemoveGroups[$group] ) ) {
3687 } elseif( $wgRemoveGroups[$group] === true ) {
3688 $groups['remove'] = self
::getAllGroups();
3689 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3690 $groups['remove'] = $wgRemoveGroups[$group];
3693 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3694 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3695 foreach( $wgGroupsAddToSelf as $key => $value ) {
3696 if( is_int( $key ) ) {
3697 $wgGroupsAddToSelf['user'][] = $value;
3702 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3703 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3704 if( is_int( $key ) ) {
3705 $wgGroupsRemoveFromSelf['user'][] = $value;
3710 // Now figure out what groups the user can add to him/herself
3711 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3712 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3713 // No idea WHY this would be used, but it's there
3714 $groups['add-self'] = User
::getAllGroups();
3715 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3716 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3719 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3720 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3721 $groups['remove-self'] = User
::getAllGroups();
3722 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3723 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3730 * Returns an array of groups that this user can add and remove
3731 * @return Array array( 'add' => array( addablegroups ),
3732 * 'remove' => array( removablegroups ),
3733 * 'add-self' => array( addablegroups to self),
3734 * 'remove-self' => array( removable groups from self) )
3736 public function changeableGroups() {
3737 if( $this->isAllowed( 'userrights' ) ) {
3738 // This group gives the right to modify everything (reverse-
3739 // compatibility with old "userrights lets you change
3741 // Using array_merge to make the groups reindexed
3742 $all = array_merge( User
::getAllGroups() );
3746 'add-self' => array(),
3747 'remove-self' => array()
3751 // Okay, it's not so simple, we will have to go through the arrays
3754 'remove' => array(),
3755 'add-self' => array(),
3756 'remove-self' => array()
3758 $addergroups = $this->getEffectiveGroups();
3760 foreach( $addergroups as $addergroup ) {
3761 $groups = array_merge_recursive(
3762 $groups, $this->changeableByGroup( $addergroup )
3764 $groups['add'] = array_unique( $groups['add'] );
3765 $groups['remove'] = array_unique( $groups['remove'] );
3766 $groups['add-self'] = array_unique( $groups['add-self'] );
3767 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3773 * Increment the user's edit-count field.
3774 * Will have no effect for anonymous users.
3776 public function incEditCount() {
3777 if( !$this->isAnon() ) {
3778 $dbw = wfGetDB( DB_MASTER
);
3779 $dbw->update( 'user',
3780 array( 'user_editcount=user_editcount+1' ),
3781 array( 'user_id' => $this->getId() ),
3784 // Lazy initialization check...
3785 if( $dbw->affectedRows() == 0 ) {
3786 // Pull from a slave to be less cruel to servers
3787 // Accuracy isn't the point anyway here
3788 $dbr = wfGetDB( DB_SLAVE
);
3789 $count = $dbr->selectField( 'revision',
3791 array( 'rev_user' => $this->getId() ),
3794 // Now here's a goddamn hack...
3795 if( $dbr !== $dbw ) {
3796 // If we actually have a slave server, the count is
3797 // at least one behind because the current transaction
3798 // has not been committed and replicated.
3801 // But if DB_SLAVE is selecting the master, then the
3802 // count we just read includes the revision that was
3803 // just added in the working transaction.
3806 $dbw->update( 'user',
3807 array( 'user_editcount' => $count ),
3808 array( 'user_id' => $this->getId() ),
3812 // edit count in user cache too
3813 $this->invalidateCache();
3817 * Get the description of a given right
3819 * @param $right String Right to query
3820 * @return String Localized description of the right
3822 public static function getRightDescription( $right ) {
3823 $key = "right-$right";
3824 $msg = wfMessage( $key );
3825 return $msg->isBlank() ?
$right : $msg->text();
3829 * Make an old-style password hash
3831 * @param $password String Plain-text password
3832 * @param $userId String User ID
3833 * @return String Password hash
3835 public static function oldCrypt( $password, $userId ) {
3836 global $wgPasswordSalt;
3837 if ( $wgPasswordSalt ) {
3838 return md5( $userId . '-' . md5( $password ) );
3840 return md5( $password );
3845 * Make a new-style password hash
3847 * @param $password String Plain-text password
3848 * @param bool|string $salt Optional salt, may be random or the user ID.
3850 * If unspecified or false, will generate one automatically
3851 * @return String Password hash
3853 public static function crypt( $password, $salt = false ) {
3854 global $wgPasswordSalt;
3857 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3861 if( $wgPasswordSalt ) {
3862 if ( $salt === false ) {
3863 $salt = substr( wfGenerateToken(), 0, 8 );
3865 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3867 return ':A:' . md5( $password );
3872 * Compare a password hash with a plain-text password. Requires the user
3873 * ID if there's a chance that the hash is an old-style hash.
3875 * @param $hash String Password hash
3876 * @param $password String Plain-text password to compare
3877 * @param $userId String|bool User ID for old-style password salt
3881 public static function comparePasswords( $hash, $password, $userId = false ) {
3882 $type = substr( $hash, 0, 3 );
3885 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3889 if ( $type == ':A:' ) {
3891 return md5( $password ) === substr( $hash, 3 );
3892 } elseif ( $type == ':B:' ) {
3894 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3895 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3898 return self
::oldCrypt( $password, $userId ) === $hash;
3903 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
3905 * @param $byEmail Boolean: account made by email?
3906 * @param $reason String: user supplied reason
3908 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
3910 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3911 global $wgUser, $wgContLang, $wgNewUserLog;
3912 if( empty( $wgNewUserLog ) ) {
3913 return true; // disabled
3916 if( $this->getName() == $wgUser->getName() ) {
3919 $action = 'create2';
3921 if ( $reason === '' ) {
3922 $reason = wfMsgForContent( 'newuserlog-byemail' );
3924 $reason = $wgContLang->commaList( array(
3925 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3929 $log = new LogPage( 'newusers' );
3930 return (int)$log->addEntry(
3932 $this->getUserPage(),
3934 array( $this->getId() )
3939 * Add an autocreate newuser log entry for this user
3940 * Used by things like CentralAuth and perhaps other authplugins.
3944 public function addNewUserLogEntryAutoCreate() {
3945 global $wgNewUserLog;
3946 if( !$wgNewUserLog ) {
3947 return true; // disabled
3949 $log = new LogPage( 'newusers', false );
3950 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3957 protected function loadOptions() {
3959 if ( $this->mOptionsLoaded ||
!$this->getId() )
3962 $this->mOptions
= self
::getDefaultOptions();
3964 // Maybe load from the object
3965 if ( !is_null( $this->mOptionOverrides
) ) {
3966 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3967 foreach( $this->mOptionOverrides
as $key => $value ) {
3968 $this->mOptions
[$key] = $value;
3971 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
3972 // Load from database
3973 $dbr = wfGetDB( DB_SLAVE
);
3975 $res = $dbr->select(
3978 array( 'up_user' => $this->getId() ),
3982 $this->mOptionOverrides
= array();
3983 foreach ( $res as $row ) {
3984 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3985 $this->mOptions
[$row->up_property
] = $row->up_value
;
3989 $this->mOptionsLoaded
= true;
3991 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3997 protected function saveOptions() {
3998 global $wgAllowPrefChange;
4000 $extuser = ExternalUser
::newFromUser( $this );
4002 $this->loadOptions();
4003 $dbw = wfGetDB( DB_MASTER
);
4005 $insert_rows = array();
4007 $saveOptions = $this->mOptions
;
4009 // Allow hooks to abort, for instance to save to a global profile.
4010 // Reset options to default state before saving.
4011 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4015 foreach( $saveOptions as $key => $value ) {
4016 # Don't bother storing default values
4017 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
4018 !( $value === false ||
is_null($value) ) ) ||
4019 $value != self
::getDefaultOption( $key ) ) {
4020 $insert_rows[] = array(
4021 'up_user' => $this->getId(),
4022 'up_property' => $key,
4023 'up_value' => $value,
4026 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4027 switch ( $wgAllowPrefChange[$key] ) {
4033 $extuser->setPref( $key, $value );
4038 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
4039 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4043 * Provide an array of HTML5 attributes to put on an input element
4044 * intended for the user to enter a new password. This may include
4045 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4047 * Do *not* use this when asking the user to enter his current password!
4048 * Regardless of configuration, users may have invalid passwords for whatever
4049 * reason (e.g., they were set before requirements were tightened up).
4050 * Only use it when asking for a new password, like on account creation or
4053 * Obviously, you still need to do server-side checking.
4055 * NOTE: A combination of bugs in various browsers means that this function
4056 * actually just returns array() unconditionally at the moment. May as
4057 * well keep it around for when the browser bugs get fixed, though.
4059 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4061 * @return array Array of HTML attributes suitable for feeding to
4062 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4063 * That will potentially output invalid XHTML 1.0 Transitional, and will
4064 * get confused by the boolean attribute syntax used.)
4066 public static function passwordChangeInputAttribs() {
4067 global $wgMinimalPasswordLength;
4069 if ( $wgMinimalPasswordLength == 0 ) {
4073 # Note that the pattern requirement will always be satisfied if the
4074 # input is empty, so we need required in all cases.
4076 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4077 # if e-mail confirmation is being used. Since HTML5 input validation
4078 # is b0rked anyway in some browsers, just return nothing. When it's
4079 # re-enabled, fix this code to not output required for e-mail
4081 #$ret = array( 'required' );
4084 # We can't actually do this right now, because Opera 9.6 will print out
4085 # the entered password visibly in its error message! When other
4086 # browsers add support for this attribute, or Opera fixes its support,
4087 # we can add support with a version check to avoid doing this on Opera
4088 # versions where it will be a problem. Reported to Opera as
4089 # DSK-262266, but they don't have a public bug tracker for us to follow.
4091 if ( $wgMinimalPasswordLength > 1 ) {
4092 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4093 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4094 $wgMinimalPasswordLength );