3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Int Number of characters in user_token field.
27 define( 'USER_TOKEN_LENGTH', 32 );
30 * Int Serialized record version.
33 define( 'MW_USER_VERSION', 8 );
36 * String Some punctuation to prevent editing from broken text-mangling proxies.
39 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
42 * Thrown by User::setPassword() on error.
45 class PasswordError
extends MWException
{
50 * The User object encapsulates all of the user-specific settings (user_id,
51 * name, rights, password, email address, options, last login time). Client
52 * classes use the getXXX() functions to access these fields. These functions
53 * do all the work of determining whether the user is logged in,
54 * whether the requested option can be satisfied from cookies or
55 * whether a database query is needed. Most of the settings needed
56 * for rendering normal pages are set in the cookie to minimize use
61 * Global constants made accessible as class constants so that autoloader
64 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
65 const MW_USER_VERSION
= MW_USER_VERSION
;
66 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
69 * Maximum items in $mWatchedItems
71 const MAX_WATCHED_ITEMS_CACHE
= 100;
74 * Array of Strings List of member variables which are saved to the
75 * shared cache (memcached). Any operation which changes the
76 * corresponding database fields must call a cache-clearing function.
79 static $mCacheVars = array(
90 'mEmailAuthenticated',
97 // user_properties table
102 * Array of Strings Core rights.
103 * Each of these should have a corresponding message of the form
107 static $mCoreRights = array(
125 'editusercssjs', #deprecated
137 'move-rootuserpages',
141 'override-export-depth',
161 'userrights-interwiki',
165 * String Cached results of getAllRights()
167 static $mAllRights = false;
169 /** @name Cache variables */
171 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
172 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
173 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
174 $mGroups, $mOptionOverrides;
178 * Bool Whether the cache variables have been loaded.
184 * Array with already loaded items or true if all items have been loaded.
186 private $mLoadedItems = array();
190 * String Initialization data source if mLoadedItems!==true. May be one of:
191 * - 'defaults' anonymous user initialised from class defaults
192 * - 'name' initialise from mName
193 * - 'id' initialise from mId
194 * - 'session' log in from cookies or session if possible
196 * Use the User::newFrom*() family of functions to set this.
201 * Lazy-initialized variables, invalidated with clearInstanceCache
203 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
204 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
205 $mLocked, $mHideName, $mOptions;
225 private $mBlockedFromCreateAccount = false;
230 private $mWatchedItems = array();
232 static $idCacheByName = array();
235 * Lightweight constructor for an anonymous user.
236 * Use the User::newFrom* factory functions for other kinds of users.
240 * @see newFromConfirmationCode()
241 * @see newFromSession()
244 function __construct() {
245 $this->clearInstanceCache( 'defaults' );
251 function __toString(){
252 return $this->getName();
256 * Load the user table data for this object from the source given by mFrom.
258 public function load() {
259 if ( $this->mLoadedItems
=== true ) {
262 wfProfileIn( __METHOD__
);
264 # Set it now to avoid infinite recursion in accessors
265 $this->mLoadedItems
= true;
267 switch ( $this->mFrom
) {
269 $this->loadDefaults();
272 $this->mId
= self
::idFromName( $this->mName
);
274 # Nonexistent user placeholder object
275 $this->loadDefaults( $this->mName
);
284 $this->loadFromSession();
285 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
288 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
290 wfProfileOut( __METHOD__
);
294 * Load user table data, given mId has already been set.
295 * @return Bool false if the ID does not exist, true otherwise
297 public function loadFromId() {
299 if ( $this->mId
== 0 ) {
300 $this->loadDefaults();
305 $key = wfMemcKey( 'user', 'id', $this->mId
);
306 $data = $wgMemc->get( $key );
307 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
308 # Object is expired, load from DB
313 wfDebug( "User: cache miss for user {$this->mId}\n" );
315 if ( !$this->loadFromDatabase() ) {
316 # Can't load from ID, user is anonymous
319 $this->saveToCache();
321 wfDebug( "User: got user {$this->mId} from cache\n" );
323 foreach ( self
::$mCacheVars as $name ) {
324 $this->$name = $data[$name];
331 * Save user data to the shared cache
333 public function saveToCache() {
336 $this->loadOptions();
337 if ( $this->isAnon() ) {
338 // Anonymous users are uncached
342 foreach ( self
::$mCacheVars as $name ) {
343 $data[$name] = $this->$name;
345 $data['mVersion'] = MW_USER_VERSION
;
346 $key = wfMemcKey( 'user', 'id', $this->mId
);
348 $wgMemc->set( $key, $data );
351 /** @name newFrom*() static factory methods */
355 * Static factory method for creation from username.
357 * This is slightly less efficient than newFromId(), so use newFromId() if
358 * you have both an ID and a name handy.
360 * @param $name String Username, validated by Title::newFromText()
361 * @param $validate String|Bool Validate username. Takes the same parameters as
362 * User::getCanonicalName(), except that true is accepted as an alias
363 * for 'valid', for BC.
365 * @return User object, or false if the username is invalid
366 * (e.g. if it contains illegal characters or is an IP address). If the
367 * username is not present in the database, the result will be a user object
368 * with a name, zero user ID and default settings.
370 public static function newFromName( $name, $validate = 'valid' ) {
371 if ( $validate === true ) {
374 $name = self
::getCanonicalName( $name, $validate );
375 if ( $name === false ) {
378 # Create unloaded user object
382 $u->setItemLoaded( 'name' );
388 * Static factory method for creation from a given user ID.
390 * @param $id Int Valid user ID
391 * @return User The corresponding User object
393 public static function newFromId( $id ) {
397 $u->setItemLoaded( 'id' );
402 * Factory method to fetch whichever user has a given email confirmation code.
403 * This code is generated when an account is created or its e-mail address
406 * If the code is invalid or has expired, returns NULL.
408 * @param $code String Confirmation code
409 * @return User object, or null
411 public static function newFromConfirmationCode( $code ) {
412 $dbr = wfGetDB( DB_SLAVE
);
413 $id = $dbr->selectField( 'user', 'user_id', array(
414 'user_email_token' => md5( $code ),
415 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
417 if( $id !== false ) {
418 return User
::newFromId( $id );
425 * Create a new user object using data from session or cookies. If the
426 * login credentials are invalid, the result is an anonymous user.
428 * @param $request WebRequest object to use; $wgRequest will be used if
430 * @return User object
432 public static function newFromSession( WebRequest
$request = null ) {
434 $user->mFrom
= 'session';
435 $user->mRequest
= $request;
440 * Create a new user object from a user row.
441 * The row should have the following fields from the user table in it:
442 * - either user_name or user_id to load further data if needed (or both)
444 * - all other fields (email, password, etc.)
445 * It is useless to provide the remaining fields if either user_id,
446 * user_name and user_real_name are not provided because the whole row
447 * will be loaded once more from the database when accessing them.
449 * @param $row Array A row from the user table
452 public static function newFromRow( $row ) {
454 $user->loadFromRow( $row );
461 * Get the username corresponding to a given user ID
462 * @param $id Int User ID
463 * @return String|bool The corresponding username
465 public static function whoIs( $id ) {
466 $dbr = wfGetDB( DB_SLAVE
);
467 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
471 * Get the real name of a user given their user ID
473 * @param $id Int User ID
474 * @return String|bool The corresponding user's real name
476 public static function whoIsReal( $id ) {
477 $dbr = wfGetDB( DB_SLAVE
);
478 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
482 * Get database id given a user name
483 * @param $name String Username
484 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
486 public static function idFromName( $name ) {
487 $nt = Title
::makeTitleSafe( NS_USER
, $name );
488 if( is_null( $nt ) ) {
493 if ( isset( self
::$idCacheByName[$name] ) ) {
494 return self
::$idCacheByName[$name];
497 $dbr = wfGetDB( DB_SLAVE
);
498 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
500 if ( $s === false ) {
503 $result = $s->user_id
;
506 self
::$idCacheByName[$name] = $result;
508 if ( count( self
::$idCacheByName ) > 1000 ) {
509 self
::$idCacheByName = array();
516 * Reset the cache used in idFromName(). For use in tests.
518 public static function resetIdByNameCache() {
519 self
::$idCacheByName = array();
523 * Does the string match an anonymous IPv4 address?
525 * This function exists for username validation, in order to reject
526 * usernames which are similar in form to IP addresses. Strings such
527 * as 300.300.300.300 will return true because it looks like an IP
528 * address, despite not being strictly valid.
530 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
531 * address because the usemod software would "cloak" anonymous IP
532 * addresses like this, if we allowed accounts like this to be created
533 * new users could get the old edits of these anonymous users.
535 * @param $name String to match
538 public static function isIP( $name ) {
539 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
543 * Is the input a valid username?
545 * Checks if the input is a valid username, we don't want an empty string,
546 * an IP address, anything that containins slashes (would mess up subpages),
547 * is longer than the maximum allowed username size or doesn't begin with
550 * @param $name String to match
553 public static function isValidUserName( $name ) {
554 global $wgContLang, $wgMaxNameChars;
557 || User
::isIP( $name )
558 ||
strpos( $name, '/' ) !== false
559 ||
strlen( $name ) > $wgMaxNameChars
560 ||
$name != $wgContLang->ucfirst( $name ) ) {
561 wfDebugLog( 'username', __METHOD__
.
562 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
567 // Ensure that the name can't be misresolved as a different title,
568 // such as with extra namespace keys at the start.
569 $parsed = Title
::newFromText( $name );
570 if( is_null( $parsed )
571 ||
$parsed->getNamespace()
572 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
573 wfDebugLog( 'username', __METHOD__
.
574 ": '$name' invalid due to ambiguous prefixes" );
578 // Check an additional blacklist of troublemaker characters.
579 // Should these be merged into the title char list?
580 $unicodeBlacklist = '/[' .
581 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
582 '\x{00a0}' . # non-breaking space
583 '\x{2000}-\x{200f}' . # various whitespace
584 '\x{2028}-\x{202f}' . # breaks and control chars
585 '\x{3000}' . # ideographic space
586 '\x{e000}-\x{f8ff}' . # private use
588 if( preg_match( $unicodeBlacklist, $name ) ) {
589 wfDebugLog( 'username', __METHOD__
.
590 ": '$name' invalid due to blacklisted characters" );
598 * Usernames which fail to pass this function will be blocked
599 * from user login and new account registrations, but may be used
600 * internally by batch processes.
602 * If an account already exists in this form, login will be blocked
603 * by a failure to pass this function.
605 * @param $name String to match
608 public static function isUsableName( $name ) {
609 global $wgReservedUsernames;
610 // Must be a valid username, obviously ;)
611 if ( !self
::isValidUserName( $name ) ) {
615 static $reservedUsernames = false;
616 if ( !$reservedUsernames ) {
617 $reservedUsernames = $wgReservedUsernames;
618 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
621 // Certain names may be reserved for batch processes.
622 foreach ( $reservedUsernames as $reserved ) {
623 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
624 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
626 if ( $reserved == $name ) {
634 * Usernames which fail to pass this function will be blocked
635 * from new account registrations, but may be used internally
636 * either by batch processes or by user accounts which have
637 * already been created.
639 * Additional blacklisting may be added here rather than in
640 * isValidUserName() to avoid disrupting existing accounts.
642 * @param $name String to match
645 public static function isCreatableName( $name ) {
646 global $wgInvalidUsernameCharacters;
648 // Ensure that the username isn't longer than 235 bytes, so that
649 // (at least for the builtin skins) user javascript and css files
650 // will work. (bug 23080)
651 if( strlen( $name ) > 235 ) {
652 wfDebugLog( 'username', __METHOD__
.
653 ": '$name' invalid due to length" );
657 // Preg yells if you try to give it an empty string
658 if( $wgInvalidUsernameCharacters !== '' ) {
659 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
660 wfDebugLog( 'username', __METHOD__
.
661 ": '$name' invalid due to wgInvalidUsernameCharacters" );
666 return self
::isUsableName( $name );
670 * Is the input a valid password for this user?
672 * @param $password String Desired password
675 public function isValidPassword( $password ) {
676 //simple boolean wrapper for getPasswordValidity
677 return $this->getPasswordValidity( $password ) === true;
681 * Given unvalidated password input, return error message on failure.
683 * @param $password String Desired password
684 * @return mixed: true on success, string or array of error message on failure
686 public function getPasswordValidity( $password ) {
687 global $wgMinimalPasswordLength, $wgContLang;
689 static $blockedLogins = array(
690 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
691 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
694 $result = false; //init $result to false for the internal checks
696 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
699 if ( $result === false ) {
700 if( strlen( $password ) < $wgMinimalPasswordLength ) {
701 return 'passwordtooshort';
702 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
703 return 'password-name-match';
704 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
705 return 'password-login-forbidden';
707 //it seems weird returning true here, but this is because of the
708 //initialization of $result to false above. If the hook is never run or it
709 //doesn't modify $result, then we will likely get down into this if with
713 } elseif( $result === true ) {
716 return $result; //the isValidPassword hook set a string $result and returned true
721 * Does a string look like an e-mail address?
723 * This validates an email address using an HTML5 specification found at:
724 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
725 * Which as of 2011-01-24 says:
727 * A valid e-mail address is a string that matches the ABNF production
728 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
729 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
732 * This function is an implementation of the specification as requested in
735 * Client-side forms will use the same standard validation rules via JS or
736 * HTML 5 validation; additional restrictions can be enforced server-side
737 * by extensions via the 'isValidEmailAddr' hook.
739 * Note that this validation doesn't 100% match RFC 2822, but is believed
740 * to be liberal enough for wide use. Some invalid addresses will still
741 * pass validation here.
743 * @param $addr String E-mail address
745 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
747 public static function isValidEmailAddr( $addr ) {
748 wfDeprecated( __METHOD__
, '1.18' );
749 return Sanitizer
::validateEmail( $addr );
753 * Given unvalidated user input, return a canonical username, or false if
754 * the username is invalid.
755 * @param $name String User input
756 * @param $validate String|Bool type of validation to use:
757 * - false No validation
758 * - 'valid' Valid for batch processes
759 * - 'usable' Valid for batch processes and login
760 * - 'creatable' Valid for batch processes, login and account creation
762 * @return bool|string
764 public static function getCanonicalName( $name, $validate = 'valid' ) {
765 # Force usernames to capital
767 $name = $wgContLang->ucfirst( $name );
769 # Reject names containing '#'; these will be cleaned up
770 # with title normalisation, but then it's too late to
772 if( strpos( $name, '#' ) !== false )
775 # Clean up name according to title rules
776 $t = ( $validate === 'valid' ) ?
777 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
778 # Check for invalid titles
779 if( is_null( $t ) ) {
783 # Reject various classes of invalid names
785 $name = $wgAuth->getCanonicalName( $t->getText() );
787 switch ( $validate ) {
791 if ( !User
::isValidUserName( $name ) ) {
796 if ( !User
::isUsableName( $name ) ) {
801 if ( !User
::isCreatableName( $name ) ) {
806 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
812 * Count the number of edits of a user
813 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
815 * @param $uid Int User ID to check
816 * @return Int the user's edit count
818 public static function edits( $uid ) {
819 wfProfileIn( __METHOD__
);
820 $dbr = wfGetDB( DB_SLAVE
);
821 // check if the user_editcount field has been initialized
822 $field = $dbr->selectField(
823 'user', 'user_editcount',
824 array( 'user_id' => $uid ),
828 if( $field === null ) { // it has not been initialized. do so.
829 $dbw = wfGetDB( DB_MASTER
);
830 $count = $dbr->selectField(
831 'revision', 'count(*)',
832 array( 'rev_user' => $uid ),
837 array( 'user_editcount' => $count ),
838 array( 'user_id' => $uid ),
844 wfProfileOut( __METHOD__
);
849 * Return a random password.
851 * @return String new random password
853 public static function randomPassword() {
854 global $wgMinimalPasswordLength;
855 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
856 $length = max( 10, $wgMinimalPasswordLength );
857 // Multiply by 1.25 to get the number of hex characters we need
858 $length = $length * 1.25;
859 // Generate random hex chars
860 $hex = MWCryptRand
::generateHex( $length );
861 // Convert from base 16 to base 32 to get a proper password like string
862 return wfBaseConvert( $hex, 16, 32 );
866 * Set cached properties to default.
868 * @note This no longer clears uncached lazy-initialised properties;
869 * the constructor does that instead.
871 * @param $name string
873 public function loadDefaults( $name = false ) {
874 wfProfileIn( __METHOD__
);
877 $this->mName
= $name;
878 $this->mRealName
= '';
879 $this->mPassword
= $this->mNewpassword
= '';
880 $this->mNewpassTime
= null;
882 $this->mOptionOverrides
= null;
883 $this->mOptionsLoaded
= false;
885 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
886 if( $loggedOut !== null ) {
887 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
889 $this->mTouched
= '0'; # Allow any pages to be cached
892 $this->mToken
= null; // Don't run cryptographic functions till we need a token
893 $this->mEmailAuthenticated
= null;
894 $this->mEmailToken
= '';
895 $this->mEmailTokenExpires
= null;
896 $this->mRegistration
= wfTimestamp( TS_MW
);
897 $this->mGroups
= array();
899 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
901 wfProfileOut( __METHOD__
);
905 * Return whether an item has been loaded.
907 * @param $item String: item to check. Current possibilities:
911 * @param $all String: 'all' to check if the whole object has been loaded
912 * or any other string to check if only the item is available (e.g.
916 public function isItemLoaded( $item, $all = 'all' ) {
917 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
918 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
922 * Set that an item has been loaded
924 * @param $item String
926 private function setItemLoaded( $item ) {
927 if ( is_array( $this->mLoadedItems
) ) {
928 $this->mLoadedItems
[$item] = true;
933 * Load user data from the session or login cookie. If there are no valid
934 * credentials, initialises the user as an anonymous user.
935 * @return Bool True if the user is logged in, false otherwise.
937 private function loadFromSession() {
938 global $wgExternalAuthType, $wgAutocreatePolicy;
941 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
942 if ( $result !== null ) {
946 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
947 $extUser = ExternalUser
::newFromCookie();
949 # TODO: Automatically create the user here (or probably a bit
950 # lower down, in fact)
954 $request = $this->getRequest();
956 $cookieId = $request->getCookie( 'UserID' );
957 $sessId = $request->getSessionData( 'wsUserID' );
959 if ( $cookieId !== null ) {
960 $sId = intval( $cookieId );
961 if( $sessId !== null && $cookieId != $sessId ) {
962 $this->loadDefaults(); // Possible collision!
963 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
964 cookie user ID ($sId) don't match!" );
967 $request->setSessionData( 'wsUserID', $sId );
968 } elseif ( $sessId !== null && $sessId != 0 ) {
971 $this->loadDefaults();
975 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
976 $sName = $request->getSessionData( 'wsUserName' );
977 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
978 $sName = $request->getCookie( 'UserName' );
979 $request->setSessionData( 'wsUserName', $sName );
981 $this->loadDefaults();
985 $proposedUser = User
::newFromId( $sId );
986 if ( !$proposedUser->isLoggedIn() ) {
988 $this->loadDefaults();
992 global $wgBlockDisablesLogin;
993 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
994 # User blocked and we've disabled blocked user logins
995 $this->loadDefaults();
999 if ( $request->getSessionData( 'wsToken' ) ) {
1000 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
1002 } elseif ( $request->getCookie( 'Token' ) ) {
1003 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
1006 # No session or persistent login cookie
1007 $this->loadDefaults();
1011 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1012 $this->loadFromUserObject( $proposedUser );
1013 $request->setSessionData( 'wsToken', $this->mToken
);
1014 wfDebug( "User: logged in from $from\n" );
1017 # Invalid credentials
1018 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1019 $this->loadDefaults();
1025 * Load user and user_group data from the database.
1026 * $this->mId must be set, this is how the user is identified.
1028 * @return Bool True if the user exists, false if the user is anonymous
1030 public function loadFromDatabase() {
1032 $this->mId
= intval( $this->mId
);
1034 /** Anonymous user */
1036 $this->loadDefaults();
1040 $dbr = wfGetDB( DB_MASTER
);
1041 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1043 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1045 if ( $s !== false ) {
1046 # Initialise user table data
1047 $this->loadFromRow( $s );
1048 $this->mGroups
= null; // deferred
1049 $this->getEditCount(); // revalidation for nulls
1054 $this->loadDefaults();
1060 * Initialize this object from a row from the user table.
1062 * @param $row Array Row from the user table to load.
1064 public function loadFromRow( $row ) {
1067 $this->mGroups
= null; // deferred
1069 if ( isset( $row->user_name
) ) {
1070 $this->mName
= $row->user_name
;
1071 $this->mFrom
= 'name';
1072 $this->setItemLoaded( 'name' );
1077 if ( isset( $row->user_real_name
) ) {
1078 $this->mRealName
= $row->user_real_name
;
1079 $this->setItemLoaded( 'realname' );
1084 if ( isset( $row->user_id
) ) {
1085 $this->mId
= intval( $row->user_id
);
1086 $this->mFrom
= 'id';
1087 $this->setItemLoaded( 'id' );
1092 if ( isset( $row->user_editcount
) ) {
1093 $this->mEditCount
= $row->user_editcount
;
1098 if ( isset( $row->user_password
) ) {
1099 $this->mPassword
= $row->user_password
;
1100 $this->mNewpassword
= $row->user_newpassword
;
1101 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1102 $this->mEmail
= $row->user_email
;
1103 if ( isset( $row->user_options
) ) {
1104 $this->decodeOptions( $row->user_options
);
1106 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1107 $this->mToken
= $row->user_token
;
1108 if ( $this->mToken
== '' ) {
1109 $this->mToken
= null;
1111 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1112 $this->mEmailToken
= $row->user_email_token
;
1113 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1114 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1120 $this->mLoadedItems
= true;
1125 * Load the data for this user object from another user object.
1129 protected function loadFromUserObject( $user ) {
1131 $user->loadGroups();
1132 $user->loadOptions();
1133 foreach ( self
::$mCacheVars as $var ) {
1134 $this->$var = $user->$var;
1139 * Load the groups from the database if they aren't already loaded.
1141 private function loadGroups() {
1142 if ( is_null( $this->mGroups
) ) {
1143 $dbr = wfGetDB( DB_MASTER
);
1144 $res = $dbr->select( 'user_groups',
1145 array( 'ug_group' ),
1146 array( 'ug_user' => $this->mId
),
1148 $this->mGroups
= array();
1149 foreach ( $res as $row ) {
1150 $this->mGroups
[] = $row->ug_group
;
1156 * Add the user to the group if he/she meets given criteria.
1158 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1159 * possible to remove manually via Special:UserRights. In such case it
1160 * will not be re-added automatically. The user will also not lose the
1161 * group if they no longer meet the criteria.
1163 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1165 * @return array Array of groups the user has been promoted to.
1167 * @see $wgAutopromoteOnce
1169 public function addAutopromoteOnceGroups( $event ) {
1170 global $wgAutopromoteOnceLogInRC;
1172 $toPromote = array();
1173 if ( $this->getId() ) {
1174 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1175 if ( count( $toPromote ) ) {
1176 $oldGroups = $this->getGroups(); // previous groups
1177 foreach ( $toPromote as $group ) {
1178 $this->addGroup( $group );
1180 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1182 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1183 $log->addEntry( 'autopromote',
1184 $this->getUserPage(),
1186 // These group names are "list to texted"-ed in class LogPage.
1187 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1195 * Clear various cached data stored in this object.
1196 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1197 * given source. May be "name", "id", "defaults", "session", or false for
1200 public function clearInstanceCache( $reloadFrom = false ) {
1201 $this->mNewtalk
= -1;
1202 $this->mDatePreference
= null;
1203 $this->mBlockedby
= -1; # Unset
1204 $this->mHash
= false;
1205 $this->mRights
= null;
1206 $this->mEffectiveGroups
= null;
1207 $this->mImplicitGroups
= null;
1208 $this->mOptions
= null;
1210 if ( $reloadFrom ) {
1211 $this->mLoadedItems
= array();
1212 $this->mFrom
= $reloadFrom;
1217 * Combine the language default options with any site-specific options
1218 * and add the default language variants.
1220 * @return Array of String options
1222 public static function getDefaultOptions() {
1223 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1225 $defOpt = $wgDefaultUserOptions;
1226 # default language setting
1227 $variant = $wgContLang->getDefaultVariant();
1228 $defOpt['variant'] = $variant;
1229 $defOpt['language'] = $variant;
1230 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1231 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1233 $defOpt['skin'] = $wgDefaultSkin;
1235 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1236 // but that breaks the parser tests because they rely on being able to change $wgContLang
1237 // mid-request and see that change reflected in the return value of this function.
1238 // Which is insane and would never happen during normal MW operation, but is also not
1239 // likely to get fixed unless and until we context-ify everything.
1240 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1241 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1247 * Get a given default option value.
1249 * @param $opt String Name of option to retrieve
1250 * @return String Default option value
1252 public static function getDefaultOption( $opt ) {
1253 $defOpts = self
::getDefaultOptions();
1254 if( isset( $defOpts[$opt] ) ) {
1255 return $defOpts[$opt];
1263 * Get blocking information
1264 * @param $bFromSlave Bool Whether to check the slave database first. To
1265 * improve performance, non-critical checks are done
1266 * against slaves. Check when actually saving should be
1267 * done against master.
1269 private function getBlockedStatus( $bFromSlave = true ) {
1270 global $wgProxyWhitelist, $wgUser;
1272 if ( -1 != $this->mBlockedby
) {
1276 wfProfileIn( __METHOD__
);
1277 wfDebug( __METHOD__
.": checking...\n" );
1279 // Initialize data...
1280 // Otherwise something ends up stomping on $this->mBlockedby when
1281 // things get lazy-loaded later, causing false positive block hits
1282 // due to -1 !== 0. Probably session-related... Nothing should be
1283 // overwriting mBlockedby, surely?
1286 # We only need to worry about passing the IP address to the Block generator if the
1287 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1288 # know which IP address they're actually coming from
1289 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1290 $ip = $this->getRequest()->getIP();
1296 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1299 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1300 && !in_array( $ip, $wgProxyWhitelist ) )
1303 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1305 $block->setBlocker( wfMsg( 'proxyblocker' ) );
1306 $block->mReason
= wfMsg( 'proxyblockreason' );
1307 $block->setTarget( $ip );
1308 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1310 $block->setBlocker( wfMsg( 'sorbs' ) );
1311 $block->mReason
= wfMsg( 'sorbsreason' );
1312 $block->setTarget( $ip );
1316 if ( $block instanceof Block
) {
1317 wfDebug( __METHOD__
. ": Found block.\n" );
1318 $this->mBlock
= $block;
1319 $this->mBlockedby
= $block->getByName();
1320 $this->mBlockreason
= $block->mReason
;
1321 $this->mHideName
= $block->mHideName
;
1322 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1324 $this->mBlockedby
= '';
1325 $this->mHideName
= 0;
1326 $this->mAllowUsertalk
= false;
1330 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1332 wfProfileOut( __METHOD__
);
1336 * Whether the given IP is in a DNS blacklist.
1338 * @param $ip String IP to check
1339 * @param $checkWhitelist Bool: whether to check the whitelist first
1340 * @return Bool True if blacklisted.
1342 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1343 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1344 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1346 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1349 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1352 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1353 return $this->inDnsBlacklist( $ip, $urls );
1357 * Whether the given IP is in a given DNS blacklist.
1359 * @param $ip String IP to check
1360 * @param $bases String|Array of Strings: URL of the DNS blacklist
1361 * @return Bool True if blacklisted.
1363 public function inDnsBlacklist( $ip, $bases ) {
1364 wfProfileIn( __METHOD__
);
1367 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1368 if( IP
::isIPv4( $ip ) ) {
1369 # Reverse IP, bug 21255
1370 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1372 foreach( (array)$bases as $base ) {
1374 # If we have an access key, use that too (ProjectHoneypot, etc.)
1375 if( is_array( $base ) ) {
1376 if( count( $base ) >= 2 ) {
1377 # Access key is 1, base URL is 0
1378 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1380 $host = "$ipReversed.{$base[0]}";
1383 $host = "$ipReversed.$base";
1387 $ipList = gethostbynamel( $host );
1390 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1394 wfDebug( "Requested $host, not found in $base.\n" );
1399 wfProfileOut( __METHOD__
);
1404 * Check if an IP address is in the local proxy list
1410 public static function isLocallyBlockedProxy( $ip ) {
1411 global $wgProxyList;
1413 if ( !$wgProxyList ) {
1416 wfProfileIn( __METHOD__
);
1418 if ( !is_array( $wgProxyList ) ) {
1419 # Load from the specified file
1420 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1423 if ( !is_array( $wgProxyList ) ) {
1425 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1427 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1428 # Old-style flipped proxy list
1433 wfProfileOut( __METHOD__
);
1438 * Is this user subject to rate limiting?
1440 * @return Bool True if rate limited
1442 public function isPingLimitable() {
1443 global $wgRateLimitsExcludedIPs;
1444 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1445 // No other good way currently to disable rate limits
1446 // for specific IPs. :P
1447 // But this is a crappy hack and should die.
1450 return !$this->isAllowed('noratelimit');
1454 * Primitive rate limits: enforce maximum actions per time period
1455 * to put a brake on flooding.
1457 * @note When using a shared cache like memcached, IP-address
1458 * last-hit counters will be shared across wikis.
1460 * @param $action String Action to enforce; 'edit' if unspecified
1461 * @return Bool True if a rate limiter was tripped
1463 public function pingLimiter( $action = 'edit' ) {
1464 # Call the 'PingLimiter' hook
1466 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1470 global $wgRateLimits;
1471 if( !isset( $wgRateLimits[$action] ) ) {
1475 # Some groups shouldn't trigger the ping limiter, ever
1476 if( !$this->isPingLimitable() )
1479 global $wgMemc, $wgRateLimitLog;
1480 wfProfileIn( __METHOD__
);
1482 $limits = $wgRateLimits[$action];
1484 $id = $this->getId();
1485 $ip = $this->getRequest()->getIP();
1488 if( isset( $limits['anon'] ) && $id == 0 ) {
1489 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1492 if( isset( $limits['user'] ) && $id != 0 ) {
1493 $userLimit = $limits['user'];
1495 if( $this->isNewbie() ) {
1496 if( isset( $limits['newbie'] ) && $id != 0 ) {
1497 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1499 if( isset( $limits['ip'] ) ) {
1500 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1503 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1504 $subnet = $matches[1];
1505 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1508 // Check for group-specific permissions
1509 // If more than one group applies, use the group with the highest limit
1510 foreach ( $this->getGroups() as $group ) {
1511 if ( isset( $limits[$group] ) ) {
1512 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1513 $userLimit = $limits[$group];
1517 // Set the user limit key
1518 if ( $userLimit !== false ) {
1519 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1520 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1524 foreach( $keys as $key => $limit ) {
1525 list( $max, $period ) = $limit;
1526 $summary = "(limit $max in {$period}s)";
1527 $count = $wgMemc->get( $key );
1530 if( $count >= $max ) {
1531 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1532 if( $wgRateLimitLog ) {
1533 wfSuppressWarnings();
1534 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1535 wfRestoreWarnings();
1539 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1542 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1543 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1545 $wgMemc->incr( $key );
1548 wfProfileOut( __METHOD__
);
1553 * Check if user is blocked
1555 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1556 * @return Bool True if blocked, false otherwise
1558 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1559 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1563 * Get the block affecting the user, or null if the user is not blocked
1565 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1566 * @return Block|null
1568 public function getBlock( $bFromSlave = true ){
1569 $this->getBlockedStatus( $bFromSlave );
1570 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1574 * Check if user is blocked from editing a particular article
1576 * @param $title Title to check
1577 * @param $bFromSlave Bool whether to check the slave database instead of the master
1580 function isBlockedFrom( $title, $bFromSlave = false ) {
1581 global $wgBlockAllowsUTEdit;
1582 wfProfileIn( __METHOD__
);
1584 $blocked = $this->isBlocked( $bFromSlave );
1585 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1586 # If a user's name is suppressed, they cannot make edits anywhere
1587 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1588 $title->getNamespace() == NS_USER_TALK
) {
1590 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1593 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1595 wfProfileOut( __METHOD__
);
1600 * If user is blocked, return the name of the user who placed the block
1601 * @return String name of blocker
1603 public function blockedBy() {
1604 $this->getBlockedStatus();
1605 return $this->mBlockedby
;
1609 * If user is blocked, return the specified reason for the block
1610 * @return String Blocking reason
1612 public function blockedFor() {
1613 $this->getBlockedStatus();
1614 return $this->mBlockreason
;
1618 * If user is blocked, return the ID for the block
1619 * @return Int Block ID
1621 public function getBlockId() {
1622 $this->getBlockedStatus();
1623 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1627 * Check if user is blocked on all wikis.
1628 * Do not use for actual edit permission checks!
1629 * This is intented for quick UI checks.
1631 * @param $ip String IP address, uses current client if none given
1632 * @return Bool True if blocked, false otherwise
1634 public function isBlockedGlobally( $ip = '' ) {
1635 if( $this->mBlockedGlobally
!== null ) {
1636 return $this->mBlockedGlobally
;
1638 // User is already an IP?
1639 if( IP
::isIPAddress( $this->getName() ) ) {
1640 $ip = $this->getName();
1642 $ip = $this->getRequest()->getIP();
1645 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1646 $this->mBlockedGlobally
= (bool)$blocked;
1647 return $this->mBlockedGlobally
;
1651 * Check if user account is locked
1653 * @return Bool True if locked, false otherwise
1655 public function isLocked() {
1656 if( $this->mLocked
!== null ) {
1657 return $this->mLocked
;
1660 $authUser = $wgAuth->getUserInstance( $this );
1661 $this->mLocked
= (bool)$authUser->isLocked();
1662 return $this->mLocked
;
1666 * Check if user account is hidden
1668 * @return Bool True if hidden, false otherwise
1670 public function isHidden() {
1671 if( $this->mHideName
!== null ) {
1672 return $this->mHideName
;
1674 $this->getBlockedStatus();
1675 if( !$this->mHideName
) {
1677 $authUser = $wgAuth->getUserInstance( $this );
1678 $this->mHideName
= (bool)$authUser->isHidden();
1680 return $this->mHideName
;
1684 * Get the user's ID.
1685 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1687 public function getId() {
1688 if( $this->mId
=== null && $this->mName
!== null
1689 && User
::isIP( $this->mName
) ) {
1690 // Special case, we know the user is anonymous
1692 } elseif( !$this->isItemLoaded( 'id' ) ) {
1693 // Don't load if this was initialized from an ID
1700 * Set the user and reload all fields according to a given ID
1701 * @param $v Int User ID to reload
1703 public function setId( $v ) {
1705 $this->clearInstanceCache( 'id' );
1709 * Get the user name, or the IP of an anonymous user
1710 * @return String User's name or IP address
1712 public function getName() {
1713 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1714 # Special case optimisation
1715 return $this->mName
;
1718 if ( $this->mName
=== false ) {
1720 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1722 return $this->mName
;
1727 * Set the user name.
1729 * This does not reload fields from the database according to the given
1730 * name. Rather, it is used to create a temporary "nonexistent user" for
1731 * later addition to the database. It can also be used to set the IP
1732 * address for an anonymous user to something other than the current
1735 * @note User::newFromName() has rougly the same function, when the named user
1737 * @param $str String New user name to set
1739 public function setName( $str ) {
1741 $this->mName
= $str;
1745 * Get the user's name escaped by underscores.
1746 * @return String Username escaped by underscores.
1748 public function getTitleKey() {
1749 return str_replace( ' ', '_', $this->getName() );
1753 * Check if the user has new messages.
1754 * @return Bool True if the user has new messages
1756 public function getNewtalk() {
1759 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1760 if( $this->mNewtalk
=== -1 ) {
1761 $this->mNewtalk
= false; # reset talk page status
1763 # Check memcached separately for anons, who have no
1764 # entire User object stored in there.
1767 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1768 $newtalk = $wgMemc->get( $key );
1769 if( strval( $newtalk ) !== '' ) {
1770 $this->mNewtalk
= (bool)$newtalk;
1772 // Since we are caching this, make sure it is up to date by getting it
1774 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1775 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1778 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1782 return (bool)$this->mNewtalk
;
1786 * Return the talk page(s) this user has new messages on.
1787 * @return Array of String page URLs
1789 public function getNewMessageLinks() {
1791 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1794 if( !$this->getNewtalk() )
1796 $up = $this->getUserPage();
1797 $utp = $up->getTalkPage();
1798 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1802 * Internal uncached check for new messages
1805 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1806 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1807 * @param $fromMaster Bool true to fetch from the master, false for a slave
1808 * @return Bool True if the user has new messages
1810 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1811 if ( $fromMaster ) {
1812 $db = wfGetDB( DB_MASTER
);
1814 $db = wfGetDB( DB_SLAVE
);
1816 $ok = $db->selectField( 'user_newtalk', $field,
1817 array( $field => $id ), __METHOD__
);
1818 return $ok !== false;
1822 * Add or update the new messages flag
1823 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1824 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1825 * @return Bool True if successful, false otherwise
1827 protected function updateNewtalk( $field, $id ) {
1828 $dbw = wfGetDB( DB_MASTER
);
1829 $dbw->insert( 'user_newtalk',
1830 array( $field => $id ),
1833 if ( $dbw->affectedRows() ) {
1834 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1837 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1843 * Clear the new messages flag for the given user
1844 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1845 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1846 * @return Bool True if successful, false otherwise
1848 protected function deleteNewtalk( $field, $id ) {
1849 $dbw = wfGetDB( DB_MASTER
);
1850 $dbw->delete( 'user_newtalk',
1851 array( $field => $id ),
1853 if ( $dbw->affectedRows() ) {
1854 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1857 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1863 * Update the 'You have new messages!' status.
1864 * @param $val Bool Whether the user has new messages
1866 public function setNewtalk( $val ) {
1867 if( wfReadOnly() ) {
1872 $this->mNewtalk
= $val;
1874 if( $this->isAnon() ) {
1876 $id = $this->getName();
1879 $id = $this->getId();
1884 $changed = $this->updateNewtalk( $field, $id );
1886 $changed = $this->deleteNewtalk( $field, $id );
1889 if( $this->isAnon() ) {
1890 // Anons have a separate memcached space, since
1891 // user records aren't kept for them.
1892 $key = wfMemcKey( 'newtalk', 'ip', $id );
1893 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1896 $this->invalidateCache();
1901 * Generate a current or new-future timestamp to be stored in the
1902 * user_touched field when we update things.
1903 * @return String Timestamp in TS_MW format
1905 private static function newTouchedTimestamp() {
1906 global $wgClockSkewFudge;
1907 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1911 * Clear user data from memcached.
1912 * Use after applying fun updates to the database; caller's
1913 * responsibility to update user_touched if appropriate.
1915 * Called implicitly from invalidateCache() and saveSettings().
1917 private function clearSharedCache() {
1921 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1926 * Immediately touch the user data cache for this account.
1927 * Updates user_touched field, and removes account data from memcached
1928 * for reload on the next hit.
1930 public function invalidateCache() {
1931 if( wfReadOnly() ) {
1936 $this->mTouched
= self
::newTouchedTimestamp();
1938 $dbw = wfGetDB( DB_MASTER
);
1940 // Prevent contention slams by checking user_touched first
1941 $now = $dbw->timestamp( $this->mTouched
);
1942 $needsPurge = $dbw->selectField( 'user', '1',
1943 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1945 if ( $needsPurge ) {
1946 $dbw->update( 'user',
1947 array( 'user_touched' => $now ),
1948 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1953 $this->clearSharedCache();
1958 * Validate the cache for this account.
1959 * @param $timestamp String A timestamp in TS_MW format
1963 public function validateCache( $timestamp ) {
1965 return ( $timestamp >= $this->mTouched
);
1969 * Get the user touched timestamp
1970 * @return String timestamp
1972 public function getTouched() {
1974 return $this->mTouched
;
1978 * Set the password and reset the random token.
1979 * Calls through to authentication plugin if necessary;
1980 * will have no effect if the auth plugin refuses to
1981 * pass the change through or if the legal password
1984 * As a special case, setting the password to null
1985 * wipes it, so the account cannot be logged in until
1986 * a new password is set, for instance via e-mail.
1988 * @param $str String New password to set
1989 * @throws PasswordError on failure
1993 public function setPassword( $str ) {
1996 if( $str !== null ) {
1997 if( !$wgAuth->allowPasswordChange() ) {
1998 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
2001 if( !$this->isValidPassword( $str ) ) {
2002 global $wgMinimalPasswordLength;
2003 $valid = $this->getPasswordValidity( $str );
2004 if ( is_array( $valid ) ) {
2005 $message = array_shift( $valid );
2009 $params = array( $wgMinimalPasswordLength );
2011 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
2015 if( !$wgAuth->setPassword( $this, $str ) ) {
2016 throw new PasswordError( wfMsg( 'externaldberror' ) );
2019 $this->setInternalPassword( $str );
2025 * Set the password and reset the random token unconditionally.
2027 * @param $str String New password to set
2029 public function setInternalPassword( $str ) {
2033 if( $str === null ) {
2034 // Save an invalid hash...
2035 $this->mPassword
= '';
2037 $this->mPassword
= self
::crypt( $str );
2039 $this->mNewpassword
= '';
2040 $this->mNewpassTime
= null;
2044 * Get the user's current token.
2045 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2046 * @return String Token
2048 public function getToken( $forceCreation = true ) {
2050 if ( !$this->mToken
&& $forceCreation ) {
2053 return $this->mToken
;
2057 * Set the random token (used for persistent authentication)
2058 * Called from loadDefaults() among other places.
2060 * @param $token String|bool If specified, set the token to this value
2062 public function setToken( $token = false ) {
2065 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2067 $this->mToken
= $token;
2072 * Set the password for a password reminder or new account email
2074 * @param $str String New password to set
2075 * @param $throttle Bool If true, reset the throttle timestamp to the present
2077 public function setNewpassword( $str, $throttle = true ) {
2079 $this->mNewpassword
= self
::crypt( $str );
2081 $this->mNewpassTime
= wfTimestampNow();
2086 * Has password reminder email been sent within the last
2087 * $wgPasswordReminderResendTime hours?
2090 public function isPasswordReminderThrottled() {
2091 global $wgPasswordReminderResendTime;
2093 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2096 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2097 return time() < $expiry;
2101 * Get the user's e-mail address
2102 * @return String User's email address
2104 public function getEmail() {
2106 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2107 return $this->mEmail
;
2111 * Get the timestamp of the user's e-mail authentication
2112 * @return String TS_MW timestamp
2114 public function getEmailAuthenticationTimestamp() {
2116 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2117 return $this->mEmailAuthenticated
;
2121 * Set the user's e-mail address
2122 * @param $str String New e-mail address
2124 public function setEmail( $str ) {
2126 if( $str == $this->mEmail
) {
2129 $this->mEmail
= $str;
2130 $this->invalidateEmail();
2131 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2135 * Set the user's e-mail address and a confirmation mail if needed.
2138 * @param $str String New e-mail address
2141 public function setEmailWithConfirmation( $str ) {
2142 global $wgEnableEmail, $wgEmailAuthentication;
2144 if ( !$wgEnableEmail ) {
2145 return Status
::newFatal( 'emaildisabled' );
2148 $oldaddr = $this->getEmail();
2149 if ( $str === $oldaddr ) {
2150 return Status
::newGood( true );
2153 $this->setEmail( $str );
2155 if ( $str !== '' && $wgEmailAuthentication ) {
2156 # Send a confirmation request to the new address if needed
2157 $type = $oldaddr != '' ?
'changed' : 'set';
2158 $result = $this->sendConfirmationMail( $type );
2159 if ( $result->isGood() ) {
2160 # Say the the caller that a confirmation mail has been sent
2161 $result->value
= 'eauth';
2164 $result = Status
::newGood( true );
2171 * Get the user's real name
2172 * @return String User's real name
2174 public function getRealName() {
2175 if ( !$this->isItemLoaded( 'realname' ) ) {
2179 return $this->mRealName
;
2183 * Set the user's real name
2184 * @param $str String New real name
2186 public function setRealName( $str ) {
2188 $this->mRealName
= $str;
2192 * Get the user's current setting for a given option.
2194 * @param $oname String The option to check
2195 * @param $defaultOverride String A default value returned if the option does not exist
2196 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2197 * @return String User's current value for the option
2198 * @see getBoolOption()
2199 * @see getIntOption()
2201 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2202 global $wgHiddenPrefs;
2203 $this->loadOptions();
2205 if ( is_null( $this->mOptions
) ) {
2206 if($defaultOverride != '') {
2207 return $defaultOverride;
2209 $this->mOptions
= User
::getDefaultOptions();
2212 # We want 'disabled' preferences to always behave as the default value for
2213 # users, even if they have set the option explicitly in their settings (ie they
2214 # set it, and then it was disabled removing their ability to change it). But
2215 # we don't want to erase the preferences in the database in case the preference
2216 # is re-enabled again. So don't touch $mOptions, just override the returned value
2217 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2218 return self
::getDefaultOption( $oname );
2221 if ( array_key_exists( $oname, $this->mOptions
) ) {
2222 return $this->mOptions
[$oname];
2224 return $defaultOverride;
2229 * Get all user's options
2233 public function getOptions() {
2234 global $wgHiddenPrefs;
2235 $this->loadOptions();
2236 $options = $this->mOptions
;
2238 # We want 'disabled' preferences to always behave as the default value for
2239 # users, even if they have set the option explicitly in their settings (ie they
2240 # set it, and then it was disabled removing their ability to change it). But
2241 # we don't want to erase the preferences in the database in case the preference
2242 # is re-enabled again. So don't touch $mOptions, just override the returned value
2243 foreach( $wgHiddenPrefs as $pref ){
2244 $default = self
::getDefaultOption( $pref );
2245 if( $default !== null ){
2246 $options[$pref] = $default;
2254 * Get the user's current setting for a given option, as a boolean value.
2256 * @param $oname String The option to check
2257 * @return Bool User's current value for the option
2260 public function getBoolOption( $oname ) {
2261 return (bool)$this->getOption( $oname );
2265 * Get the user's current setting for a given option, as a boolean value.
2267 * @param $oname String The option to check
2268 * @param $defaultOverride Int A default value returned if the option does not exist
2269 * @return Int User's current value for the option
2272 public function getIntOption( $oname, $defaultOverride=0 ) {
2273 $val = $this->getOption( $oname );
2275 $val = $defaultOverride;
2277 return intval( $val );
2281 * Set the given option for a user.
2283 * @param $oname String The option to set
2284 * @param $val mixed New value to set
2286 public function setOption( $oname, $val ) {
2288 $this->loadOptions();
2290 // Explicitly NULL values should refer to defaults
2291 global $wgDefaultUserOptions;
2292 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2293 $val = $wgDefaultUserOptions[$oname];
2296 $this->mOptions
[$oname] = $val;
2300 * Reset all options to the site defaults
2302 public function resetOptions() {
2305 $this->mOptions
= self
::getDefaultOptions();
2306 $this->mOptionsLoaded
= true;
2310 * Get the user's preferred date format.
2311 * @return String User's preferred date format
2313 public function getDatePreference() {
2314 // Important migration for old data rows
2315 if ( is_null( $this->mDatePreference
) ) {
2317 $value = $this->getOption( 'date' );
2318 $map = $wgLang->getDatePreferenceMigrationMap();
2319 if ( isset( $map[$value] ) ) {
2320 $value = $map[$value];
2322 $this->mDatePreference
= $value;
2324 return $this->mDatePreference
;
2328 * Get the user preferred stub threshold
2332 public function getStubThreshold() {
2333 global $wgMaxArticleSize; # Maximum article size, in Kb
2334 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2335 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2336 # If they have set an impossible value, disable the preference
2337 # so we can use the parser cache again.
2344 * Get the permissions this user has.
2345 * @return Array of String permission names
2347 public function getRights() {
2348 if ( is_null( $this->mRights
) ) {
2349 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2350 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2351 // Force reindexation of rights when a hook has unset one of them
2352 $this->mRights
= array_values( $this->mRights
);
2354 return $this->mRights
;
2358 * Get the list of explicit group memberships this user has.
2359 * The implicit * and user groups are not included.
2360 * @return Array of String internal group names
2362 public function getGroups() {
2364 $this->loadGroups();
2365 return $this->mGroups
;
2369 * Get the list of implicit group memberships this user has.
2370 * This includes all explicit groups, plus 'user' if logged in,
2371 * '*' for all accounts, and autopromoted groups
2372 * @param $recache Bool Whether to avoid the cache
2373 * @return Array of String internal group names
2375 public function getEffectiveGroups( $recache = false ) {
2376 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2377 wfProfileIn( __METHOD__
);
2378 $this->mEffectiveGroups
= array_unique( array_merge(
2379 $this->getGroups(), // explicit groups
2380 $this->getAutomaticGroups( $recache ) // implicit groups
2382 # Hook for additional groups
2383 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2384 wfProfileOut( __METHOD__
);
2386 return $this->mEffectiveGroups
;
2390 * Get the list of implicit group memberships this user has.
2391 * This includes 'user' if logged in, '*' for all accounts,
2392 * and autopromoted groups
2393 * @param $recache Bool Whether to avoid the cache
2394 * @return Array of String internal group names
2396 public function getAutomaticGroups( $recache = false ) {
2397 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2398 wfProfileIn( __METHOD__
);
2399 $this->mImplicitGroups
= array( '*' );
2400 if ( $this->getId() ) {
2401 $this->mImplicitGroups
[] = 'user';
2403 $this->mImplicitGroups
= array_unique( array_merge(
2404 $this->mImplicitGroups
,
2405 Autopromote
::getAutopromoteGroups( $this )
2409 # Assure data consistency with rights/groups,
2410 # as getEffectiveGroups() depends on this function
2411 $this->mEffectiveGroups
= null;
2413 wfProfileOut( __METHOD__
);
2415 return $this->mImplicitGroups
;
2419 * Returns the groups the user has belonged to.
2421 * The user may still belong to the returned groups. Compare with getGroups().
2423 * The function will not return groups the user had belonged to before MW 1.17
2425 * @return array Names of the groups the user has belonged to.
2427 public function getFormerGroups() {
2428 if( is_null( $this->mFormerGroups
) ) {
2429 $dbr = wfGetDB( DB_MASTER
);
2430 $res = $dbr->select( 'user_former_groups',
2431 array( 'ufg_group' ),
2432 array( 'ufg_user' => $this->mId
),
2434 $this->mFormerGroups
= array();
2435 foreach( $res as $row ) {
2436 $this->mFormerGroups
[] = $row->ufg_group
;
2439 return $this->mFormerGroups
;
2443 * Get the user's edit count.
2446 public function getEditCount() {
2447 if( $this->getId() ) {
2448 if ( !isset( $this->mEditCount
) ) {
2449 /* Populate the count, if it has not been populated yet */
2450 $this->mEditCount
= User
::edits( $this->mId
);
2452 return $this->mEditCount
;
2460 * Add the user to the given group.
2461 * This takes immediate effect.
2462 * @param $group String Name of the group to add
2464 public function addGroup( $group ) {
2465 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2466 $dbw = wfGetDB( DB_MASTER
);
2467 if( $this->getId() ) {
2468 $dbw->insert( 'user_groups',
2470 'ug_user' => $this->getID(),
2471 'ug_group' => $group,
2474 array( 'IGNORE' ) );
2477 $this->loadGroups();
2478 $this->mGroups
[] = $group;
2479 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2481 $this->invalidateCache();
2485 * Remove the user from the given group.
2486 * This takes immediate effect.
2487 * @param $group String Name of the group to remove
2489 public function removeGroup( $group ) {
2491 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2492 $dbw = wfGetDB( DB_MASTER
);
2493 $dbw->delete( 'user_groups',
2495 'ug_user' => $this->getID(),
2496 'ug_group' => $group,
2498 // Remember that the user was in this group
2499 $dbw->insert( 'user_former_groups',
2501 'ufg_user' => $this->getID(),
2502 'ufg_group' => $group,
2505 array( 'IGNORE' ) );
2507 $this->loadGroups();
2508 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2509 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2511 $this->invalidateCache();
2515 * Get whether the user is logged in
2518 public function isLoggedIn() {
2519 return $this->getID() != 0;
2523 * Get whether the user is anonymous
2526 public function isAnon() {
2527 return !$this->isLoggedIn();
2531 * Check if user is allowed to access a feature / make an action
2533 * @internal param \String $varargs permissions to test
2534 * @return Boolean: True if user is allowed to perform *any* of the given actions
2538 public function isAllowedAny( /*...*/ ){
2539 $permissions = func_get_args();
2540 foreach( $permissions as $permission ){
2541 if( $this->isAllowed( $permission ) ){
2550 * @internal param $varargs string
2551 * @return bool True if the user is allowed to perform *all* of the given actions
2553 public function isAllowedAll( /*...*/ ){
2554 $permissions = func_get_args();
2555 foreach( $permissions as $permission ){
2556 if( !$this->isAllowed( $permission ) ){
2564 * Internal mechanics of testing a permission
2565 * @param $action String
2568 public function isAllowed( $action = '' ) {
2569 if ( $action === '' ) {
2570 return true; // In the spirit of DWIM
2572 # Patrolling may not be enabled
2573 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2574 global $wgUseRCPatrol, $wgUseNPPatrol;
2575 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2578 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2579 # by misconfiguration: 0 == 'foo'
2580 return in_array( $action, $this->getRights(), true );
2584 * Check whether to enable recent changes patrol features for this user
2585 * @return Boolean: True or false
2587 public function useRCPatrol() {
2588 global $wgUseRCPatrol;
2589 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2593 * Check whether to enable new pages patrol features for this user
2594 * @return Bool True or false
2596 public function useNPPatrol() {
2597 global $wgUseRCPatrol, $wgUseNPPatrol;
2598 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2602 * Get the WebRequest object to use with this object
2604 * @return WebRequest
2606 public function getRequest() {
2607 if ( $this->mRequest
) {
2608 return $this->mRequest
;
2616 * Get the current skin, loading it if required
2617 * @return Skin The current skin
2618 * @todo FIXME: Need to check the old failback system [AV]
2619 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2621 public function getSkin() {
2622 wfDeprecated( __METHOD__
, '1.18' );
2623 return RequestContext
::getMain()->getSkin();
2627 * Get a WatchedItem for this user and $title.
2629 * @param $title Title
2630 * @return WatchedItem
2632 public function getWatchedItem( $title ) {
2633 $key = $title->getNamespace() . ':' . $title->getDBkey();
2635 if ( isset( $this->mWatchedItems
[$key] ) ) {
2636 return $this->mWatchedItems
[$key];
2639 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2640 $this->mWatchedItems
= array();
2643 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2644 return $this->mWatchedItems
[$key];
2648 * Check the watched status of an article.
2649 * @param $title Title of the article to look at
2652 public function isWatched( $title ) {
2653 return $this->getWatchedItem( $title )->isWatched();
2658 * @param $title Title of the article to look at
2660 public function addWatch( $title ) {
2661 $this->getWatchedItem( $title )->addWatch();
2662 $this->invalidateCache();
2666 * Stop watching an article.
2667 * @param $title Title of the article to look at
2669 public function removeWatch( $title ) {
2670 $this->getWatchedItem( $title )->removeWatch();
2671 $this->invalidateCache();
2675 * Clear the user's notification timestamp for the given title.
2676 * If e-notif e-mails are on, they will receive notification mails on
2677 * the next change of the page if it's watched etc.
2678 * @param $title Title of the article to look at
2680 public function clearNotification( &$title ) {
2681 global $wgUseEnotif, $wgShowUpdatedMarker;
2683 # Do nothing if the database is locked to writes
2684 if( wfReadOnly() ) {
2688 if( $title->getNamespace() == NS_USER_TALK
&&
2689 $title->getText() == $this->getName() ) {
2690 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2692 $this->setNewtalk( false );
2695 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2699 if( $this->isAnon() ) {
2700 // Nothing else to do...
2704 // Only update the timestamp if the page is being watched.
2705 // The query to find out if it is watched is cached both in memcached and per-invocation,
2706 // and when it does have to be executed, it can be on a slave
2707 // If this is the user's newtalk page, we always update the timestamp
2709 if ( $title->getNamespace() == NS_USER_TALK
&&
2710 $title->getText() == $this->getName() )
2715 $wi = WatchedItem
::fromUserTitle( $this, $title );
2716 $wi->resetNotificationTimestamp( $force );
2720 * Resets all of the given user's page-change notification timestamps.
2721 * If e-notif e-mails are on, they will receive notification mails on
2722 * the next change of any watched page.
2724 public function clearAllNotifications() {
2725 global $wgUseEnotif, $wgShowUpdatedMarker;
2726 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2727 $this->setNewtalk( false );
2730 $id = $this->getId();
2732 $dbw = wfGetDB( DB_MASTER
);
2733 $dbw->update( 'watchlist',
2735 'wl_notificationtimestamp' => null
2736 ), array( /* WHERE */
2740 # We also need to clear here the "you have new message" notification for the own user_talk page
2741 # This is cleared one page view later in Article::viewUpdates();
2746 * Set this user's options from an encoded string
2747 * @param $str String Encoded options to import
2749 * @deprecated in 1.19 due to removal of user_options from the user table
2751 private function decodeOptions( $str ) {
2752 wfDeprecated( __METHOD__
, '1.19' );
2756 $this->mOptionsLoaded
= true;
2757 $this->mOptionOverrides
= array();
2759 // If an option is not set in $str, use the default value
2760 $this->mOptions
= self
::getDefaultOptions();
2762 $a = explode( "\n", $str );
2763 foreach ( $a as $s ) {
2765 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2766 $this->mOptions
[$m[1]] = $m[2];
2767 $this->mOptionOverrides
[$m[1]] = $m[2];
2773 * Set a cookie on the user's client. Wrapper for
2774 * WebResponse::setCookie
2775 * @param $name String Name of the cookie to set
2776 * @param $value String Value to set
2777 * @param $exp Int Expiration time, as a UNIX time value;
2778 * if 0 or not specified, use the default $wgCookieExpiration
2780 protected function setCookie( $name, $value, $exp = 0 ) {
2781 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2785 * Clear a cookie on the user's client
2786 * @param $name String Name of the cookie to clear
2788 protected function clearCookie( $name ) {
2789 $this->setCookie( $name, '', time() - 86400 );
2793 * Set the default cookies for this session on the user's client.
2795 * @param $request WebRequest object to use; $wgRequest will be used if null
2798 public function setCookies( $request = null ) {
2799 if ( $request === null ) {
2800 $request = $this->getRequest();
2804 if ( 0 == $this->mId
) return;
2805 if ( !$this->mToken
) {
2806 // When token is empty or NULL generate a new one and then save it to the database
2807 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2808 // Simply by setting every cell in the user_token column to NULL and letting them be
2809 // regenerated as users log back into the wiki.
2811 $this->saveSettings();
2814 'wsUserID' => $this->mId
,
2815 'wsToken' => $this->mToken
,
2816 'wsUserName' => $this->getName()
2819 'UserID' => $this->mId
,
2820 'UserName' => $this->getName(),
2822 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2823 $cookies['Token'] = $this->mToken
;
2825 $cookies['Token'] = false;
2828 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2830 foreach ( $session as $name => $value ) {
2831 $request->setSessionData( $name, $value );
2833 foreach ( $cookies as $name => $value ) {
2834 if ( $value === false ) {
2835 $this->clearCookie( $name );
2837 $this->setCookie( $name, $value );
2843 * Log this user out.
2845 public function logout() {
2846 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2852 * Clear the user's cookies and session, and reset the instance cache.
2855 public function doLogout() {
2856 $this->clearInstanceCache( 'defaults' );
2858 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2860 $this->clearCookie( 'UserID' );
2861 $this->clearCookie( 'Token' );
2863 # Remember when user logged out, to prevent seeing cached pages
2864 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2868 * Save this user's settings into the database.
2869 * @todo Only rarely do all these fields need to be set!
2871 public function saveSettings() {
2873 if ( wfReadOnly() ) { return; }
2874 if ( 0 == $this->mId
) { return; }
2876 $this->mTouched
= self
::newTouchedTimestamp();
2878 $dbw = wfGetDB( DB_MASTER
);
2879 $dbw->update( 'user',
2881 'user_name' => $this->mName
,
2882 'user_password' => $this->mPassword
,
2883 'user_newpassword' => $this->mNewpassword
,
2884 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2885 'user_real_name' => $this->mRealName
,
2886 'user_email' => $this->mEmail
,
2887 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2888 'user_touched' => $dbw->timestamp( $this->mTouched
),
2889 'user_token' => strval( $this->mToken
),
2890 'user_email_token' => $this->mEmailToken
,
2891 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2892 ), array( /* WHERE */
2893 'user_id' => $this->mId
2897 $this->saveOptions();
2899 wfRunHooks( 'UserSaveSettings', array( $this ) );
2900 $this->clearSharedCache();
2901 $this->getUserPage()->invalidateCache();
2905 * If only this user's username is known, and it exists, return the user ID.
2908 public function idForName() {
2909 $s = trim( $this->getName() );
2910 if ( $s === '' ) return 0;
2912 $dbr = wfGetDB( DB_SLAVE
);
2913 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2914 if ( $id === false ) {
2921 * Add a user to the database, return the user object
2923 * @param $name String Username to add
2924 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2925 * - password The user's password hash. Password logins will be disabled if this is omitted.
2926 * - newpassword Hash for a temporary password that has been mailed to the user
2927 * - email The user's email address
2928 * - email_authenticated The email authentication timestamp
2929 * - real_name The user's real name
2930 * - options An associative array of non-default options
2931 * - token Random authentication token. Do not set.
2932 * - registration Registration timestamp. Do not set.
2934 * @return User object, or null if the username already exists
2936 public static function createNew( $name, $params = array() ) {
2939 if ( isset( $params['options'] ) ) {
2940 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2941 unset( $params['options'] );
2943 $dbw = wfGetDB( DB_MASTER
);
2944 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2947 'user_id' => $seqVal,
2948 'user_name' => $name,
2949 'user_password' => $user->mPassword
,
2950 'user_newpassword' => $user->mNewpassword
,
2951 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2952 'user_email' => $user->mEmail
,
2953 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2954 'user_real_name' => $user->mRealName
,
2955 'user_token' => strval( $user->mToken
),
2956 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2957 'user_editcount' => 0,
2958 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
2960 foreach ( $params as $name => $value ) {
2961 $fields["user_$name"] = $value;
2963 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2964 if ( $dbw->affectedRows() ) {
2965 $newUser = User
::newFromId( $dbw->insertId() );
2973 * Add this existing user object to the database
2975 public function addToDatabase() {
2978 $this->mTouched
= self
::newTouchedTimestamp();
2980 $dbw = wfGetDB( DB_MASTER
);
2981 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2982 $dbw->insert( 'user',
2984 'user_id' => $seqVal,
2985 'user_name' => $this->mName
,
2986 'user_password' => $this->mPassword
,
2987 'user_newpassword' => $this->mNewpassword
,
2988 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2989 'user_email' => $this->mEmail
,
2990 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2991 'user_real_name' => $this->mRealName
,
2992 'user_token' => strval( $this->mToken
),
2993 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2994 'user_editcount' => 0,
2995 'user_touched' => $dbw->timestamp( $this->mTouched
),
2998 $this->mId
= $dbw->insertId();
3000 // Clear instance cache other than user table data, which is already accurate
3001 $this->clearInstanceCache();
3003 $this->saveOptions();
3007 * If this user is logged-in and blocked,
3008 * block any IP address they've successfully logged in from.
3009 * @return bool A block was spread
3011 public function spreadAnyEditBlock() {
3012 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3013 return $this->spreadBlock();
3019 * If this (non-anonymous) user is blocked,
3020 * block the IP address they've successfully logged in from.
3021 * @return bool A block was spread
3023 protected function spreadBlock() {
3024 wfDebug( __METHOD__
. "()\n" );
3026 if ( $this->mId
== 0 ) {
3030 $userblock = Block
::newFromTarget( $this->getName() );
3031 if ( !$userblock ) {
3035 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3039 * Generate a string which will be different for any combination of
3040 * user options which would produce different parser output.
3041 * This will be used as part of the hash key for the parser cache,
3042 * so users with the same options can share the same cached data
3045 * Extensions which require it should install 'PageRenderingHash' hook,
3046 * which will give them a chance to modify this key based on their own
3049 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3050 * @return String Page rendering hash
3052 public function getPageRenderingHash() {
3053 wfDeprecated( __METHOD__
, '1.17' );
3055 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3057 return $this->mHash
;
3060 // stubthreshold is only included below for completeness,
3061 // since it disables the parser cache, its value will always
3062 // be 0 when this function is called by parsercache.
3064 $confstr = $this->getOption( 'math' );
3065 $confstr .= '!' . $this->getStubThreshold();
3066 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3067 $confstr .= '!' . $this->getDatePreference();
3069 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3070 $confstr .= '!' . $wgLang->getCode();
3071 $confstr .= '!' . $this->getOption( 'thumbsize' );
3072 // add in language specific options, if any
3073 $extra = $wgContLang->getExtraHashOptions();
3076 // Since the skin could be overloading link(), it should be
3077 // included here but in practice, none of our skins do that.
3079 $confstr .= $wgRenderHashAppend;
3081 // Give a chance for extensions to modify the hash, if they have
3082 // extra options or other effects on the parser cache.
3083 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3085 // Make it a valid memcached key fragment
3086 $confstr = str_replace( ' ', '_', $confstr );
3087 $this->mHash
= $confstr;
3092 * Get whether the user is explicitly blocked from account creation.
3093 * @return Bool|Block
3095 public function isBlockedFromCreateAccount() {
3096 $this->getBlockedStatus();
3097 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3098 return $this->mBlock
;
3101 # bug 13611: if the IP address the user is trying to create an account from is
3102 # blocked with createaccount disabled, prevent new account creation there even
3103 # when the user is logged in
3104 if( $this->mBlockedFromCreateAccount
=== false ){
3105 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3107 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3108 ?
$this->mBlockedFromCreateAccount
3113 * Get whether the user is blocked from using Special:Emailuser.
3116 public function isBlockedFromEmailuser() {
3117 $this->getBlockedStatus();
3118 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3122 * Get whether the user is allowed to create an account.
3125 function isAllowedToCreateAccount() {
3126 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3130 * Get this user's personal page title.
3132 * @return Title: User's personal page title
3134 public function getUserPage() {
3135 return Title
::makeTitle( NS_USER
, $this->getName() );
3139 * Get this user's talk page title.
3141 * @return Title: User's talk page title
3143 public function getTalkPage() {
3144 $title = $this->getUserPage();
3145 return $title->getTalkPage();
3149 * Determine whether the user is a newbie. Newbies are either
3150 * anonymous IPs, or the most recently created accounts.
3153 public function isNewbie() {
3154 return !$this->isAllowed( 'autoconfirmed' );
3158 * Check to see if the given clear-text password is one of the accepted passwords
3159 * @param $password String: user password.
3160 * @return Boolean: True if the given password is correct, otherwise False.
3162 public function checkPassword( $password ) {
3163 global $wgAuth, $wgLegacyEncoding;
3166 // Even though we stop people from creating passwords that
3167 // are shorter than this, doesn't mean people wont be able
3168 // to. Certain authentication plugins do NOT want to save
3169 // domain passwords in a mysql database, so we should
3170 // check this (in case $wgAuth->strict() is false).
3171 if( !$this->isValidPassword( $password ) ) {
3175 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3177 } elseif( $wgAuth->strict() ) {
3178 /* Auth plugin doesn't allow local authentication */
3180 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3181 /* Auth plugin doesn't allow local authentication for this user name */
3184 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3186 } elseif ( $wgLegacyEncoding ) {
3187 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3188 # Check for this with iconv
3189 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3190 if ( $cp1252Password != $password &&
3191 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3200 * Check if the given clear-text password matches the temporary password
3201 * sent by e-mail for password reset operations.
3203 * @param $plaintext string
3205 * @return Boolean: True if matches, false otherwise
3207 public function checkTemporaryPassword( $plaintext ) {
3208 global $wgNewPasswordExpiry;
3211 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3212 if ( is_null( $this->mNewpassTime
) ) {
3215 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3216 return ( time() < $expiry );
3223 * Alias for getEditToken.
3224 * @deprecated since 1.19, use getEditToken instead.
3226 * @param $salt String|Array of Strings Optional function-specific data for hashing
3227 * @param $request WebRequest object to use or null to use $wgRequest
3228 * @return String The new edit token
3230 public function editToken( $salt = '', $request = null ) {
3231 wfDeprecated( __METHOD__
, '1.19' );
3232 return $this->getEditToken( $salt, $request );
3236 * Initialize (if necessary) and return a session token value
3237 * which can be used in edit forms to show that the user's
3238 * login credentials aren't being hijacked with a foreign form
3243 * @param $salt String|Array of Strings Optional function-specific data for hashing
3244 * @param $request WebRequest object to use or null to use $wgRequest
3245 * @return String The new edit token
3247 public function getEditToken( $salt = '', $request = null ) {
3248 if ( $request == null ) {
3249 $request = $this->getRequest();
3252 if ( $this->isAnon() ) {
3253 return EDIT_TOKEN_SUFFIX
;
3255 $token = $request->getSessionData( 'wsEditToken' );
3256 if ( $token === null ) {
3257 $token = MWCryptRand
::generateHex( 32 );
3258 $request->setSessionData( 'wsEditToken', $token );
3260 if( is_array( $salt ) ) {
3261 $salt = implode( '|', $salt );
3263 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3268 * Generate a looking random token for various uses.
3270 * @param $salt String Optional salt value
3271 * @return String The new random token
3272 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3274 public static function generateToken( $salt = '' ) {
3275 return MWCryptRand
::generateHex( 32 );
3279 * Check given value against the token value stored in the session.
3280 * A match should confirm that the form was submitted from the
3281 * user's own login session, not a form submission from a third-party
3284 * @param $val String Input value to compare
3285 * @param $salt String Optional function-specific data for hashing
3286 * @param $request WebRequest object to use or null to use $wgRequest
3287 * @return Boolean: Whether the token matches
3289 public function matchEditToken( $val, $salt = '', $request = null ) {
3290 $sessionToken = $this->getEditToken( $salt, $request );
3291 if ( $val != $sessionToken ) {
3292 wfDebug( "User::matchEditToken: broken session data\n" );
3294 return $val == $sessionToken;
3298 * Check given value against the token value stored in the session,
3299 * ignoring the suffix.
3301 * @param $val String Input value to compare
3302 * @param $salt String Optional function-specific data for hashing
3303 * @param $request WebRequest object to use or null to use $wgRequest
3304 * @return Boolean: Whether the token matches
3306 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3307 $sessionToken = $this->getEditToken( $salt, $request );
3308 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3312 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3313 * mail to the user's given address.
3315 * @param $type String: message to send, either "created", "changed" or "set"
3316 * @return Status object
3318 public function sendConfirmationMail( $type = 'created' ) {
3320 $expiration = null; // gets passed-by-ref and defined in next line.
3321 $token = $this->confirmationToken( $expiration );
3322 $url = $this->confirmationTokenUrl( $token );
3323 $invalidateURL = $this->invalidationTokenUrl( $token );
3324 $this->saveSettings();
3326 if ( $type == 'created' ||
$type === false ) {
3327 $message = 'confirmemail_body';
3328 } elseif ( $type === true ) {
3329 $message = 'confirmemail_body_changed';
3331 $message = 'confirmemail_body_' . $type;
3334 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3336 $this->getRequest()->getIP(),
3339 $wgLang->timeanddate( $expiration, false ),
3341 $wgLang->date( $expiration, false ),
3342 $wgLang->time( $expiration, false ) ) );
3346 * Send an e-mail to this user's account. Does not check for
3347 * confirmed status or validity.
3349 * @param $subject String Message subject
3350 * @param $body String Message body
3351 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3352 * @param $replyto String Reply-To address
3355 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3356 if( is_null( $from ) ) {
3357 global $wgPasswordSender, $wgPasswordSenderName;
3358 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3360 $sender = new MailAddress( $from );
3363 $to = new MailAddress( $this );
3364 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3368 * Generate, store, and return a new e-mail confirmation code.
3369 * A hash (unsalted, since it's used as a key) is stored.
3371 * @note Call saveSettings() after calling this function to commit
3372 * this change to the database.
3374 * @param &$expiration \mixed Accepts the expiration time
3375 * @return String New token
3377 private function confirmationToken( &$expiration ) {
3378 global $wgUserEmailConfirmationTokenExpiry;
3380 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3381 $expiration = wfTimestamp( TS_MW
, $expires );
3383 $token = MWCryptRand
::generateHex( 32 );
3384 $hash = md5( $token );
3385 $this->mEmailToken
= $hash;
3386 $this->mEmailTokenExpires
= $expiration;
3391 * Return a URL the user can use to confirm their email address.
3392 * @param $token String Accepts the email confirmation token
3393 * @return String New token URL
3395 private function confirmationTokenUrl( $token ) {
3396 return $this->getTokenUrl( 'ConfirmEmail', $token );
3400 * Return a URL the user can use to invalidate their email address.
3401 * @param $token String Accepts the email confirmation token
3402 * @return String New token URL
3404 private function invalidationTokenUrl( $token ) {
3405 return $this->getTokenUrl( 'InvalidateEmail', $token );
3409 * Internal function to format the e-mail validation/invalidation URLs.
3410 * This uses a quickie hack to use the
3411 * hardcoded English names of the Special: pages, for ASCII safety.
3413 * @note Since these URLs get dropped directly into emails, using the
3414 * short English names avoids insanely long URL-encoded links, which
3415 * also sometimes can get corrupted in some browsers/mailers
3416 * (bug 6957 with Gmail and Internet Explorer).
3418 * @param $page String Special page
3419 * @param $token String Token
3420 * @return String Formatted URL
3422 protected function getTokenUrl( $page, $token ) {
3423 // Hack to bypass localization of 'Special:'
3424 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3425 return $title->getCanonicalUrl();
3429 * Mark the e-mail address confirmed.
3431 * @note Call saveSettings() after calling this function to commit the change.
3435 public function confirmEmail() {
3436 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3437 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3442 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3443 * address if it was already confirmed.
3445 * @note Call saveSettings() after calling this function to commit the change.
3446 * @return bool Returns true
3448 function invalidateEmail() {
3450 $this->mEmailToken
= null;
3451 $this->mEmailTokenExpires
= null;
3452 $this->setEmailAuthenticationTimestamp( null );
3453 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3458 * Set the e-mail authentication timestamp.
3459 * @param $timestamp String TS_MW timestamp
3461 function setEmailAuthenticationTimestamp( $timestamp ) {
3463 $this->mEmailAuthenticated
= $timestamp;
3464 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3468 * Is this user allowed to send e-mails within limits of current
3469 * site configuration?
3472 public function canSendEmail() {
3473 global $wgEnableEmail, $wgEnableUserEmail;
3474 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3477 $canSend = $this->isEmailConfirmed();
3478 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3483 * Is this user allowed to receive e-mails within limits of current
3484 * site configuration?
3487 public function canReceiveEmail() {
3488 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3492 * Is this user's e-mail address valid-looking and confirmed within
3493 * limits of the current site configuration?
3495 * @note If $wgEmailAuthentication is on, this may require the user to have
3496 * confirmed their address by returning a code or using a password
3497 * sent to the address from the wiki.
3501 public function isEmailConfirmed() {
3502 global $wgEmailAuthentication;
3505 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3506 if( $this->isAnon() ) {
3509 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3512 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3522 * Check whether there is an outstanding request for e-mail confirmation.
3525 public function isEmailConfirmationPending() {
3526 global $wgEmailAuthentication;
3527 return $wgEmailAuthentication &&
3528 !$this->isEmailConfirmed() &&
3529 $this->mEmailToken
&&
3530 $this->mEmailTokenExpires
> wfTimestamp();
3534 * Get the timestamp of account creation.
3536 * @return String|Bool Timestamp of account creation, or false for
3537 * non-existent/anonymous user accounts.
3539 public function getRegistration() {
3540 if ( $this->isAnon() ) {
3544 return $this->mRegistration
;
3548 * Get the timestamp of the first edit
3550 * @return String|Bool Timestamp of first edit, or false for
3551 * non-existent/anonymous user accounts.
3553 public function getFirstEditTimestamp() {
3554 if( $this->getId() == 0 ) {
3555 return false; // anons
3557 $dbr = wfGetDB( DB_SLAVE
);
3558 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3559 array( 'rev_user' => $this->getId() ),
3561 array( 'ORDER BY' => 'rev_timestamp ASC' )
3564 return false; // no edits
3566 return wfTimestamp( TS_MW
, $time );
3570 * Get the permissions associated with a given list of groups
3572 * @param $groups Array of Strings List of internal group names
3573 * @return Array of Strings List of permission key names for given groups combined
3575 public static function getGroupPermissions( $groups ) {
3576 global $wgGroupPermissions, $wgRevokePermissions;
3578 // grant every granted permission first
3579 foreach( $groups as $group ) {
3580 if( isset( $wgGroupPermissions[$group] ) ) {
3581 $rights = array_merge( $rights,
3582 // array_filter removes empty items
3583 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3586 // now revoke the revoked permissions
3587 foreach( $groups as $group ) {
3588 if( isset( $wgRevokePermissions[$group] ) ) {
3589 $rights = array_diff( $rights,
3590 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3593 return array_unique( $rights );
3597 * Get all the groups who have a given permission
3599 * @param $role String Role to check
3600 * @return Array of Strings List of internal group names with the given permission
3602 public static function getGroupsWithPermission( $role ) {
3603 global $wgGroupPermissions;
3604 $allowedGroups = array();
3605 foreach ( $wgGroupPermissions as $group => $rights ) {
3606 if ( isset( $rights[$role] ) && $rights[$role] ) {
3607 $allowedGroups[] = $group;
3610 return $allowedGroups;
3614 * Get the localized descriptive name for a group, if it exists
3616 * @param $group String Internal group name
3617 * @return String Localized descriptive group name
3619 public static function getGroupName( $group ) {
3620 $msg = wfMessage( "group-$group" );
3621 return $msg->isBlank() ?
$group : $msg->text();
3625 * Get the localized descriptive name for a member of a group, if it exists
3627 * @param $group String Internal group name
3628 * @param $username String Username for gender (since 1.19)
3629 * @return String Localized name for group member
3631 public static function getGroupMember( $group, $username = '#' ) {
3632 $msg = wfMessage( "group-$group-member", $username );
3633 return $msg->isBlank() ?
$group : $msg->text();
3637 * Return the set of defined explicit groups.
3638 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3639 * are not included, as they are defined automatically, not in the database.
3640 * @return Array of internal group names
3642 public static function getAllGroups() {
3643 global $wgGroupPermissions, $wgRevokePermissions;
3645 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3646 self
::getImplicitGroups()
3651 * Get a list of all available permissions.
3652 * @return Array of permission names
3654 public static function getAllRights() {
3655 if ( self
::$mAllRights === false ) {
3656 global $wgAvailableRights;
3657 if ( count( $wgAvailableRights ) ) {
3658 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3660 self
::$mAllRights = self
::$mCoreRights;
3662 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3664 return self
::$mAllRights;
3668 * Get a list of implicit groups
3669 * @return Array of Strings Array of internal group names
3671 public static function getImplicitGroups() {
3672 global $wgImplicitGroups;
3673 $groups = $wgImplicitGroups;
3674 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3679 * Get the title of a page describing a particular group
3681 * @param $group String Internal group name
3682 * @return Title|Bool Title of the page if it exists, false otherwise
3684 public static function getGroupPage( $group ) {
3685 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3686 if( $msg->exists() ) {
3687 $title = Title
::newFromText( $msg->text() );
3688 if( is_object( $title ) )
3695 * Create a link to the group in HTML, if available;
3696 * else return the group name.
3698 * @param $group String Internal name of the group
3699 * @param $text String The text of the link
3700 * @return String HTML link to the group
3702 public static function makeGroupLinkHTML( $group, $text = '' ) {
3704 $text = self
::getGroupName( $group );
3706 $title = self
::getGroupPage( $group );
3708 return Linker
::link( $title, htmlspecialchars( $text ) );
3715 * Create a link to the group in Wikitext, if available;
3716 * else return the group name.
3718 * @param $group String Internal name of the group
3719 * @param $text String The text of the link
3720 * @return String Wikilink to the group
3722 public static function makeGroupLinkWiki( $group, $text = '' ) {
3724 $text = self
::getGroupName( $group );
3726 $title = self
::getGroupPage( $group );
3728 $page = $title->getPrefixedText();
3729 return "[[$page|$text]]";
3736 * Returns an array of the groups that a particular group can add/remove.
3738 * @param $group String: the group to check for whether it can add/remove
3739 * @return Array array( 'add' => array( addablegroups ),
3740 * 'remove' => array( removablegroups ),
3741 * 'add-self' => array( addablegroups to self),
3742 * 'remove-self' => array( removable groups from self) )
3744 public static function changeableByGroup( $group ) {
3745 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3747 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3748 if( empty( $wgAddGroups[$group] ) ) {
3749 // Don't add anything to $groups
3750 } elseif( $wgAddGroups[$group] === true ) {
3751 // You get everything
3752 $groups['add'] = self
::getAllGroups();
3753 } elseif( is_array( $wgAddGroups[$group] ) ) {
3754 $groups['add'] = $wgAddGroups[$group];
3757 // Same thing for remove
3758 if( empty( $wgRemoveGroups[$group] ) ) {
3759 } elseif( $wgRemoveGroups[$group] === true ) {
3760 $groups['remove'] = self
::getAllGroups();
3761 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3762 $groups['remove'] = $wgRemoveGroups[$group];
3765 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3766 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3767 foreach( $wgGroupsAddToSelf as $key => $value ) {
3768 if( is_int( $key ) ) {
3769 $wgGroupsAddToSelf['user'][] = $value;
3774 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3775 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3776 if( is_int( $key ) ) {
3777 $wgGroupsRemoveFromSelf['user'][] = $value;
3782 // Now figure out what groups the user can add to him/herself
3783 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3784 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3785 // No idea WHY this would be used, but it's there
3786 $groups['add-self'] = User
::getAllGroups();
3787 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3788 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3791 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3792 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3793 $groups['remove-self'] = User
::getAllGroups();
3794 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3795 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3802 * Returns an array of groups that this user can add and remove
3803 * @return Array array( 'add' => array( addablegroups ),
3804 * 'remove' => array( removablegroups ),
3805 * 'add-self' => array( addablegroups to self),
3806 * 'remove-self' => array( removable groups from self) )
3808 public function changeableGroups() {
3809 if( $this->isAllowed( 'userrights' ) ) {
3810 // This group gives the right to modify everything (reverse-
3811 // compatibility with old "userrights lets you change
3813 // Using array_merge to make the groups reindexed
3814 $all = array_merge( User
::getAllGroups() );
3818 'add-self' => array(),
3819 'remove-self' => array()
3823 // Okay, it's not so simple, we will have to go through the arrays
3826 'remove' => array(),
3827 'add-self' => array(),
3828 'remove-self' => array()
3830 $addergroups = $this->getEffectiveGroups();
3832 foreach( $addergroups as $addergroup ) {
3833 $groups = array_merge_recursive(
3834 $groups, $this->changeableByGroup( $addergroup )
3836 $groups['add'] = array_unique( $groups['add'] );
3837 $groups['remove'] = array_unique( $groups['remove'] );
3838 $groups['add-self'] = array_unique( $groups['add-self'] );
3839 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3845 * Increment the user's edit-count field.
3846 * Will have no effect for anonymous users.
3848 public function incEditCount() {
3849 if( !$this->isAnon() ) {
3850 $dbw = wfGetDB( DB_MASTER
);
3851 $dbw->update( 'user',
3852 array( 'user_editcount=user_editcount+1' ),
3853 array( 'user_id' => $this->getId() ),
3856 // Lazy initialization check...
3857 if( $dbw->affectedRows() == 0 ) {
3858 // Pull from a slave to be less cruel to servers
3859 // Accuracy isn't the point anyway here
3860 $dbr = wfGetDB( DB_SLAVE
);
3861 $count = $dbr->selectField( 'revision',
3863 array( 'rev_user' => $this->getId() ),
3866 // Now here's a goddamn hack...
3867 if( $dbr !== $dbw ) {
3868 // If we actually have a slave server, the count is
3869 // at least one behind because the current transaction
3870 // has not been committed and replicated.
3873 // But if DB_SLAVE is selecting the master, then the
3874 // count we just read includes the revision that was
3875 // just added in the working transaction.
3878 $dbw->update( 'user',
3879 array( 'user_editcount' => $count ),
3880 array( 'user_id' => $this->getId() ),
3884 // edit count in user cache too
3885 $this->invalidateCache();
3889 * Get the description of a given right
3891 * @param $right String Right to query
3892 * @return String Localized description of the right
3894 public static function getRightDescription( $right ) {
3895 $key = "right-$right";
3896 $msg = wfMessage( $key );
3897 return $msg->isBlank() ?
$right : $msg->text();
3901 * Make an old-style password hash
3903 * @param $password String Plain-text password
3904 * @param $userId String User ID
3905 * @return String Password hash
3907 public static function oldCrypt( $password, $userId ) {
3908 global $wgPasswordSalt;
3909 if ( $wgPasswordSalt ) {
3910 return md5( $userId . '-' . md5( $password ) );
3912 return md5( $password );
3917 * Make a new-style password hash
3919 * @param $password String Plain-text password
3920 * @param bool|string $salt Optional salt, may be random or the user ID.
3922 * If unspecified or false, will generate one automatically
3923 * @return String Password hash
3925 public static function crypt( $password, $salt = false ) {
3926 global $wgPasswordSalt;
3929 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3933 if( $wgPasswordSalt ) {
3934 if ( $salt === false ) {
3935 $salt = MWCryptRand
::generateHex( 8 );
3937 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3939 return ':A:' . md5( $password );
3944 * Compare a password hash with a plain-text password. Requires the user
3945 * ID if there's a chance that the hash is an old-style hash.
3947 * @param $hash String Password hash
3948 * @param $password String Plain-text password to compare
3949 * @param $userId String|bool User ID for old-style password salt
3953 public static function comparePasswords( $hash, $password, $userId = false ) {
3954 $type = substr( $hash, 0, 3 );
3957 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3961 if ( $type == ':A:' ) {
3963 return md5( $password ) === substr( $hash, 3 );
3964 } elseif ( $type == ':B:' ) {
3966 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3967 return md5( $salt.'-'.md5( $password ) ) === $realHash;
3970 return self
::oldCrypt( $password, $userId ) === $hash;
3975 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
3977 * @param $byEmail Boolean: account made by email?
3978 * @param $reason String: user supplied reason
3980 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
3982 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3983 global $wgUser, $wgContLang, $wgNewUserLog;
3984 if( empty( $wgNewUserLog ) ) {
3985 return true; // disabled
3988 if( $this->getName() == $wgUser->getName() ) {
3991 $action = 'create2';
3993 if ( $reason === '' ) {
3994 $reason = wfMsgForContent( 'newuserlog-byemail' );
3996 $reason = $wgContLang->commaList( array(
3997 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
4001 $log = new LogPage( 'newusers' );
4002 return (int)$log->addEntry(
4004 $this->getUserPage(),
4006 array( $this->getId() )
4011 * Add an autocreate newuser log entry for this user
4012 * Used by things like CentralAuth and perhaps other authplugins.
4016 public function addNewUserLogEntryAutoCreate() {
4017 global $wgNewUserLog;
4018 if( !$wgNewUserLog ) {
4019 return true; // disabled
4021 $log = new LogPage( 'newusers', false );
4022 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4029 protected function loadOptions() {
4031 if ( $this->mOptionsLoaded ||
!$this->getId() )
4034 $this->mOptions
= self
::getDefaultOptions();
4036 // Maybe load from the object
4037 if ( !is_null( $this->mOptionOverrides
) ) {
4038 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4039 foreach( $this->mOptionOverrides
as $key => $value ) {
4040 $this->mOptions
[$key] = $value;
4043 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4044 // Load from database
4045 $dbr = wfGetDB( DB_SLAVE
);
4047 $res = $dbr->select(
4049 array( 'up_property', 'up_value' ),
4050 array( 'up_user' => $this->getId() ),
4054 $this->mOptionOverrides
= array();
4055 foreach ( $res as $row ) {
4056 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4057 $this->mOptions
[$row->up_property
] = $row->up_value
;
4061 $this->mOptionsLoaded
= true;
4063 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4069 protected function saveOptions() {
4070 global $wgAllowPrefChange;
4072 $this->loadOptions();
4074 // Not using getOptions(), to keep hidden preferences in database
4075 $saveOptions = $this->mOptions
;
4077 // Allow hooks to abort, for instance to save to a global profile.
4078 // Reset options to default state before saving.
4079 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4083 $extuser = ExternalUser
::newFromUser( $this );
4084 $userId = $this->getId();
4085 $insert_rows = array();
4086 foreach( $saveOptions as $key => $value ) {
4087 # Don't bother storing default values
4088 $defaultOption = self
::getDefaultOption( $key );
4089 if ( ( is_null( $defaultOption ) &&
4090 !( $value === false ||
is_null( $value ) ) ) ||
4091 $value != $defaultOption ) {
4092 $insert_rows[] = array(
4093 'up_user' => $userId,
4094 'up_property' => $key,
4095 'up_value' => $value,
4098 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4099 switch ( $wgAllowPrefChange[$key] ) {
4105 $extuser->setPref( $key, $value );
4110 $dbw = wfGetDB( DB_MASTER
);
4111 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4112 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4116 * Provide an array of HTML5 attributes to put on an input element
4117 * intended for the user to enter a new password. This may include
4118 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4120 * Do *not* use this when asking the user to enter his current password!
4121 * Regardless of configuration, users may have invalid passwords for whatever
4122 * reason (e.g., they were set before requirements were tightened up).
4123 * Only use it when asking for a new password, like on account creation or
4126 * Obviously, you still need to do server-side checking.
4128 * NOTE: A combination of bugs in various browsers means that this function
4129 * actually just returns array() unconditionally at the moment. May as
4130 * well keep it around for when the browser bugs get fixed, though.
4132 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4134 * @return array Array of HTML attributes suitable for feeding to
4135 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4136 * That will potentially output invalid XHTML 1.0 Transitional, and will
4137 * get confused by the boolean attribute syntax used.)
4139 public static function passwordChangeInputAttribs() {
4140 global $wgMinimalPasswordLength;
4142 if ( $wgMinimalPasswordLength == 0 ) {
4146 # Note that the pattern requirement will always be satisfied if the
4147 # input is empty, so we need required in all cases.
4149 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4150 # if e-mail confirmation is being used. Since HTML5 input validation
4151 # is b0rked anyway in some browsers, just return nothing. When it's
4152 # re-enabled, fix this code to not output required for e-mail
4154 #$ret = array( 'required' );
4157 # We can't actually do this right now, because Opera 9.6 will print out
4158 # the entered password visibly in its error message! When other
4159 # browsers add support for this attribute, or Opera fixes its support,
4160 # we can add support with a version check to avoid doing this on Opera
4161 # versions where it will be a problem. Reported to Opera as
4162 # DSK-262266, but they don't have a public bug tracker for us to follow.
4164 if ( $wgMinimalPasswordLength > 1 ) {
4165 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4166 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4167 $wgMinimalPasswordLength );
4175 * Return the list of user fields that should be selected to create
4176 * a new user object.
4179 public static function selectFields() {
4186 'user_newpass_time',
4190 'user_email_authenticated',
4192 'user_email_token_expires',
4193 'user_registration',