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];
336 $this->mLoadedItems
= true;
342 * Save user data to the shared cache
344 public function saveToCache() {
347 $this->loadOptions();
348 if ( $this->isAnon() ) {
349 // Anonymous users are uncached
353 foreach ( self
::$mCacheVars as $name ) {
354 $data[$name] = $this->$name;
356 $data['mVersion'] = MW_USER_VERSION
;
357 $key = wfMemcKey( 'user', 'id', $this->mId
);
359 $wgMemc->set( $key, $data );
362 /** @name newFrom*() static factory methods */
366 * Static factory method for creation from username.
368 * This is slightly less efficient than newFromId(), so use newFromId() if
369 * you have both an ID and a name handy.
371 * @param $name String Username, validated by Title::newFromText()
372 * @param $validate String|Bool Validate username. Takes the same parameters as
373 * User::getCanonicalName(), except that true is accepted as an alias
374 * for 'valid', for BC.
376 * @return User|bool User object, or false if the username is invalid
377 * (e.g. if it contains illegal characters or is an IP address). If the
378 * username is not present in the database, the result will be a user object
379 * with a name, zero user ID and default settings.
381 public static function newFromName( $name, $validate = 'valid' ) {
382 if ( $validate === true ) {
385 $name = self
::getCanonicalName( $name, $validate );
386 if ( $name === false ) {
389 # Create unloaded user object
393 $u->setItemLoaded( 'name' );
399 * Static factory method for creation from a given user ID.
401 * @param $id Int Valid user ID
402 * @return User The corresponding User object
404 public static function newFromId( $id ) {
408 $u->setItemLoaded( 'id' );
413 * Factory method to fetch whichever user has a given email confirmation code.
414 * This code is generated when an account is created or its e-mail address
417 * If the code is invalid or has expired, returns NULL.
419 * @param $code String Confirmation code
420 * @return User object, or null
422 public static function newFromConfirmationCode( $code ) {
423 $dbr = wfGetDB( DB_SLAVE
);
424 $id = $dbr->selectField( 'user', 'user_id', array(
425 'user_email_token' => md5( $code ),
426 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
428 if( $id !== false ) {
429 return User
::newFromId( $id );
436 * Create a new user object using data from session or cookies. If the
437 * login credentials are invalid, the result is an anonymous user.
439 * @param $request WebRequest object to use; $wgRequest will be used if
441 * @return User object
443 public static function newFromSession( WebRequest
$request = null ) {
445 $user->mFrom
= 'session';
446 $user->mRequest
= $request;
451 * Create a new user object from a user row.
452 * The row should have the following fields from the user table in it:
453 * - either user_name or user_id to load further data if needed (or both)
455 * - all other fields (email, password, etc.)
456 * It is useless to provide the remaining fields if either user_id,
457 * user_name and user_real_name are not provided because the whole row
458 * will be loaded once more from the database when accessing them.
460 * @param $row Array A row from the user table
461 * @param $data Array Further data to load into the object (see User::loadFromRow for valid keys)
464 public static function newFromRow( $row, $data = null ) {
466 $user->loadFromRow( $row, $data );
473 * Get the username corresponding to a given user ID
474 * @param $id Int User ID
475 * @return String|bool The corresponding username
477 public static function whoIs( $id ) {
478 return UserCache
::singleton()->getProp( $id, 'name' );
482 * Get the real name of a user given their user ID
484 * @param $id Int User ID
485 * @return String|bool The corresponding user's real name
487 public static function whoIsReal( $id ) {
488 return UserCache
::singleton()->getProp( $id, 'real_name' );
492 * Get database id given a user name
493 * @param $name String Username
494 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
496 public static function idFromName( $name ) {
497 $nt = Title
::makeTitleSafe( NS_USER
, $name );
498 if( is_null( $nt ) ) {
503 if ( isset( self
::$idCacheByName[$name] ) ) {
504 return self
::$idCacheByName[$name];
507 $dbr = wfGetDB( DB_SLAVE
);
508 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
510 if ( $s === false ) {
513 $result = $s->user_id
;
516 self
::$idCacheByName[$name] = $result;
518 if ( count( self
::$idCacheByName ) > 1000 ) {
519 self
::$idCacheByName = array();
526 * Reset the cache used in idFromName(). For use in tests.
528 public static function resetIdByNameCache() {
529 self
::$idCacheByName = array();
533 * Does the string match an anonymous IPv4 address?
535 * This function exists for username validation, in order to reject
536 * usernames which are similar in form to IP addresses. Strings such
537 * as 300.300.300.300 will return true because it looks like an IP
538 * address, despite not being strictly valid.
540 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
541 * address because the usemod software would "cloak" anonymous IP
542 * addresses like this, if we allowed accounts like this to be created
543 * new users could get the old edits of these anonymous users.
545 * @param $name String to match
548 public static function isIP( $name ) {
549 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
553 * Is the input a valid username?
555 * Checks if the input is a valid username, we don't want an empty string,
556 * an IP address, anything that containins slashes (would mess up subpages),
557 * is longer than the maximum allowed username size or doesn't begin with
560 * @param $name String to match
563 public static function isValidUserName( $name ) {
564 global $wgContLang, $wgMaxNameChars;
567 || User
::isIP( $name )
568 ||
strpos( $name, '/' ) !== false
569 ||
strlen( $name ) > $wgMaxNameChars
570 ||
$name != $wgContLang->ucfirst( $name ) ) {
571 wfDebugLog( 'username', __METHOD__
.
572 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
577 // Ensure that the name can't be misresolved as a different title,
578 // such as with extra namespace keys at the start.
579 $parsed = Title
::newFromText( $name );
580 if( is_null( $parsed )
581 ||
$parsed->getNamespace()
582 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
583 wfDebugLog( 'username', __METHOD__
.
584 ": '$name' invalid due to ambiguous prefixes" );
588 // Check an additional blacklist of troublemaker characters.
589 // Should these be merged into the title char list?
590 $unicodeBlacklist = '/[' .
591 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
592 '\x{00a0}' . # non-breaking space
593 '\x{2000}-\x{200f}' . # various whitespace
594 '\x{2028}-\x{202f}' . # breaks and control chars
595 '\x{3000}' . # ideographic space
596 '\x{e000}-\x{f8ff}' . # private use
598 if( preg_match( $unicodeBlacklist, $name ) ) {
599 wfDebugLog( 'username', __METHOD__
.
600 ": '$name' invalid due to blacklisted characters" );
608 * Usernames which fail to pass this function will be blocked
609 * from user login and new account registrations, but may be used
610 * internally by batch processes.
612 * If an account already exists in this form, login will be blocked
613 * by a failure to pass this function.
615 * @param $name String to match
618 public static function isUsableName( $name ) {
619 global $wgReservedUsernames;
620 // Must be a valid username, obviously ;)
621 if ( !self
::isValidUserName( $name ) ) {
625 static $reservedUsernames = false;
626 if ( !$reservedUsernames ) {
627 $reservedUsernames = $wgReservedUsernames;
628 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
631 // Certain names may be reserved for batch processes.
632 foreach ( $reservedUsernames as $reserved ) {
633 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
634 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
636 if ( $reserved == $name ) {
644 * Usernames which fail to pass this function will be blocked
645 * from new account registrations, but may be used internally
646 * either by batch processes or by user accounts which have
647 * already been created.
649 * Additional blacklisting may be added here rather than in
650 * isValidUserName() to avoid disrupting existing accounts.
652 * @param $name String to match
655 public static function isCreatableName( $name ) {
656 global $wgInvalidUsernameCharacters;
658 // Ensure that the username isn't longer than 235 bytes, so that
659 // (at least for the builtin skins) user javascript and css files
660 // will work. (bug 23080)
661 if( strlen( $name ) > 235 ) {
662 wfDebugLog( 'username', __METHOD__
.
663 ": '$name' invalid due to length" );
667 // Preg yells if you try to give it an empty string
668 if( $wgInvalidUsernameCharacters !== '' ) {
669 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
670 wfDebugLog( 'username', __METHOD__
.
671 ": '$name' invalid due to wgInvalidUsernameCharacters" );
676 return self
::isUsableName( $name );
680 * Is the input a valid password for this user?
682 * @param $password String Desired password
685 public function isValidPassword( $password ) {
686 //simple boolean wrapper for getPasswordValidity
687 return $this->getPasswordValidity( $password ) === true;
691 * Given unvalidated password input, return error message on failure.
693 * @param $password String Desired password
694 * @return mixed: true on success, string or array of error message on failure
696 public function getPasswordValidity( $password ) {
697 global $wgMinimalPasswordLength, $wgContLang;
699 static $blockedLogins = array(
700 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
701 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
704 $result = false; //init $result to false for the internal checks
706 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
709 if ( $result === false ) {
710 if( strlen( $password ) < $wgMinimalPasswordLength ) {
711 return 'passwordtooshort';
712 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
713 return 'password-name-match';
714 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
715 return 'password-login-forbidden';
717 //it seems weird returning true here, but this is because of the
718 //initialization of $result to false above. If the hook is never run or it
719 //doesn't modify $result, then we will likely get down into this if with
723 } elseif( $result === true ) {
726 return $result; //the isValidPassword hook set a string $result and returned true
731 * Does a string look like an e-mail address?
733 * This validates an email address using an HTML5 specification found at:
734 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
735 * Which as of 2011-01-24 says:
737 * A valid e-mail address is a string that matches the ABNF production
738 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
739 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
742 * This function is an implementation of the specification as requested in
745 * Client-side forms will use the same standard validation rules via JS or
746 * HTML 5 validation; additional restrictions can be enforced server-side
747 * by extensions via the 'isValidEmailAddr' hook.
749 * Note that this validation doesn't 100% match RFC 2822, but is believed
750 * to be liberal enough for wide use. Some invalid addresses will still
751 * pass validation here.
753 * @param $addr String E-mail address
755 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
757 public static function isValidEmailAddr( $addr ) {
758 wfDeprecated( __METHOD__
, '1.18' );
759 return Sanitizer
::validateEmail( $addr );
763 * Given unvalidated user input, return a canonical username, or false if
764 * the username is invalid.
765 * @param $name String User input
766 * @param $validate String|Bool type of validation to use:
767 * - false No validation
768 * - 'valid' Valid for batch processes
769 * - 'usable' Valid for batch processes and login
770 * - 'creatable' Valid for batch processes, login and account creation
772 * @throws MWException
773 * @return bool|string
775 public static function getCanonicalName( $name, $validate = 'valid' ) {
776 # Force usernames to capital
778 $name = $wgContLang->ucfirst( $name );
780 # Reject names containing '#'; these will be cleaned up
781 # with title normalisation, but then it's too late to
783 if( strpos( $name, '#' ) !== false )
786 # Clean up name according to title rules
787 $t = ( $validate === 'valid' ) ?
788 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
789 # Check for invalid titles
790 if( is_null( $t ) ) {
794 # Reject various classes of invalid names
796 $name = $wgAuth->getCanonicalName( $t->getText() );
798 switch ( $validate ) {
802 if ( !User
::isValidUserName( $name ) ) {
807 if ( !User
::isUsableName( $name ) ) {
812 if ( !User
::isCreatableName( $name ) ) {
817 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
823 * Count the number of edits of a user
825 * @param $uid Int User ID to check
826 * @return Int the user's edit count
828 * @deprecated since 1.21 in favour of User::getEditCount
830 public static function edits( $uid ) {
831 wfDeprecated( __METHOD__
, '1.21' );
832 $user = self
::newFromId( $uid );
833 return $user->getEditCount();
837 * Return a random password.
839 * @return String new random password
841 public static function randomPassword() {
842 global $wgMinimalPasswordLength;
843 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
844 $length = max( 10, $wgMinimalPasswordLength );
845 // Multiply by 1.25 to get the number of hex characters we need
846 $length = $length * 1.25;
847 // Generate random hex chars
848 $hex = MWCryptRand
::generateHex( $length );
849 // Convert from base 16 to base 32 to get a proper password like string
850 return wfBaseConvert( $hex, 16, 32 );
854 * Set cached properties to default.
856 * @note This no longer clears uncached lazy-initialised properties;
857 * the constructor does that instead.
859 * @param $name string
861 public function loadDefaults( $name = false ) {
862 wfProfileIn( __METHOD__
);
865 $this->mName
= $name;
866 $this->mRealName
= '';
867 $this->mPassword
= $this->mNewpassword
= '';
868 $this->mNewpassTime
= null;
870 $this->mOptionOverrides
= null;
871 $this->mOptionsLoaded
= false;
873 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
874 if( $loggedOut !== null ) {
875 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
877 $this->mTouched
= '1'; # Allow any pages to be cached
880 $this->mToken
= null; // Don't run cryptographic functions till we need a token
881 $this->mEmailAuthenticated
= null;
882 $this->mEmailToken
= '';
883 $this->mEmailTokenExpires
= null;
884 $this->mRegistration
= wfTimestamp( TS_MW
);
885 $this->mGroups
= array();
887 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
889 wfProfileOut( __METHOD__
);
893 * Return whether an item has been loaded.
895 * @param $item String: item to check. Current possibilities:
899 * @param $all String: 'all' to check if the whole object has been loaded
900 * or any other string to check if only the item is available (e.g.
904 public function isItemLoaded( $item, $all = 'all' ) {
905 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
906 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
910 * Set that an item has been loaded
912 * @param $item String
914 private function setItemLoaded( $item ) {
915 if ( is_array( $this->mLoadedItems
) ) {
916 $this->mLoadedItems
[$item] = true;
921 * Load user data from the session or login cookie.
922 * @return Bool True if the user is logged in, false otherwise.
924 private function loadFromSession() {
925 global $wgExternalAuthType, $wgAutocreatePolicy;
928 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
929 if ( $result !== null ) {
933 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
934 $extUser = ExternalUser
::newFromCookie();
936 # TODO: Automatically create the user here (or probably a bit
937 # lower down, in fact)
941 $request = $this->getRequest();
943 $cookieId = $request->getCookie( 'UserID' );
944 $sessId = $request->getSessionData( 'wsUserID' );
946 if ( $cookieId !== null ) {
947 $sId = intval( $cookieId );
948 if( $sessId !== null && $cookieId != $sessId ) {
949 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
950 cookie user ID ($sId) don't match!" );
953 $request->setSessionData( 'wsUserID', $sId );
954 } elseif ( $sessId !== null && $sessId != 0 ) {
960 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
961 $sName = $request->getSessionData( 'wsUserName' );
962 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
963 $sName = $request->getCookie( 'UserName' );
964 $request->setSessionData( 'wsUserName', $sName );
969 $proposedUser = User
::newFromId( $sId );
970 if ( !$proposedUser->isLoggedIn() ) {
975 global $wgBlockDisablesLogin;
976 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
977 # User blocked and we've disabled blocked user logins
981 if ( $request->getSessionData( 'wsToken' ) ) {
982 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
984 } elseif ( $request->getCookie( 'Token' ) ) {
985 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
988 # No session or persistent login cookie
992 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
993 $this->loadFromUserObject( $proposedUser );
994 $request->setSessionData( 'wsToken', $this->mToken
);
995 wfDebug( "User: logged in from $from\n" );
998 # Invalid credentials
999 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1005 * Load user and user_group data from the database.
1006 * $this->mId must be set, this is how the user is identified.
1008 * @return Bool True if the user exists, false if the user is anonymous
1010 public function loadFromDatabase() {
1012 $this->mId
= intval( $this->mId
);
1014 /** Anonymous user */
1016 $this->loadDefaults();
1020 $dbr = wfGetDB( DB_MASTER
);
1021 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1023 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1025 if ( $s !== false ) {
1026 # Initialise user table data
1027 $this->loadFromRow( $s );
1028 $this->mGroups
= null; // deferred
1029 $this->getEditCount(); // revalidation for nulls
1034 $this->loadDefaults();
1040 * Initialize this object from a row from the user table.
1042 * @param $row Array Row from the user table to load.
1043 * @param $data Array Further user data to load into the object
1045 * user_groups Array with groups out of the user_groups table
1046 * user_properties Array with properties out of the user_properties table
1048 public function loadFromRow( $row, $data = null ) {
1051 $this->mGroups
= null; // deferred
1053 if ( isset( $row->user_name
) ) {
1054 $this->mName
= $row->user_name
;
1055 $this->mFrom
= 'name';
1056 $this->setItemLoaded( 'name' );
1061 if ( isset( $row->user_real_name
) ) {
1062 $this->mRealName
= $row->user_real_name
;
1063 $this->setItemLoaded( 'realname' );
1068 if ( isset( $row->user_id
) ) {
1069 $this->mId
= intval( $row->user_id
);
1070 $this->mFrom
= 'id';
1071 $this->setItemLoaded( 'id' );
1076 if ( isset( $row->user_editcount
) ) {
1077 $this->mEditCount
= $row->user_editcount
;
1082 if ( isset( $row->user_password
) ) {
1083 $this->mPassword
= $row->user_password
;
1084 $this->mNewpassword
= $row->user_newpassword
;
1085 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1086 $this->mEmail
= $row->user_email
;
1087 if ( isset( $row->user_options
) ) {
1088 $this->decodeOptions( $row->user_options
);
1090 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1091 $this->mToken
= $row->user_token
;
1092 if ( $this->mToken
== '' ) {
1093 $this->mToken
= null;
1095 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1096 $this->mEmailToken
= $row->user_email_token
;
1097 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1098 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1104 $this->mLoadedItems
= true;
1107 if ( is_array( $data ) ) {
1108 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1109 $this->mGroups
= $data['user_groups'];
1111 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1112 $this->loadOptions( $data['user_properties'] );
1118 * Load the data for this user object from another user object.
1122 protected function loadFromUserObject( $user ) {
1124 $user->loadGroups();
1125 $user->loadOptions();
1126 foreach ( self
::$mCacheVars as $var ) {
1127 $this->$var = $user->$var;
1132 * Load the groups from the database if they aren't already loaded.
1134 private function loadGroups() {
1135 if ( is_null( $this->mGroups
) ) {
1136 $dbr = wfGetDB( DB_MASTER
);
1137 $res = $dbr->select( 'user_groups',
1138 array( 'ug_group' ),
1139 array( 'ug_user' => $this->mId
),
1141 $this->mGroups
= array();
1142 foreach ( $res as $row ) {
1143 $this->mGroups
[] = $row->ug_group
;
1149 * Add the user to the group if he/she meets given criteria.
1151 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1152 * possible to remove manually via Special:UserRights. In such case it
1153 * will not be re-added automatically. The user will also not lose the
1154 * group if they no longer meet the criteria.
1156 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1158 * @return array Array of groups the user has been promoted to.
1160 * @see $wgAutopromoteOnce
1162 public function addAutopromoteOnceGroups( $event ) {
1163 global $wgAutopromoteOnceLogInRC;
1165 $toPromote = array();
1166 if ( $this->getId() ) {
1167 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1168 if ( count( $toPromote ) ) {
1169 $oldGroups = $this->getGroups(); // previous groups
1170 foreach ( $toPromote as $group ) {
1171 $this->addGroup( $group );
1173 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1175 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1176 $logEntry->setPerformer( $this );
1177 $logEntry->setTarget( $this->getUserPage() );
1178 $logEntry->setParameters( array(
1179 '4::oldgroups' => $oldGroups,
1180 '5::newgroups' => $newGroups,
1182 $logid = $logEntry->insert();
1183 if ( $wgAutopromoteOnceLogInRC ) {
1184 $logEntry->publish( $logid );
1192 * Clear various cached data stored in this object. The cache of the user table
1193 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
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->mGroups
= null;
1208 $this->mOptions
= null;
1209 $this->mOptionsLoaded
= false;
1210 $this->mEditCount
= null;
1212 if ( $reloadFrom ) {
1213 $this->mLoadedItems
= array();
1214 $this->mFrom
= $reloadFrom;
1219 * Combine the language default options with any site-specific options
1220 * and add the default language variants.
1222 * @return Array of String options
1224 public static function getDefaultOptions() {
1225 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1227 static $defOpt = null;
1228 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1229 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1230 // mid-request and see that change reflected in the return value of this function.
1231 // Which is insane and would never happen during normal MW operation
1235 $defOpt = $wgDefaultUserOptions;
1236 # default language setting
1237 $defOpt['variant'] = $wgContLang->getCode();
1238 $defOpt['language'] = $wgContLang->getCode();
1239 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1240 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1242 $defOpt['skin'] = $wgDefaultSkin;
1244 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1250 * Get a given default option value.
1252 * @param $opt String Name of option to retrieve
1253 * @return String Default option value
1255 public static function getDefaultOption( $opt ) {
1256 $defOpts = self
::getDefaultOptions();
1257 if( isset( $defOpts[$opt] ) ) {
1258 return $defOpts[$opt];
1266 * Get blocking information
1267 * @param $bFromSlave Bool Whether to check the slave database first. To
1268 * improve performance, non-critical checks are done
1269 * against slaves. Check when actually saving should be
1270 * done against master.
1272 private function getBlockedStatus( $bFromSlave = true ) {
1273 global $wgProxyWhitelist, $wgUser;
1275 if ( -1 != $this->mBlockedby
) {
1279 wfProfileIn( __METHOD__
);
1280 wfDebug( __METHOD__
.": checking...\n" );
1282 // Initialize data...
1283 // Otherwise something ends up stomping on $this->mBlockedby when
1284 // things get lazy-loaded later, causing false positive block hits
1285 // due to -1 !== 0. Probably session-related... Nothing should be
1286 // overwriting mBlockedby, surely?
1289 # We only need to worry about passing the IP address to the Block generator if the
1290 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1291 # know which IP address they're actually coming from
1292 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1293 $ip = $this->getRequest()->getIP();
1299 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1302 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1303 && !in_array( $ip, $wgProxyWhitelist ) )
1306 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1308 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1309 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1310 $block->setTarget( $ip );
1311 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1313 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1314 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1315 $block->setTarget( $ip );
1319 if ( $block instanceof Block
) {
1320 wfDebug( __METHOD__
. ": Found block.\n" );
1321 $this->mBlock
= $block;
1322 $this->mBlockedby
= $block->getByName();
1323 $this->mBlockreason
= $block->mReason
;
1324 $this->mHideName
= $block->mHideName
;
1325 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1327 $this->mBlockedby
= '';
1328 $this->mHideName
= 0;
1329 $this->mAllowUsertalk
= false;
1333 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1335 wfProfileOut( __METHOD__
);
1339 * Whether the given IP is in a DNS blacklist.
1341 * @param $ip String IP to check
1342 * @param $checkWhitelist Bool: whether to check the whitelist first
1343 * @return Bool True if blacklisted.
1345 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1346 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1347 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1349 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1352 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1355 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1356 return $this->inDnsBlacklist( $ip, $urls );
1360 * Whether the given IP is in a given DNS blacklist.
1362 * @param $ip String IP to check
1363 * @param $bases String|Array of Strings: URL of the DNS blacklist
1364 * @return Bool True if blacklisted.
1366 public function inDnsBlacklist( $ip, $bases ) {
1367 wfProfileIn( __METHOD__
);
1370 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1371 if( IP
::isIPv4( $ip ) ) {
1372 # Reverse IP, bug 21255
1373 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1375 foreach( (array)$bases as $base ) {
1377 # If we have an access key, use that too (ProjectHoneypot, etc.)
1378 if( is_array( $base ) ) {
1379 if( count( $base ) >= 2 ) {
1380 # Access key is 1, base URL is 0
1381 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1383 $host = "$ipReversed.{$base[0]}";
1386 $host = "$ipReversed.$base";
1390 $ipList = gethostbynamel( $host );
1393 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1397 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1402 wfProfileOut( __METHOD__
);
1407 * Check if an IP address is in the local proxy list
1413 public static function isLocallyBlockedProxy( $ip ) {
1414 global $wgProxyList;
1416 if ( !$wgProxyList ) {
1419 wfProfileIn( __METHOD__
);
1421 if ( !is_array( $wgProxyList ) ) {
1422 # Load from the specified file
1423 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1426 if ( !is_array( $wgProxyList ) ) {
1428 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1430 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1431 # Old-style flipped proxy list
1436 wfProfileOut( __METHOD__
);
1441 * Is this user subject to rate limiting?
1443 * @return Bool True if rate limited
1445 public function isPingLimitable() {
1446 global $wgRateLimitsExcludedIPs;
1447 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1448 // No other good way currently to disable rate limits
1449 // for specific IPs. :P
1450 // But this is a crappy hack and should die.
1453 return !$this->isAllowed('noratelimit');
1457 * Primitive rate limits: enforce maximum actions per time period
1458 * to put a brake on flooding.
1460 * @note When using a shared cache like memcached, IP-address
1461 * last-hit counters will be shared across wikis.
1463 * @param $action String Action to enforce; 'edit' if unspecified
1464 * @return Bool True if a rate limiter was tripped
1466 public function pingLimiter( $action = 'edit' ) {
1467 # Call the 'PingLimiter' hook
1469 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1473 global $wgRateLimits;
1474 if( !isset( $wgRateLimits[$action] ) ) {
1478 # Some groups shouldn't trigger the ping limiter, ever
1479 if( !$this->isPingLimitable() )
1482 global $wgMemc, $wgRateLimitLog;
1483 wfProfileIn( __METHOD__
);
1485 $limits = $wgRateLimits[$action];
1487 $id = $this->getId();
1488 $ip = $this->getRequest()->getIP();
1491 if( isset( $limits['anon'] ) && $id == 0 ) {
1492 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1495 if( isset( $limits['user'] ) && $id != 0 ) {
1496 $userLimit = $limits['user'];
1498 if( $this->isNewbie() ) {
1499 if( isset( $limits['newbie'] ) && $id != 0 ) {
1500 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1502 if( isset( $limits['ip'] ) ) {
1503 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1506 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1507 $subnet = $matches[1];
1508 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1511 // Check for group-specific permissions
1512 // If more than one group applies, use the group with the highest limit
1513 foreach ( $this->getGroups() as $group ) {
1514 if ( isset( $limits[$group] ) ) {
1515 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1516 $userLimit = $limits[$group];
1520 // Set the user limit key
1521 if ( $userLimit !== false ) {
1522 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1523 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1527 foreach( $keys as $key => $limit ) {
1528 list( $max, $period ) = $limit;
1529 $summary = "(limit $max in {$period}s)";
1530 $count = $wgMemc->get( $key );
1533 if( $count >= $max ) {
1534 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1535 if( $wgRateLimitLog ) {
1536 wfSuppressWarnings();
1537 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1538 wfRestoreWarnings();
1542 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1545 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1546 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1548 $wgMemc->incr( $key );
1551 wfProfileOut( __METHOD__
);
1556 * Check if user is blocked
1558 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1559 * @return Bool True if blocked, false otherwise
1561 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1562 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1566 * Get the block affecting the user, or null if the user is not blocked
1568 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1569 * @return Block|null
1571 public function getBlock( $bFromSlave = true ){
1572 $this->getBlockedStatus( $bFromSlave );
1573 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1577 * Check if user is blocked from editing a particular article
1579 * @param $title Title to check
1580 * @param $bFromSlave Bool whether to check the slave database instead of the master
1583 function isBlockedFrom( $title, $bFromSlave = false ) {
1584 global $wgBlockAllowsUTEdit;
1585 wfProfileIn( __METHOD__
);
1587 $blocked = $this->isBlocked( $bFromSlave );
1588 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1589 # If a user's name is suppressed, they cannot make edits anywhere
1590 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1591 $title->getNamespace() == NS_USER_TALK
) {
1593 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1596 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1598 wfProfileOut( __METHOD__
);
1603 * If user is blocked, return the name of the user who placed the block
1604 * @return String name of blocker
1606 public function blockedBy() {
1607 $this->getBlockedStatus();
1608 return $this->mBlockedby
;
1612 * If user is blocked, return the specified reason for the block
1613 * @return String Blocking reason
1615 public function blockedFor() {
1616 $this->getBlockedStatus();
1617 return $this->mBlockreason
;
1621 * If user is blocked, return the ID for the block
1622 * @return Int Block ID
1624 public function getBlockId() {
1625 $this->getBlockedStatus();
1626 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1630 * Check if user is blocked on all wikis.
1631 * Do not use for actual edit permission checks!
1632 * This is intented for quick UI checks.
1634 * @param $ip String IP address, uses current client if none given
1635 * @return Bool True if blocked, false otherwise
1637 public function isBlockedGlobally( $ip = '' ) {
1638 if( $this->mBlockedGlobally
!== null ) {
1639 return $this->mBlockedGlobally
;
1641 // User is already an IP?
1642 if( IP
::isIPAddress( $this->getName() ) ) {
1643 $ip = $this->getName();
1645 $ip = $this->getRequest()->getIP();
1648 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1649 $this->mBlockedGlobally
= (bool)$blocked;
1650 return $this->mBlockedGlobally
;
1654 * Check if user account is locked
1656 * @return Bool True if locked, false otherwise
1658 public function isLocked() {
1659 if( $this->mLocked
!== null ) {
1660 return $this->mLocked
;
1663 $authUser = $wgAuth->getUserInstance( $this );
1664 $this->mLocked
= (bool)$authUser->isLocked();
1665 return $this->mLocked
;
1669 * Check if user account is hidden
1671 * @return Bool True if hidden, false otherwise
1673 public function isHidden() {
1674 if( $this->mHideName
!== null ) {
1675 return $this->mHideName
;
1677 $this->getBlockedStatus();
1678 if( !$this->mHideName
) {
1680 $authUser = $wgAuth->getUserInstance( $this );
1681 $this->mHideName
= (bool)$authUser->isHidden();
1683 return $this->mHideName
;
1687 * Get the user's ID.
1688 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1690 public function getId() {
1691 if( $this->mId
=== null && $this->mName
!== null
1692 && User
::isIP( $this->mName
) ) {
1693 // Special case, we know the user is anonymous
1695 } elseif( !$this->isItemLoaded( 'id' ) ) {
1696 // Don't load if this was initialized from an ID
1703 * Set the user and reload all fields according to a given ID
1704 * @param $v Int User ID to reload
1706 public function setId( $v ) {
1708 $this->clearInstanceCache( 'id' );
1712 * Get the user name, or the IP of an anonymous user
1713 * @return String User's name or IP address
1715 public function getName() {
1716 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1717 # Special case optimisation
1718 return $this->mName
;
1721 if ( $this->mName
=== false ) {
1723 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1725 return $this->mName
;
1730 * Set the user name.
1732 * This does not reload fields from the database according to the given
1733 * name. Rather, it is used to create a temporary "nonexistent user" for
1734 * later addition to the database. It can also be used to set the IP
1735 * address for an anonymous user to something other than the current
1738 * @note User::newFromName() has rougly the same function, when the named user
1740 * @param $str String New user name to set
1742 public function setName( $str ) {
1744 $this->mName
= $str;
1748 * Get the user's name escaped by underscores.
1749 * @return String Username escaped by underscores.
1751 public function getTitleKey() {
1752 return str_replace( ' ', '_', $this->getName() );
1756 * Check if the user has new messages.
1757 * @return Bool True if the user has new messages
1759 public function getNewtalk() {
1762 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1763 if( $this->mNewtalk
=== -1 ) {
1764 $this->mNewtalk
= false; # reset talk page status
1766 # Check memcached separately for anons, who have no
1767 # entire User object stored in there.
1769 global $wgDisableAnonTalk;
1770 if( $wgDisableAnonTalk ) {
1771 // Anon newtalk disabled by configuration.
1772 $this->mNewtalk
= false;
1775 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1776 $newtalk = $wgMemc->get( $key );
1777 if( strval( $newtalk ) !== '' ) {
1778 $this->mNewtalk
= (bool)$newtalk;
1780 // Since we are caching this, make sure it is up to date by getting it
1782 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1783 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1787 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1791 return (bool)$this->mNewtalk
;
1795 * Return the talk page(s) this user has new messages on.
1796 * @return Array of String page URLs
1798 public function getNewMessageLinks() {
1800 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1802 } elseif( !$this->getNewtalk() ) {
1805 $utp = $this->getTalkPage();
1806 $dbr = wfGetDB( DB_SLAVE
);
1807 // Get the "last viewed rev" timestamp from the oldest message notification
1808 $timestamp = $dbr->selectField( 'user_newtalk',
1809 'MIN(user_last_timestamp)',
1810 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1812 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1813 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1817 * Internal uncached check for new messages
1820 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1821 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1822 * @param $fromMaster Bool true to fetch from the master, false for a slave
1823 * @return Bool True if the user has new messages
1825 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1826 if ( $fromMaster ) {
1827 $db = wfGetDB( DB_MASTER
);
1829 $db = wfGetDB( DB_SLAVE
);
1831 $ok = $db->selectField( 'user_newtalk', $field,
1832 array( $field => $id ), __METHOD__
);
1833 return $ok !== false;
1837 * Add or update the new messages flag
1838 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1839 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1840 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1841 * @return Bool True if successful, false otherwise
1843 protected function updateNewtalk( $field, $id, $curRev = null ) {
1844 // Get timestamp of the talk page revision prior to the current one
1845 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1846 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1847 // Mark the user as having new messages since this revision
1848 $dbw = wfGetDB( DB_MASTER
);
1849 $dbw->insert( 'user_newtalk',
1850 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1853 if ( $dbw->affectedRows() ) {
1854 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1857 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1863 * Clear the new messages flag for the given user
1864 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1865 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1866 * @return Bool True if successful, false otherwise
1868 protected function deleteNewtalk( $field, $id ) {
1869 $dbw = wfGetDB( DB_MASTER
);
1870 $dbw->delete( 'user_newtalk',
1871 array( $field => $id ),
1873 if ( $dbw->affectedRows() ) {
1874 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1877 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1883 * Update the 'You have new messages!' status.
1884 * @param $val Bool Whether the user has new messages
1885 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1887 public function setNewtalk( $val, $curRev = null ) {
1888 if( wfReadOnly() ) {
1893 $this->mNewtalk
= $val;
1895 if( $this->isAnon() ) {
1897 $id = $this->getName();
1900 $id = $this->getId();
1905 $changed = $this->updateNewtalk( $field, $id, $curRev );
1907 $changed = $this->deleteNewtalk( $field, $id );
1910 if( $this->isAnon() ) {
1911 // Anons have a separate memcached space, since
1912 // user records aren't kept for them.
1913 $key = wfMemcKey( 'newtalk', 'ip', $id );
1914 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1917 $this->invalidateCache();
1922 * Generate a current or new-future timestamp to be stored in the
1923 * user_touched field when we update things.
1924 * @return String Timestamp in TS_MW format
1926 private static function newTouchedTimestamp() {
1927 global $wgClockSkewFudge;
1928 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1932 * Clear user data from memcached.
1933 * Use after applying fun updates to the database; caller's
1934 * responsibility to update user_touched if appropriate.
1936 * Called implicitly from invalidateCache() and saveSettings().
1938 private function clearSharedCache() {
1942 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1947 * Immediately touch the user data cache for this account.
1948 * Updates user_touched field, and removes account data from memcached
1949 * for reload on the next hit.
1951 public function invalidateCache() {
1952 if( wfReadOnly() ) {
1957 $this->mTouched
= self
::newTouchedTimestamp();
1959 $dbw = wfGetDB( DB_MASTER
);
1961 // Prevent contention slams by checking user_touched first
1962 $now = $dbw->timestamp( $this->mTouched
);
1963 $needsPurge = $dbw->selectField( 'user', '1',
1964 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1966 if ( $needsPurge ) {
1967 $dbw->update( 'user',
1968 array( 'user_touched' => $now ),
1969 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1974 $this->clearSharedCache();
1979 * Validate the cache for this account.
1980 * @param $timestamp String A timestamp in TS_MW format
1984 public function validateCache( $timestamp ) {
1986 return ( $timestamp >= $this->mTouched
);
1990 * Get the user touched timestamp
1991 * @return String timestamp
1993 public function getTouched() {
1995 return $this->mTouched
;
1999 * Set the password and reset the random token.
2000 * Calls through to authentication plugin if necessary;
2001 * will have no effect if the auth plugin refuses to
2002 * pass the change through or if the legal password
2005 * As a special case, setting the password to null
2006 * wipes it, so the account cannot be logged in until
2007 * a new password is set, for instance via e-mail.
2009 * @param $str String New password to set
2010 * @throws PasswordError on failure
2014 public function setPassword( $str ) {
2017 if( $str !== null ) {
2018 if( !$wgAuth->allowPasswordChange() ) {
2019 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2022 if( !$this->isValidPassword( $str ) ) {
2023 global $wgMinimalPasswordLength;
2024 $valid = $this->getPasswordValidity( $str );
2025 if ( is_array( $valid ) ) {
2026 $message = array_shift( $valid );
2030 $params = array( $wgMinimalPasswordLength );
2032 throw new PasswordError( wfMessage( $message, $params )->text() );
2036 if( !$wgAuth->setPassword( $this, $str ) ) {
2037 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2040 $this->setInternalPassword( $str );
2046 * Set the password and reset the random token unconditionally.
2048 * @param $str String New password to set
2050 public function setInternalPassword( $str ) {
2054 if( $str === null ) {
2055 // Save an invalid hash...
2056 $this->mPassword
= '';
2058 $this->mPassword
= self
::crypt( $str );
2060 $this->mNewpassword
= '';
2061 $this->mNewpassTime
= null;
2065 * Get the user's current token.
2066 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2067 * @return String Token
2069 public function getToken( $forceCreation = true ) {
2071 if ( !$this->mToken
&& $forceCreation ) {
2074 return $this->mToken
;
2078 * Set the random token (used for persistent authentication)
2079 * Called from loadDefaults() among other places.
2081 * @param $token String|bool If specified, set the token to this value
2083 public function setToken( $token = false ) {
2086 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2088 $this->mToken
= $token;
2093 * Set the password for a password reminder or new account email
2095 * @param $str String New password to set
2096 * @param $throttle Bool If true, reset the throttle timestamp to the present
2098 public function setNewpassword( $str, $throttle = true ) {
2100 $this->mNewpassword
= self
::crypt( $str );
2102 $this->mNewpassTime
= wfTimestampNow();
2107 * Has password reminder email been sent within the last
2108 * $wgPasswordReminderResendTime hours?
2111 public function isPasswordReminderThrottled() {
2112 global $wgPasswordReminderResendTime;
2114 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2117 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2118 return time() < $expiry;
2122 * Get the user's e-mail address
2123 * @return String User's email address
2125 public function getEmail() {
2127 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2128 return $this->mEmail
;
2132 * Get the timestamp of the user's e-mail authentication
2133 * @return String TS_MW timestamp
2135 public function getEmailAuthenticationTimestamp() {
2137 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2138 return $this->mEmailAuthenticated
;
2142 * Set the user's e-mail address
2143 * @param $str String New e-mail address
2145 public function setEmail( $str ) {
2147 if( $str == $this->mEmail
) {
2150 $this->mEmail
= $str;
2151 $this->invalidateEmail();
2152 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2156 * Set the user's e-mail address and a confirmation mail if needed.
2159 * @param $str String New e-mail address
2162 public function setEmailWithConfirmation( $str ) {
2163 global $wgEnableEmail, $wgEmailAuthentication;
2165 if ( !$wgEnableEmail ) {
2166 return Status
::newFatal( 'emaildisabled' );
2169 $oldaddr = $this->getEmail();
2170 if ( $str === $oldaddr ) {
2171 return Status
::newGood( true );
2174 $this->setEmail( $str );
2176 if ( $str !== '' && $wgEmailAuthentication ) {
2177 # Send a confirmation request to the new address if needed
2178 $type = $oldaddr != '' ?
'changed' : 'set';
2179 $result = $this->sendConfirmationMail( $type );
2180 if ( $result->isGood() ) {
2181 # Say the the caller that a confirmation mail has been sent
2182 $result->value
= 'eauth';
2185 $result = Status
::newGood( true );
2192 * Get the user's real name
2193 * @return String User's real name
2195 public function getRealName() {
2196 if ( !$this->isItemLoaded( 'realname' ) ) {
2200 return $this->mRealName
;
2204 * Set the user's real name
2205 * @param $str String New real name
2207 public function setRealName( $str ) {
2209 $this->mRealName
= $str;
2213 * Get the user's current setting for a given option.
2215 * @param $oname String The option to check
2216 * @param $defaultOverride String A default value returned if the option does not exist
2217 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2218 * @return String User's current value for the option
2219 * @see getBoolOption()
2220 * @see getIntOption()
2222 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2223 global $wgHiddenPrefs;
2224 $this->loadOptions();
2226 # We want 'disabled' preferences to always behave as the default value for
2227 # users, even if they have set the option explicitly in their settings (ie they
2228 # set it, and then it was disabled removing their ability to change it). But
2229 # we don't want to erase the preferences in the database in case the preference
2230 # is re-enabled again. So don't touch $mOptions, just override the returned value
2231 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2232 return self
::getDefaultOption( $oname );
2235 if ( array_key_exists( $oname, $this->mOptions
) ) {
2236 return $this->mOptions
[$oname];
2238 return $defaultOverride;
2243 * Get all user's options
2247 public function getOptions() {
2248 global $wgHiddenPrefs;
2249 $this->loadOptions();
2250 $options = $this->mOptions
;
2252 # We want 'disabled' preferences to always behave as the default value for
2253 # users, even if they have set the option explicitly in their settings (ie they
2254 # set it, and then it was disabled removing their ability to change it). But
2255 # we don't want to erase the preferences in the database in case the preference
2256 # is re-enabled again. So don't touch $mOptions, just override the returned value
2257 foreach( $wgHiddenPrefs as $pref ){
2258 $default = self
::getDefaultOption( $pref );
2259 if( $default !== null ){
2260 $options[$pref] = $default;
2268 * Get the user's current setting for a given option, as a boolean value.
2270 * @param $oname String The option to check
2271 * @return Bool User's current value for the option
2274 public function getBoolOption( $oname ) {
2275 return (bool)$this->getOption( $oname );
2279 * Get the user's current setting for a given option, as a boolean value.
2281 * @param $oname String The option to check
2282 * @param $defaultOverride Int A default value returned if the option does not exist
2283 * @return Int User's current value for the option
2286 public function getIntOption( $oname, $defaultOverride=0 ) {
2287 $val = $this->getOption( $oname );
2289 $val = $defaultOverride;
2291 return intval( $val );
2295 * Set the given option for a user.
2297 * @param $oname String The option to set
2298 * @param $val mixed New value to set
2300 public function setOption( $oname, $val ) {
2301 $this->loadOptions();
2303 // Explicitly NULL values should refer to defaults
2304 if( is_null( $val ) ) {
2305 $val = self
::getDefaultOption( $oname );
2308 $this->mOptions
[$oname] = $val;
2312 * Reset all options to the site defaults
2314 public function resetOptions() {
2317 $this->mOptions
= self
::getDefaultOptions();
2318 $this->mOptionsLoaded
= true;
2322 * Get the user's preferred date format.
2323 * @return String User's preferred date format
2325 public function getDatePreference() {
2326 // Important migration for old data rows
2327 if ( is_null( $this->mDatePreference
) ) {
2329 $value = $this->getOption( 'date' );
2330 $map = $wgLang->getDatePreferenceMigrationMap();
2331 if ( isset( $map[$value] ) ) {
2332 $value = $map[$value];
2334 $this->mDatePreference
= $value;
2336 return $this->mDatePreference
;
2340 * Get the user preferred stub threshold
2344 public function getStubThreshold() {
2345 global $wgMaxArticleSize; # Maximum article size, in Kb
2346 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2347 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2348 # If they have set an impossible value, disable the preference
2349 # so we can use the parser cache again.
2356 * Get the permissions this user has.
2357 * @return Array of String permission names
2359 public function getRights() {
2360 if ( is_null( $this->mRights
) ) {
2361 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2362 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2363 // Force reindexation of rights when a hook has unset one of them
2364 $this->mRights
= array_values( array_unique( $this->mRights
) );
2366 return $this->mRights
;
2370 * Get the list of explicit group memberships this user has.
2371 * The implicit * and user groups are not included.
2372 * @return Array of String internal group names
2374 public function getGroups() {
2376 $this->loadGroups();
2377 return $this->mGroups
;
2381 * Get the list of implicit group memberships this user has.
2382 * This includes all explicit groups, plus 'user' if logged in,
2383 * '*' for all accounts, and autopromoted groups
2384 * @param $recache Bool Whether to avoid the cache
2385 * @return Array of String internal group names
2387 public function getEffectiveGroups( $recache = false ) {
2388 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2389 wfProfileIn( __METHOD__
);
2390 $this->mEffectiveGroups
= array_unique( array_merge(
2391 $this->getGroups(), // explicit groups
2392 $this->getAutomaticGroups( $recache ) // implicit groups
2394 # Hook for additional groups
2395 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2396 // Force reindexation of groups when a hook has unset one of them
2397 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
2398 wfProfileOut( __METHOD__
);
2400 return $this->mEffectiveGroups
;
2404 * Get the list of implicit group memberships this user has.
2405 * This includes 'user' if logged in, '*' for all accounts,
2406 * and autopromoted groups
2407 * @param $recache Bool Whether to avoid the cache
2408 * @return Array of String internal group names
2410 public function getAutomaticGroups( $recache = false ) {
2411 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2412 wfProfileIn( __METHOD__
);
2413 $this->mImplicitGroups
= array( '*' );
2414 if ( $this->getId() ) {
2415 $this->mImplicitGroups
[] = 'user';
2417 $this->mImplicitGroups
= array_unique( array_merge(
2418 $this->mImplicitGroups
,
2419 Autopromote
::getAutopromoteGroups( $this )
2423 # Assure data consistency with rights/groups,
2424 # as getEffectiveGroups() depends on this function
2425 $this->mEffectiveGroups
= null;
2427 wfProfileOut( __METHOD__
);
2429 return $this->mImplicitGroups
;
2433 * Returns the groups the user has belonged to.
2435 * The user may still belong to the returned groups. Compare with getGroups().
2437 * The function will not return groups the user had belonged to before MW 1.17
2439 * @return array Names of the groups the user has belonged to.
2441 public function getFormerGroups() {
2442 if( is_null( $this->mFormerGroups
) ) {
2443 $dbr = wfGetDB( DB_MASTER
);
2444 $res = $dbr->select( 'user_former_groups',
2445 array( 'ufg_group' ),
2446 array( 'ufg_user' => $this->mId
),
2448 $this->mFormerGroups
= array();
2449 foreach( $res as $row ) {
2450 $this->mFormerGroups
[] = $row->ufg_group
;
2453 return $this->mFormerGroups
;
2457 * Get the user's edit count.
2460 public function getEditCount() {
2461 if ( !$this->getId() ) {
2465 if ( !isset( $this->mEditCount
) ) {
2466 /* Populate the count, if it has not been populated yet */
2467 wfProfileIn( __METHOD__
);
2468 $dbr = wfGetDB( DB_SLAVE
);
2469 // check if the user_editcount field has been initialized
2470 $count = $dbr->selectField(
2471 'user', 'user_editcount',
2472 array( 'user_id' => $this->mId
),
2476 if( $count === null ) {
2477 // it has not been initialized. do so.
2478 $count = $this->initEditCount();
2480 $this->mEditCount
= intval( $count );
2481 wfProfileOut( __METHOD__
);
2483 return $this->mEditCount
;
2487 * Add the user to the given group.
2488 * This takes immediate effect.
2489 * @param $group String Name of the group to add
2491 public function addGroup( $group ) {
2492 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2493 $dbw = wfGetDB( DB_MASTER
);
2494 if( $this->getId() ) {
2495 $dbw->insert( 'user_groups',
2497 'ug_user' => $this->getID(),
2498 'ug_group' => $group,
2501 array( 'IGNORE' ) );
2504 $this->loadGroups();
2505 $this->mGroups
[] = $group;
2506 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2508 $this->invalidateCache();
2512 * Remove the user from the given group.
2513 * This takes immediate effect.
2514 * @param $group String Name of the group to remove
2516 public function removeGroup( $group ) {
2518 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2519 $dbw = wfGetDB( DB_MASTER
);
2520 $dbw->delete( 'user_groups',
2522 'ug_user' => $this->getID(),
2523 'ug_group' => $group,
2525 // Remember that the user was in this group
2526 $dbw->insert( 'user_former_groups',
2528 'ufg_user' => $this->getID(),
2529 'ufg_group' => $group,
2532 array( 'IGNORE' ) );
2534 $this->loadGroups();
2535 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2536 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2538 $this->invalidateCache();
2542 * Get whether the user is logged in
2545 public function isLoggedIn() {
2546 return $this->getID() != 0;
2550 * Get whether the user is anonymous
2553 public function isAnon() {
2554 return !$this->isLoggedIn();
2558 * Check if user is allowed to access a feature / make an action
2560 * @internal param \String $varargs permissions to test
2561 * @return Boolean: True if user is allowed to perform *any* of the given actions
2565 public function isAllowedAny( /*...*/ ) {
2566 $permissions = func_get_args();
2567 foreach( $permissions as $permission ){
2568 if( $this->isAllowed( $permission ) ){
2577 * @internal param $varargs string
2578 * @return bool True if the user is allowed to perform *all* of the given actions
2580 public function isAllowedAll( /*...*/ ) {
2581 $permissions = func_get_args();
2582 foreach( $permissions as $permission ){
2583 if( !$this->isAllowed( $permission ) ){
2591 * Internal mechanics of testing a permission
2592 * @param $action String
2595 public function isAllowed( $action = '' ) {
2596 if ( $action === '' ) {
2597 return true; // In the spirit of DWIM
2599 # Patrolling may not be enabled
2600 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2601 global $wgUseRCPatrol, $wgUseNPPatrol;
2602 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2605 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2606 # by misconfiguration: 0 == 'foo'
2607 return in_array( $action, $this->getRights(), true );
2611 * Check whether to enable recent changes patrol features for this user
2612 * @return Boolean: True or false
2614 public function useRCPatrol() {
2615 global $wgUseRCPatrol;
2616 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2620 * Check whether to enable new pages patrol features for this user
2621 * @return Bool True or false
2623 public function useNPPatrol() {
2624 global $wgUseRCPatrol, $wgUseNPPatrol;
2625 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2629 * Get the WebRequest object to use with this object
2631 * @return WebRequest
2633 public function getRequest() {
2634 if ( $this->mRequest
) {
2635 return $this->mRequest
;
2643 * Get the current skin, loading it if required
2644 * @return Skin The current skin
2645 * @todo FIXME: Need to check the old failback system [AV]
2646 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2648 public function getSkin() {
2649 wfDeprecated( __METHOD__
, '1.18' );
2650 return RequestContext
::getMain()->getSkin();
2654 * Get a WatchedItem for this user and $title.
2656 * @param $title Title
2657 * @return WatchedItem
2659 public function getWatchedItem( $title ) {
2660 $key = $title->getNamespace() . ':' . $title->getDBkey();
2662 if ( isset( $this->mWatchedItems
[$key] ) ) {
2663 return $this->mWatchedItems
[$key];
2666 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2667 $this->mWatchedItems
= array();
2670 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2671 return $this->mWatchedItems
[$key];
2675 * Check the watched status of an article.
2676 * @param $title Title of the article to look at
2679 public function isWatched( $title ) {
2680 return $this->getWatchedItem( $title )->isWatched();
2685 * @param $title Title of the article to look at
2687 public function addWatch( $title ) {
2688 $this->getWatchedItem( $title )->addWatch();
2689 $this->invalidateCache();
2693 * Stop watching an article.
2694 * @param $title Title of the article to look at
2696 public function removeWatch( $title ) {
2697 $this->getWatchedItem( $title )->removeWatch();
2698 $this->invalidateCache();
2702 * Clear the user's notification timestamp for the given title.
2703 * If e-notif e-mails are on, they will receive notification mails on
2704 * the next change of the page if it's watched etc.
2705 * @param $title Title of the article to look at
2707 public function clearNotification( &$title ) {
2708 global $wgUseEnotif, $wgShowUpdatedMarker;
2710 # Do nothing if the database is locked to writes
2711 if( wfReadOnly() ) {
2715 if( $title->getNamespace() == NS_USER_TALK
&&
2716 $title->getText() == $this->getName() ) {
2717 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2719 $this->setNewtalk( false );
2722 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2726 if( $this->isAnon() ) {
2727 // Nothing else to do...
2731 // Only update the timestamp if the page is being watched.
2732 // The query to find out if it is watched is cached both in memcached and per-invocation,
2733 // and when it does have to be executed, it can be on a slave
2734 // If this is the user's newtalk page, we always update the timestamp
2736 if ( $title->getNamespace() == NS_USER_TALK
&&
2737 $title->getText() == $this->getName() )
2742 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2746 * Resets all of the given user's page-change notification timestamps.
2747 * If e-notif e-mails are on, they will receive notification mails on
2748 * the next change of any watched page.
2750 public function clearAllNotifications() {
2751 global $wgUseEnotif, $wgShowUpdatedMarker;
2752 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2753 $this->setNewtalk( false );
2756 $id = $this->getId();
2758 $dbw = wfGetDB( DB_MASTER
);
2759 $dbw->update( 'watchlist',
2761 'wl_notificationtimestamp' => null
2762 ), array( /* WHERE */
2766 # We also need to clear here the "you have new message" notification for the own user_talk page
2767 # This is cleared one page view later in Article::viewUpdates();
2772 * Set this user's options from an encoded string
2773 * @param $str String Encoded options to import
2775 * @deprecated in 1.19 due to removal of user_options from the user table
2777 private function decodeOptions( $str ) {
2778 wfDeprecated( __METHOD__
, '1.19' );
2782 $this->mOptionsLoaded
= true;
2783 $this->mOptionOverrides
= array();
2785 // If an option is not set in $str, use the default value
2786 $this->mOptions
= self
::getDefaultOptions();
2788 $a = explode( "\n", $str );
2789 foreach ( $a as $s ) {
2791 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2792 $this->mOptions
[$m[1]] = $m[2];
2793 $this->mOptionOverrides
[$m[1]] = $m[2];
2799 * Set a cookie on the user's client. Wrapper for
2800 * WebResponse::setCookie
2801 * @param $name String Name of the cookie to set
2802 * @param $value String Value to set
2803 * @param $exp Int Expiration time, as a UNIX time value;
2804 * if 0 or not specified, use the default $wgCookieExpiration
2805 * @param $secure Bool
2806 * true: Force setting the secure attribute when setting the cookie
2807 * false: Force NOT setting the secure attribute when setting the cookie
2808 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
2810 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
2811 $this->getRequest()->response()->setcookie( $name, $value, $exp, null, null, $secure );
2815 * Clear a cookie on the user's client
2816 * @param $name String Name of the cookie to clear
2818 protected function clearCookie( $name ) {
2819 $this->setCookie( $name, '', time() - 86400 );
2823 * Set the default cookies for this session on the user's client.
2825 * @param $request WebRequest object to use; $wgRequest will be used if null
2827 * @param $secure Whether to force secure/insecure cookies or use default
2829 public function setCookies( $request = null, $secure = null ) {
2830 if ( $request === null ) {
2831 $request = $this->getRequest();
2835 if ( 0 == $this->mId
) return;
2836 if ( !$this->mToken
) {
2837 // When token is empty or NULL generate a new one and then save it to the database
2838 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2839 // Simply by setting every cell in the user_token column to NULL and letting them be
2840 // regenerated as users log back into the wiki.
2842 $this->saveSettings();
2845 'wsUserID' => $this->mId
,
2846 'wsToken' => $this->mToken
,
2847 'wsUserName' => $this->getName()
2850 'UserID' => $this->mId
,
2851 'UserName' => $this->getName(),
2853 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2854 $cookies['Token'] = $this->mToken
;
2856 $cookies['Token'] = false;
2859 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2861 foreach ( $session as $name => $value ) {
2862 $request->setSessionData( $name, $value );
2864 foreach ( $cookies as $name => $value ) {
2865 if ( $value === false ) {
2866 $this->clearCookie( $name );
2868 $this->setCookie( $name, $value, 0, $secure );
2873 * If wpStickHTTPS was selected, also set an insecure cookie that
2874 * will cause the site to redirect the user to HTTPS, if they access
2875 * it over HTTP. Bug 29898.
2877 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
2878 $this->setCookie( 'forceHTTPS', 'true', time() +
2592000, false ); //30 days
2883 * Log this user out.
2885 public function logout() {
2886 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2892 * Clear the user's cookies and session, and reset the instance cache.
2895 public function doLogout() {
2896 $this->clearInstanceCache( 'defaults' );
2898 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2900 $this->clearCookie( 'UserID' );
2901 $this->clearCookie( 'Token' );
2902 $this->clearCookie( 'forceHTTPS' );
2904 # Remember when user logged out, to prevent seeing cached pages
2905 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2909 * Save this user's settings into the database.
2910 * @todo Only rarely do all these fields need to be set!
2912 public function saveSettings() {
2916 if ( wfReadOnly() ) { return; }
2917 if ( 0 == $this->mId
) { return; }
2919 $this->mTouched
= self
::newTouchedTimestamp();
2920 if ( !$wgAuth->allowSetLocalPassword() ) {
2921 $this->mPassword
= '';
2924 $dbw = wfGetDB( DB_MASTER
);
2925 $dbw->update( 'user',
2927 'user_name' => $this->mName
,
2928 'user_password' => $this->mPassword
,
2929 'user_newpassword' => $this->mNewpassword
,
2930 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2931 'user_real_name' => $this->mRealName
,
2932 'user_email' => $this->mEmail
,
2933 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2934 'user_touched' => $dbw->timestamp( $this->mTouched
),
2935 'user_token' => strval( $this->mToken
),
2936 'user_email_token' => $this->mEmailToken
,
2937 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2938 ), array( /* WHERE */
2939 'user_id' => $this->mId
2943 $this->saveOptions();
2945 wfRunHooks( 'UserSaveSettings', array( $this ) );
2946 $this->clearSharedCache();
2947 $this->getUserPage()->invalidateCache();
2951 * If only this user's username is known, and it exists, return the user ID.
2954 public function idForName() {
2955 $s = trim( $this->getName() );
2956 if ( $s === '' ) return 0;
2958 $dbr = wfGetDB( DB_SLAVE
);
2959 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2960 if ( $id === false ) {
2967 * Add a user to the database, return the user object
2969 * @param $name String Username to add
2970 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2971 * - password The user's password hash. Password logins will be disabled if this is omitted.
2972 * - newpassword Hash for a temporary password that has been mailed to the user
2973 * - email The user's email address
2974 * - email_authenticated The email authentication timestamp
2975 * - real_name The user's real name
2976 * - options An associative array of non-default options
2977 * - token Random authentication token. Do not set.
2978 * - registration Registration timestamp. Do not set.
2980 * @return User object, or null if the username already exists
2982 public static function createNew( $name, $params = array() ) {
2985 if ( isset( $params['options'] ) ) {
2986 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2987 unset( $params['options'] );
2989 $dbw = wfGetDB( DB_MASTER
);
2990 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2993 'user_id' => $seqVal,
2994 'user_name' => $name,
2995 'user_password' => $user->mPassword
,
2996 'user_newpassword' => $user->mNewpassword
,
2997 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2998 'user_email' => $user->mEmail
,
2999 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3000 'user_real_name' => $user->mRealName
,
3001 'user_token' => strval( $user->mToken
),
3002 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3003 'user_editcount' => 0,
3004 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3006 foreach ( $params as $name => $value ) {
3007 $fields["user_$name"] = $value;
3009 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3010 if ( $dbw->affectedRows() ) {
3011 $newUser = User
::newFromId( $dbw->insertId() );
3019 * Add this existing user object to the database. If the user already
3020 * exists, a fatal status object is returned, and the user object is
3021 * initialised with the data from the database.
3023 * Previously, this function generated a DB error due to a key conflict
3024 * if the user already existed. Many extension callers use this function
3025 * in code along the lines of:
3027 * $user = User::newFromName( $name );
3028 * if ( !$user->isLoggedIn() ) {
3029 * $user->addToDatabase();
3031 * // do something with $user...
3033 * However, this was vulnerable to a race condition (bug 16020). By
3034 * initialising the user object if the user exists, we aim to support this
3035 * calling sequence as far as possible.
3037 * Note that if the user exists, this function will acquire a write lock,
3038 * so it is still advisable to make the call conditional on isLoggedIn(),
3039 * and to commit the transaction after calling.
3041 * @throws MWException
3044 public function addToDatabase() {
3047 $this->mTouched
= self
::newTouchedTimestamp();
3049 $dbw = wfGetDB( DB_MASTER
);
3050 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3051 $dbw->insert( 'user',
3053 'user_id' => $seqVal,
3054 'user_name' => $this->mName
,
3055 'user_password' => $this->mPassword
,
3056 'user_newpassword' => $this->mNewpassword
,
3057 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3058 'user_email' => $this->mEmail
,
3059 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3060 'user_real_name' => $this->mRealName
,
3061 'user_token' => strval( $this->mToken
),
3062 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3063 'user_editcount' => 0,
3064 'user_touched' => $dbw->timestamp( $this->mTouched
),
3068 if ( !$dbw->affectedRows() ) {
3069 $this->mId
= $dbw->selectField( 'user', 'user_id',
3070 array( 'user_name' => $this->mName
), __METHOD__
);
3073 if ( $this->loadFromDatabase() ) {
3078 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3079 "to insert a user row, but then it doesn't exist when we select it!" );
3081 return Status
::newFatal( 'userexists' );
3083 $this->mId
= $dbw->insertId();
3085 // Clear instance cache other than user table data, which is already accurate
3086 $this->clearInstanceCache();
3088 $this->saveOptions();
3089 return Status
::newGood();
3093 * If this user is logged-in and blocked,
3094 * block any IP address they've successfully logged in from.
3095 * @return bool A block was spread
3097 public function spreadAnyEditBlock() {
3098 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3099 return $this->spreadBlock();
3105 * If this (non-anonymous) user is blocked,
3106 * block the IP address they've successfully logged in from.
3107 * @return bool A block was spread
3109 protected function spreadBlock() {
3110 wfDebug( __METHOD__
. "()\n" );
3112 if ( $this->mId
== 0 ) {
3116 $userblock = Block
::newFromTarget( $this->getName() );
3117 if ( !$userblock ) {
3121 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3125 * Generate a string which will be different for any combination of
3126 * user options which would produce different parser output.
3127 * This will be used as part of the hash key for the parser cache,
3128 * so users with the same options can share the same cached data
3131 * Extensions which require it should install 'PageRenderingHash' hook,
3132 * which will give them a chance to modify this key based on their own
3135 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3136 * @return String Page rendering hash
3138 public function getPageRenderingHash() {
3139 wfDeprecated( __METHOD__
, '1.17' );
3141 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3143 return $this->mHash
;
3146 // stubthreshold is only included below for completeness,
3147 // since it disables the parser cache, its value will always
3148 // be 0 when this function is called by parsercache.
3150 $confstr = $this->getOption( 'math' );
3151 $confstr .= '!' . $this->getStubThreshold();
3152 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3153 $confstr .= '!' . $this->getDatePreference();
3155 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3156 $confstr .= '!' . $wgLang->getCode();
3157 $confstr .= '!' . $this->getOption( 'thumbsize' );
3158 // add in language specific options, if any
3159 $extra = $wgContLang->getExtraHashOptions();
3162 // Since the skin could be overloading link(), it should be
3163 // included here but in practice, none of our skins do that.
3165 $confstr .= $wgRenderHashAppend;
3167 // Give a chance for extensions to modify the hash, if they have
3168 // extra options or other effects on the parser cache.
3169 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3171 // Make it a valid memcached key fragment
3172 $confstr = str_replace( ' ', '_', $confstr );
3173 $this->mHash
= $confstr;
3178 * Get whether the user is explicitly blocked from account creation.
3179 * @return Bool|Block
3181 public function isBlockedFromCreateAccount() {
3182 $this->getBlockedStatus();
3183 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3184 return $this->mBlock
;
3187 # bug 13611: if the IP address the user is trying to create an account from is
3188 # blocked with createaccount disabled, prevent new account creation there even
3189 # when the user is logged in
3190 if( $this->mBlockedFromCreateAccount
=== false ){
3191 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3193 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3194 ?
$this->mBlockedFromCreateAccount
3199 * Get whether the user is blocked from using Special:Emailuser.
3202 public function isBlockedFromEmailuser() {
3203 $this->getBlockedStatus();
3204 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3208 * Get whether the user is allowed to create an account.
3211 function isAllowedToCreateAccount() {
3212 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3216 * Get this user's personal page title.
3218 * @return Title: User's personal page title
3220 public function getUserPage() {
3221 return Title
::makeTitle( NS_USER
, $this->getName() );
3225 * Get this user's talk page title.
3227 * @return Title: User's talk page title
3229 public function getTalkPage() {
3230 $title = $this->getUserPage();
3231 return $title->getTalkPage();
3235 * Determine whether the user is a newbie. Newbies are either
3236 * anonymous IPs, or the most recently created accounts.
3239 public function isNewbie() {
3240 return !$this->isAllowed( 'autoconfirmed' );
3244 * Check to see if the given clear-text password is one of the accepted passwords
3245 * @param $password String: user password.
3246 * @return Boolean: True if the given password is correct, otherwise False.
3248 public function checkPassword( $password ) {
3249 global $wgAuth, $wgLegacyEncoding;
3252 // Even though we stop people from creating passwords that
3253 // are shorter than this, doesn't mean people wont be able
3254 // to. Certain authentication plugins do NOT want to save
3255 // domain passwords in a mysql database, so we should
3256 // check this (in case $wgAuth->strict() is false).
3257 if( !$this->isValidPassword( $password ) ) {
3261 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3263 } elseif( $wgAuth->strict() ) {
3264 /* Auth plugin doesn't allow local authentication */
3266 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3267 /* Auth plugin doesn't allow local authentication for this user name */
3270 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3272 } elseif ( $wgLegacyEncoding ) {
3273 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3274 # Check for this with iconv
3275 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3276 if ( $cp1252Password != $password &&
3277 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3286 * Check if the given clear-text password matches the temporary password
3287 * sent by e-mail for password reset operations.
3289 * @param $plaintext string
3291 * @return Boolean: True if matches, false otherwise
3293 public function checkTemporaryPassword( $plaintext ) {
3294 global $wgNewPasswordExpiry;
3297 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3298 if ( is_null( $this->mNewpassTime
) ) {
3301 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3302 return ( time() < $expiry );
3309 * Alias for getEditToken.
3310 * @deprecated since 1.19, use getEditToken instead.
3312 * @param $salt String|Array of Strings Optional function-specific data for hashing
3313 * @param $request WebRequest object to use or null to use $wgRequest
3314 * @return String The new edit token
3316 public function editToken( $salt = '', $request = null ) {
3317 wfDeprecated( __METHOD__
, '1.19' );
3318 return $this->getEditToken( $salt, $request );
3322 * Initialize (if necessary) and return a session token value
3323 * which can be used in edit forms to show that the user's
3324 * login credentials aren't being hijacked with a foreign form
3329 * @param $salt String|Array of Strings Optional function-specific data for hashing
3330 * @param $request WebRequest object to use or null to use $wgRequest
3331 * @return String The new edit token
3333 public function getEditToken( $salt = '', $request = null ) {
3334 if ( $request == null ) {
3335 $request = $this->getRequest();
3338 if ( $this->isAnon() ) {
3339 return EDIT_TOKEN_SUFFIX
;
3341 $token = $request->getSessionData( 'wsEditToken' );
3342 if ( $token === null ) {
3343 $token = MWCryptRand
::generateHex( 32 );
3344 $request->setSessionData( 'wsEditToken', $token );
3346 if( is_array( $salt ) ) {
3347 $salt = implode( '|', $salt );
3349 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3354 * Generate a looking random token for various uses.
3356 * @param $salt String Optional salt value
3357 * @return String The new random token
3358 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3360 public static function generateToken( $salt = '' ) {
3361 return MWCryptRand
::generateHex( 32 );
3365 * Check given value against the token value stored in the session.
3366 * A match should confirm that the form was submitted from the
3367 * user's own login session, not a form submission from a third-party
3370 * @param $val String Input value to compare
3371 * @param $salt String Optional function-specific data for hashing
3372 * @param $request WebRequest object to use or null to use $wgRequest
3373 * @return Boolean: Whether the token matches
3375 public function matchEditToken( $val, $salt = '', $request = null ) {
3376 $sessionToken = $this->getEditToken( $salt, $request );
3377 if ( $val != $sessionToken ) {
3378 wfDebug( "User::matchEditToken: broken session data\n" );
3380 return $val == $sessionToken;
3384 * Check given value against the token value stored in the session,
3385 * ignoring the suffix.
3387 * @param $val String Input value to compare
3388 * @param $salt String Optional function-specific data for hashing
3389 * @param $request WebRequest object to use or null to use $wgRequest
3390 * @return Boolean: Whether the token matches
3392 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3393 $sessionToken = $this->getEditToken( $salt, $request );
3394 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3398 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3399 * mail to the user's given address.
3401 * @param $type String: message to send, either "created", "changed" or "set"
3402 * @return Status object
3404 public function sendConfirmationMail( $type = 'created' ) {
3406 $expiration = null; // gets passed-by-ref and defined in next line.
3407 $token = $this->confirmationToken( $expiration );
3408 $url = $this->confirmationTokenUrl( $token );
3409 $invalidateURL = $this->invalidationTokenUrl( $token );
3410 $this->saveSettings();
3412 if ( $type == 'created' ||
$type === false ) {
3413 $message = 'confirmemail_body';
3414 } elseif ( $type === true ) {
3415 $message = 'confirmemail_body_changed';
3417 $message = 'confirmemail_body_' . $type;
3420 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3421 wfMessage( $message,
3422 $this->getRequest()->getIP(),
3425 $wgLang->timeanddate( $expiration, false ),
3427 $wgLang->date( $expiration, false ),
3428 $wgLang->time( $expiration, false ) )->text() );
3432 * Send an e-mail to this user's account. Does not check for
3433 * confirmed status or validity.
3435 * @param $subject String Message subject
3436 * @param $body String Message body
3437 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3438 * @param $replyto String Reply-To address
3441 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3442 if( is_null( $from ) ) {
3443 global $wgPasswordSender, $wgPasswordSenderName;
3444 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3446 $sender = new MailAddress( $from );
3449 $to = new MailAddress( $this );
3450 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3454 * Generate, store, and return a new e-mail confirmation code.
3455 * A hash (unsalted, since it's used as a key) is stored.
3457 * @note Call saveSettings() after calling this function to commit
3458 * this change to the database.
3460 * @param &$expiration \mixed Accepts the expiration time
3461 * @return String New token
3463 private function confirmationToken( &$expiration ) {
3464 global $wgUserEmailConfirmationTokenExpiry;
3466 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3467 $expiration = wfTimestamp( TS_MW
, $expires );
3469 $token = MWCryptRand
::generateHex( 32 );
3470 $hash = md5( $token );
3471 $this->mEmailToken
= $hash;
3472 $this->mEmailTokenExpires
= $expiration;
3477 * Return a URL the user can use to confirm their email address.
3478 * @param $token String Accepts the email confirmation token
3479 * @return String New token URL
3481 private function confirmationTokenUrl( $token ) {
3482 return $this->getTokenUrl( 'ConfirmEmail', $token );
3486 * Return a URL the user can use to invalidate their email address.
3487 * @param $token String Accepts the email confirmation token
3488 * @return String New token URL
3490 private function invalidationTokenUrl( $token ) {
3491 return $this->getTokenUrl( 'InvalidateEmail', $token );
3495 * Internal function to format the e-mail validation/invalidation URLs.
3496 * This uses a quickie hack to use the
3497 * hardcoded English names of the Special: pages, for ASCII safety.
3499 * @note Since these URLs get dropped directly into emails, using the
3500 * short English names avoids insanely long URL-encoded links, which
3501 * also sometimes can get corrupted in some browsers/mailers
3502 * (bug 6957 with Gmail and Internet Explorer).
3504 * @param $page String Special page
3505 * @param $token String Token
3506 * @return String Formatted URL
3508 protected function getTokenUrl( $page, $token ) {
3509 // Hack to bypass localization of 'Special:'
3510 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3511 return $title->getCanonicalUrl();
3515 * Mark the e-mail address confirmed.
3517 * @note Call saveSettings() after calling this function to commit the change.
3521 public function confirmEmail() {
3522 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3523 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3528 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3529 * address if it was already confirmed.
3531 * @note Call saveSettings() after calling this function to commit the change.
3532 * @return bool Returns true
3534 function invalidateEmail() {
3536 $this->mEmailToken
= null;
3537 $this->mEmailTokenExpires
= null;
3538 $this->setEmailAuthenticationTimestamp( null );
3539 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3544 * Set the e-mail authentication timestamp.
3545 * @param $timestamp String TS_MW timestamp
3547 function setEmailAuthenticationTimestamp( $timestamp ) {
3549 $this->mEmailAuthenticated
= $timestamp;
3550 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3554 * Is this user allowed to send e-mails within limits of current
3555 * site configuration?
3558 public function canSendEmail() {
3559 global $wgEnableEmail, $wgEnableUserEmail;
3560 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3563 $canSend = $this->isEmailConfirmed();
3564 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3569 * Is this user allowed to receive e-mails within limits of current
3570 * site configuration?
3573 public function canReceiveEmail() {
3574 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3578 * Is this user's e-mail address valid-looking and confirmed within
3579 * limits of the current site configuration?
3581 * @note If $wgEmailAuthentication is on, this may require the user to have
3582 * confirmed their address by returning a code or using a password
3583 * sent to the address from the wiki.
3587 public function isEmailConfirmed() {
3588 global $wgEmailAuthentication;
3591 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3592 if( $this->isAnon() ) {
3595 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3598 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3608 * Check whether there is an outstanding request for e-mail confirmation.
3611 public function isEmailConfirmationPending() {
3612 global $wgEmailAuthentication;
3613 return $wgEmailAuthentication &&
3614 !$this->isEmailConfirmed() &&
3615 $this->mEmailToken
&&
3616 $this->mEmailTokenExpires
> wfTimestamp();
3620 * Get the timestamp of account creation.
3622 * @return String|Bool Timestamp of account creation, or false for
3623 * non-existent/anonymous user accounts.
3625 public function getRegistration() {
3626 if ( $this->isAnon() ) {
3630 return $this->mRegistration
;
3634 * Get the timestamp of the first edit
3636 * @return String|Bool Timestamp of first edit, or false for
3637 * non-existent/anonymous user accounts.
3639 public function getFirstEditTimestamp() {
3640 if( $this->getId() == 0 ) {
3641 return false; // anons
3643 $dbr = wfGetDB( DB_SLAVE
);
3644 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3645 array( 'rev_user' => $this->getId() ),
3647 array( 'ORDER BY' => 'rev_timestamp ASC' )
3650 return false; // no edits
3652 return wfTimestamp( TS_MW
, $time );
3656 * Get the permissions associated with a given list of groups
3658 * @param $groups Array of Strings List of internal group names
3659 * @return Array of Strings List of permission key names for given groups combined
3661 public static function getGroupPermissions( $groups ) {
3662 global $wgGroupPermissions, $wgRevokePermissions;
3664 // grant every granted permission first
3665 foreach( $groups as $group ) {
3666 if( isset( $wgGroupPermissions[$group] ) ) {
3667 $rights = array_merge( $rights,
3668 // array_filter removes empty items
3669 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3672 // now revoke the revoked permissions
3673 foreach( $groups as $group ) {
3674 if( isset( $wgRevokePermissions[$group] ) ) {
3675 $rights = array_diff( $rights,
3676 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3679 return array_unique( $rights );
3683 * Get all the groups who have a given permission
3685 * @param $role String Role to check
3686 * @return Array of Strings List of internal group names with the given permission
3688 public static function getGroupsWithPermission( $role ) {
3689 global $wgGroupPermissions;
3690 $allowedGroups = array();
3691 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
3692 if ( self
::groupHasPermission( $group, $role ) ) {
3693 $allowedGroups[] = $group;
3696 return $allowedGroups;
3700 * Check, if the given group has the given permission
3702 * @param $group String Group to check
3703 * @param $role String Role to check
3706 public static function groupHasPermission( $group, $role ) {
3707 global $wgGroupPermissions, $wgRevokePermissions;
3708 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
3709 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
3713 * Get the localized descriptive name for a group, if it exists
3715 * @param $group String Internal group name
3716 * @return String Localized descriptive group name
3718 public static function getGroupName( $group ) {
3719 $msg = wfMessage( "group-$group" );
3720 return $msg->isBlank() ?
$group : $msg->text();
3724 * Get the localized descriptive name for a member of a group, if it exists
3726 * @param $group String Internal group name
3727 * @param $username String Username for gender (since 1.19)
3728 * @return String Localized name for group member
3730 public static function getGroupMember( $group, $username = '#' ) {
3731 $msg = wfMessage( "group-$group-member", $username );
3732 return $msg->isBlank() ?
$group : $msg->text();
3736 * Return the set of defined explicit groups.
3737 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3738 * are not included, as they are defined automatically, not in the database.
3739 * @return Array of internal group names
3741 public static function getAllGroups() {
3742 global $wgGroupPermissions, $wgRevokePermissions;
3744 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3745 self
::getImplicitGroups()
3750 * Get a list of all available permissions.
3751 * @return Array of permission names
3753 public static function getAllRights() {
3754 if ( self
::$mAllRights === false ) {
3755 global $wgAvailableRights;
3756 if ( count( $wgAvailableRights ) ) {
3757 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3759 self
::$mAllRights = self
::$mCoreRights;
3761 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3763 return self
::$mAllRights;
3767 * Get a list of implicit groups
3768 * @return Array of Strings Array of internal group names
3770 public static function getImplicitGroups() {
3771 global $wgImplicitGroups;
3772 $groups = $wgImplicitGroups;
3773 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3778 * Get the title of a page describing a particular group
3780 * @param $group String Internal group name
3781 * @return Title|Bool Title of the page if it exists, false otherwise
3783 public static function getGroupPage( $group ) {
3784 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3785 if( $msg->exists() ) {
3786 $title = Title
::newFromText( $msg->text() );
3787 if( is_object( $title ) )
3794 * Create a link to the group in HTML, if available;
3795 * else return the group name.
3797 * @param $group String Internal name of the group
3798 * @param $text String The text of the link
3799 * @return String HTML link to the group
3801 public static function makeGroupLinkHTML( $group, $text = '' ) {
3803 $text = self
::getGroupName( $group );
3805 $title = self
::getGroupPage( $group );
3807 return Linker
::link( $title, htmlspecialchars( $text ) );
3814 * Create a link to the group in Wikitext, if available;
3815 * else return the group name.
3817 * @param $group String Internal name of the group
3818 * @param $text String The text of the link
3819 * @return String Wikilink to the group
3821 public static function makeGroupLinkWiki( $group, $text = '' ) {
3823 $text = self
::getGroupName( $group );
3825 $title = self
::getGroupPage( $group );
3827 $page = $title->getPrefixedText();
3828 return "[[$page|$text]]";
3835 * Returns an array of the groups that a particular group can add/remove.
3837 * @param $group String: the group to check for whether it can add/remove
3838 * @return Array array( 'add' => array( addablegroups ),
3839 * 'remove' => array( removablegroups ),
3840 * 'add-self' => array( addablegroups to self),
3841 * 'remove-self' => array( removable groups from self) )
3843 public static function changeableByGroup( $group ) {
3844 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3846 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3847 if( empty( $wgAddGroups[$group] ) ) {
3848 // Don't add anything to $groups
3849 } elseif( $wgAddGroups[$group] === true ) {
3850 // You get everything
3851 $groups['add'] = self
::getAllGroups();
3852 } elseif( is_array( $wgAddGroups[$group] ) ) {
3853 $groups['add'] = $wgAddGroups[$group];
3856 // Same thing for remove
3857 if( empty( $wgRemoveGroups[$group] ) ) {
3858 } elseif( $wgRemoveGroups[$group] === true ) {
3859 $groups['remove'] = self
::getAllGroups();
3860 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3861 $groups['remove'] = $wgRemoveGroups[$group];
3864 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3865 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3866 foreach( $wgGroupsAddToSelf as $key => $value ) {
3867 if( is_int( $key ) ) {
3868 $wgGroupsAddToSelf['user'][] = $value;
3873 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3874 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3875 if( is_int( $key ) ) {
3876 $wgGroupsRemoveFromSelf['user'][] = $value;
3881 // Now figure out what groups the user can add to him/herself
3882 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3883 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3884 // No idea WHY this would be used, but it's there
3885 $groups['add-self'] = User
::getAllGroups();
3886 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3887 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3890 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3891 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3892 $groups['remove-self'] = User
::getAllGroups();
3893 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3894 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3901 * Returns an array of groups that this user can add and remove
3902 * @return Array array( 'add' => array( addablegroups ),
3903 * 'remove' => array( removablegroups ),
3904 * 'add-self' => array( addablegroups to self),
3905 * 'remove-self' => array( removable groups from self) )
3907 public function changeableGroups() {
3908 if( $this->isAllowed( 'userrights' ) ) {
3909 // This group gives the right to modify everything (reverse-
3910 // compatibility with old "userrights lets you change
3912 // Using array_merge to make the groups reindexed
3913 $all = array_merge( User
::getAllGroups() );
3917 'add-self' => array(),
3918 'remove-self' => array()
3922 // Okay, it's not so simple, we will have to go through the arrays
3925 'remove' => array(),
3926 'add-self' => array(),
3927 'remove-self' => array()
3929 $addergroups = $this->getEffectiveGroups();
3931 foreach( $addergroups as $addergroup ) {
3932 $groups = array_merge_recursive(
3933 $groups, $this->changeableByGroup( $addergroup )
3935 $groups['add'] = array_unique( $groups['add'] );
3936 $groups['remove'] = array_unique( $groups['remove'] );
3937 $groups['add-self'] = array_unique( $groups['add-self'] );
3938 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3944 * Increment the user's edit-count field.
3945 * Will have no effect for anonymous users.
3947 public function incEditCount() {
3948 if( !$this->isAnon() ) {
3949 $dbw = wfGetDB( DB_MASTER
);
3952 array( 'user_editcount=user_editcount+1' ),
3953 array( 'user_id' => $this->getId() ),
3957 // Lazy initialization check...
3958 if( $dbw->affectedRows() == 0 ) {
3959 // Now here's a goddamn hack...
3960 $dbr = wfGetDB( DB_SLAVE
);
3961 if( $dbr !== $dbw ) {
3962 // If we actually have a slave server, the count is
3963 // at least one behind because the current transaction
3964 // has not been committed and replicated.
3965 $this->initEditCount( 1 );
3967 // But if DB_SLAVE is selecting the master, then the
3968 // count we just read includes the revision that was
3969 // just added in the working transaction.
3970 $this->initEditCount();
3974 // edit count in user cache too
3975 $this->invalidateCache();
3979 * Initialize user_editcount from data out of the revision table
3981 * @param $add Integer Edits to add to the count from the revision table
3982 * @return Integer Number of edits
3984 protected function initEditCount( $add = 0 ) {
3985 // Pull from a slave to be less cruel to servers
3986 // Accuracy isn't the point anyway here
3987 $dbr = wfGetDB( DB_SLAVE
);
3988 $count = (int) $dbr->selectField(
3991 array( 'rev_user' => $this->getId() ),
3994 $count = $count +
$add;
3996 $dbw = wfGetDB( DB_MASTER
);
3999 array( 'user_editcount' => $count ),
4000 array( 'user_id' => $this->getId() ),
4008 * Get the description of a given right
4010 * @param $right String Right to query
4011 * @return String Localized description of the right
4013 public static function getRightDescription( $right ) {
4014 $key = "right-$right";
4015 $msg = wfMessage( $key );
4016 return $msg->isBlank() ?
$right : $msg->text();
4020 * Make an old-style password hash
4022 * @param $password String Plain-text password
4023 * @param $userId String User ID
4024 * @return String Password hash
4026 public static function oldCrypt( $password, $userId ) {
4027 global $wgPasswordSalt;
4028 if ( $wgPasswordSalt ) {
4029 return md5( $userId . '-' . md5( $password ) );
4031 return md5( $password );
4036 * Make a new-style password hash
4038 * @param $password String Plain-text password
4039 * @param bool|string $salt Optional salt, may be random or the user ID.
4041 * If unspecified or false, will generate one automatically
4042 * @return String Password hash
4044 public static function crypt( $password, $salt = false ) {
4045 global $wgPasswordSalt;
4048 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
4052 if( $wgPasswordSalt ) {
4053 if ( $salt === false ) {
4054 $salt = MWCryptRand
::generateHex( 8 );
4056 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
4058 return ':A:' . md5( $password );
4063 * Compare a password hash with a plain-text password. Requires the user
4064 * ID if there's a chance that the hash is an old-style hash.
4066 * @param $hash String Password hash
4067 * @param $password String Plain-text password to compare
4068 * @param $userId String|bool User ID for old-style password salt
4072 public static function comparePasswords( $hash, $password, $userId = false ) {
4073 $type = substr( $hash, 0, 3 );
4076 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4080 if ( $type == ':A:' ) {
4082 return md5( $password ) === substr( $hash, 3 );
4083 } elseif ( $type == ':B:' ) {
4085 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4086 return md5( $salt.'-'.md5( $password ) ) === $realHash;
4089 return self
::oldCrypt( $password, $userId ) === $hash;
4094 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
4096 * @param $byEmail Boolean: account made by email?
4097 * @param $reason String: user supplied reason
4099 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4101 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
4102 global $wgUser, $wgContLang, $wgNewUserLog;
4103 if( empty( $wgNewUserLog ) ) {
4104 return true; // disabled
4107 if( $this->getName() == $wgUser->getName() ) {
4110 $action = 'create2';
4112 if ( $reason === '' ) {
4113 $reason = wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text();
4115 $reason = $wgContLang->commaList( array(
4116 $reason, wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text() ) );
4120 $log = new LogPage( 'newusers' );
4121 return (int)$log->addEntry(
4123 $this->getUserPage(),
4125 array( $this->getId() )
4130 * Add an autocreate newuser log entry for this user
4131 * Used by things like CentralAuth and perhaps other authplugins.
4135 public function addNewUserLogEntryAutoCreate() {
4136 global $wgNewUserLog;
4137 if( !$wgNewUserLog ) {
4138 return true; // disabled
4140 $log = new LogPage( 'newusers', false );
4141 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4146 * Load the user options either from cache, the database or an array
4148 * @param $data Rows for the current user out of the user_properties table
4150 protected function loadOptions( $data = null ) {
4155 if ( $this->mOptionsLoaded
) {
4159 $this->mOptions
= self
::getDefaultOptions();
4161 if ( !$this->getId() ) {
4162 // For unlogged-in users, load language/variant options from request.
4163 // There's no need to do it for logged-in users: they can set preferences,
4164 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4165 // so don't override user's choice (especially when the user chooses site default).
4166 $variant = $wgContLang->getDefaultVariant();
4167 $this->mOptions
['variant'] = $variant;
4168 $this->mOptions
['language'] = $variant;
4169 $this->mOptionsLoaded
= true;
4173 // Maybe load from the object
4174 if ( !is_null( $this->mOptionOverrides
) ) {
4175 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4176 foreach( $this->mOptionOverrides
as $key => $value ) {
4177 $this->mOptions
[$key] = $value;
4180 if( !is_array( $data ) ) {
4181 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4182 // Load from database
4183 $dbr = wfGetDB( DB_SLAVE
);
4185 $res = $dbr->select(
4187 array( 'up_property', 'up_value' ),
4188 array( 'up_user' => $this->getId() ),
4192 $this->mOptionOverrides
= array();
4194 foreach ( $res as $row ) {
4195 $data[$row->up_property
] = $row->up_value
;
4198 foreach ( $data as $property => $value ) {
4199 $this->mOptionOverrides
[$property] = $value;
4200 $this->mOptions
[$property] = $value;
4204 $this->mOptionsLoaded
= true;
4206 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4212 protected function saveOptions() {
4213 global $wgAllowPrefChange;
4215 $this->loadOptions();
4217 // Not using getOptions(), to keep hidden preferences in database
4218 $saveOptions = $this->mOptions
;
4220 // Allow hooks to abort, for instance to save to a global profile.
4221 // Reset options to default state before saving.
4222 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4226 $extuser = ExternalUser
::newFromUser( $this );
4227 $userId = $this->getId();
4228 $insert_rows = array();
4229 foreach( $saveOptions as $key => $value ) {
4230 # Don't bother storing default values
4231 $defaultOption = self
::getDefaultOption( $key );
4232 if ( ( is_null( $defaultOption ) &&
4233 !( $value === false ||
is_null( $value ) ) ) ||
4234 $value != $defaultOption ) {
4235 $insert_rows[] = array(
4236 'up_user' => $userId,
4237 'up_property' => $key,
4238 'up_value' => $value,
4241 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4242 switch ( $wgAllowPrefChange[$key] ) {
4248 $extuser->setPref( $key, $value );
4253 $dbw = wfGetDB( DB_MASTER
);
4254 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4255 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4259 * Provide an array of HTML5 attributes to put on an input element
4260 * intended for the user to enter a new password. This may include
4261 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4263 * Do *not* use this when asking the user to enter his current password!
4264 * Regardless of configuration, users may have invalid passwords for whatever
4265 * reason (e.g., they were set before requirements were tightened up).
4266 * Only use it when asking for a new password, like on account creation or
4269 * Obviously, you still need to do server-side checking.
4271 * NOTE: A combination of bugs in various browsers means that this function
4272 * actually just returns array() unconditionally at the moment. May as
4273 * well keep it around for when the browser bugs get fixed, though.
4275 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4277 * @return array Array of HTML attributes suitable for feeding to
4278 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4279 * That will potentially output invalid XHTML 1.0 Transitional, and will
4280 * get confused by the boolean attribute syntax used.)
4282 public static function passwordChangeInputAttribs() {
4283 global $wgMinimalPasswordLength;
4285 if ( $wgMinimalPasswordLength == 0 ) {
4289 # Note that the pattern requirement will always be satisfied if the
4290 # input is empty, so we need required in all cases.
4292 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4293 # if e-mail confirmation is being used. Since HTML5 input validation
4294 # is b0rked anyway in some browsers, just return nothing. When it's
4295 # re-enabled, fix this code to not output required for e-mail
4297 #$ret = array( 'required' );
4300 # We can't actually do this right now, because Opera 9.6 will print out
4301 # the entered password visibly in its error message! When other
4302 # browsers add support for this attribute, or Opera fixes its support,
4303 # we can add support with a version check to avoid doing this on Opera
4304 # versions where it will be a problem. Reported to Opera as
4305 # DSK-262266, but they don't have a public bug tracker for us to follow.
4307 if ( $wgMinimalPasswordLength > 1 ) {
4308 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4309 $ret['title'] = wfMessage( 'passwordtooshort' )
4310 ->numParams( $wgMinimalPasswordLength )->text();
4318 * Return the list of user fields that should be selected to create
4319 * a new user object.
4322 public static function selectFields() {
4329 'user_newpass_time',
4333 'user_email_authenticated',
4335 'user_email_token_expires',
4336 'user_registration',