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.
841 * @return String new random password
843 public static function randomPassword() {
844 global $wgMinimalPasswordLength;
845 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
846 $length = max( 10, $wgMinimalPasswordLength );
847 // Multiply by 1.25 to get the number of hex characters we need
848 $length = $length * 1.25;
849 // Generate random hex chars
850 $hex = MWCryptRand
::generateHex( $length );
851 // Convert from base 16 to base 32 to get a proper password like string
852 return wfBaseConvert( $hex, 16, 32 );
856 * Set cached properties to default.
858 * @note This no longer clears uncached lazy-initialised properties;
859 * the constructor does that instead.
861 * @param $name string
863 public function loadDefaults( $name = false ) {
864 wfProfileIn( __METHOD__
);
867 $this->mName
= $name;
868 $this->mRealName
= '';
869 $this->mPassword
= $this->mNewpassword
= '';
870 $this->mNewpassTime
= null;
872 $this->mOptionOverrides
= null;
873 $this->mOptionsLoaded
= false;
875 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
876 if( $loggedOut !== null ) {
877 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
879 $this->mTouched
= '0'; # Allow any pages to be cached
882 $this->mToken
= null; // Don't run cryptographic functions till we need a token
883 $this->mEmailAuthenticated
= null;
884 $this->mEmailToken
= '';
885 $this->mEmailTokenExpires
= null;
886 $this->mRegistration
= wfTimestamp( TS_MW
);
887 $this->mGroups
= array();
889 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
891 wfProfileOut( __METHOD__
);
895 * Return whether an item has been loaded.
897 * @param $item String: item to check. Current possibilities:
901 * @param $all String: 'all' to check if the whole object has been loaded
902 * or any other string to check if only the item is available (e.g.
906 public function isItemLoaded( $item, $all = 'all' ) {
907 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
908 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
912 * Set that an item has been loaded
914 * @param $item String
916 private function setItemLoaded( $item ) {
917 if ( is_array( $this->mLoadedItems
) ) {
918 $this->mLoadedItems
[$item] = true;
923 * Load user data from the session or login cookie. If there are no valid
924 * credentials, initialises the user as an anonymous user.
925 * @return Bool True if the user is logged in, false otherwise.
927 private function loadFromSession() {
928 global $wgExternalAuthType, $wgAutocreatePolicy;
931 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
932 if ( $result !== null ) {
936 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
937 $extUser = ExternalUser
::newFromCookie();
939 # TODO: Automatically create the user here (or probably a bit
940 # lower down, in fact)
944 $request = $this->getRequest();
946 $cookieId = $request->getCookie( 'UserID' );
947 $sessId = $request->getSessionData( 'wsUserID' );
949 if ( $cookieId !== null ) {
950 $sId = intval( $cookieId );
951 if( $sessId !== null && $cookieId != $sessId ) {
952 $this->loadDefaults(); // Possible collision!
953 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
954 cookie user ID ($sId) don't match!" );
957 $request->setSessionData( 'wsUserID', $sId );
958 } elseif ( $sessId !== null && $sessId != 0 ) {
961 $this->loadDefaults();
965 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
966 $sName = $request->getSessionData( 'wsUserName' );
967 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
968 $sName = $request->getCookie( 'UserName' );
969 $request->setSessionData( 'wsUserName', $sName );
971 $this->loadDefaults();
975 $proposedUser = User
::newFromId( $sId );
976 if ( !$proposedUser->isLoggedIn() ) {
978 $this->loadDefaults();
982 global $wgBlockDisablesLogin;
983 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
984 # User blocked and we've disabled blocked user logins
985 $this->loadDefaults();
989 if ( $request->getSessionData( 'wsToken' ) ) {
990 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
992 } elseif ( $request->getCookie( 'Token' ) ) {
993 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
996 # No session or persistent login cookie
997 $this->loadDefaults();
1001 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1002 $this->loadFromUserObject( $proposedUser );
1003 $request->setSessionData( 'wsToken', $this->mToken
);
1004 wfDebug( "User: logged in from $from\n" );
1007 # Invalid credentials
1008 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1009 $this->loadDefaults();
1015 * Load user and user_group data from the database.
1016 * $this->mId must be set, this is how the user is identified.
1018 * @return Bool True if the user exists, false if the user is anonymous
1020 public function loadFromDatabase() {
1022 $this->mId
= intval( $this->mId
);
1024 /** Anonymous user */
1026 $this->loadDefaults();
1030 $dbr = wfGetDB( DB_MASTER
);
1031 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
1033 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1035 if ( $s !== false ) {
1036 # Initialise user table data
1037 $this->loadFromRow( $s );
1038 $this->mGroups
= null; // deferred
1039 $this->getEditCount(); // revalidation for nulls
1044 $this->loadDefaults();
1050 * Initialize this object from a row from the user table.
1052 * @param $row Array Row from the user table to load.
1054 public function loadFromRow( $row ) {
1057 $this->mGroups
= null; // deferred
1059 if ( isset( $row->user_name
) ) {
1060 $this->mName
= $row->user_name
;
1061 $this->mFrom
= 'name';
1062 $this->setItemLoaded( 'name' );
1067 if ( isset( $row->user_real_name
) ) {
1068 $this->mRealName
= $row->user_real_name
;
1069 $this->setItemLoaded( 'realname' );
1074 if ( isset( $row->user_id
) ) {
1075 $this->mId
= intval( $row->user_id
);
1076 $this->mFrom
= 'id';
1077 $this->setItemLoaded( 'id' );
1082 if ( isset( $row->user_editcount
) ) {
1083 $this->mEditCount
= $row->user_editcount
;
1088 if ( isset( $row->user_password
) ) {
1089 $this->mPassword
= $row->user_password
;
1090 $this->mNewpassword
= $row->user_newpassword
;
1091 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1092 $this->mEmail
= $row->user_email
;
1093 if ( isset( $row->user_options
) ) {
1094 $this->decodeOptions( $row->user_options
);
1096 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1097 $this->mToken
= $row->user_token
;
1098 if ( $this->mToken
== '' ) {
1099 $this->mToken
= null;
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 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2027 * @return String Token
2029 public function getToken( $forceCreation = true ) {
2031 if ( !$this->mToken
&& $forceCreation ) {
2034 return $this->mToken
;
2038 * Set the random token (used for persistent authentication)
2039 * Called from loadDefaults() among other places.
2041 * @param $token String|bool If specified, set the token to this value
2043 public function setToken( $token = false ) {
2046 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2048 $this->mToken
= $token;
2053 * Set the password for a password reminder or new account email
2055 * @param $str String New password to set
2056 * @param $throttle Bool If true, reset the throttle timestamp to the present
2058 public function setNewpassword( $str, $throttle = true ) {
2060 $this->mNewpassword
= self
::crypt( $str );
2062 $this->mNewpassTime
= wfTimestampNow();
2067 * Has password reminder email been sent within the last
2068 * $wgPasswordReminderResendTime hours?
2071 public function isPasswordReminderThrottled() {
2072 global $wgPasswordReminderResendTime;
2074 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2077 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2078 return time() < $expiry;
2082 * Get the user's e-mail address
2083 * @return String User's email address
2085 public function getEmail() {
2087 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2088 return $this->mEmail
;
2092 * Get the timestamp of the user's e-mail authentication
2093 * @return String TS_MW timestamp
2095 public function getEmailAuthenticationTimestamp() {
2097 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2098 return $this->mEmailAuthenticated
;
2102 * Set the user's e-mail address
2103 * @param $str String New e-mail address
2105 public function setEmail( $str ) {
2107 if( $str == $this->mEmail
) {
2110 $this->mEmail
= $str;
2111 $this->invalidateEmail();
2112 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2116 * Set the user's e-mail address and a confirmation mail if needed.
2119 * @param $str String New e-mail address
2122 public function setEmailWithConfirmation( $str ) {
2123 global $wgEnableEmail, $wgEmailAuthentication;
2125 if ( !$wgEnableEmail ) {
2126 return Status
::newFatal( 'emaildisabled' );
2129 $oldaddr = $this->getEmail();
2130 if ( $str === $oldaddr ) {
2131 return Status
::newGood( true );
2134 $this->setEmail( $str );
2136 if ( $str !== '' && $wgEmailAuthentication ) {
2137 # Send a confirmation request to the new address if needed
2138 $type = $oldaddr != '' ?
'changed' : 'set';
2139 $result = $this->sendConfirmationMail( $type );
2140 if ( $result->isGood() ) {
2141 # Say the the caller that a confirmation mail has been sent
2142 $result->value
= 'eauth';
2145 $result = Status
::newGood( true );
2152 * Get the user's real name
2153 * @return String User's real name
2155 public function getRealName() {
2156 if ( !$this->isItemLoaded( 'realname' ) ) {
2160 return $this->mRealName
;
2164 * Set the user's real name
2165 * @param $str String New real name
2167 public function setRealName( $str ) {
2169 $this->mRealName
= $str;
2173 * Get the user's current setting for a given option.
2175 * @param $oname String The option to check
2176 * @param $defaultOverride String A default value returned if the option does not exist
2177 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2178 * @return String User's current value for the option
2179 * @see getBoolOption()
2180 * @see getIntOption()
2182 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2183 global $wgHiddenPrefs;
2184 $this->loadOptions();
2186 if ( is_null( $this->mOptions
) ) {
2187 if($defaultOverride != '') {
2188 return $defaultOverride;
2190 $this->mOptions
= User
::getDefaultOptions();
2193 # We want 'disabled' preferences to always behave as the default value for
2194 # users, even if they have set the option explicitly in their settings (ie they
2195 # set it, and then it was disabled removing their ability to change it). But
2196 # we don't want to erase the preferences in the database in case the preference
2197 # is re-enabled again. So don't touch $mOptions, just override the returned value
2198 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2199 return self
::getDefaultOption( $oname );
2202 if ( array_key_exists( $oname, $this->mOptions
) ) {
2203 return $this->mOptions
[$oname];
2205 return $defaultOverride;
2210 * Get all user's options
2214 public function getOptions() {
2215 global $wgHiddenPrefs;
2216 $this->loadOptions();
2217 $options = $this->mOptions
;
2219 # We want 'disabled' preferences to always behave as the default value for
2220 # users, even if they have set the option explicitly in their settings (ie they
2221 # set it, and then it was disabled removing their ability to change it). But
2222 # we don't want to erase the preferences in the database in case the preference
2223 # is re-enabled again. So don't touch $mOptions, just override the returned value
2224 foreach( $wgHiddenPrefs as $pref ){
2225 $default = self
::getDefaultOption( $pref );
2226 if( $default !== null ){
2227 $options[$pref] = $default;
2235 * Get the user's current setting for a given option, as a boolean value.
2237 * @param $oname String The option to check
2238 * @return Bool User's current value for the option
2241 public function getBoolOption( $oname ) {
2242 return (bool)$this->getOption( $oname );
2246 * Get the user's current setting for a given option, as a boolean value.
2248 * @param $oname String The option to check
2249 * @param $defaultOverride Int A default value returned if the option does not exist
2250 * @return Int User's current value for the option
2253 public function getIntOption( $oname, $defaultOverride=0 ) {
2254 $val = $this->getOption( $oname );
2256 $val = $defaultOverride;
2258 return intval( $val );
2262 * Set the given option for a user.
2264 * @param $oname String The option to set
2265 * @param $val mixed New value to set
2267 public function setOption( $oname, $val ) {
2269 $this->loadOptions();
2271 // Explicitly NULL values should refer to defaults
2272 global $wgDefaultUserOptions;
2273 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2274 $val = $wgDefaultUserOptions[$oname];
2277 $this->mOptions
[$oname] = $val;
2281 * Reset all options to the site defaults
2283 public function resetOptions() {
2284 $this->mOptions
= self
::getDefaultOptions();
2288 * Get the user's preferred date format.
2289 * @return String User's preferred date format
2291 public function getDatePreference() {
2292 // Important migration for old data rows
2293 if ( is_null( $this->mDatePreference
) ) {
2295 $value = $this->getOption( 'date' );
2296 $map = $wgLang->getDatePreferenceMigrationMap();
2297 if ( isset( $map[$value] ) ) {
2298 $value = $map[$value];
2300 $this->mDatePreference
= $value;
2302 return $this->mDatePreference
;
2306 * Get the user preferred stub threshold
2310 public function getStubThreshold() {
2311 global $wgMaxArticleSize; # Maximum article size, in Kb
2312 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2313 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2314 # If they have set an impossible value, disable the preference
2315 # so we can use the parser cache again.
2322 * Get the permissions this user has.
2323 * @return Array of String permission names
2325 public function getRights() {
2326 if ( is_null( $this->mRights
) ) {
2327 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2328 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2329 // Force reindexation of rights when a hook has unset one of them
2330 $this->mRights
= array_values( $this->mRights
);
2332 return $this->mRights
;
2336 * Get the list of explicit group memberships this user has.
2337 * The implicit * and user groups are not included.
2338 * @return Array of String internal group names
2340 public function getGroups() {
2342 $this->loadGroups();
2343 return $this->mGroups
;
2347 * Get the list of implicit group memberships this user has.
2348 * This includes all explicit groups, plus 'user' if logged in,
2349 * '*' for all accounts, and autopromoted groups
2350 * @param $recache Bool Whether to avoid the cache
2351 * @return Array of String internal group names
2353 public function getEffectiveGroups( $recache = false ) {
2354 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2355 wfProfileIn( __METHOD__
);
2356 $this->mEffectiveGroups
= array_unique( array_merge(
2357 $this->getGroups(), // explicit groups
2358 $this->getAutomaticGroups( $recache ) // implicit groups
2360 # Hook for additional groups
2361 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2362 wfProfileOut( __METHOD__
);
2364 return $this->mEffectiveGroups
;
2368 * Get the list of implicit group memberships this user has.
2369 * This includes 'user' if logged in, '*' for all accounts,
2370 * and autopromoted groups
2371 * @param $recache Bool Whether to avoid the cache
2372 * @return Array of String internal group names
2374 public function getAutomaticGroups( $recache = false ) {
2375 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2376 wfProfileIn( __METHOD__
);
2377 $this->mImplicitGroups
= array( '*' );
2378 if ( $this->getId() ) {
2379 $this->mImplicitGroups
[] = 'user';
2381 $this->mImplicitGroups
= array_unique( array_merge(
2382 $this->mImplicitGroups
,
2383 Autopromote
::getAutopromoteGroups( $this )
2387 # Assure data consistency with rights/groups,
2388 # as getEffectiveGroups() depends on this function
2389 $this->mEffectiveGroups
= null;
2391 wfProfileOut( __METHOD__
);
2393 return $this->mImplicitGroups
;
2397 * Returns the groups the user has belonged to.
2399 * The user may still belong to the returned groups. Compare with getGroups().
2401 * The function will not return groups the user had belonged to before MW 1.17
2403 * @return array Names of the groups the user has belonged to.
2405 public function getFormerGroups() {
2406 if( is_null( $this->mFormerGroups
) ) {
2407 $dbr = wfGetDB( DB_MASTER
);
2408 $res = $dbr->select( 'user_former_groups',
2409 array( 'ufg_group' ),
2410 array( 'ufg_user' => $this->mId
),
2412 $this->mFormerGroups
= array();
2413 foreach( $res as $row ) {
2414 $this->mFormerGroups
[] = $row->ufg_group
;
2417 return $this->mFormerGroups
;
2421 * Get the user's edit count.
2424 public function getEditCount() {
2425 if( $this->getId() ) {
2426 if ( !isset( $this->mEditCount
) ) {
2427 /* Populate the count, if it has not been populated yet */
2428 $this->mEditCount
= User
::edits( $this->mId
);
2430 return $this->mEditCount
;
2438 * Add the user to the given group.
2439 * This takes immediate effect.
2440 * @param $group String Name of the group to add
2442 public function addGroup( $group ) {
2443 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2444 $dbw = wfGetDB( DB_MASTER
);
2445 if( $this->getId() ) {
2446 $dbw->insert( 'user_groups',
2448 'ug_user' => $this->getID(),
2449 'ug_group' => $group,
2452 array( 'IGNORE' ) );
2455 $this->loadGroups();
2456 $this->mGroups
[] = $group;
2457 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2459 $this->invalidateCache();
2463 * Remove the user from the given group.
2464 * This takes immediate effect.
2465 * @param $group String Name of the group to remove
2467 public function removeGroup( $group ) {
2469 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2470 $dbw = wfGetDB( DB_MASTER
);
2471 $dbw->delete( 'user_groups',
2473 'ug_user' => $this->getID(),
2474 'ug_group' => $group,
2476 // Remember that the user was in this group
2477 $dbw->insert( 'user_former_groups',
2479 'ufg_user' => $this->getID(),
2480 'ufg_group' => $group,
2483 array( 'IGNORE' ) );
2485 $this->loadGroups();
2486 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2487 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2489 $this->invalidateCache();
2493 * Get whether the user is logged in
2496 public function isLoggedIn() {
2497 return $this->getID() != 0;
2501 * Get whether the user is anonymous
2504 public function isAnon() {
2505 return !$this->isLoggedIn();
2509 * Check if user is allowed to access a feature / make an action
2511 * @internal param \String $varargs permissions to test
2512 * @return Boolean: True if user is allowed to perform *any* of the given actions
2516 public function isAllowedAny( /*...*/ ){
2517 $permissions = func_get_args();
2518 foreach( $permissions as $permission ){
2519 if( $this->isAllowed( $permission ) ){
2528 * @internal param $varargs string
2529 * @return bool True if the user is allowed to perform *all* of the given actions
2531 public function isAllowedAll( /*...*/ ){
2532 $permissions = func_get_args();
2533 foreach( $permissions as $permission ){
2534 if( !$this->isAllowed( $permission ) ){
2542 * Internal mechanics of testing a permission
2543 * @param $action String
2546 public function isAllowed( $action = '' ) {
2547 if ( $action === '' ) {
2548 return true; // In the spirit of DWIM
2550 # Patrolling may not be enabled
2551 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2552 global $wgUseRCPatrol, $wgUseNPPatrol;
2553 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2556 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2557 # by misconfiguration: 0 == 'foo'
2558 return in_array( $action, $this->getRights(), true );
2562 * Check whether to enable recent changes patrol features for this user
2563 * @return Boolean: True or false
2565 public function useRCPatrol() {
2566 global $wgUseRCPatrol;
2567 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2571 * Check whether to enable new pages patrol features for this user
2572 * @return Bool True or false
2574 public function useNPPatrol() {
2575 global $wgUseRCPatrol, $wgUseNPPatrol;
2576 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2580 * Get the WebRequest object to use with this object
2582 * @return WebRequest
2584 public function getRequest() {
2585 if ( $this->mRequest
) {
2586 return $this->mRequest
;
2594 * Get the current skin, loading it if required
2595 * @return Skin The current skin
2596 * @todo FIXME: Need to check the old failback system [AV]
2597 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2599 public function getSkin() {
2600 wfDeprecated( __METHOD__
, '1.18' );
2601 return RequestContext
::getMain()->getSkin();
2605 * Check the watched status of an article.
2606 * @param $title Title of the article to look at
2609 public function isWatched( $title ) {
2610 $wl = WatchedItem
::fromUserTitle( $this, $title );
2611 return $wl->isWatched();
2616 * @param $title Title of the article to look at
2618 public function addWatch( $title ) {
2619 $wl = WatchedItem
::fromUserTitle( $this, $title );
2621 $this->invalidateCache();
2625 * Stop watching an article.
2626 * @param $title Title of the article to look at
2628 public function removeWatch( $title ) {
2629 $wl = WatchedItem
::fromUserTitle( $this, $title );
2631 $this->invalidateCache();
2635 * Clear the user's notification timestamp for the given title.
2636 * If e-notif e-mails are on, they will receive notification mails on
2637 * the next change of the page if it's watched etc.
2638 * @param $title Title of the article to look at
2640 public function clearNotification( &$title ) {
2641 global $wgUseEnotif, $wgShowUpdatedMarker;
2643 # Do nothing if the database is locked to writes
2644 if( wfReadOnly() ) {
2648 if( $title->getNamespace() == NS_USER_TALK
&&
2649 $title->getText() == $this->getName() ) {
2650 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2652 $this->setNewtalk( false );
2655 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2659 if( $this->isAnon() ) {
2660 // Nothing else to do...
2664 // Only update the timestamp if the page is being watched.
2665 // The query to find out if it is watched is cached both in memcached and per-invocation,
2666 // and when it does have to be executed, it can be on a slave
2667 // If this is the user's newtalk page, we always update the timestamp
2669 if ( $title->getNamespace() == NS_USER_TALK
&&
2670 $title->getText() == $this->getName() )
2675 $wi = WatchedItem
::fromUserTitle( $this, $title );
2676 $wi->resetNotificationTimestamp( $force );
2680 * Resets all of the given user's page-change notification timestamps.
2681 * If e-notif e-mails are on, they will receive notification mails on
2682 * the next change of any watched page.
2684 public function clearAllNotifications() {
2685 global $wgUseEnotif, $wgShowUpdatedMarker;
2686 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2687 $this->setNewtalk( false );
2690 $id = $this->getId();
2692 $dbw = wfGetDB( DB_MASTER
);
2693 $dbw->update( 'watchlist',
2695 'wl_notificationtimestamp' => null
2696 ), array( /* WHERE */
2700 # We also need to clear here the "you have new message" notification for the own user_talk page
2701 # This is cleared one page view later in Article::viewUpdates();
2706 * Set this user's options from an encoded string
2707 * @param $str String Encoded options to import
2709 * @deprecated in 1.19 due to removal of user_options from the user table
2711 private function decodeOptions( $str ) {
2712 wfDeprecated( __METHOD__
, '1.19' );
2716 $this->mOptionsLoaded
= true;
2717 $this->mOptionOverrides
= array();
2719 // If an option is not set in $str, use the default value
2720 $this->mOptions
= self
::getDefaultOptions();
2722 $a = explode( "\n", $str );
2723 foreach ( $a as $s ) {
2725 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2726 $this->mOptions
[$m[1]] = $m[2];
2727 $this->mOptionOverrides
[$m[1]] = $m[2];
2733 * Set a cookie on the user's client. Wrapper for
2734 * WebResponse::setCookie
2735 * @param $name String Name of the cookie to set
2736 * @param $value String Value to set
2737 * @param $exp Int Expiration time, as a UNIX time value;
2738 * if 0 or not specified, use the default $wgCookieExpiration
2740 protected function setCookie( $name, $value, $exp = 0 ) {
2741 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2745 * Clear a cookie on the user's client
2746 * @param $name String Name of the cookie to clear
2748 protected function clearCookie( $name ) {
2749 $this->setCookie( $name, '', time() - 86400 );
2753 * Set the default cookies for this session on the user's client.
2755 * @param $request WebRequest object to use; $wgRequest will be used if null
2758 public function setCookies( $request = null ) {
2759 if ( $request === null ) {
2760 $request = $this->getRequest();
2764 if ( 0 == $this->mId
) return;
2765 if ( !$this->mToken
) {
2766 // When token is empty or NULL generate a new one and then save it to the database
2767 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2768 // Simply by setting every cell in the user_token column to NULL and letting them be
2769 // regenerated as users log back into the wiki.
2771 $this->saveSettings();
2774 'wsUserID' => $this->mId
,
2775 'wsToken' => $this->mToken
,
2776 'wsUserName' => $this->getName()
2779 'UserID' => $this->mId
,
2780 'UserName' => $this->getName(),
2782 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2783 $cookies['Token'] = $this->mToken
;
2785 $cookies['Token'] = false;
2788 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2790 foreach ( $session as $name => $value ) {
2791 $request->setSessionData( $name, $value );
2793 foreach ( $cookies as $name => $value ) {
2794 if ( $value === false ) {
2795 $this->clearCookie( $name );
2797 $this->setCookie( $name, $value );
2803 * Log this user out.
2805 public function logout() {
2806 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2812 * Clear the user's cookies and session, and reset the instance cache.
2815 public function doLogout() {
2816 $this->clearInstanceCache( 'defaults' );
2818 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2820 $this->clearCookie( 'UserID' );
2821 $this->clearCookie( 'Token' );
2823 # Remember when user logged out, to prevent seeing cached pages
2824 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2828 * Save this user's settings into the database.
2829 * @todo Only rarely do all these fields need to be set!
2831 public function saveSettings() {
2833 if ( wfReadOnly() ) { return; }
2834 if ( 0 == $this->mId
) { return; }
2836 $this->mTouched
= self
::newTouchedTimestamp();
2838 $dbw = wfGetDB( DB_MASTER
);
2839 $dbw->update( 'user',
2841 'user_name' => $this->mName
,
2842 'user_password' => $this->mPassword
,
2843 'user_newpassword' => $this->mNewpassword
,
2844 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2845 'user_real_name' => $this->mRealName
,
2846 'user_email' => $this->mEmail
,
2847 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2848 'user_touched' => $dbw->timestamp( $this->mTouched
),
2849 'user_token' => strval( $this->mToken
),
2850 'user_email_token' => $this->mEmailToken
,
2851 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2852 ), array( /* WHERE */
2853 'user_id' => $this->mId
2857 $this->saveOptions();
2859 wfRunHooks( 'UserSaveSettings', array( $this ) );
2860 $this->clearSharedCache();
2861 $this->getUserPage()->invalidateCache();
2865 * If only this user's username is known, and it exists, return the user ID.
2868 public function idForName() {
2869 $s = trim( $this->getName() );
2870 if ( $s === '' ) return 0;
2872 $dbr = wfGetDB( DB_SLAVE
);
2873 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2874 if ( $id === false ) {
2881 * Add a user to the database, return the user object
2883 * @param $name String Username to add
2884 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2885 * - password The user's password hash. Password logins will be disabled if this is omitted.
2886 * - newpassword Hash for a temporary password that has been mailed to the user
2887 * - email The user's email address
2888 * - email_authenticated The email authentication timestamp
2889 * - real_name The user's real name
2890 * - options An associative array of non-default options
2891 * - token Random authentication token. Do not set.
2892 * - registration Registration timestamp. Do not set.
2894 * @return User object, or null if the username already exists
2896 public static function createNew( $name, $params = array() ) {
2899 if ( isset( $params['options'] ) ) {
2900 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2901 unset( $params['options'] );
2903 $dbw = wfGetDB( DB_MASTER
);
2904 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2907 'user_id' => $seqVal,
2908 'user_name' => $name,
2909 'user_password' => $user->mPassword
,
2910 'user_newpassword' => $user->mNewpassword
,
2911 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2912 'user_email' => $user->mEmail
,
2913 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2914 'user_real_name' => $user->mRealName
,
2915 'user_token' => strval( $user->mToken
),
2916 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2917 'user_editcount' => 0,
2918 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
2920 foreach ( $params as $name => $value ) {
2921 $fields["user_$name"] = $value;
2923 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2924 if ( $dbw->affectedRows() ) {
2925 $newUser = User
::newFromId( $dbw->insertId() );
2933 * Add this existing user object to the database
2935 public function addToDatabase() {
2938 $this->mTouched
= self
::newTouchedTimestamp();
2940 $dbw = wfGetDB( DB_MASTER
);
2941 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2942 $dbw->insert( 'user',
2944 'user_id' => $seqVal,
2945 'user_name' => $this->mName
,
2946 'user_password' => $this->mPassword
,
2947 'user_newpassword' => $this->mNewpassword
,
2948 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2949 'user_email' => $this->mEmail
,
2950 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2951 'user_real_name' => $this->mRealName
,
2952 'user_token' => strval( $this->mToken
),
2953 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2954 'user_editcount' => 0,
2955 'user_touched' => $dbw->timestamp( $this->mTouched
),
2958 $this->mId
= $dbw->insertId();
2960 // Clear instance cache other than user table data, which is already accurate
2961 $this->clearInstanceCache();
2963 $this->saveOptions();
2967 * If this user is logged-in and blocked,
2968 * block any IP address they've successfully logged in from.
2969 * @return bool A block was spread
2971 public function spreadAnyEditBlock() {
2972 if ( $this->isLoggedIn() && $this->isBlocked() ) {
2973 return $this->spreadBlock();
2979 * If this (non-anonymous) user is blocked,
2980 * block the IP address they've successfully logged in from.
2981 * @return bool A block was spread
2983 protected function spreadBlock() {
2984 wfDebug( __METHOD__
. "()\n" );
2986 if ( $this->mId
== 0 ) {
2990 $userblock = Block
::newFromTarget( $this->getName() );
2991 if ( !$userblock ) {
2995 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
2999 * Generate a string which will be different for any combination of
3000 * user options which would produce different parser output.
3001 * This will be used as part of the hash key for the parser cache,
3002 * so users with the same options can share the same cached data
3005 * Extensions which require it should install 'PageRenderingHash' hook,
3006 * which will give them a chance to modify this key based on their own
3009 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3010 * @return String Page rendering hash
3012 public function getPageRenderingHash() {
3013 wfDeprecated( __METHOD__
, '1.17' );
3015 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3017 return $this->mHash
;
3020 // stubthreshold is only included below for completeness,
3021 // since it disables the parser cache, its value will always
3022 // be 0 when this function is called by parsercache.
3024 $confstr = $this->getOption( 'math' );
3025 $confstr .= '!' . $this->getStubThreshold();
3026 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3027 $confstr .= '!' . $this->getDatePreference();
3029 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3030 $confstr .= '!' . $wgLang->getCode();
3031 $confstr .= '!' . $this->getOption( 'thumbsize' );
3032 // add in language specific options, if any
3033 $extra = $wgContLang->getExtraHashOptions();
3036 // Since the skin could be overloading link(), it should be
3037 // included here but in practice, none of our skins do that.
3039 $confstr .= $wgRenderHashAppend;
3041 // Give a chance for extensions to modify the hash, if they have
3042 // extra options or other effects on the parser cache.
3043 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3045 // Make it a valid memcached key fragment
3046 $confstr = str_replace( ' ', '_', $confstr );
3047 $this->mHash
= $confstr;
3052 * Get whether the user is explicitly blocked from account creation.
3053 * @return Bool|Block
3055 public function isBlockedFromCreateAccount() {
3056 $this->getBlockedStatus();
3057 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3058 return $this->mBlock
;
3061 # bug 13611: if the IP address the user is trying to create an account from is
3062 # blocked with createaccount disabled, prevent new account creation there even
3063 # when the user is logged in
3064 if( $this->mBlockedFromCreateAccount
=== false ){
3065 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3067 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3068 ?
$this->mBlockedFromCreateAccount
3073 * Get whether the user is blocked from using Special:Emailuser.
3076 public function isBlockedFromEmailuser() {
3077 $this->getBlockedStatus();
3078 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3082 * Get whether the user is allowed to create an account.
3085 function isAllowedToCreateAccount() {
3086 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3090 * Get this user's personal page title.
3092 * @return Title: User's personal page title
3094 public function getUserPage() {
3095 return Title
::makeTitle( NS_USER
, $this->getName() );
3099 * Get this user's talk page title.
3101 * @return Title: User's talk page title
3103 public function getTalkPage() {
3104 $title = $this->getUserPage();
3105 return $title->getTalkPage();
3109 * Determine whether the user is a newbie. Newbies are either
3110 * anonymous IPs, or the most recently created accounts.
3113 public function isNewbie() {
3114 return !$this->isAllowed( 'autoconfirmed' );
3118 * Check to see if the given clear-text password is one of the accepted passwords
3119 * @param $password String: user password.
3120 * @return Boolean: True if the given password is correct, otherwise False.
3122 public function checkPassword( $password ) {
3123 global $wgAuth, $wgLegacyEncoding;
3126 // Even though we stop people from creating passwords that
3127 // are shorter than this, doesn't mean people wont be able
3128 // to. Certain authentication plugins do NOT want to save
3129 // domain passwords in a mysql database, so we should
3130 // check this (in case $wgAuth->strict() is false).
3131 if( !$this->isValidPassword( $password ) ) {
3135 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3137 } elseif( $wgAuth->strict() ) {
3138 /* Auth plugin doesn't allow local authentication */
3140 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3141 /* Auth plugin doesn't allow local authentication for this user name */
3144 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3146 } elseif ( $wgLegacyEncoding ) {
3147 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3148 # Check for this with iconv
3149 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3150 if ( $cp1252Password != $password &&
3151 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3160 * Check if the given clear-text password matches the temporary password
3161 * sent by e-mail for password reset operations.
3163 * @param $plaintext string
3165 * @return Boolean: True if matches, false otherwise
3167 public function checkTemporaryPassword( $plaintext ) {
3168 global $wgNewPasswordExpiry;
3171 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3172 if ( is_null( $this->mNewpassTime
) ) {
3175 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3176 return ( time() < $expiry );
3183 * Alias for getEditToken.
3184 * @deprecated since 1.19, use getEditToken instead.
3186 * @param $salt String|Array of Strings Optional function-specific data for hashing
3187 * @param $request WebRequest object to use or null to use $wgRequest
3188 * @return String The new edit token
3190 public function editToken( $salt = '', $request = null ) {
3191 wfDeprecated( __METHOD__
, '1.19' );
3192 return $this->getEditToken( $salt, $request );
3196 * Initialize (if necessary) and return a session token value
3197 * which can be used in edit forms to show that the user's
3198 * login credentials aren't being hijacked with a foreign form
3203 * @param $salt String|Array of Strings Optional function-specific data for hashing
3204 * @param $request WebRequest object to use or null to use $wgRequest
3205 * @return String The new edit token
3207 public function getEditToken( $salt = '', $request = null ) {
3208 if ( $request == null ) {
3209 $request = $this->getRequest();
3212 if ( $this->isAnon() ) {
3213 return EDIT_TOKEN_SUFFIX
;
3215 $token = $request->getSessionData( 'wsEditToken' );
3216 if ( $token === null ) {
3217 $token = MWCryptRand
::generateHex( 32 );
3218 $request->setSessionData( 'wsEditToken', $token );
3220 if( is_array( $salt ) ) {
3221 $salt = implode( '|', $salt );
3223 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3228 * Generate a looking random token for various uses.
3230 * @param $salt String Optional salt value
3231 * @return String The new random token
3232 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3234 public static function generateToken( $salt = '' ) {
3235 return MWCryptRand
::generateHex( 32 );
3239 * Check given value against the token value stored in the session.
3240 * A match should confirm that the form was submitted from the
3241 * user's own login session, not a form submission from a third-party
3244 * @param $val String Input value to compare
3245 * @param $salt String Optional function-specific data for hashing
3246 * @param $request WebRequest object to use or null to use $wgRequest
3247 * @return Boolean: Whether the token matches
3249 public function matchEditToken( $val, $salt = '', $request = null ) {
3250 $sessionToken = $this->getEditToken( $salt, $request );
3251 if ( $val != $sessionToken ) {
3252 wfDebug( "User::matchEditToken: broken session data\n" );
3254 return $val == $sessionToken;
3258 * Check given value against the token value stored in the session,
3259 * ignoring the suffix.
3261 * @param $val String Input value to compare
3262 * @param $salt String Optional function-specific data for hashing
3263 * @param $request WebRequest object to use or null to use $wgRequest
3264 * @return Boolean: Whether the token matches
3266 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3267 $sessionToken = $this->getEditToken( $salt, $request );
3268 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3272 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3273 * mail to the user's given address.
3275 * @param $type String: message to send, either "created", "changed" or "set"
3276 * @return Status object
3278 public function sendConfirmationMail( $type = 'created' ) {
3280 $expiration = null; // gets passed-by-ref and defined in next line.
3281 $token = $this->confirmationToken( $expiration );
3282 $url = $this->confirmationTokenUrl( $token );
3283 $invalidateURL = $this->invalidationTokenUrl( $token );
3284 $this->saveSettings();
3286 if ( $type == 'created' ||
$type === false ) {
3287 $message = 'confirmemail_body';
3288 } elseif ( $type === true ) {
3289 $message = 'confirmemail_body_changed';
3291 $message = 'confirmemail_body_' . $type;
3294 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3296 $this->getRequest()->getIP(),
3299 $wgLang->timeanddate( $expiration, false ),
3301 $wgLang->date( $expiration, false ),
3302 $wgLang->time( $expiration, false ) ) );
3306 * Send an e-mail to this user's account. Does not check for
3307 * confirmed status or validity.
3309 * @param $subject String Message subject
3310 * @param $body String Message body
3311 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3312 * @param $replyto String Reply-To address
3315 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3316 if( is_null( $from ) ) {
3317 global $wgPasswordSender, $wgPasswordSenderName;
3318 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3320 $sender = new MailAddress( $from );
3323 $to = new MailAddress( $this );
3324 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3328 * Generate, store, and return a new e-mail confirmation code.
3329 * A hash (unsalted, since it's used as a key) is stored.
3331 * @note Call saveSettings() after calling this function to commit
3332 * this change to the database.
3334 * @param &$expiration \mixed Accepts the expiration time
3335 * @return String New token
3337 private function confirmationToken( &$expiration ) {
3338 global $wgUserEmailConfirmationTokenExpiry;
3340 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3341 $expiration = wfTimestamp( TS_MW
, $expires );
3343 $token = MWCryptRand
::generateHex( 32 );
3344 $hash = md5( $token );
3345 $this->mEmailToken
= $hash;
3346 $this->mEmailTokenExpires
= $expiration;
3351 * Return a URL the user can use to confirm their email address.
3352 * @param $token String Accepts the email confirmation token
3353 * @return String New token URL
3355 private function confirmationTokenUrl( $token ) {
3356 return $this->getTokenUrl( 'ConfirmEmail', $token );
3360 * Return a URL the user can use to invalidate their email address.
3361 * @param $token String Accepts the email confirmation token
3362 * @return String New token URL
3364 private function invalidationTokenUrl( $token ) {
3365 return $this->getTokenUrl( 'Invalidateemail', $token );
3369 * Internal function to format the e-mail validation/invalidation URLs.
3370 * This uses a quickie hack to use the
3371 * hardcoded English names of the Special: pages, for ASCII safety.
3373 * @note Since these URLs get dropped directly into emails, using the
3374 * short English names avoids insanely long URL-encoded links, which
3375 * also sometimes can get corrupted in some browsers/mailers
3376 * (bug 6957 with Gmail and Internet Explorer).
3378 * @param $page String Special page
3379 * @param $token String Token
3380 * @return String Formatted URL
3382 protected function getTokenUrl( $page, $token ) {
3383 // Hack to bypass localization of 'Special:'
3384 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3385 return $title->getCanonicalUrl();
3389 * Mark the e-mail address confirmed.
3391 * @note Call saveSettings() after calling this function to commit the change.
3395 public function confirmEmail() {
3396 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3397 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3402 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3403 * address if it was already confirmed.
3405 * @note Call saveSettings() after calling this function to commit the change.
3406 * @return bool Returns true
3408 function invalidateEmail() {
3410 $this->mEmailToken
= null;
3411 $this->mEmailTokenExpires
= null;
3412 $this->setEmailAuthenticationTimestamp( null );
3413 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3418 * Set the e-mail authentication timestamp.
3419 * @param $timestamp String TS_MW timestamp
3421 function setEmailAuthenticationTimestamp( $timestamp ) {
3423 $this->mEmailAuthenticated
= $timestamp;
3424 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3428 * Is this user allowed to send e-mails within limits of current
3429 * site configuration?
3432 public function canSendEmail() {
3433 global $wgEnableEmail, $wgEnableUserEmail;
3434 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3437 $canSend = $this->isEmailConfirmed();
3438 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3443 * Is this user allowed to receive e-mails within limits of current
3444 * site configuration?
3447 public function canReceiveEmail() {
3448 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3452 * Is this user's e-mail address valid-looking and confirmed within
3453 * limits of the current site configuration?
3455 * @note If $wgEmailAuthentication is on, this may require the user to have
3456 * confirmed their address by returning a code or using a password
3457 * sent to the address from the wiki.
3461 public function isEmailConfirmed() {
3462 global $wgEmailAuthentication;
3465 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3466 if( $this->isAnon() ) {
3469 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3472 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3482 * Check whether there is an outstanding request for e-mail confirmation.
3485 public function isEmailConfirmationPending() {
3486 global $wgEmailAuthentication;
3487 return $wgEmailAuthentication &&
3488 !$this->isEmailConfirmed() &&
3489 $this->mEmailToken
&&
3490 $this->mEmailTokenExpires
> wfTimestamp();
3494 * Get the timestamp of account creation.
3496 * @return String|Bool Timestamp of account creation, or false for
3497 * non-existent/anonymous user accounts.
3499 public function getRegistration() {
3500 if ( $this->isAnon() ) {
3504 return $this->mRegistration
;
3508 * Get the timestamp of the first edit
3510 * @return String|Bool Timestamp of first edit, or false for
3511 * non-existent/anonymous user accounts.
3513 public function getFirstEditTimestamp() {
3514 if( $this->getId() == 0 ) {
3515 return false; // anons
3517 $dbr = wfGetDB( DB_SLAVE
);
3518 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3519 array( 'rev_user' => $this->getId() ),
3521 array( 'ORDER BY' => 'rev_timestamp ASC' )
3524 return false; // no edits
3526 return wfTimestamp( TS_MW
, $time );
3530 * Get the permissions associated with a given list of groups
3532 * @param $groups Array of Strings List of internal group names
3533 * @return Array of Strings List of permission key names for given groups combined
3535 public static function getGroupPermissions( $groups ) {
3536 global $wgGroupPermissions, $wgRevokePermissions;
3538 // grant every granted permission first
3539 foreach( $groups as $group ) {
3540 if( isset( $wgGroupPermissions[$group] ) ) {
3541 $rights = array_merge( $rights,
3542 // array_filter removes empty items
3543 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3546 // now revoke the revoked permissions
3547 foreach( $groups as $group ) {
3548 if( isset( $wgRevokePermissions[$group] ) ) {
3549 $rights = array_diff( $rights,
3550 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3553 return array_unique( $rights );
3557 * Get all the groups who have a given permission
3559 * @param $role String Role to check
3560 * @return Array of Strings List of internal group names with the given permission
3562 public static function getGroupsWithPermission( $role ) {
3563 global $wgGroupPermissions;
3564 $allowedGroups = array();
3565 foreach ( $wgGroupPermissions as $group => $rights ) {
3566 if ( isset( $rights[$role] ) && $rights[$role] ) {
3567 $allowedGroups[] = $group;
3570 return $allowedGroups;
3574 * Get the localized descriptive name for a group, if it exists
3576 * @param $group String Internal group name
3577 * @return String Localized descriptive group name
3579 public static function getGroupName( $group ) {
3580 $msg = wfMessage( "group-$group" );
3581 return $msg->isBlank() ?
$group : $msg->text();
3585 * Get the localized descriptive name for a member of a group, if it exists
3587 * @param $group String Internal group name
3588 * @param $username String Username for gender (since 1.19)
3589 * @return String Localized name for group member
3591 public static function getGroupMember( $group, $username = '#' ) {
3592 $msg = wfMessage( "group-$group-member", $username );
3593 return $msg->isBlank() ?
$group : $msg->text();
3597 * Return the set of defined explicit groups.
3598 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3599 * are not included, as they are defined automatically, not in the database.
3600 * @return Array of internal group names
3602 public static function getAllGroups() {
3603 global $wgGroupPermissions, $wgRevokePermissions;
3605 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3606 self
::getImplicitGroups()
3611 * Get a list of all available permissions.
3612 * @return Array of permission names
3614 public static function getAllRights() {
3615 if ( self
::$mAllRights === false ) {
3616 global $wgAvailableRights;
3617 if ( count( $wgAvailableRights ) ) {
3618 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3620 self
::$mAllRights = self
::$mCoreRights;
3622 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3624 return self
::$mAllRights;
3628 * Get a list of implicit groups
3629 * @return Array of Strings Array of internal group names
3631 public static function getImplicitGroups() {
3632 global $wgImplicitGroups;
3633 $groups = $wgImplicitGroups;
3634 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3639 * Get the title of a page describing a particular group
3641 * @param $group String Internal group name
3642 * @return Title|Bool Title of the page if it exists, false otherwise
3644 public static function getGroupPage( $group ) {
3645 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3646 if( $msg->exists() ) {
3647 $title = Title
::newFromText( $msg->text() );
3648 if( is_object( $title ) )
3655 * Create a link to the group in HTML, if available;
3656 * else return the group name.
3658 * @param $group String Internal name of the group
3659 * @param $text String The text of the link
3660 * @return String HTML link to the group
3662 public static function makeGroupLinkHTML( $group, $text = '' ) {
3664 $text = self
::getGroupName( $group );
3666 $title = self
::getGroupPage( $group );
3668 return Linker
::link( $title, htmlspecialchars( $text ) );
3675 * Create a link to the group in Wikitext, if available;
3676 * else return the group name.
3678 * @param $group String Internal name of the group
3679 * @param $text String The text of the link
3680 * @return String Wikilink to the group
3682 public static function makeGroupLinkWiki( $group, $text = '' ) {
3684 $text = self
::getGroupName( $group );
3686 $title = self
::getGroupPage( $group );
3688 $page = $title->getPrefixedText();
3689 return "[[$page|$text]]";
3696 * Returns an array of the groups that a particular group can add/remove.
3698 * @param $group String: the group to check for whether it can add/remove
3699 * @return Array array( 'add' => array( addablegroups ),
3700 * 'remove' => array( removablegroups ),
3701 * 'add-self' => array( addablegroups to self),
3702 * 'remove-self' => array( removable groups from self) )
3704 public static function changeableByGroup( $group ) {
3705 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3707 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3708 if( empty( $wgAddGroups[$group] ) ) {
3709 // Don't add anything to $groups
3710 } elseif( $wgAddGroups[$group] === true ) {
3711 // You get everything
3712 $groups['add'] = self
::getAllGroups();
3713 } elseif( is_array( $wgAddGroups[$group] ) ) {
3714 $groups['add'] = $wgAddGroups[$group];
3717 // Same thing for remove
3718 if( empty( $wgRemoveGroups[$group] ) ) {
3719 } elseif( $wgRemoveGroups[$group] === true ) {
3720 $groups['remove'] = self
::getAllGroups();
3721 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3722 $groups['remove'] = $wgRemoveGroups[$group];
3725 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3726 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3727 foreach( $wgGroupsAddToSelf as $key => $value ) {
3728 if( is_int( $key ) ) {
3729 $wgGroupsAddToSelf['user'][] = $value;
3734 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3735 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3736 if( is_int( $key ) ) {
3737 $wgGroupsRemoveFromSelf['user'][] = $value;
3742 // Now figure out what groups the user can add to him/herself
3743 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3744 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3745 // No idea WHY this would be used, but it's there
3746 $groups['add-self'] = User
::getAllGroups();
3747 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3748 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3751 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3752 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3753 $groups['remove-self'] = User
::getAllGroups();
3754 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3755 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3762 * Returns an array of groups that this user can add and remove
3763 * @return Array array( 'add' => array( addablegroups ),
3764 * 'remove' => array( removablegroups ),
3765 * 'add-self' => array( addablegroups to self),
3766 * 'remove-self' => array( removable groups from self) )
3768 public function changeableGroups() {
3769 if( $this->isAllowed( 'userrights' ) ) {
3770 // This group gives the right to modify everything (reverse-
3771 // compatibility with old "userrights lets you change
3773 // Using array_merge to make the groups reindexed
3774 $all = array_merge( User
::getAllGroups() );
3778 'add-self' => array(),
3779 'remove-self' => array()
3783 // Okay, it's not so simple, we will have to go through the arrays
3786 'remove' => array(),
3787 'add-self' => array(),
3788 'remove-self' => array()
3790 $addergroups = $this->getEffectiveGroups();
3792 foreach( $addergroups as $addergroup ) {
3793 $groups = array_merge_recursive(
3794 $groups, $this->changeableByGroup( $addergroup )
3796 $groups['add'] = array_unique( $groups['add'] );
3797 $groups['remove'] = array_unique( $groups['remove'] );
3798 $groups['add-self'] = array_unique( $groups['add-self'] );
3799 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3805 * Increment the user's edit-count field.
3806 * Will have no effect for anonymous users.
3808 public function incEditCount() {
3809 if( !$this->isAnon() ) {
3810 $dbw = wfGetDB( DB_MASTER
);
3811 $dbw->update( 'user',
3812 array( 'user_editcount=user_editcount+1' ),
3813 array( 'user_id' => $this->getId() ),
3816 // Lazy initialization check...
3817 if( $dbw->affectedRows() == 0 ) {
3818 // Pull from a slave to be less cruel to servers
3819 // Accuracy isn't the point anyway here
3820 $dbr = wfGetDB( DB_SLAVE
);
3821 $count = $dbr->selectField( 'revision',
3823 array( 'rev_user' => $this->getId() ),
3826 // Now here's a goddamn hack...
3827 if( $dbr !== $dbw ) {
3828 // If we actually have a slave server, the count is
3829 // at least one behind because the current transaction
3830 // has not been committed and replicated.
3833 // But if DB_SLAVE is selecting the master, then the
3834 // count we just read includes the revision that was
3835 // just added in the working transaction.
3838 $dbw->update( 'user',
3839 array( 'user_editcount' => $count ),
3840 array( 'user_id' => $this->getId() ),
3844 // edit count in user cache too
3845 $this->invalidateCache();
3849 * Get the description of a given right
3851 * @param $right String Right to query
3852 * @return String Localized description of the right
3854 public static function getRightDescription( $right ) {
3855 $key = "right-$right";
3856 $msg = wfMessage( $key );
3857 return $msg->isBlank() ?
$right : $msg->text();
3861 * Make an old-style password hash
3863 * @param $password String Plain-text password
3864 * @param $userId String User ID
3865 * @return String Password hash
3867 public static function oldCrypt( $password, $userId ) {
3868 global $wgPasswordSalt;
3869 if ( $wgPasswordSalt ) {
3870 return md5( $userId . '-' . md5( $password ) );
3872 return md5( $password );
3877 * Make a new-style password hash
3879 * @param $password String Plain-text password
3880 * @param bool|string $salt Optional salt, may be random or the user ID.
3882 * If unspecified or false, will generate one automatically
3883 * @return String Password hash
3885 public static function crypt( $password, $salt = false ) {
3886 global $wgPasswordSalt;
3889 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3893 if( $wgPasswordSalt ) {
3894 if ( $salt === false ) {
3895 $salt = MWCryptRand
::generateHex( 8 );
3897 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3899 return ':A:' . md5( $password );
3904 * Compare a password hash with a plain-text password. Requires the user
3905 * ID if there's a chance that the hash is an old-style hash.
3907 * @param $hash String Password hash
3908 * @param $password String Plain-text password to compare
3909 * @param $userId String|bool User ID for old-style password salt
3913 public static function comparePasswords( $hash, $password, $userId = false ) {
3914 $type = substr( $hash, 0, 3 );
3917 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3921 if ( $type == ':A:' ) {
3923 return md5( $password ) === substr( $hash, 3 );
3924 } elseif ( $type == ':B:' ) {
3926 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3927 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3930 return self
::oldCrypt( $password, $userId ) === $hash;
3935 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
3937 * @param $byEmail Boolean: account made by email?
3938 * @param $reason String: user supplied reason
3940 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
3942 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3943 global $wgUser, $wgContLang, $wgNewUserLog;
3944 if( empty( $wgNewUserLog ) ) {
3945 return true; // disabled
3948 if( $this->getName() == $wgUser->getName() ) {
3951 $action = 'create2';
3953 if ( $reason === '' ) {
3954 $reason = wfMsgForContent( 'newuserlog-byemail' );
3956 $reason = $wgContLang->commaList( array(
3957 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3961 $log = new LogPage( 'newusers' );
3962 return (int)$log->addEntry(
3964 $this->getUserPage(),
3966 array( $this->getId() )
3971 * Add an autocreate newuser log entry for this user
3972 * Used by things like CentralAuth and perhaps other authplugins.
3976 public function addNewUserLogEntryAutoCreate() {
3977 global $wgNewUserLog;
3978 if( !$wgNewUserLog ) {
3979 return true; // disabled
3981 $log = new LogPage( 'newusers', false );
3982 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
3989 protected function loadOptions() {
3991 if ( $this->mOptionsLoaded ||
!$this->getId() )
3994 $this->mOptions
= self
::getDefaultOptions();
3996 // Maybe load from the object
3997 if ( !is_null( $this->mOptionOverrides
) ) {
3998 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3999 foreach( $this->mOptionOverrides
as $key => $value ) {
4000 $this->mOptions
[$key] = $value;
4003 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4004 // Load from database
4005 $dbr = wfGetDB( DB_SLAVE
);
4007 $res = $dbr->select(
4010 array( 'up_user' => $this->getId() ),
4014 $this->mOptionOverrides
= array();
4015 foreach ( $res as $row ) {
4016 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4017 $this->mOptions
[$row->up_property
] = $row->up_value
;
4021 $this->mOptionsLoaded
= true;
4023 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4029 protected function saveOptions() {
4030 global $wgAllowPrefChange;
4032 $extuser = ExternalUser
::newFromUser( $this );
4034 $this->loadOptions();
4035 $dbw = wfGetDB( DB_MASTER
);
4037 $insert_rows = array();
4039 $saveOptions = $this->mOptions
;
4041 // Allow hooks to abort, for instance to save to a global profile.
4042 // Reset options to default state before saving.
4043 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4047 foreach( $saveOptions as $key => $value ) {
4048 # Don't bother storing default values
4049 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
4050 !( $value === false ||
is_null($value) ) ) ||
4051 $value != self
::getDefaultOption( $key ) ) {
4052 $insert_rows[] = array(
4053 'up_user' => $this->getId(),
4054 'up_property' => $key,
4055 'up_value' => $value,
4058 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4059 switch ( $wgAllowPrefChange[$key] ) {
4065 $extuser->setPref( $key, $value );
4070 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
4071 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4075 * Provide an array of HTML5 attributes to put on an input element
4076 * intended for the user to enter a new password. This may include
4077 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4079 * Do *not* use this when asking the user to enter his current password!
4080 * Regardless of configuration, users may have invalid passwords for whatever
4081 * reason (e.g., they were set before requirements were tightened up).
4082 * Only use it when asking for a new password, like on account creation or
4085 * Obviously, you still need to do server-side checking.
4087 * NOTE: A combination of bugs in various browsers means that this function
4088 * actually just returns array() unconditionally at the moment. May as
4089 * well keep it around for when the browser bugs get fixed, though.
4091 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4093 * @return array Array of HTML attributes suitable for feeding to
4094 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4095 * That will potentially output invalid XHTML 1.0 Transitional, and will
4096 * get confused by the boolean attribute syntax used.)
4098 public static function passwordChangeInputAttribs() {
4099 global $wgMinimalPasswordLength;
4101 if ( $wgMinimalPasswordLength == 0 ) {
4105 # Note that the pattern requirement will always be satisfied if the
4106 # input is empty, so we need required in all cases.
4108 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4109 # if e-mail confirmation is being used. Since HTML5 input validation
4110 # is b0rked anyway in some browsers, just return nothing. When it's
4111 # re-enabled, fix this code to not output required for e-mail
4113 #$ret = array( 'required' );
4116 # We can't actually do this right now, because Opera 9.6 will print out
4117 # the entered password visibly in its error message! When other
4118 # browsers add support for this attribute, or Opera fixes its support,
4119 # we can add support with a version check to avoid doing this on Opera
4120 # versions where it will be a problem. Reported to Opera as
4121 # DSK-262266, but they don't have a public bug tracker for us to follow.
4123 if ( $wgMinimalPasswordLength > 1 ) {
4124 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4125 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4126 $wgMinimalPasswordLength );