3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Int Number of characters in user_token field.
27 define( 'USER_TOKEN_LENGTH', 32 );
30 * Int Serialized record version.
33 define( 'MW_USER_VERSION', 8 );
36 * String Some punctuation to prevent editing from broken text-mangling proxies.
39 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
42 * Thrown by User::setPassword() on error.
45 class PasswordError
extends MWException
{
50 * The User object encapsulates all of the user-specific settings (user_id,
51 * name, rights, password, email address, options, last login time). Client
52 * classes use the getXXX() functions to access these fields. These functions
53 * do all the work of determining whether the user is logged in,
54 * whether the requested option can be satisfied from cookies or
55 * whether a database query is needed. Most of the settings needed
56 * for rendering normal pages are set in the cookie to minimize use
61 * Global constants made accessible as class constants so that autoloader
64 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
65 const MW_USER_VERSION
= MW_USER_VERSION
;
66 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
69 * Maximum items in $mWatchedItems
71 const MAX_WATCHED_ITEMS_CACHE
= 100;
74 * Array of Strings List of member variables which are saved to the
75 * shared cache (memcached). Any operation which changes the
76 * corresponding database fields must call a cache-clearing function.
79 static $mCacheVars = array(
90 'mEmailAuthenticated',
97 // user_properties table
102 * Array of Strings Core rights.
103 * Each of these should have a corresponding message of the form
107 static $mCoreRights = array(
127 'editusercssjs', #deprecated
139 'move-rootuserpages',
143 'override-export-depth',
166 'userrights-interwiki',
170 * String Cached results of getAllRights()
172 static $mAllRights = false;
174 /** @name Cache variables */
176 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
177 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
178 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
179 $mGroups, $mOptionOverrides;
183 * Bool Whether the cache variables have been loaded.
189 * Array with already loaded items or true if all items have been loaded.
191 private $mLoadedItems = array();
195 * String Initialization data source if mLoadedItems!==true. May be one of:
196 * - 'defaults' anonymous user initialised from class defaults
197 * - 'name' initialise from mName
198 * - 'id' initialise from mId
199 * - 'session' log in from cookies or session if possible
201 * Use the User::newFrom*() family of functions to set this.
206 * Lazy-initialized variables, invalidated with clearInstanceCache
208 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
209 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
210 $mLocked, $mHideName, $mOptions;
230 private $mBlockedFromCreateAccount = false;
235 private $mWatchedItems = array();
237 static $idCacheByName = array();
240 * Lightweight constructor for an anonymous user.
241 * Use the User::newFrom* factory functions for other kinds of users.
245 * @see newFromConfirmationCode()
246 * @see newFromSession()
249 function __construct() {
250 $this->clearInstanceCache( 'defaults' );
256 function __toString(){
257 return $this->getName();
261 * Load the user table data for this object from the source given by mFrom.
263 public function load() {
264 if ( $this->mLoadedItems
=== true ) {
267 wfProfileIn( __METHOD__
);
269 # Set it now to avoid infinite recursion in accessors
270 $this->mLoadedItems
= true;
272 switch ( $this->mFrom
) {
274 $this->loadDefaults();
277 $this->mId
= self
::idFromName( $this->mName
);
279 # Nonexistent user placeholder object
280 $this->loadDefaults( $this->mName
);
289 if( !$this->loadFromSession() ) {
290 // Loading from session failed. Load defaults.
291 $this->loadDefaults();
293 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
296 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
298 wfProfileOut( __METHOD__
);
302 * Load user table data, given mId has already been set.
303 * @return Bool false if the ID does not exist, true otherwise
305 public function loadFromId() {
307 if ( $this->mId
== 0 ) {
308 $this->loadDefaults();
313 $key = wfMemcKey( 'user', 'id', $this->mId
);
314 $data = $wgMemc->get( $key );
315 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
316 # Object is expired, load from DB
321 wfDebug( "User: cache miss for user {$this->mId}\n" );
323 if ( !$this->loadFromDatabase() ) {
324 # Can't load from ID, user is anonymous
327 $this->saveToCache();
329 wfDebug( "User: got user {$this->mId} from cache\n" );
331 foreach ( self
::$mCacheVars as $name ) {
332 $this->$name = $data[$name];
339 * Save user data to the shared cache
341 public function saveToCache() {
344 $this->loadOptions();
345 if ( $this->isAnon() ) {
346 // Anonymous users are uncached
350 foreach ( self
::$mCacheVars as $name ) {
351 $data[$name] = $this->$name;
353 $data['mVersion'] = MW_USER_VERSION
;
354 $key = wfMemcKey( 'user', 'id', $this->mId
);
356 $wgMemc->set( $key, $data );
359 /** @name newFrom*() static factory methods */
363 * Static factory method for creation from username.
365 * This is slightly less efficient than newFromId(), so use newFromId() if
366 * you have both an ID and a name handy.
368 * @param $name String Username, validated by Title::newFromText()
369 * @param $validate String|Bool Validate username. Takes the same parameters as
370 * User::getCanonicalName(), except that true is accepted as an alias
371 * for 'valid', for BC.
373 * @return User object, or false if the username is invalid
374 * (e.g. if it contains illegal characters or is an IP address). If the
375 * username is not present in the database, the result will be a user object
376 * with a name, zero user ID and default settings.
378 public static function newFromName( $name, $validate = 'valid' ) {
379 if ( $validate === true ) {
382 $name = self
::getCanonicalName( $name, $validate );
383 if ( $name === false ) {
386 # Create unloaded user object
390 $u->setItemLoaded( 'name' );
396 * Static factory method for creation from a given user ID.
398 * @param $id Int Valid user ID
399 * @return User The corresponding User object
401 public static function newFromId( $id ) {
405 $u->setItemLoaded( 'id' );
410 * Factory method to fetch whichever user has a given email confirmation code.
411 * This code is generated when an account is created or its e-mail address
414 * If the code is invalid or has expired, returns NULL.
416 * @param $code String Confirmation code
417 * @return User object, or null
419 public static function newFromConfirmationCode( $code ) {
420 $dbr = wfGetDB( DB_SLAVE
);
421 $id = $dbr->selectField( 'user', 'user_id', array(
422 'user_email_token' => md5( $code ),
423 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
425 if( $id !== false ) {
426 return User
::newFromId( $id );
433 * Create a new user object using data from session or cookies. If the
434 * login credentials are invalid, the result is an anonymous user.
436 * @param $request WebRequest object to use; $wgRequest will be used if
438 * @return User object
440 public static function newFromSession( WebRequest
$request = null ) {
442 $user->mFrom
= 'session';
443 $user->mRequest
= $request;
448 * Create a new user object from a user row.
449 * The row should have the following fields from the user table in it:
450 * - either user_name or user_id to load further data if needed (or both)
452 * - all other fields (email, password, etc.)
453 * It is useless to provide the remaining fields if either user_id,
454 * user_name and user_real_name are not provided because the whole row
455 * will be loaded once more from the database when accessing them.
457 * @param $row Array A row from the user table
460 public static function newFromRow( $row ) {
462 $user->loadFromRow( $row );
469 * Get the username corresponding to a given user ID
470 * @param $id Int User ID
471 * @return String|bool The corresponding username
473 public static function whoIs( $id ) {
474 return UserCache
::singleton()->getProp( $id, 'name' );
478 * Get the real name of a user given their user ID
480 * @param $id Int User ID
481 * @return String|bool The corresponding user's real name
483 public static function whoIsReal( $id ) {
484 return UserCache
::singleton()->getProp( $id, 'real_name' );
488 * Get database id given a user name
489 * @param $name String Username
490 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
492 public static function idFromName( $name ) {
493 $nt = Title
::makeTitleSafe( NS_USER
, $name );
494 if( is_null( $nt ) ) {
499 if ( isset( self
::$idCacheByName[$name] ) ) {
500 return self
::$idCacheByName[$name];
503 $dbr = wfGetDB( DB_SLAVE
);
504 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
506 if ( $s === false ) {
509 $result = $s->user_id
;
512 self
::$idCacheByName[$name] = $result;
514 if ( count( self
::$idCacheByName ) > 1000 ) {
515 self
::$idCacheByName = array();
522 * Reset the cache used in idFromName(). For use in tests.
524 public static function resetIdByNameCache() {
525 self
::$idCacheByName = array();
529 * Does the string match an anonymous IPv4 address?
531 * This function exists for username validation, in order to reject
532 * usernames which are similar in form to IP addresses. Strings such
533 * as 300.300.300.300 will return true because it looks like an IP
534 * address, despite not being strictly valid.
536 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
537 * address because the usemod software would "cloak" anonymous IP
538 * addresses like this, if we allowed accounts like this to be created
539 * new users could get the old edits of these anonymous users.
541 * @param $name String to match
544 public static function isIP( $name ) {
545 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
549 * Is the input a valid username?
551 * Checks if the input is a valid username, we don't want an empty string,
552 * an IP address, anything that containins slashes (would mess up subpages),
553 * is longer than the maximum allowed username size or doesn't begin with
556 * @param $name String to match
559 public static function isValidUserName( $name ) {
560 global $wgContLang, $wgMaxNameChars;
563 || User
::isIP( $name )
564 ||
strpos( $name, '/' ) !== false
565 ||
strlen( $name ) > $wgMaxNameChars
566 ||
$name != $wgContLang->ucfirst( $name ) ) {
567 wfDebugLog( 'username', __METHOD__
.
568 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
573 // Ensure that the name can't be misresolved as a different title,
574 // such as with extra namespace keys at the start.
575 $parsed = Title
::newFromText( $name );
576 if( is_null( $parsed )
577 ||
$parsed->getNamespace()
578 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
579 wfDebugLog( 'username', __METHOD__
.
580 ": '$name' invalid due to ambiguous prefixes" );
584 // Check an additional blacklist of troublemaker characters.
585 // Should these be merged into the title char list?
586 $unicodeBlacklist = '/[' .
587 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
588 '\x{00a0}' . # non-breaking space
589 '\x{2000}-\x{200f}' . # various whitespace
590 '\x{2028}-\x{202f}' . # breaks and control chars
591 '\x{3000}' . # ideographic space
592 '\x{e000}-\x{f8ff}' . # private use
594 if( preg_match( $unicodeBlacklist, $name ) ) {
595 wfDebugLog( 'username', __METHOD__
.
596 ": '$name' invalid due to blacklisted characters" );
604 * Usernames which fail to pass this function will be blocked
605 * from user login and new account registrations, but may be used
606 * internally by batch processes.
608 * If an account already exists in this form, login will be blocked
609 * by a failure to pass this function.
611 * @param $name String to match
614 public static function isUsableName( $name ) {
615 global $wgReservedUsernames;
616 // Must be a valid username, obviously ;)
617 if ( !self
::isValidUserName( $name ) ) {
621 static $reservedUsernames = false;
622 if ( !$reservedUsernames ) {
623 $reservedUsernames = $wgReservedUsernames;
624 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
627 // Certain names may be reserved for batch processes.
628 foreach ( $reservedUsernames as $reserved ) {
629 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
630 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
632 if ( $reserved == $name ) {
640 * Usernames which fail to pass this function will be blocked
641 * from new account registrations, but may be used internally
642 * either by batch processes or by user accounts which have
643 * already been created.
645 * Additional blacklisting may be added here rather than in
646 * isValidUserName() to avoid disrupting existing accounts.
648 * @param $name String to match
651 public static function isCreatableName( $name ) {
652 global $wgInvalidUsernameCharacters;
654 // Ensure that the username isn't longer than 235 bytes, so that
655 // (at least for the builtin skins) user javascript and css files
656 // will work. (bug 23080)
657 if( strlen( $name ) > 235 ) {
658 wfDebugLog( 'username', __METHOD__
.
659 ": '$name' invalid due to length" );
663 // Preg yells if you try to give it an empty string
664 if( $wgInvalidUsernameCharacters !== '' ) {
665 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
666 wfDebugLog( 'username', __METHOD__
.
667 ": '$name' invalid due to wgInvalidUsernameCharacters" );
672 return self
::isUsableName( $name );
676 * Is the input a valid password for this user?
678 * @param $password String Desired password
681 public function isValidPassword( $password ) {
682 //simple boolean wrapper for getPasswordValidity
683 return $this->getPasswordValidity( $password ) === true;
687 * Given unvalidated password input, return error message on failure.
689 * @param $password String Desired password
690 * @return mixed: true on success, string or array of error message on failure
692 public function getPasswordValidity( $password ) {
693 global $wgMinimalPasswordLength, $wgContLang;
695 static $blockedLogins = array(
696 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
697 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
700 $result = false; //init $result to false for the internal checks
702 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
705 if ( $result === false ) {
706 if( strlen( $password ) < $wgMinimalPasswordLength ) {
707 return 'passwordtooshort';
708 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
709 return 'password-name-match';
710 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
711 return 'password-login-forbidden';
713 //it seems weird returning true here, but this is because of the
714 //initialization of $result to false above. If the hook is never run or it
715 //doesn't modify $result, then we will likely get down into this if with
719 } elseif( $result === true ) {
722 return $result; //the isValidPassword hook set a string $result and returned true
727 * Does a string look like an e-mail address?
729 * This validates an email address using an HTML5 specification found at:
730 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
731 * Which as of 2011-01-24 says:
733 * A valid e-mail address is a string that matches the ABNF production
734 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
735 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
738 * This function is an implementation of the specification as requested in
741 * Client-side forms will use the same standard validation rules via JS or
742 * HTML 5 validation; additional restrictions can be enforced server-side
743 * by extensions via the 'isValidEmailAddr' hook.
745 * Note that this validation doesn't 100% match RFC 2822, but is believed
746 * to be liberal enough for wide use. Some invalid addresses will still
747 * pass validation here.
749 * @param $addr String E-mail address
751 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
753 public static function isValidEmailAddr( $addr ) {
754 wfDeprecated( __METHOD__
, '1.18' );
755 return Sanitizer
::validateEmail( $addr );
759 * Given unvalidated user input, return a canonical username, or false if
760 * the username is invalid.
761 * @param $name String User input
762 * @param $validate String|Bool type of validation to use:
763 * - false No validation
764 * - 'valid' Valid for batch processes
765 * - 'usable' Valid for batch processes and login
766 * - 'creatable' Valid for batch processes, login and account creation
768 * @throws MWException
769 * @return bool|string
771 public static function getCanonicalName( $name, $validate = 'valid' ) {
772 # Force usernames to capital
774 $name = $wgContLang->ucfirst( $name );
776 # Reject names containing '#'; these will be cleaned up
777 # with title normalisation, but then it's too late to
779 if( strpos( $name, '#' ) !== false )
782 # Clean up name according to title rules
783 $t = ( $validate === 'valid' ) ?
784 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
785 # Check for invalid titles
786 if( is_null( $t ) ) {
790 # Reject various classes of invalid names
792 $name = $wgAuth->getCanonicalName( $t->getText() );
794 switch ( $validate ) {
798 if ( !User
::isValidUserName( $name ) ) {
803 if ( !User
::isUsableName( $name ) ) {
808 if ( !User
::isCreatableName( $name ) ) {
813 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
819 * Count the number of edits of a user
820 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
822 * @param $uid Int User ID to check
823 * @return Int the user's edit count
825 public static function edits( $uid ) {
826 wfProfileIn( __METHOD__
);
827 $dbr = wfGetDB( DB_SLAVE
);
828 // check if the user_editcount field has been initialized
829 $field = $dbr->selectField(
830 'user', 'user_editcount',
831 array( 'user_id' => $uid ),
835 if( $field === null ) { // it has not been initialized. do so.
836 $dbw = wfGetDB( DB_MASTER
);
837 $count = $dbr->selectField(
838 'revision', 'count(*)',
839 array( 'rev_user' => $uid ),
844 array( 'user_editcount' => $count ),
845 array( 'user_id' => $uid ),
851 wfProfileOut( __METHOD__
);
856 * Return a random password.
858 * @return String new random password
860 public static function randomPassword() {
861 global $wgMinimalPasswordLength;
862 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
863 $length = max( 10, $wgMinimalPasswordLength );
864 // Multiply by 1.25 to get the number of hex characters we need
865 $length = $length * 1.25;
866 // Generate random hex chars
867 $hex = MWCryptRand
::generateHex( $length );
868 // Convert from base 16 to base 32 to get a proper password like string
869 return wfBaseConvert( $hex, 16, 32 );
873 * Set cached properties to default.
875 * @note This no longer clears uncached lazy-initialised properties;
876 * the constructor does that instead.
878 * @param $name string
880 public function loadDefaults( $name = false ) {
881 wfProfileIn( __METHOD__
);
884 $this->mName
= $name;
885 $this->mRealName
= '';
886 $this->mPassword
= $this->mNewpassword
= '';
887 $this->mNewpassTime
= null;
889 $this->mOptionOverrides
= null;
890 $this->mOptionsLoaded
= false;
892 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
893 if( $loggedOut !== null ) {
894 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
896 $this->mTouched
= '1'; # Allow any pages to be cached
899 $this->mToken
= null; // Don't run cryptographic functions till we need a token
900 $this->mEmailAuthenticated
= null;
901 $this->mEmailToken
= '';
902 $this->mEmailTokenExpires
= null;
903 $this->mRegistration
= wfTimestamp( TS_MW
);
904 $this->mGroups
= array();
906 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
908 wfProfileOut( __METHOD__
);
912 * Return whether an item has been loaded.
914 * @param $item String: item to check. Current possibilities:
918 * @param $all String: 'all' to check if the whole object has been loaded
919 * or any other string to check if only the item is available (e.g.
923 public function isItemLoaded( $item, $all = 'all' ) {
924 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
925 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
929 * Set that an item has been loaded
931 * @param $item String
933 private function setItemLoaded( $item ) {
934 if ( is_array( $this->mLoadedItems
) ) {
935 $this->mLoadedItems
[$item] = true;
940 * Load user data from the session or login cookie.
941 * @return Bool True if the user is logged in, false otherwise.
943 private function loadFromSession() {
944 global $wgExternalAuthType, $wgAutocreatePolicy;
947 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
948 if ( $result !== null ) {
952 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
953 $extUser = ExternalUser
::newFromCookie();
955 # TODO: Automatically create the user here (or probably a bit
956 # lower down, in fact)
960 $request = $this->getRequest();
962 $cookieId = $request->getCookie( 'UserID' );
963 $sessId = $request->getSessionData( 'wsUserID' );
965 if ( $cookieId !== null ) {
966 $sId = intval( $cookieId );
967 if( $sessId !== null && $cookieId != $sessId ) {
968 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
969 cookie user ID ($sId) don't match!" );
972 $request->setSessionData( 'wsUserID', $sId );
973 } elseif ( $sessId !== null && $sessId != 0 ) {
979 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
980 $sName = $request->getSessionData( 'wsUserName' );
981 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
982 $sName = $request->getCookie( 'UserName' );
983 $request->setSessionData( 'wsUserName', $sName );
988 $proposedUser = User
::newFromId( $sId );
989 if ( !$proposedUser->isLoggedIn() ) {
994 global $wgBlockDisablesLogin;
995 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
996 # User blocked and we've disabled blocked user logins
1000 if ( $request->getSessionData( 'wsToken' ) ) {
1001 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
1003 } elseif ( $request->getCookie( 'Token' ) ) {
1004 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
1007 # No session or persistent login cookie
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" );
1024 * Load user and user_group data from the database.
1025 * $this->mId must be set, this is how the user is identified.
1027 * @return Bool True if the user exists, false if the user is anonymous
1029 public function loadFromDatabase() {
1031 $this->mId
= intval( $this->mId
);
1033 /** Anonymous user */
1035 $this->loadDefaults();
1039 $dbr = wfGetDB( DB_MASTER
);
1040 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1042 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1044 if ( $s !== false ) {
1045 # Initialise user table data
1046 $this->loadFromRow( $s );
1047 $this->mGroups
= null; // deferred
1048 $this->getEditCount(); // revalidation for nulls
1053 $this->loadDefaults();
1059 * Initialize this object from a row from the user table.
1061 * @param $row Array Row from the user table to load.
1063 public function loadFromRow( $row ) {
1066 $this->mGroups
= null; // deferred
1068 if ( isset( $row->user_name
) ) {
1069 $this->mName
= $row->user_name
;
1070 $this->mFrom
= 'name';
1071 $this->setItemLoaded( 'name' );
1076 if ( isset( $row->user_real_name
) ) {
1077 $this->mRealName
= $row->user_real_name
;
1078 $this->setItemLoaded( 'realname' );
1083 if ( isset( $row->user_id
) ) {
1084 $this->mId
= intval( $row->user_id
);
1085 $this->mFrom
= 'id';
1086 $this->setItemLoaded( 'id' );
1091 if ( isset( $row->user_editcount
) ) {
1092 $this->mEditCount
= $row->user_editcount
;
1097 if ( isset( $row->user_password
) ) {
1098 $this->mPassword
= $row->user_password
;
1099 $this->mNewpassword
= $row->user_newpassword
;
1100 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1101 $this->mEmail
= $row->user_email
;
1102 if ( isset( $row->user_options
) ) {
1103 $this->decodeOptions( $row->user_options
);
1105 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1106 $this->mToken
= $row->user_token
;
1107 if ( $this->mToken
== '' ) {
1108 $this->mToken
= null;
1110 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1111 $this->mEmailToken
= $row->user_email_token
;
1112 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1113 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1119 $this->mLoadedItems
= true;
1124 * Load the data for this user object from another user object.
1128 protected function loadFromUserObject( $user ) {
1130 $user->loadGroups();
1131 $user->loadOptions();
1132 foreach ( self
::$mCacheVars as $var ) {
1133 $this->$var = $user->$var;
1138 * Load the groups from the database if they aren't already loaded.
1140 private function loadGroups() {
1141 if ( is_null( $this->mGroups
) ) {
1142 $dbr = wfGetDB( DB_MASTER
);
1143 $res = $dbr->select( 'user_groups',
1144 array( 'ug_group' ),
1145 array( 'ug_user' => $this->mId
),
1147 $this->mGroups
= array();
1148 foreach ( $res as $row ) {
1149 $this->mGroups
[] = $row->ug_group
;
1155 * Add the user to the group if he/she meets given criteria.
1157 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1158 * possible to remove manually via Special:UserRights. In such case it
1159 * will not be re-added automatically. The user will also not lose the
1160 * group if they no longer meet the criteria.
1162 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1164 * @return array Array of groups the user has been promoted to.
1166 * @see $wgAutopromoteOnce
1168 public function addAutopromoteOnceGroups( $event ) {
1169 global $wgAutopromoteOnceLogInRC;
1171 $toPromote = array();
1172 if ( $this->getId() ) {
1173 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1174 if ( count( $toPromote ) ) {
1175 $oldGroups = $this->getGroups(); // previous groups
1176 foreach ( $toPromote as $group ) {
1177 $this->addGroup( $group );
1179 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1181 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1182 $log->addEntry( 'autopromote',
1183 $this->getUserPage(),
1185 // These group names are "list to texted"-ed in class LogPage.
1186 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1194 * Clear various cached data stored in this object.
1195 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1196 * given source. May be "name", "id", "defaults", "session", or false for
1199 public function clearInstanceCache( $reloadFrom = false ) {
1200 $this->mNewtalk
= -1;
1201 $this->mDatePreference
= null;
1202 $this->mBlockedby
= -1; # Unset
1203 $this->mHash
= false;
1204 $this->mRights
= null;
1205 $this->mEffectiveGroups
= null;
1206 $this->mImplicitGroups
= null;
1207 $this->mOptions
= null;
1208 $this->mEditCount
= 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 $defOpt['variant'] = $wgContLang->getCode();
1228 $defOpt['language'] = $wgContLang->getCode();
1229 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1230 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1232 $defOpt['skin'] = $wgDefaultSkin;
1234 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1235 // but that breaks the parser tests because they rely on being able to change $wgContLang
1236 // mid-request and see that change reflected in the return value of this function.
1237 // Which is insane and would never happen during normal MW operation, but is also not
1238 // likely to get fixed unless and until we context-ify everything.
1239 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1240 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1246 * Get a given default option value.
1248 * @param $opt String Name of option to retrieve
1249 * @return String Default option value
1251 public static function getDefaultOption( $opt ) {
1252 $defOpts = self
::getDefaultOptions();
1253 if( isset( $defOpts[$opt] ) ) {
1254 return $defOpts[$opt];
1262 * Get blocking information
1263 * @param $bFromSlave Bool Whether to check the slave database first. To
1264 * improve performance, non-critical checks are done
1265 * against slaves. Check when actually saving should be
1266 * done against master.
1268 private function getBlockedStatus( $bFromSlave = true ) {
1269 global $wgProxyWhitelist, $wgUser;
1271 if ( -1 != $this->mBlockedby
) {
1275 wfProfileIn( __METHOD__
);
1276 wfDebug( __METHOD__
.": checking...\n" );
1278 // Initialize data...
1279 // Otherwise something ends up stomping on $this->mBlockedby when
1280 // things get lazy-loaded later, causing false positive block hits
1281 // due to -1 !== 0. Probably session-related... Nothing should be
1282 // overwriting mBlockedby, surely?
1285 # We only need to worry about passing the IP address to the Block generator if the
1286 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1287 # know which IP address they're actually coming from
1288 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1289 $ip = $this->getRequest()->getIP();
1295 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1298 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1299 && !in_array( $ip, $wgProxyWhitelist ) )
1302 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1304 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1305 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1306 $block->setTarget( $ip );
1307 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1309 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1310 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1311 $block->setTarget( $ip );
1315 if ( $block instanceof Block
) {
1316 wfDebug( __METHOD__
. ": Found block.\n" );
1317 $this->mBlock
= $block;
1318 $this->mBlockedby
= $block->getByName();
1319 $this->mBlockreason
= $block->mReason
;
1320 $this->mHideName
= $block->mHideName
;
1321 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1323 $this->mBlockedby
= '';
1324 $this->mHideName
= 0;
1325 $this->mAllowUsertalk
= false;
1329 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1331 wfProfileOut( __METHOD__
);
1335 * Whether the given IP is in a DNS blacklist.
1337 * @param $ip String IP to check
1338 * @param $checkWhitelist Bool: whether to check the whitelist first
1339 * @return Bool True if blacklisted.
1341 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1342 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1343 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1345 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1348 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1351 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1352 return $this->inDnsBlacklist( $ip, $urls );
1356 * Whether the given IP is in a given DNS blacklist.
1358 * @param $ip String IP to check
1359 * @param $bases String|Array of Strings: URL of the DNS blacklist
1360 * @return Bool True if blacklisted.
1362 public function inDnsBlacklist( $ip, $bases ) {
1363 wfProfileIn( __METHOD__
);
1366 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1367 if( IP
::isIPv4( $ip ) ) {
1368 # Reverse IP, bug 21255
1369 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1371 foreach( (array)$bases as $base ) {
1373 # If we have an access key, use that too (ProjectHoneypot, etc.)
1374 if( is_array( $base ) ) {
1375 if( count( $base ) >= 2 ) {
1376 # Access key is 1, base URL is 0
1377 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1379 $host = "$ipReversed.{$base[0]}";
1382 $host = "$ipReversed.$base";
1386 $ipList = gethostbynamel( $host );
1389 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1393 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1398 wfProfileOut( __METHOD__
);
1403 * Check if an IP address is in the local proxy list
1409 public static function isLocallyBlockedProxy( $ip ) {
1410 global $wgProxyList;
1412 if ( !$wgProxyList ) {
1415 wfProfileIn( __METHOD__
);
1417 if ( !is_array( $wgProxyList ) ) {
1418 # Load from the specified file
1419 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1422 if ( !is_array( $wgProxyList ) ) {
1424 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1426 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1427 # Old-style flipped proxy list
1432 wfProfileOut( __METHOD__
);
1437 * Is this user subject to rate limiting?
1439 * @return Bool True if rate limited
1441 public function isPingLimitable() {
1442 global $wgRateLimitsExcludedIPs;
1443 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1444 // No other good way currently to disable rate limits
1445 // for specific IPs. :P
1446 // But this is a crappy hack and should die.
1449 return !$this->isAllowed('noratelimit');
1453 * Primitive rate limits: enforce maximum actions per time period
1454 * to put a brake on flooding.
1456 * @note When using a shared cache like memcached, IP-address
1457 * last-hit counters will be shared across wikis.
1459 * @param $action String Action to enforce; 'edit' if unspecified
1460 * @return Bool True if a rate limiter was tripped
1462 public function pingLimiter( $action = 'edit' ) {
1463 # Call the 'PingLimiter' hook
1465 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1469 global $wgRateLimits;
1470 if( !isset( $wgRateLimits[$action] ) ) {
1474 # Some groups shouldn't trigger the ping limiter, ever
1475 if( !$this->isPingLimitable() )
1478 global $wgMemc, $wgRateLimitLog;
1479 wfProfileIn( __METHOD__
);
1481 $limits = $wgRateLimits[$action];
1483 $id = $this->getId();
1484 $ip = $this->getRequest()->getIP();
1487 if( isset( $limits['anon'] ) && $id == 0 ) {
1488 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1491 if( isset( $limits['user'] ) && $id != 0 ) {
1492 $userLimit = $limits['user'];
1494 if( $this->isNewbie() ) {
1495 if( isset( $limits['newbie'] ) && $id != 0 ) {
1496 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1498 if( isset( $limits['ip'] ) ) {
1499 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1502 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1503 $subnet = $matches[1];
1504 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1507 // Check for group-specific permissions
1508 // If more than one group applies, use the group with the highest limit
1509 foreach ( $this->getGroups() as $group ) {
1510 if ( isset( $limits[$group] ) ) {
1511 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1512 $userLimit = $limits[$group];
1516 // Set the user limit key
1517 if ( $userLimit !== false ) {
1518 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1519 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1523 foreach( $keys as $key => $limit ) {
1524 list( $max, $period ) = $limit;
1525 $summary = "(limit $max in {$period}s)";
1526 $count = $wgMemc->get( $key );
1529 if( $count >= $max ) {
1530 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1531 if( $wgRateLimitLog ) {
1532 wfSuppressWarnings();
1533 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1534 wfRestoreWarnings();
1538 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1541 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1542 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1544 $wgMemc->incr( $key );
1547 wfProfileOut( __METHOD__
);
1552 * Check if user is blocked
1554 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1555 * @return Bool True if blocked, false otherwise
1557 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1558 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1562 * Get the block affecting the user, or null if the user is not blocked
1564 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1565 * @return Block|null
1567 public function getBlock( $bFromSlave = true ){
1568 $this->getBlockedStatus( $bFromSlave );
1569 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1573 * Check if user is blocked from editing a particular article
1575 * @param $title Title to check
1576 * @param $bFromSlave Bool whether to check the slave database instead of the master
1579 function isBlockedFrom( $title, $bFromSlave = false ) {
1580 global $wgBlockAllowsUTEdit;
1581 wfProfileIn( __METHOD__
);
1583 $blocked = $this->isBlocked( $bFromSlave );
1584 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1585 # If a user's name is suppressed, they cannot make edits anywhere
1586 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1587 $title->getNamespace() == NS_USER_TALK
) {
1589 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1592 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1594 wfProfileOut( __METHOD__
);
1599 * If user is blocked, return the name of the user who placed the block
1600 * @return String name of blocker
1602 public function blockedBy() {
1603 $this->getBlockedStatus();
1604 return $this->mBlockedby
;
1608 * If user is blocked, return the specified reason for the block
1609 * @return String Blocking reason
1611 public function blockedFor() {
1612 $this->getBlockedStatus();
1613 return $this->mBlockreason
;
1617 * If user is blocked, return the ID for the block
1618 * @return Int Block ID
1620 public function getBlockId() {
1621 $this->getBlockedStatus();
1622 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1626 * Check if user is blocked on all wikis.
1627 * Do not use for actual edit permission checks!
1628 * This is intented for quick UI checks.
1630 * @param $ip String IP address, uses current client if none given
1631 * @return Bool True if blocked, false otherwise
1633 public function isBlockedGlobally( $ip = '' ) {
1634 if( $this->mBlockedGlobally
!== null ) {
1635 return $this->mBlockedGlobally
;
1637 // User is already an IP?
1638 if( IP
::isIPAddress( $this->getName() ) ) {
1639 $ip = $this->getName();
1641 $ip = $this->getRequest()->getIP();
1644 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1645 $this->mBlockedGlobally
= (bool)$blocked;
1646 return $this->mBlockedGlobally
;
1650 * Check if user account is locked
1652 * @return Bool True if locked, false otherwise
1654 public function isLocked() {
1655 if( $this->mLocked
!== null ) {
1656 return $this->mLocked
;
1659 $authUser = $wgAuth->getUserInstance( $this );
1660 $this->mLocked
= (bool)$authUser->isLocked();
1661 return $this->mLocked
;
1665 * Check if user account is hidden
1667 * @return Bool True if hidden, false otherwise
1669 public function isHidden() {
1670 if( $this->mHideName
!== null ) {
1671 return $this->mHideName
;
1673 $this->getBlockedStatus();
1674 if( !$this->mHideName
) {
1676 $authUser = $wgAuth->getUserInstance( $this );
1677 $this->mHideName
= (bool)$authUser->isHidden();
1679 return $this->mHideName
;
1683 * Get the user's ID.
1684 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1686 public function getId() {
1687 if( $this->mId
=== null && $this->mName
!== null
1688 && User
::isIP( $this->mName
) ) {
1689 // Special case, we know the user is anonymous
1691 } elseif( !$this->isItemLoaded( 'id' ) ) {
1692 // Don't load if this was initialized from an ID
1699 * Set the user and reload all fields according to a given ID
1700 * @param $v Int User ID to reload
1702 public function setId( $v ) {
1704 $this->clearInstanceCache( 'id' );
1708 * Get the user name, or the IP of an anonymous user
1709 * @return String User's name or IP address
1711 public function getName() {
1712 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1713 # Special case optimisation
1714 return $this->mName
;
1717 if ( $this->mName
=== false ) {
1719 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1721 return $this->mName
;
1726 * Set the user name.
1728 * This does not reload fields from the database according to the given
1729 * name. Rather, it is used to create a temporary "nonexistent user" for
1730 * later addition to the database. It can also be used to set the IP
1731 * address for an anonymous user to something other than the current
1734 * @note User::newFromName() has rougly the same function, when the named user
1736 * @param $str String New user name to set
1738 public function setName( $str ) {
1740 $this->mName
= $str;
1744 * Get the user's name escaped by underscores.
1745 * @return String Username escaped by underscores.
1747 public function getTitleKey() {
1748 return str_replace( ' ', '_', $this->getName() );
1752 * Check if the user has new messages.
1753 * @return Bool True if the user has new messages
1755 public function getNewtalk() {
1758 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1759 if( $this->mNewtalk
=== -1 ) {
1760 $this->mNewtalk
= false; # reset talk page status
1762 # Check memcached separately for anons, who have no
1763 # entire User object stored in there.
1765 global $wgDisableAnonTalk;
1766 if( $wgDisableAnonTalk ) {
1767 // Anon newtalk disabled by configuration.
1768 $this->mNewtalk
= false;
1771 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1772 $newtalk = $wgMemc->get( $key );
1773 if( strval( $newtalk ) !== '' ) {
1774 $this->mNewtalk
= (bool)$newtalk;
1776 // Since we are caching this, make sure it is up to date by getting it
1778 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1779 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1783 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1787 return (bool)$this->mNewtalk
;
1791 * Return the talk page(s) this user has new messages on.
1792 * @return Array of String page URLs
1794 public function getNewMessageLinks() {
1796 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1798 } elseif( !$this->getNewtalk() ) {
1801 $utp = $this->getTalkPage();
1802 $dbr = wfGetDB( DB_SLAVE
);
1803 // Get the "last viewed rev" timestamp from the oldest message notification
1804 $timestamp = $dbr->selectField( 'user_newtalk',
1805 'MIN(user_last_timestamp)',
1806 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1808 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1809 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1813 * Internal uncached check for new messages
1816 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1817 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1818 * @param $fromMaster Bool true to fetch from the master, false for a slave
1819 * @return Bool True if the user has new messages
1821 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1822 if ( $fromMaster ) {
1823 $db = wfGetDB( DB_MASTER
);
1825 $db = wfGetDB( DB_SLAVE
);
1827 $ok = $db->selectField( 'user_newtalk', $field,
1828 array( $field => $id ), __METHOD__
);
1829 return $ok !== false;
1833 * Add or update the new messages flag
1834 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1835 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1836 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1837 * @return Bool True if successful, false otherwise
1839 protected function updateNewtalk( $field, $id, $curRev = null ) {
1840 // Get timestamp of the talk page revision prior to the current one
1841 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1842 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1843 // Mark the user as having new messages since this revision
1844 $dbw = wfGetDB( DB_MASTER
);
1845 $dbw->insert( 'user_newtalk',
1846 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1849 if ( $dbw->affectedRows() ) {
1850 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1853 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1859 * Clear the new messages flag for the given user
1860 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1861 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1862 * @return Bool True if successful, false otherwise
1864 protected function deleteNewtalk( $field, $id ) {
1865 $dbw = wfGetDB( DB_MASTER
);
1866 $dbw->delete( 'user_newtalk',
1867 array( $field => $id ),
1869 if ( $dbw->affectedRows() ) {
1870 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1873 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1879 * Update the 'You have new messages!' status.
1880 * @param $val Bool Whether the user has new messages
1881 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1883 public function setNewtalk( $val, $curRev = null ) {
1884 if( wfReadOnly() ) {
1889 $this->mNewtalk
= $val;
1891 if( $this->isAnon() ) {
1893 $id = $this->getName();
1896 $id = $this->getId();
1901 $changed = $this->updateNewtalk( $field, $id, $curRev );
1903 $changed = $this->deleteNewtalk( $field, $id );
1906 if( $this->isAnon() ) {
1907 // Anons have a separate memcached space, since
1908 // user records aren't kept for them.
1909 $key = wfMemcKey( 'newtalk', 'ip', $id );
1910 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1913 $this->invalidateCache();
1918 * Generate a current or new-future timestamp to be stored in the
1919 * user_touched field when we update things.
1920 * @return String Timestamp in TS_MW format
1922 private static function newTouchedTimestamp() {
1923 global $wgClockSkewFudge;
1924 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1928 * Clear user data from memcached.
1929 * Use after applying fun updates to the database; caller's
1930 * responsibility to update user_touched if appropriate.
1932 * Called implicitly from invalidateCache() and saveSettings().
1934 private function clearSharedCache() {
1938 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1943 * Immediately touch the user data cache for this account.
1944 * Updates user_touched field, and removes account data from memcached
1945 * for reload on the next hit.
1947 public function invalidateCache() {
1948 if( wfReadOnly() ) {
1953 $this->mTouched
= self
::newTouchedTimestamp();
1955 $dbw = wfGetDB( DB_MASTER
);
1957 // Prevent contention slams by checking user_touched first
1958 $now = $dbw->timestamp( $this->mTouched
);
1959 $needsPurge = $dbw->selectField( 'user', '1',
1960 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1962 if ( $needsPurge ) {
1963 $dbw->update( 'user',
1964 array( 'user_touched' => $now ),
1965 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1970 $this->clearSharedCache();
1975 * Validate the cache for this account.
1976 * @param $timestamp String A timestamp in TS_MW format
1980 public function validateCache( $timestamp ) {
1982 return ( $timestamp >= $this->mTouched
);
1986 * Get the user touched timestamp
1987 * @return String timestamp
1989 public function getTouched() {
1991 return $this->mTouched
;
1995 * Set the password and reset the random token.
1996 * Calls through to authentication plugin if necessary;
1997 * will have no effect if the auth plugin refuses to
1998 * pass the change through or if the legal password
2001 * As a special case, setting the password to null
2002 * wipes it, so the account cannot be logged in until
2003 * a new password is set, for instance via e-mail.
2005 * @param $str String New password to set
2006 * @throws PasswordError on failure
2010 public function setPassword( $str ) {
2013 if( $str !== null ) {
2014 if( !$wgAuth->allowPasswordChange() ) {
2015 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2018 if( !$this->isValidPassword( $str ) ) {
2019 global $wgMinimalPasswordLength;
2020 $valid = $this->getPasswordValidity( $str );
2021 if ( is_array( $valid ) ) {
2022 $message = array_shift( $valid );
2026 $params = array( $wgMinimalPasswordLength );
2028 throw new PasswordError( wfMessage( $message, $params )->text() );
2032 if( !$wgAuth->setPassword( $this, $str ) ) {
2033 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2036 $this->setInternalPassword( $str );
2042 * Set the password and reset the random token unconditionally.
2044 * @param $str String New password to set
2046 public function setInternalPassword( $str ) {
2050 if( $str === null ) {
2051 // Save an invalid hash...
2052 $this->mPassword
= '';
2054 $this->mPassword
= self
::crypt( $str );
2056 $this->mNewpassword
= '';
2057 $this->mNewpassTime
= null;
2061 * Get the user's current token.
2062 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2063 * @return String Token
2065 public function getToken( $forceCreation = true ) {
2067 if ( !$this->mToken
&& $forceCreation ) {
2070 return $this->mToken
;
2074 * Set the random token (used for persistent authentication)
2075 * Called from loadDefaults() among other places.
2077 * @param $token String|bool If specified, set the token to this value
2079 public function setToken( $token = false ) {
2082 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2084 $this->mToken
= $token;
2089 * Set the password for a password reminder or new account email
2091 * @param $str String New password to set
2092 * @param $throttle Bool If true, reset the throttle timestamp to the present
2094 public function setNewpassword( $str, $throttle = true ) {
2096 $this->mNewpassword
= self
::crypt( $str );
2098 $this->mNewpassTime
= wfTimestampNow();
2103 * Has password reminder email been sent within the last
2104 * $wgPasswordReminderResendTime hours?
2107 public function isPasswordReminderThrottled() {
2108 global $wgPasswordReminderResendTime;
2110 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2113 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2114 return time() < $expiry;
2118 * Get the user's e-mail address
2119 * @return String User's email address
2121 public function getEmail() {
2123 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2124 return $this->mEmail
;
2128 * Get the timestamp of the user's e-mail authentication
2129 * @return String TS_MW timestamp
2131 public function getEmailAuthenticationTimestamp() {
2133 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2134 return $this->mEmailAuthenticated
;
2138 * Set the user's e-mail address
2139 * @param $str String New e-mail address
2141 public function setEmail( $str ) {
2143 if( $str == $this->mEmail
) {
2146 $this->mEmail
= $str;
2147 $this->invalidateEmail();
2148 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2152 * Set the user's e-mail address and a confirmation mail if needed.
2155 * @param $str String New e-mail address
2158 public function setEmailWithConfirmation( $str ) {
2159 global $wgEnableEmail, $wgEmailAuthentication;
2161 if ( !$wgEnableEmail ) {
2162 return Status
::newFatal( 'emaildisabled' );
2165 $oldaddr = $this->getEmail();
2166 if ( $str === $oldaddr ) {
2167 return Status
::newGood( true );
2170 $this->setEmail( $str );
2172 if ( $str !== '' && $wgEmailAuthentication ) {
2173 # Send a confirmation request to the new address if needed
2174 $type = $oldaddr != '' ?
'changed' : 'set';
2175 $result = $this->sendConfirmationMail( $type );
2176 if ( $result->isGood() ) {
2177 # Say the the caller that a confirmation mail has been sent
2178 $result->value
= 'eauth';
2181 $result = Status
::newGood( true );
2188 * Get the user's real name
2189 * @return String User's real name
2191 public function getRealName() {
2192 if ( !$this->isItemLoaded( 'realname' ) ) {
2196 return $this->mRealName
;
2200 * Set the user's real name
2201 * @param $str String New real name
2203 public function setRealName( $str ) {
2205 $this->mRealName
= $str;
2209 * Get the user's current setting for a given option.
2211 * @param $oname String The option to check
2212 * @param $defaultOverride String A default value returned if the option does not exist
2213 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2214 * @return String User's current value for the option
2215 * @see getBoolOption()
2216 * @see getIntOption()
2218 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2219 global $wgHiddenPrefs;
2220 $this->loadOptions();
2222 if ( is_null( $this->mOptions
) ) {
2223 if($defaultOverride != '') {
2224 return $defaultOverride;
2226 $this->mOptions
= User
::getDefaultOptions();
2229 # We want 'disabled' preferences to always behave as the default value for
2230 # users, even if they have set the option explicitly in their settings (ie they
2231 # set it, and then it was disabled removing their ability to change it). But
2232 # we don't want to erase the preferences in the database in case the preference
2233 # is re-enabled again. So don't touch $mOptions, just override the returned value
2234 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2235 return self
::getDefaultOption( $oname );
2238 if ( array_key_exists( $oname, $this->mOptions
) ) {
2239 return $this->mOptions
[$oname];
2241 return $defaultOverride;
2246 * Get all user's options
2250 public function getOptions() {
2251 global $wgHiddenPrefs;
2252 $this->loadOptions();
2253 $options = $this->mOptions
;
2255 # We want 'disabled' preferences to always behave as the default value for
2256 # users, even if they have set the option explicitly in their settings (ie they
2257 # set it, and then it was disabled removing their ability to change it). But
2258 # we don't want to erase the preferences in the database in case the preference
2259 # is re-enabled again. So don't touch $mOptions, just override the returned value
2260 foreach( $wgHiddenPrefs as $pref ){
2261 $default = self
::getDefaultOption( $pref );
2262 if( $default !== null ){
2263 $options[$pref] = $default;
2271 * Get the user's current setting for a given option, as a boolean value.
2273 * @param $oname String The option to check
2274 * @return Bool User's current value for the option
2277 public function getBoolOption( $oname ) {
2278 return (bool)$this->getOption( $oname );
2282 * Get the user's current setting for a given option, as a boolean value.
2284 * @param $oname String The option to check
2285 * @param $defaultOverride Int A default value returned if the option does not exist
2286 * @return Int User's current value for the option
2289 public function getIntOption( $oname, $defaultOverride=0 ) {
2290 $val = $this->getOption( $oname );
2292 $val = $defaultOverride;
2294 return intval( $val );
2298 * Set the given option for a user.
2300 * @param $oname String The option to set
2301 * @param $val mixed New value to set
2303 public function setOption( $oname, $val ) {
2305 $this->loadOptions();
2307 // Explicitly NULL values should refer to defaults
2308 if( is_null( $val ) ) {
2309 $defaultOption = self
::getDefaultOption( $oname );
2310 if( !is_null( $defaultOption ) ) {
2311 $val = $defaultOption;
2315 $this->mOptions
[$oname] = $val;
2319 * Reset all options to the site defaults
2321 public function resetOptions() {
2324 $this->mOptions
= self
::getDefaultOptions();
2325 $this->mOptionsLoaded
= true;
2329 * Get the user's preferred date format.
2330 * @return String User's preferred date format
2332 public function getDatePreference() {
2333 // Important migration for old data rows
2334 if ( is_null( $this->mDatePreference
) ) {
2336 $value = $this->getOption( 'date' );
2337 $map = $wgLang->getDatePreferenceMigrationMap();
2338 if ( isset( $map[$value] ) ) {
2339 $value = $map[$value];
2341 $this->mDatePreference
= $value;
2343 return $this->mDatePreference
;
2347 * Get the user preferred stub threshold
2351 public function getStubThreshold() {
2352 global $wgMaxArticleSize; # Maximum article size, in Kb
2353 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2354 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2355 # If they have set an impossible value, disable the preference
2356 # so we can use the parser cache again.
2363 * Get the permissions this user has.
2364 * @return Array of String permission names
2366 public function getRights() {
2367 if ( is_null( $this->mRights
) ) {
2368 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2369 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2370 // Force reindexation of rights when a hook has unset one of them
2371 $this->mRights
= array_values( $this->mRights
);
2373 return $this->mRights
;
2377 * Get the list of explicit group memberships this user has.
2378 * The implicit * and user groups are not included.
2379 * @return Array of String internal group names
2381 public function getGroups() {
2383 $this->loadGroups();
2384 return $this->mGroups
;
2388 * Get the list of implicit group memberships this user has.
2389 * This includes all explicit groups, plus 'user' if logged in,
2390 * '*' for all accounts, and autopromoted groups
2391 * @param $recache Bool Whether to avoid the cache
2392 * @return Array of String internal group names
2394 public function getEffectiveGroups( $recache = false ) {
2395 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2396 wfProfileIn( __METHOD__
);
2397 $this->mEffectiveGroups
= array_unique( array_merge(
2398 $this->getGroups(), // explicit groups
2399 $this->getAutomaticGroups( $recache ) // implicit groups
2401 # Hook for additional groups
2402 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2403 wfProfileOut( __METHOD__
);
2405 return $this->mEffectiveGroups
;
2409 * Get the list of implicit group memberships this user has.
2410 * This includes 'user' if logged in, '*' for all accounts,
2411 * and autopromoted groups
2412 * @param $recache Bool Whether to avoid the cache
2413 * @return Array of String internal group names
2415 public function getAutomaticGroups( $recache = false ) {
2416 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2417 wfProfileIn( __METHOD__
);
2418 $this->mImplicitGroups
= array( '*' );
2419 if ( $this->getId() ) {
2420 $this->mImplicitGroups
[] = 'user';
2422 $this->mImplicitGroups
= array_unique( array_merge(
2423 $this->mImplicitGroups
,
2424 Autopromote
::getAutopromoteGroups( $this )
2428 # Assure data consistency with rights/groups,
2429 # as getEffectiveGroups() depends on this function
2430 $this->mEffectiveGroups
= null;
2432 wfProfileOut( __METHOD__
);
2434 return $this->mImplicitGroups
;
2438 * Returns the groups the user has belonged to.
2440 * The user may still belong to the returned groups. Compare with getGroups().
2442 * The function will not return groups the user had belonged to before MW 1.17
2444 * @return array Names of the groups the user has belonged to.
2446 public function getFormerGroups() {
2447 if( is_null( $this->mFormerGroups
) ) {
2448 $dbr = wfGetDB( DB_MASTER
);
2449 $res = $dbr->select( 'user_former_groups',
2450 array( 'ufg_group' ),
2451 array( 'ufg_user' => $this->mId
),
2453 $this->mFormerGroups
= array();
2454 foreach( $res as $row ) {
2455 $this->mFormerGroups
[] = $row->ufg_group
;
2458 return $this->mFormerGroups
;
2462 * Get the user's edit count.
2465 public function getEditCount() {
2466 if( $this->getId() ) {
2467 if ( !isset( $this->mEditCount
) ) {
2468 /* Populate the count, if it has not been populated yet */
2469 $this->mEditCount
= User
::edits( $this->mId
);
2471 return $this->mEditCount
;
2479 * Add the user to the given group.
2480 * This takes immediate effect.
2481 * @param $group String Name of the group to add
2483 public function addGroup( $group ) {
2484 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2485 $dbw = wfGetDB( DB_MASTER
);
2486 if( $this->getId() ) {
2487 $dbw->insert( 'user_groups',
2489 'ug_user' => $this->getID(),
2490 'ug_group' => $group,
2493 array( 'IGNORE' ) );
2496 $this->loadGroups();
2497 $this->mGroups
[] = $group;
2498 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2500 $this->invalidateCache();
2504 * Remove the user from the given group.
2505 * This takes immediate effect.
2506 * @param $group String Name of the group to remove
2508 public function removeGroup( $group ) {
2510 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2511 $dbw = wfGetDB( DB_MASTER
);
2512 $dbw->delete( 'user_groups',
2514 'ug_user' => $this->getID(),
2515 'ug_group' => $group,
2517 // Remember that the user was in this group
2518 $dbw->insert( 'user_former_groups',
2520 'ufg_user' => $this->getID(),
2521 'ufg_group' => $group,
2524 array( 'IGNORE' ) );
2526 $this->loadGroups();
2527 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2528 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2530 $this->invalidateCache();
2534 * Get whether the user is logged in
2537 public function isLoggedIn() {
2538 return $this->getID() != 0;
2542 * Get whether the user is anonymous
2545 public function isAnon() {
2546 return !$this->isLoggedIn();
2550 * Check if user is allowed to access a feature / make an action
2552 * @internal param \String $varargs permissions to test
2553 * @return Boolean: True if user is allowed to perform *any* of the given actions
2557 public function isAllowedAny( /*...*/ ){
2558 $permissions = func_get_args();
2559 foreach( $permissions as $permission ){
2560 if( $this->isAllowed( $permission ) ){
2569 * @internal param $varargs string
2570 * @return bool True if the user is allowed to perform *all* of the given actions
2572 public function isAllowedAll( /*...*/ ){
2573 $permissions = func_get_args();
2574 foreach( $permissions as $permission ){
2575 if( !$this->isAllowed( $permission ) ){
2583 * Internal mechanics of testing a permission
2584 * @param $action String
2587 public function isAllowed( $action = '' ) {
2588 if ( $action === '' ) {
2589 return true; // In the spirit of DWIM
2591 # Patrolling may not be enabled
2592 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2593 global $wgUseRCPatrol, $wgUseNPPatrol;
2594 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2597 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2598 # by misconfiguration: 0 == 'foo'
2599 return in_array( $action, $this->getRights(), true );
2603 * Check whether to enable recent changes patrol features for this user
2604 * @return Boolean: True or false
2606 public function useRCPatrol() {
2607 global $wgUseRCPatrol;
2608 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2612 * Check whether to enable new pages patrol features for this user
2613 * @return Bool True or false
2615 public function useNPPatrol() {
2616 global $wgUseRCPatrol, $wgUseNPPatrol;
2617 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2621 * Get the WebRequest object to use with this object
2623 * @return WebRequest
2625 public function getRequest() {
2626 if ( $this->mRequest
) {
2627 return $this->mRequest
;
2635 * Get the current skin, loading it if required
2636 * @return Skin The current skin
2637 * @todo FIXME: Need to check the old failback system [AV]
2638 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2640 public function getSkin() {
2641 wfDeprecated( __METHOD__
, '1.18' );
2642 return RequestContext
::getMain()->getSkin();
2646 * Get a WatchedItem for this user and $title.
2648 * @param $title Title
2649 * @return WatchedItem
2651 public function getWatchedItem( $title ) {
2652 $key = $title->getNamespace() . ':' . $title->getDBkey();
2654 if ( isset( $this->mWatchedItems
[$key] ) ) {
2655 return $this->mWatchedItems
[$key];
2658 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2659 $this->mWatchedItems
= array();
2662 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2663 return $this->mWatchedItems
[$key];
2667 * Check the watched status of an article.
2668 * @param $title Title of the article to look at
2671 public function isWatched( $title ) {
2672 return $this->getWatchedItem( $title )->isWatched();
2677 * @param $title Title of the article to look at
2679 public function addWatch( $title ) {
2680 $this->getWatchedItem( $title )->addWatch();
2681 $this->invalidateCache();
2685 * Stop watching an article.
2686 * @param $title Title of the article to look at
2688 public function removeWatch( $title ) {
2689 $this->getWatchedItem( $title )->removeWatch();
2690 $this->invalidateCache();
2694 * Clear the user's notification timestamp for the given title.
2695 * If e-notif e-mails are on, they will receive notification mails on
2696 * the next change of the page if it's watched etc.
2697 * @param $title Title of the article to look at
2699 public function clearNotification( &$title ) {
2700 global $wgUseEnotif, $wgShowUpdatedMarker;
2702 # Do nothing if the database is locked to writes
2703 if( wfReadOnly() ) {
2707 if( $title->getNamespace() == NS_USER_TALK
&&
2708 $title->getText() == $this->getName() ) {
2709 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2711 $this->setNewtalk( false );
2714 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2718 if( $this->isAnon() ) {
2719 // Nothing else to do...
2723 // Only update the timestamp if the page is being watched.
2724 // The query to find out if it is watched is cached both in memcached and per-invocation,
2725 // and when it does have to be executed, it can be on a slave
2726 // If this is the user's newtalk page, we always update the timestamp
2728 if ( $title->getNamespace() == NS_USER_TALK
&&
2729 $title->getText() == $this->getName() )
2734 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2738 * Resets all of the given user's page-change notification timestamps.
2739 * If e-notif e-mails are on, they will receive notification mails on
2740 * the next change of any watched page.
2742 public function clearAllNotifications() {
2743 global $wgUseEnotif, $wgShowUpdatedMarker;
2744 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2745 $this->setNewtalk( false );
2748 $id = $this->getId();
2750 $dbw = wfGetDB( DB_MASTER
);
2751 $dbw->update( 'watchlist',
2753 'wl_notificationtimestamp' => null
2754 ), array( /* WHERE */
2758 # We also need to clear here the "you have new message" notification for the own user_talk page
2759 # This is cleared one page view later in Article::viewUpdates();
2764 * Set this user's options from an encoded string
2765 * @param $str String Encoded options to import
2767 * @deprecated in 1.19 due to removal of user_options from the user table
2769 private function decodeOptions( $str ) {
2770 wfDeprecated( __METHOD__
, '1.19' );
2774 $this->mOptionsLoaded
= true;
2775 $this->mOptionOverrides
= array();
2777 // If an option is not set in $str, use the default value
2778 $this->mOptions
= self
::getDefaultOptions();
2780 $a = explode( "\n", $str );
2781 foreach ( $a as $s ) {
2783 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2784 $this->mOptions
[$m[1]] = $m[2];
2785 $this->mOptionOverrides
[$m[1]] = $m[2];
2791 * Set a cookie on the user's client. Wrapper for
2792 * WebResponse::setCookie
2793 * @param $name String Name of the cookie to set
2794 * @param $value String Value to set
2795 * @param $exp Int Expiration time, as a UNIX time value;
2796 * if 0 or not specified, use the default $wgCookieExpiration
2797 * @param $secure Bool
2798 * true: Force setting the secure attribute when setting the cookie
2799 * false: Force NOT setting the secure attribute when setting the cookie
2800 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
2802 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
2803 $this->getRequest()->response()->setcookie( $name, $value, $exp, null, null, $secure );
2807 * Clear a cookie on the user's client
2808 * @param $name String Name of the cookie to clear
2810 protected function clearCookie( $name ) {
2811 $this->setCookie( $name, '', time() - 86400 );
2815 * Set the default cookies for this session on the user's client.
2817 * @param $request WebRequest object to use; $wgRequest will be used if null
2819 * @param $secure Whether to force secure/insecure cookies or use default
2821 public function setCookies( $request = null, $secure = null ) {
2822 if ( $request === null ) {
2823 $request = $this->getRequest();
2827 if ( 0 == $this->mId
) return;
2828 if ( !$this->mToken
) {
2829 // When token is empty or NULL generate a new one and then save it to the database
2830 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2831 // Simply by setting every cell in the user_token column to NULL and letting them be
2832 // regenerated as users log back into the wiki.
2834 $this->saveSettings();
2837 'wsUserID' => $this->mId
,
2838 'wsToken' => $this->mToken
,
2839 'wsUserName' => $this->getName()
2842 'UserID' => $this->mId
,
2843 'UserName' => $this->getName(),
2845 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2846 $cookies['Token'] = $this->mToken
;
2848 $cookies['Token'] = false;
2851 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2853 foreach ( $session as $name => $value ) {
2854 $request->setSessionData( $name, $value );
2856 foreach ( $cookies as $name => $value ) {
2857 if ( $value === false ) {
2858 $this->clearCookie( $name );
2860 $this->setCookie( $name, $value, 0, $secure );
2865 * If wpStickHTTPS was selected, also set an insecure cookie that
2866 * will cause the site to redirect the user to HTTPS, if they access
2867 * it over HTTP. Bug 29898.
2869 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
2870 $this->setCookie( 'forceHTTPS', 'true', time() +
2592000, false ); //30 days
2875 * Log this user out.
2877 public function logout() {
2878 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2884 * Clear the user's cookies and session, and reset the instance cache.
2887 public function doLogout() {
2888 $this->clearInstanceCache( 'defaults' );
2890 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2892 $this->clearCookie( 'UserID' );
2893 $this->clearCookie( 'Token' );
2894 $this->clearCookie( 'forceHTTPS' );
2896 # Remember when user logged out, to prevent seeing cached pages
2897 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2901 * Save this user's settings into the database.
2902 * @todo Only rarely do all these fields need to be set!
2904 public function saveSettings() {
2908 if ( wfReadOnly() ) { return; }
2909 if ( 0 == $this->mId
) { return; }
2911 $this->mTouched
= self
::newTouchedTimestamp();
2912 if ( !$wgAuth->allowSetLocalPassword() ) {
2913 $this->mPassword
= '';
2916 $dbw = wfGetDB( DB_MASTER
);
2917 $dbw->update( 'user',
2919 'user_name' => $this->mName
,
2920 'user_password' => $this->mPassword
,
2921 'user_newpassword' => $this->mNewpassword
,
2922 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2923 'user_real_name' => $this->mRealName
,
2924 'user_email' => $this->mEmail
,
2925 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2926 'user_touched' => $dbw->timestamp( $this->mTouched
),
2927 'user_token' => strval( $this->mToken
),
2928 'user_email_token' => $this->mEmailToken
,
2929 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2930 ), array( /* WHERE */
2931 'user_id' => $this->mId
2935 $this->saveOptions();
2937 wfRunHooks( 'UserSaveSettings', array( $this ) );
2938 $this->clearSharedCache();
2939 $this->getUserPage()->invalidateCache();
2943 * If only this user's username is known, and it exists, return the user ID.
2946 public function idForName() {
2947 $s = trim( $this->getName() );
2948 if ( $s === '' ) return 0;
2950 $dbr = wfGetDB( DB_SLAVE
);
2951 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2952 if ( $id === false ) {
2959 * Add a user to the database, return the user object
2961 * @param $name String Username to add
2962 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2963 * - password The user's password hash. Password logins will be disabled if this is omitted.
2964 * - newpassword Hash for a temporary password that has been mailed to the user
2965 * - email The user's email address
2966 * - email_authenticated The email authentication timestamp
2967 * - real_name The user's real name
2968 * - options An associative array of non-default options
2969 * - token Random authentication token. Do not set.
2970 * - registration Registration timestamp. Do not set.
2972 * @return User object, or null if the username already exists
2974 public static function createNew( $name, $params = array() ) {
2977 if ( isset( $params['options'] ) ) {
2978 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2979 unset( $params['options'] );
2981 $dbw = wfGetDB( DB_MASTER
);
2982 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2985 'user_id' => $seqVal,
2986 'user_name' => $name,
2987 'user_password' => $user->mPassword
,
2988 'user_newpassword' => $user->mNewpassword
,
2989 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2990 'user_email' => $user->mEmail
,
2991 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2992 'user_real_name' => $user->mRealName
,
2993 'user_token' => strval( $user->mToken
),
2994 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2995 'user_editcount' => 0,
2996 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
2998 foreach ( $params as $name => $value ) {
2999 $fields["user_$name"] = $value;
3001 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3002 if ( $dbw->affectedRows() ) {
3003 $newUser = User
::newFromId( $dbw->insertId() );
3011 * Add this existing user object to the database. If the user already
3012 * exists, a fatal status object is returned, and the user object is
3013 * initialised with the data from the database.
3015 * Previously, this function generated a DB error due to a key conflict
3016 * if the user already existed. Many extension callers use this function
3017 * in code along the lines of:
3019 * $user = User::newFromName( $name );
3020 * if ( !$user->isLoggedIn() ) {
3021 * $user->addToDatabase();
3023 * // do something with $user...
3025 * However, this was vulnerable to a race condition (bug 16020). By
3026 * initialising the user object if the user exists, we aim to support this
3027 * calling sequence as far as possible.
3029 * Note that if the user exists, this function will acquire a write lock,
3030 * so it is still advisable to make the call conditional on isLoggedIn(),
3031 * and to commit the transaction after calling.
3035 public function addToDatabase() {
3038 $this->mTouched
= self
::newTouchedTimestamp();
3040 $dbw = wfGetDB( DB_MASTER
);
3041 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3042 $dbw->insert( 'user',
3044 'user_id' => $seqVal,
3045 'user_name' => $this->mName
,
3046 'user_password' => $this->mPassword
,
3047 'user_newpassword' => $this->mNewpassword
,
3048 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3049 'user_email' => $this->mEmail
,
3050 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3051 'user_real_name' => $this->mRealName
,
3052 'user_token' => strval( $this->mToken
),
3053 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3054 'user_editcount' => 0,
3055 'user_touched' => $dbw->timestamp( $this->mTouched
),
3059 if ( !$dbw->affectedRows() ) {
3060 $this->mId
= $dbw->selectField( 'user', 'user_id',
3061 array( 'user_name' => $this->mName
), __METHOD__
);
3064 if ( $this->loadFromDatabase() ) {
3069 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3070 "to insert a user row, but then it doesn't exist when we select it!" );
3072 return Status
::newFatal( 'userexists' );
3074 $this->mId
= $dbw->insertId();
3076 // Clear instance cache other than user table data, which is already accurate
3077 $this->clearInstanceCache();
3079 $this->saveOptions();
3080 return Status
::newGood();
3084 * If this user is logged-in and blocked,
3085 * block any IP address they've successfully logged in from.
3086 * @return bool A block was spread
3088 public function spreadAnyEditBlock() {
3089 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3090 return $this->spreadBlock();
3096 * If this (non-anonymous) user is blocked,
3097 * block the IP address they've successfully logged in from.
3098 * @return bool A block was spread
3100 protected function spreadBlock() {
3101 wfDebug( __METHOD__
. "()\n" );
3103 if ( $this->mId
== 0 ) {
3107 $userblock = Block
::newFromTarget( $this->getName() );
3108 if ( !$userblock ) {
3112 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3116 * Generate a string which will be different for any combination of
3117 * user options which would produce different parser output.
3118 * This will be used as part of the hash key for the parser cache,
3119 * so users with the same options can share the same cached data
3122 * Extensions which require it should install 'PageRenderingHash' hook,
3123 * which will give them a chance to modify this key based on their own
3126 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3127 * @return String Page rendering hash
3129 public function getPageRenderingHash() {
3130 wfDeprecated( __METHOD__
, '1.17' );
3132 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3134 return $this->mHash
;
3137 // stubthreshold is only included below for completeness,
3138 // since it disables the parser cache, its value will always
3139 // be 0 when this function is called by parsercache.
3141 $confstr = $this->getOption( 'math' );
3142 $confstr .= '!' . $this->getStubThreshold();
3143 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3144 $confstr .= '!' . $this->getDatePreference();
3146 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3147 $confstr .= '!' . $wgLang->getCode();
3148 $confstr .= '!' . $this->getOption( 'thumbsize' );
3149 // add in language specific options, if any
3150 $extra = $wgContLang->getExtraHashOptions();
3153 // Since the skin could be overloading link(), it should be
3154 // included here but in practice, none of our skins do that.
3156 $confstr .= $wgRenderHashAppend;
3158 // Give a chance for extensions to modify the hash, if they have
3159 // extra options or other effects on the parser cache.
3160 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3162 // Make it a valid memcached key fragment
3163 $confstr = str_replace( ' ', '_', $confstr );
3164 $this->mHash
= $confstr;
3169 * Get whether the user is explicitly blocked from account creation.
3170 * @return Bool|Block
3172 public function isBlockedFromCreateAccount() {
3173 $this->getBlockedStatus();
3174 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3175 return $this->mBlock
;
3178 # bug 13611: if the IP address the user is trying to create an account from is
3179 # blocked with createaccount disabled, prevent new account creation there even
3180 # when the user is logged in
3181 if( $this->mBlockedFromCreateAccount
=== false ){
3182 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3184 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3185 ?
$this->mBlockedFromCreateAccount
3190 * Get whether the user is blocked from using Special:Emailuser.
3193 public function isBlockedFromEmailuser() {
3194 $this->getBlockedStatus();
3195 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3199 * Get whether the user is allowed to create an account.
3202 function isAllowedToCreateAccount() {
3203 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3207 * Get this user's personal page title.
3209 * @return Title: User's personal page title
3211 public function getUserPage() {
3212 return Title
::makeTitle( NS_USER
, $this->getName() );
3216 * Get this user's talk page title.
3218 * @return Title: User's talk page title
3220 public function getTalkPage() {
3221 $title = $this->getUserPage();
3222 return $title->getTalkPage();
3226 * Determine whether the user is a newbie. Newbies are either
3227 * anonymous IPs, or the most recently created accounts.
3230 public function isNewbie() {
3231 return !$this->isAllowed( 'autoconfirmed' );
3235 * Check to see if the given clear-text password is one of the accepted passwords
3236 * @param $password String: user password.
3237 * @return Boolean: True if the given password is correct, otherwise False.
3239 public function checkPassword( $password ) {
3240 global $wgAuth, $wgLegacyEncoding;
3243 // Even though we stop people from creating passwords that
3244 // are shorter than this, doesn't mean people wont be able
3245 // to. Certain authentication plugins do NOT want to save
3246 // domain passwords in a mysql database, so we should
3247 // check this (in case $wgAuth->strict() is false).
3248 if( !$this->isValidPassword( $password ) ) {
3252 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3254 } elseif( $wgAuth->strict() ) {
3255 /* Auth plugin doesn't allow local authentication */
3257 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3258 /* Auth plugin doesn't allow local authentication for this user name */
3261 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3263 } elseif ( $wgLegacyEncoding ) {
3264 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3265 # Check for this with iconv
3266 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3267 if ( $cp1252Password != $password &&
3268 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3277 * Check if the given clear-text password matches the temporary password
3278 * sent by e-mail for password reset operations.
3280 * @param $plaintext string
3282 * @return Boolean: True if matches, false otherwise
3284 public function checkTemporaryPassword( $plaintext ) {
3285 global $wgNewPasswordExpiry;
3288 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3289 if ( is_null( $this->mNewpassTime
) ) {
3292 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3293 return ( time() < $expiry );
3300 * Alias for getEditToken.
3301 * @deprecated since 1.19, use getEditToken instead.
3303 * @param $salt String|Array of Strings Optional function-specific data for hashing
3304 * @param $request WebRequest object to use or null to use $wgRequest
3305 * @return String The new edit token
3307 public function editToken( $salt = '', $request = null ) {
3308 wfDeprecated( __METHOD__
, '1.19' );
3309 return $this->getEditToken( $salt, $request );
3313 * Initialize (if necessary) and return a session token value
3314 * which can be used in edit forms to show that the user's
3315 * login credentials aren't being hijacked with a foreign form
3320 * @param $salt String|Array of Strings Optional function-specific data for hashing
3321 * @param $request WebRequest object to use or null to use $wgRequest
3322 * @return String The new edit token
3324 public function getEditToken( $salt = '', $request = null ) {
3325 if ( $request == null ) {
3326 $request = $this->getRequest();
3329 if ( $this->isAnon() ) {
3330 return EDIT_TOKEN_SUFFIX
;
3332 $token = $request->getSessionData( 'wsEditToken' );
3333 if ( $token === null ) {
3334 $token = MWCryptRand
::generateHex( 32 );
3335 $request->setSessionData( 'wsEditToken', $token );
3337 if( is_array( $salt ) ) {
3338 $salt = implode( '|', $salt );
3340 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3345 * Generate a looking random token for various uses.
3347 * @param $salt String Optional salt value
3348 * @return String The new random token
3349 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3351 public static function generateToken( $salt = '' ) {
3352 return MWCryptRand
::generateHex( 32 );
3356 * Check given value against the token value stored in the session.
3357 * A match should confirm that the form was submitted from the
3358 * user's own login session, not a form submission from a third-party
3361 * @param $val String Input value to compare
3362 * @param $salt String Optional function-specific data for hashing
3363 * @param $request WebRequest object to use or null to use $wgRequest
3364 * @return Boolean: Whether the token matches
3366 public function matchEditToken( $val, $salt = '', $request = null ) {
3367 $sessionToken = $this->getEditToken( $salt, $request );
3368 if ( $val != $sessionToken ) {
3369 wfDebug( "User::matchEditToken: broken session data\n" );
3371 return $val == $sessionToken;
3375 * Check given value against the token value stored in the session,
3376 * ignoring the suffix.
3378 * @param $val String Input value to compare
3379 * @param $salt String Optional function-specific data for hashing
3380 * @param $request WebRequest object to use or null to use $wgRequest
3381 * @return Boolean: Whether the token matches
3383 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3384 $sessionToken = $this->getEditToken( $salt, $request );
3385 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3389 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3390 * mail to the user's given address.
3392 * @param $type String: message to send, either "created", "changed" or "set"
3393 * @return Status object
3395 public function sendConfirmationMail( $type = 'created' ) {
3397 $expiration = null; // gets passed-by-ref and defined in next line.
3398 $token = $this->confirmationToken( $expiration );
3399 $url = $this->confirmationTokenUrl( $token );
3400 $invalidateURL = $this->invalidationTokenUrl( $token );
3401 $this->saveSettings();
3403 if ( $type == 'created' ||
$type === false ) {
3404 $message = 'confirmemail_body';
3405 } elseif ( $type === true ) {
3406 $message = 'confirmemail_body_changed';
3408 $message = 'confirmemail_body_' . $type;
3411 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3412 wfMessage( $message,
3413 $this->getRequest()->getIP(),
3416 $wgLang->timeanddate( $expiration, false ),
3418 $wgLang->date( $expiration, false ),
3419 $wgLang->time( $expiration, false ) )->text() );
3423 * Send an e-mail to this user's account. Does not check for
3424 * confirmed status or validity.
3426 * @param $subject String Message subject
3427 * @param $body String Message body
3428 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3429 * @param $replyto String Reply-To address
3432 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3433 if( is_null( $from ) ) {
3434 global $wgPasswordSender, $wgPasswordSenderName;
3435 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3437 $sender = new MailAddress( $from );
3440 $to = new MailAddress( $this );
3441 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3445 * Generate, store, and return a new e-mail confirmation code.
3446 * A hash (unsalted, since it's used as a key) is stored.
3448 * @note Call saveSettings() after calling this function to commit
3449 * this change to the database.
3451 * @param &$expiration \mixed Accepts the expiration time
3452 * @return String New token
3454 private function confirmationToken( &$expiration ) {
3455 global $wgUserEmailConfirmationTokenExpiry;
3457 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3458 $expiration = wfTimestamp( TS_MW
, $expires );
3460 $token = MWCryptRand
::generateHex( 32 );
3461 $hash = md5( $token );
3462 $this->mEmailToken
= $hash;
3463 $this->mEmailTokenExpires
= $expiration;
3468 * Return a URL the user can use to confirm their email address.
3469 * @param $token String Accepts the email confirmation token
3470 * @return String New token URL
3472 private function confirmationTokenUrl( $token ) {
3473 return $this->getTokenUrl( 'ConfirmEmail', $token );
3477 * Return a URL the user can use to invalidate their email address.
3478 * @param $token String Accepts the email confirmation token
3479 * @return String New token URL
3481 private function invalidationTokenUrl( $token ) {
3482 return $this->getTokenUrl( 'InvalidateEmail', $token );
3486 * Internal function to format the e-mail validation/invalidation URLs.
3487 * This uses a quickie hack to use the
3488 * hardcoded English names of the Special: pages, for ASCII safety.
3490 * @note Since these URLs get dropped directly into emails, using the
3491 * short English names avoids insanely long URL-encoded links, which
3492 * also sometimes can get corrupted in some browsers/mailers
3493 * (bug 6957 with Gmail and Internet Explorer).
3495 * @param $page String Special page
3496 * @param $token String Token
3497 * @return String Formatted URL
3499 protected function getTokenUrl( $page, $token ) {
3500 // Hack to bypass localization of 'Special:'
3501 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3502 return $title->getCanonicalUrl();
3506 * Mark the e-mail address confirmed.
3508 * @note Call saveSettings() after calling this function to commit the change.
3512 public function confirmEmail() {
3513 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3514 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3519 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3520 * address if it was already confirmed.
3522 * @note Call saveSettings() after calling this function to commit the change.
3523 * @return bool Returns true
3525 function invalidateEmail() {
3527 $this->mEmailToken
= null;
3528 $this->mEmailTokenExpires
= null;
3529 $this->setEmailAuthenticationTimestamp( null );
3530 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3535 * Set the e-mail authentication timestamp.
3536 * @param $timestamp String TS_MW timestamp
3538 function setEmailAuthenticationTimestamp( $timestamp ) {
3540 $this->mEmailAuthenticated
= $timestamp;
3541 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3545 * Is this user allowed to send e-mails within limits of current
3546 * site configuration?
3549 public function canSendEmail() {
3550 global $wgEnableEmail, $wgEnableUserEmail;
3551 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3554 $canSend = $this->isEmailConfirmed();
3555 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3560 * Is this user allowed to receive e-mails within limits of current
3561 * site configuration?
3564 public function canReceiveEmail() {
3565 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3569 * Is this user's e-mail address valid-looking and confirmed within
3570 * limits of the current site configuration?
3572 * @note If $wgEmailAuthentication is on, this may require the user to have
3573 * confirmed their address by returning a code or using a password
3574 * sent to the address from the wiki.
3578 public function isEmailConfirmed() {
3579 global $wgEmailAuthentication;
3582 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3583 if( $this->isAnon() ) {
3586 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3589 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3599 * Check whether there is an outstanding request for e-mail confirmation.
3602 public function isEmailConfirmationPending() {
3603 global $wgEmailAuthentication;
3604 return $wgEmailAuthentication &&
3605 !$this->isEmailConfirmed() &&
3606 $this->mEmailToken
&&
3607 $this->mEmailTokenExpires
> wfTimestamp();
3611 * Get the timestamp of account creation.
3613 * @return String|Bool Timestamp of account creation, or false for
3614 * non-existent/anonymous user accounts.
3616 public function getRegistration() {
3617 if ( $this->isAnon() ) {
3621 return $this->mRegistration
;
3625 * Get the timestamp of the first edit
3627 * @return String|Bool Timestamp of first edit, or false for
3628 * non-existent/anonymous user accounts.
3630 public function getFirstEditTimestamp() {
3631 if( $this->getId() == 0 ) {
3632 return false; // anons
3634 $dbr = wfGetDB( DB_SLAVE
);
3635 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3636 array( 'rev_user' => $this->getId() ),
3638 array( 'ORDER BY' => 'rev_timestamp ASC' )
3641 return false; // no edits
3643 return wfTimestamp( TS_MW
, $time );
3647 * Get the permissions associated with a given list of groups
3649 * @param $groups Array of Strings List of internal group names
3650 * @return Array of Strings List of permission key names for given groups combined
3652 public static function getGroupPermissions( $groups ) {
3653 global $wgGroupPermissions, $wgRevokePermissions;
3655 // grant every granted permission first
3656 foreach( $groups as $group ) {
3657 if( isset( $wgGroupPermissions[$group] ) ) {
3658 $rights = array_merge( $rights,
3659 // array_filter removes empty items
3660 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3663 // now revoke the revoked permissions
3664 foreach( $groups as $group ) {
3665 if( isset( $wgRevokePermissions[$group] ) ) {
3666 $rights = array_diff( $rights,
3667 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3670 return array_unique( $rights );
3674 * Get all the groups who have a given permission
3676 * @param $role String Role to check
3677 * @return Array of Strings List of internal group names with the given permission
3679 public static function getGroupsWithPermission( $role ) {
3680 global $wgGroupPermissions;
3681 $allowedGroups = array();
3682 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
3683 if ( self
::groupHasPermission( $group, $role ) ) {
3684 $allowedGroups[] = $group;
3687 return $allowedGroups;
3691 * Check, if the given group has the given permission
3693 * @param $group String Group to check
3694 * @param $role String Role to check
3697 public static function groupHasPermission( $group, $role ) {
3698 global $wgGroupPermissions, $wgRevokePermissions;
3699 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
3700 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
3704 * Get the localized descriptive name for a group, if it exists
3706 * @param $group String Internal group name
3707 * @return String Localized descriptive group name
3709 public static function getGroupName( $group ) {
3710 $msg = wfMessage( "group-$group" );
3711 return $msg->isBlank() ?
$group : $msg->text();
3715 * Get the localized descriptive name for a member of a group, if it exists
3717 * @param $group String Internal group name
3718 * @param $username String Username for gender (since 1.19)
3719 * @return String Localized name for group member
3721 public static function getGroupMember( $group, $username = '#' ) {
3722 $msg = wfMessage( "group-$group-member", $username );
3723 return $msg->isBlank() ?
$group : $msg->text();
3727 * Return the set of defined explicit groups.
3728 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3729 * are not included, as they are defined automatically, not in the database.
3730 * @return Array of internal group names
3732 public static function getAllGroups() {
3733 global $wgGroupPermissions, $wgRevokePermissions;
3735 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3736 self
::getImplicitGroups()
3741 * Get a list of all available permissions.
3742 * @return Array of permission names
3744 public static function getAllRights() {
3745 if ( self
::$mAllRights === false ) {
3746 global $wgAvailableRights;
3747 if ( count( $wgAvailableRights ) ) {
3748 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3750 self
::$mAllRights = self
::$mCoreRights;
3752 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3754 return self
::$mAllRights;
3758 * Get a list of implicit groups
3759 * @return Array of Strings Array of internal group names
3761 public static function getImplicitGroups() {
3762 global $wgImplicitGroups;
3763 $groups = $wgImplicitGroups;
3764 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3769 * Get the title of a page describing a particular group
3771 * @param $group String Internal group name
3772 * @return Title|Bool Title of the page if it exists, false otherwise
3774 public static function getGroupPage( $group ) {
3775 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3776 if( $msg->exists() ) {
3777 $title = Title
::newFromText( $msg->text() );
3778 if( is_object( $title ) )
3785 * Create a link to the group in HTML, if available;
3786 * else return the group name.
3788 * @param $group String Internal name of the group
3789 * @param $text String The text of the link
3790 * @return String HTML link to the group
3792 public static function makeGroupLinkHTML( $group, $text = '' ) {
3794 $text = self
::getGroupName( $group );
3796 $title = self
::getGroupPage( $group );
3798 return Linker
::link( $title, htmlspecialchars( $text ) );
3805 * Create a link to the group in Wikitext, if available;
3806 * else return the group name.
3808 * @param $group String Internal name of the group
3809 * @param $text String The text of the link
3810 * @return String Wikilink to the group
3812 public static function makeGroupLinkWiki( $group, $text = '' ) {
3814 $text = self
::getGroupName( $group );
3816 $title = self
::getGroupPage( $group );
3818 $page = $title->getPrefixedText();
3819 return "[[$page|$text]]";
3826 * Returns an array of the groups that a particular group can add/remove.
3828 * @param $group String: the group to check for whether it can add/remove
3829 * @return Array array( 'add' => array( addablegroups ),
3830 * 'remove' => array( removablegroups ),
3831 * 'add-self' => array( addablegroups to self),
3832 * 'remove-self' => array( removable groups from self) )
3834 public static function changeableByGroup( $group ) {
3835 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3837 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3838 if( empty( $wgAddGroups[$group] ) ) {
3839 // Don't add anything to $groups
3840 } elseif( $wgAddGroups[$group] === true ) {
3841 // You get everything
3842 $groups['add'] = self
::getAllGroups();
3843 } elseif( is_array( $wgAddGroups[$group] ) ) {
3844 $groups['add'] = $wgAddGroups[$group];
3847 // Same thing for remove
3848 if( empty( $wgRemoveGroups[$group] ) ) {
3849 } elseif( $wgRemoveGroups[$group] === true ) {
3850 $groups['remove'] = self
::getAllGroups();
3851 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3852 $groups['remove'] = $wgRemoveGroups[$group];
3855 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3856 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3857 foreach( $wgGroupsAddToSelf as $key => $value ) {
3858 if( is_int( $key ) ) {
3859 $wgGroupsAddToSelf['user'][] = $value;
3864 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3865 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3866 if( is_int( $key ) ) {
3867 $wgGroupsRemoveFromSelf['user'][] = $value;
3872 // Now figure out what groups the user can add to him/herself
3873 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3874 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3875 // No idea WHY this would be used, but it's there
3876 $groups['add-self'] = User
::getAllGroups();
3877 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3878 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3881 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3882 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3883 $groups['remove-self'] = User
::getAllGroups();
3884 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3885 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3892 * Returns an array of groups that this user can add and remove
3893 * @return Array array( 'add' => array( addablegroups ),
3894 * 'remove' => array( removablegroups ),
3895 * 'add-self' => array( addablegroups to self),
3896 * 'remove-self' => array( removable groups from self) )
3898 public function changeableGroups() {
3899 if( $this->isAllowed( 'userrights' ) ) {
3900 // This group gives the right to modify everything (reverse-
3901 // compatibility with old "userrights lets you change
3903 // Using array_merge to make the groups reindexed
3904 $all = array_merge( User
::getAllGroups() );
3908 'add-self' => array(),
3909 'remove-self' => array()
3913 // Okay, it's not so simple, we will have to go through the arrays
3916 'remove' => array(),
3917 'add-self' => array(),
3918 'remove-self' => array()
3920 $addergroups = $this->getEffectiveGroups();
3922 foreach( $addergroups as $addergroup ) {
3923 $groups = array_merge_recursive(
3924 $groups, $this->changeableByGroup( $addergroup )
3926 $groups['add'] = array_unique( $groups['add'] );
3927 $groups['remove'] = array_unique( $groups['remove'] );
3928 $groups['add-self'] = array_unique( $groups['add-self'] );
3929 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3935 * Increment the user's edit-count field.
3936 * Will have no effect for anonymous users.
3938 public function incEditCount() {
3939 if( !$this->isAnon() ) {
3940 $dbw = wfGetDB( DB_MASTER
);
3941 $dbw->update( 'user',
3942 array( 'user_editcount=user_editcount+1' ),
3943 array( 'user_id' => $this->getId() ),
3946 // Lazy initialization check...
3947 if( $dbw->affectedRows() == 0 ) {
3948 // Pull from a slave to be less cruel to servers
3949 // Accuracy isn't the point anyway here
3950 $dbr = wfGetDB( DB_SLAVE
);
3951 $count = $dbr->selectField( 'revision',
3953 array( 'rev_user' => $this->getId() ),
3956 // Now here's a goddamn hack...
3957 if( $dbr !== $dbw ) {
3958 // If we actually have a slave server, the count is
3959 // at least one behind because the current transaction
3960 // has not been committed and replicated.
3963 // But if DB_SLAVE is selecting the master, then the
3964 // count we just read includes the revision that was
3965 // just added in the working transaction.
3968 $dbw->update( 'user',
3969 array( 'user_editcount' => $count ),
3970 array( 'user_id' => $this->getId() ),
3974 // edit count in user cache too
3975 $this->invalidateCache();
3979 * Get the description of a given right
3981 * @param $right String Right to query
3982 * @return String Localized description of the right
3984 public static function getRightDescription( $right ) {
3985 $key = "right-$right";
3986 $msg = wfMessage( $key );
3987 return $msg->isBlank() ?
$right : $msg->text();
3991 * Make an old-style password hash
3993 * @param $password String Plain-text password
3994 * @param $userId String User ID
3995 * @return String Password hash
3997 public static function oldCrypt( $password, $userId ) {
3998 global $wgPasswordSalt;
3999 if ( $wgPasswordSalt ) {
4000 return md5( $userId . '-' . md5( $password ) );
4002 return md5( $password );
4007 * Make a new-style password hash
4009 * @param $password String Plain-text password
4010 * @param bool|string $salt Optional salt, may be random or the user ID.
4012 * If unspecified or false, will generate one automatically
4013 * @return String Password hash
4015 public static function crypt( $password, $salt = false ) {
4016 global $wgPasswordSalt;
4019 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
4023 if( $wgPasswordSalt ) {
4024 if ( $salt === false ) {
4025 $salt = MWCryptRand
::generateHex( 8 );
4027 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
4029 return ':A:' . md5( $password );
4034 * Compare a password hash with a plain-text password. Requires the user
4035 * ID if there's a chance that the hash is an old-style hash.
4037 * @param $hash String Password hash
4038 * @param $password String Plain-text password to compare
4039 * @param $userId String|bool User ID for old-style password salt
4043 public static function comparePasswords( $hash, $password, $userId = false ) {
4044 $type = substr( $hash, 0, 3 );
4047 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4051 if ( $type == ':A:' ) {
4053 return md5( $password ) === substr( $hash, 3 );
4054 } elseif ( $type == ':B:' ) {
4056 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4057 return md5( $salt.'-'.md5( $password ) ) === $realHash;
4060 return self
::oldCrypt( $password, $userId ) === $hash;
4065 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
4067 * @param $byEmail Boolean: account made by email?
4068 * @param $reason String: user supplied reason
4070 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4072 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
4073 global $wgUser, $wgContLang, $wgNewUserLog;
4074 if( empty( $wgNewUserLog ) ) {
4075 return true; // disabled
4078 if( $this->getName() == $wgUser->getName() ) {
4081 $action = 'create2';
4083 if ( $reason === '' ) {
4084 $reason = wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text();
4086 $reason = $wgContLang->commaList( array(
4087 $reason, wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text() ) );
4091 $log = new LogPage( 'newusers' );
4092 return (int)$log->addEntry(
4094 $this->getUserPage(),
4096 array( $this->getId() )
4101 * Add an autocreate newuser log entry for this user
4102 * Used by things like CentralAuth and perhaps other authplugins.
4106 public function addNewUserLogEntryAutoCreate() {
4107 global $wgNewUserLog;
4108 if( !$wgNewUserLog ) {
4109 return true; // disabled
4111 $log = new LogPage( 'newusers', false );
4112 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4119 protected function loadOptions() {
4124 if ( $this->mOptionsLoaded
) {
4128 $this->mOptions
= self
::getDefaultOptions();
4130 if ( !$this->getId() ) {
4131 // For unlogged-in users, load language/variant options from request.
4132 // There's no need to do it for logged-in users: they can set preferences,
4133 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4134 // so don't override user's choice (especially when the user chooses site default).
4135 $variant = $wgContLang->getDefaultVariant();
4136 $this->mOptions
['variant'] = $variant;
4137 $this->mOptions
['language'] = $variant;
4138 $this->mOptionsLoaded
= true;
4142 // Maybe load from the object
4143 if ( !is_null( $this->mOptionOverrides
) ) {
4144 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4145 foreach( $this->mOptionOverrides
as $key => $value ) {
4146 $this->mOptions
[$key] = $value;
4149 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4150 // Load from database
4151 $dbr = wfGetDB( DB_SLAVE
);
4153 $res = $dbr->select(
4155 array( 'up_property', 'up_value' ),
4156 array( 'up_user' => $this->getId() ),
4160 $this->mOptionOverrides
= array();
4161 foreach ( $res as $row ) {
4162 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4163 $this->mOptions
[$row->up_property
] = $row->up_value
;
4167 $this->mOptionsLoaded
= true;
4169 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4175 protected function saveOptions() {
4176 global $wgAllowPrefChange;
4178 $this->loadOptions();
4180 // Not using getOptions(), to keep hidden preferences in database
4181 $saveOptions = $this->mOptions
;
4183 // Allow hooks to abort, for instance to save to a global profile.
4184 // Reset options to default state before saving.
4185 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4189 $extuser = ExternalUser
::newFromUser( $this );
4190 $userId = $this->getId();
4191 $insert_rows = array();
4192 foreach( $saveOptions as $key => $value ) {
4193 # Don't bother storing default values
4194 $defaultOption = self
::getDefaultOption( $key );
4195 if ( ( is_null( $defaultOption ) &&
4196 !( $value === false ||
is_null( $value ) ) ) ||
4197 $value != $defaultOption ) {
4198 $insert_rows[] = array(
4199 'up_user' => $userId,
4200 'up_property' => $key,
4201 'up_value' => $value,
4204 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4205 switch ( $wgAllowPrefChange[$key] ) {
4211 $extuser->setPref( $key, $value );
4216 $dbw = wfGetDB( DB_MASTER
);
4217 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4218 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4222 * Provide an array of HTML5 attributes to put on an input element
4223 * intended for the user to enter a new password. This may include
4224 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4226 * Do *not* use this when asking the user to enter his current password!
4227 * Regardless of configuration, users may have invalid passwords for whatever
4228 * reason (e.g., they were set before requirements were tightened up).
4229 * Only use it when asking for a new password, like on account creation or
4232 * Obviously, you still need to do server-side checking.
4234 * NOTE: A combination of bugs in various browsers means that this function
4235 * actually just returns array() unconditionally at the moment. May as
4236 * well keep it around for when the browser bugs get fixed, though.
4238 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4240 * @return array Array of HTML attributes suitable for feeding to
4241 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4242 * That will potentially output invalid XHTML 1.0 Transitional, and will
4243 * get confused by the boolean attribute syntax used.)
4245 public static function passwordChangeInputAttribs() {
4246 global $wgMinimalPasswordLength;
4248 if ( $wgMinimalPasswordLength == 0 ) {
4252 # Note that the pattern requirement will always be satisfied if the
4253 # input is empty, so we need required in all cases.
4255 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4256 # if e-mail confirmation is being used. Since HTML5 input validation
4257 # is b0rked anyway in some browsers, just return nothing. When it's
4258 # re-enabled, fix this code to not output required for e-mail
4260 #$ret = array( 'required' );
4263 # We can't actually do this right now, because Opera 9.6 will print out
4264 # the entered password visibly in its error message! When other
4265 # browsers add support for this attribute, or Opera fixes its support,
4266 # we can add support with a version check to avoid doing this on Opera
4267 # versions where it will be a problem. Reported to Opera as
4268 # DSK-262266, but they don't have a public bug tracker for us to follow.
4270 if ( $wgMinimalPasswordLength > 1 ) {
4271 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4272 $ret['title'] = wfMessage( 'passwordtooshort' )
4273 ->numParams( $wgMinimalPasswordLength )->text();
4281 * Return the list of user fields that should be selected to create
4282 * a new user object.
4285 public static function selectFields() {
4292 'user_newpass_time',
4296 'user_email_authenticated',
4298 'user_email_token_expires',
4299 'user_registration',