3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Int Number of characters in user_token field.
27 define( 'USER_TOKEN_LENGTH', 32 );
30 * Int Serialized record version.
33 define( 'MW_USER_VERSION', 8 );
36 * String Some punctuation to prevent editing from broken text-mangling proxies.
39 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
42 * Thrown by User::setPassword() on error.
45 class PasswordError
extends MWException
{
50 * The User object encapsulates all of the user-specific settings (user_id,
51 * name, rights, password, email address, options, last login time). Client
52 * classes use the getXXX() functions to access these fields. These functions
53 * do all the work of determining whether the user is logged in,
54 * whether the requested option can be satisfied from cookies or
55 * whether a database query is needed. Most of the settings needed
56 * for rendering normal pages are set in the cookie to minimize use
61 * Global constants made accessible as class constants so that autoloader
64 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
65 const MW_USER_VERSION
= MW_USER_VERSION
;
66 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
69 * Maximum items in $mWatchedItems
71 const MAX_WATCHED_ITEMS_CACHE
= 100;
74 * Array of Strings List of member variables which are saved to the
75 * shared cache (memcached). Any operation which changes the
76 * corresponding database fields must call a cache-clearing function.
79 static $mCacheVars = array(
90 'mEmailAuthenticated',
97 // user_properties table
102 * Array of Strings Core rights.
103 * Each of these should have a corresponding message of the form
107 static $mCoreRights = array(
127 'editusercssjs', #deprecated
139 'move-rootuserpages',
143 'override-export-depth',
166 'userrights-interwiki',
170 * String Cached results of getAllRights()
172 static $mAllRights = false;
174 /** @name Cache variables */
176 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
177 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
178 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
179 $mGroups, $mOptionOverrides;
183 * Bool Whether the cache variables have been loaded.
189 * Array with already loaded items or true if all items have been loaded.
191 private $mLoadedItems = array();
195 * String Initialization data source if mLoadedItems!==true. May be one of:
196 * - 'defaults' anonymous user initialised from class defaults
197 * - 'name' initialise from mName
198 * - 'id' initialise from mId
199 * - 'session' log in from cookies or session if possible
201 * Use the User::newFrom*() family of functions to set this.
206 * Lazy-initialized variables, invalidated with clearInstanceCache
208 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
209 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
210 $mLocked, $mHideName, $mOptions;
230 private $mBlockedFromCreateAccount = false;
235 private $mWatchedItems = array();
237 static $idCacheByName = array();
240 * Lightweight constructor for an anonymous user.
241 * Use the User::newFrom* factory functions for other kinds of users.
245 * @see newFromConfirmationCode()
246 * @see newFromSession()
249 function __construct() {
250 $this->clearInstanceCache( 'defaults' );
256 function __toString(){
257 return $this->getName();
261 * Load the user table data for this object from the source given by mFrom.
263 public function load() {
264 if ( $this->mLoadedItems
=== true ) {
267 wfProfileIn( __METHOD__
);
269 # Set it now to avoid infinite recursion in accessors
270 $this->mLoadedItems
= true;
272 switch ( $this->mFrom
) {
274 $this->loadDefaults();
277 $this->mId
= self
::idFromName( $this->mName
);
279 # Nonexistent user placeholder object
280 $this->loadDefaults( $this->mName
);
289 if( !$this->loadFromSession() ) {
290 // Loading from session failed. Load defaults.
291 $this->loadDefaults();
293 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
296 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
298 wfProfileOut( __METHOD__
);
302 * Load user table data, given mId has already been set.
303 * @return Bool false if the ID does not exist, true otherwise
305 public function loadFromId() {
307 if ( $this->mId
== 0 ) {
308 $this->loadDefaults();
313 $key = wfMemcKey( 'user', 'id', $this->mId
);
314 $data = $wgMemc->get( $key );
315 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
316 # Object is expired, load from DB
321 wfDebug( "User: cache miss for user {$this->mId}\n" );
323 if ( !$this->loadFromDatabase() ) {
324 # Can't load from ID, user is anonymous
327 $this->saveToCache();
329 wfDebug( "User: got user {$this->mId} from cache\n" );
331 foreach ( self
::$mCacheVars as $name ) {
332 $this->$name = $data[$name];
339 * Save user data to the shared cache
341 public function saveToCache() {
344 $this->loadOptions();
345 if ( $this->isAnon() ) {
346 // Anonymous users are uncached
350 foreach ( self
::$mCacheVars as $name ) {
351 $data[$name] = $this->$name;
353 $data['mVersion'] = MW_USER_VERSION
;
354 $key = wfMemcKey( 'user', 'id', $this->mId
);
356 $wgMemc->set( $key, $data );
359 /** @name newFrom*() static factory methods */
363 * Static factory method for creation from username.
365 * This is slightly less efficient than newFromId(), so use newFromId() if
366 * you have both an ID and a name handy.
368 * @param $name String Username, validated by Title::newFromText()
369 * @param $validate String|Bool Validate username. Takes the same parameters as
370 * User::getCanonicalName(), except that true is accepted as an alias
371 * for 'valid', for BC.
373 * @return User object, or false if the username is invalid
374 * (e.g. if it contains illegal characters or is an IP address). If the
375 * username is not present in the database, the result will be a user object
376 * with a name, zero user ID and default settings.
378 public static function newFromName( $name, $validate = 'valid' ) {
379 if ( $validate === true ) {
382 $name = self
::getCanonicalName( $name, $validate );
383 if ( $name === false ) {
386 # Create unloaded user object
390 $u->setItemLoaded( 'name' );
396 * Static factory method for creation from a given user ID.
398 * @param $id Int Valid user ID
399 * @return User The corresponding User object
401 public static function newFromId( $id ) {
405 $u->setItemLoaded( 'id' );
410 * Factory method to fetch whichever user has a given email confirmation code.
411 * This code is generated when an account is created or its e-mail address
414 * If the code is invalid or has expired, returns NULL.
416 * @param $code String Confirmation code
417 * @return User object, or null
419 public static function newFromConfirmationCode( $code ) {
420 $dbr = wfGetDB( DB_SLAVE
);
421 $id = $dbr->selectField( 'user', 'user_id', array(
422 'user_email_token' => md5( $code ),
423 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
425 if( $id !== false ) {
426 return User
::newFromId( $id );
433 * Create a new user object using data from session or cookies. If the
434 * login credentials are invalid, the result is an anonymous user.
436 * @param $request WebRequest object to use; $wgRequest will be used if
438 * @return User object
440 public static function newFromSession( WebRequest
$request = null ) {
442 $user->mFrom
= 'session';
443 $user->mRequest
= $request;
448 * Create a new user object from a user row.
449 * The row should have the following fields from the user table in it:
450 * - either user_name or user_id to load further data if needed (or both)
452 * - all other fields (email, password, etc.)
453 * It is useless to provide the remaining fields if either user_id,
454 * user_name and user_real_name are not provided because the whole row
455 * will be loaded once more from the database when accessing them.
457 * @param $row Array A row from the user table
458 * @param $data Array Further data to load into the object (see User::loadFromRow for valid keys)
461 public static function newFromRow( $row, $data = null ) {
463 $user->loadFromRow( $row, $data );
470 * Get the username corresponding to a given user ID
471 * @param $id Int User ID
472 * @return String|bool The corresponding username
474 public static function whoIs( $id ) {
475 return UserCache
::singleton()->getProp( $id, 'name' );
479 * Get the real name of a user given their user ID
481 * @param $id Int User ID
482 * @return String|bool The corresponding user's real name
484 public static function whoIsReal( $id ) {
485 return UserCache
::singleton()->getProp( $id, 'real_name' );
489 * Get database id given a user name
490 * @param $name String Username
491 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
493 public static function idFromName( $name ) {
494 $nt = Title
::makeTitleSafe( NS_USER
, $name );
495 if( is_null( $nt ) ) {
500 if ( isset( self
::$idCacheByName[$name] ) ) {
501 return self
::$idCacheByName[$name];
504 $dbr = wfGetDB( DB_SLAVE
);
505 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
507 if ( $s === false ) {
510 $result = $s->user_id
;
513 self
::$idCacheByName[$name] = $result;
515 if ( count( self
::$idCacheByName ) > 1000 ) {
516 self
::$idCacheByName = array();
523 * Reset the cache used in idFromName(). For use in tests.
525 public static function resetIdByNameCache() {
526 self
::$idCacheByName = array();
530 * Does the string match an anonymous IPv4 address?
532 * This function exists for username validation, in order to reject
533 * usernames which are similar in form to IP addresses. Strings such
534 * as 300.300.300.300 will return true because it looks like an IP
535 * address, despite not being strictly valid.
537 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
538 * address because the usemod software would "cloak" anonymous IP
539 * addresses like this, if we allowed accounts like this to be created
540 * new users could get the old edits of these anonymous users.
542 * @param $name String to match
545 public static function isIP( $name ) {
546 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
550 * Is the input a valid username?
552 * Checks if the input is a valid username, we don't want an empty string,
553 * an IP address, anything that containins slashes (would mess up subpages),
554 * is longer than the maximum allowed username size or doesn't begin with
557 * @param $name String to match
560 public static function isValidUserName( $name ) {
561 global $wgContLang, $wgMaxNameChars;
564 || User
::isIP( $name )
565 ||
strpos( $name, '/' ) !== false
566 ||
strlen( $name ) > $wgMaxNameChars
567 ||
$name != $wgContLang->ucfirst( $name ) ) {
568 wfDebugLog( 'username', __METHOD__
.
569 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
574 // Ensure that the name can't be misresolved as a different title,
575 // such as with extra namespace keys at the start.
576 $parsed = Title
::newFromText( $name );
577 if( is_null( $parsed )
578 ||
$parsed->getNamespace()
579 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
580 wfDebugLog( 'username', __METHOD__
.
581 ": '$name' invalid due to ambiguous prefixes" );
585 // Check an additional blacklist of troublemaker characters.
586 // Should these be merged into the title char list?
587 $unicodeBlacklist = '/[' .
588 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
589 '\x{00a0}' . # non-breaking space
590 '\x{2000}-\x{200f}' . # various whitespace
591 '\x{2028}-\x{202f}' . # breaks and control chars
592 '\x{3000}' . # ideographic space
593 '\x{e000}-\x{f8ff}' . # private use
595 if( preg_match( $unicodeBlacklist, $name ) ) {
596 wfDebugLog( 'username', __METHOD__
.
597 ": '$name' invalid due to blacklisted characters" );
605 * Usernames which fail to pass this function will be blocked
606 * from user login and new account registrations, but may be used
607 * internally by batch processes.
609 * If an account already exists in this form, login will be blocked
610 * by a failure to pass this function.
612 * @param $name String to match
615 public static function isUsableName( $name ) {
616 global $wgReservedUsernames;
617 // Must be a valid username, obviously ;)
618 if ( !self
::isValidUserName( $name ) ) {
622 static $reservedUsernames = false;
623 if ( !$reservedUsernames ) {
624 $reservedUsernames = $wgReservedUsernames;
625 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
628 // Certain names may be reserved for batch processes.
629 foreach ( $reservedUsernames as $reserved ) {
630 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
631 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
633 if ( $reserved == $name ) {
641 * Usernames which fail to pass this function will be blocked
642 * from new account registrations, but may be used internally
643 * either by batch processes or by user accounts which have
644 * already been created.
646 * Additional blacklisting may be added here rather than in
647 * isValidUserName() to avoid disrupting existing accounts.
649 * @param $name String to match
652 public static function isCreatableName( $name ) {
653 global $wgInvalidUsernameCharacters;
655 // Ensure that the username isn't longer than 235 bytes, so that
656 // (at least for the builtin skins) user javascript and css files
657 // will work. (bug 23080)
658 if( strlen( $name ) > 235 ) {
659 wfDebugLog( 'username', __METHOD__
.
660 ": '$name' invalid due to length" );
664 // Preg yells if you try to give it an empty string
665 if( $wgInvalidUsernameCharacters !== '' ) {
666 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
667 wfDebugLog( 'username', __METHOD__
.
668 ": '$name' invalid due to wgInvalidUsernameCharacters" );
673 return self
::isUsableName( $name );
677 * Is the input a valid password for this user?
679 * @param $password String Desired password
682 public function isValidPassword( $password ) {
683 //simple boolean wrapper for getPasswordValidity
684 return $this->getPasswordValidity( $password ) === true;
688 * Given unvalidated password input, return error message on failure.
690 * @param $password String Desired password
691 * @return mixed: true on success, string or array of error message on failure
693 public function getPasswordValidity( $password ) {
694 global $wgMinimalPasswordLength, $wgContLang;
696 static $blockedLogins = array(
697 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
698 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
701 $result = false; //init $result to false for the internal checks
703 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
706 if ( $result === false ) {
707 if( strlen( $password ) < $wgMinimalPasswordLength ) {
708 return 'passwordtooshort';
709 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
710 return 'password-name-match';
711 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
712 return 'password-login-forbidden';
714 //it seems weird returning true here, but this is because of the
715 //initialization of $result to false above. If the hook is never run or it
716 //doesn't modify $result, then we will likely get down into this if with
720 } elseif( $result === true ) {
723 return $result; //the isValidPassword hook set a string $result and returned true
728 * Does a string look like an e-mail address?
730 * This validates an email address using an HTML5 specification found at:
731 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
732 * Which as of 2011-01-24 says:
734 * A valid e-mail address is a string that matches the ABNF production
735 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
736 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
739 * This function is an implementation of the specification as requested in
742 * Client-side forms will use the same standard validation rules via JS or
743 * HTML 5 validation; additional restrictions can be enforced server-side
744 * by extensions via the 'isValidEmailAddr' hook.
746 * Note that this validation doesn't 100% match RFC 2822, but is believed
747 * to be liberal enough for wide use. Some invalid addresses will still
748 * pass validation here.
750 * @param $addr String E-mail address
752 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
754 public static function isValidEmailAddr( $addr ) {
755 wfDeprecated( __METHOD__
, '1.18' );
756 return Sanitizer
::validateEmail( $addr );
760 * Given unvalidated user input, return a canonical username, or false if
761 * the username is invalid.
762 * @param $name String User input
763 * @param $validate String|Bool type of validation to use:
764 * - false No validation
765 * - 'valid' Valid for batch processes
766 * - 'usable' Valid for batch processes and login
767 * - 'creatable' Valid for batch processes, login and account creation
769 * @throws MWException
770 * @return bool|string
772 public static function getCanonicalName( $name, $validate = 'valid' ) {
773 # Force usernames to capital
775 $name = $wgContLang->ucfirst( $name );
777 # Reject names containing '#'; these will be cleaned up
778 # with title normalisation, but then it's too late to
780 if( strpos( $name, '#' ) !== false )
783 # Clean up name according to title rules
784 $t = ( $validate === 'valid' ) ?
785 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
786 # Check for invalid titles
787 if( is_null( $t ) ) {
791 # Reject various classes of invalid names
793 $name = $wgAuth->getCanonicalName( $t->getText() );
795 switch ( $validate ) {
799 if ( !User
::isValidUserName( $name ) ) {
804 if ( !User
::isUsableName( $name ) ) {
809 if ( !User
::isCreatableName( $name ) ) {
814 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
820 * Count the number of edits of a user
822 * @param $uid Int User ID to check
823 * @return Int the user's edit count
825 * @deprecated since 1.21 in favour of User::getEditCount
827 public static function edits( $uid ) {
828 wfDeprecated( __METHOD__
, '1.21' );
829 $user = self
::newFromId( $uid );
830 return $user->getEditCount();
834 * Return a random password.
836 * @return String new random password
838 public static function randomPassword() {
839 global $wgMinimalPasswordLength;
840 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
841 $length = max( 10, $wgMinimalPasswordLength );
842 // Multiply by 1.25 to get the number of hex characters we need
843 $length = $length * 1.25;
844 // Generate random hex chars
845 $hex = MWCryptRand
::generateHex( $length );
846 // Convert from base 16 to base 32 to get a proper password like string
847 return wfBaseConvert( $hex, 16, 32 );
851 * Set cached properties to default.
853 * @note This no longer clears uncached lazy-initialised properties;
854 * the constructor does that instead.
856 * @param $name string
858 public function loadDefaults( $name = false ) {
859 wfProfileIn( __METHOD__
);
862 $this->mName
= $name;
863 $this->mRealName
= '';
864 $this->mPassword
= $this->mNewpassword
= '';
865 $this->mNewpassTime
= null;
867 $this->mOptionOverrides
= null;
868 $this->mOptionsLoaded
= false;
870 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
871 if( $loggedOut !== null ) {
872 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
874 $this->mTouched
= '1'; # Allow any pages to be cached
877 $this->mToken
= null; // Don't run cryptographic functions till we need a token
878 $this->mEmailAuthenticated
= null;
879 $this->mEmailToken
= '';
880 $this->mEmailTokenExpires
= null;
881 $this->mRegistration
= wfTimestamp( TS_MW
);
882 $this->mGroups
= array();
884 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
886 wfProfileOut( __METHOD__
);
890 * Return whether an item has been loaded.
892 * @param $item String: item to check. Current possibilities:
896 * @param $all String: 'all' to check if the whole object has been loaded
897 * or any other string to check if only the item is available (e.g.
901 public function isItemLoaded( $item, $all = 'all' ) {
902 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
903 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
907 * Set that an item has been loaded
909 * @param $item String
911 private function setItemLoaded( $item ) {
912 if ( is_array( $this->mLoadedItems
) ) {
913 $this->mLoadedItems
[$item] = true;
918 * Load user data from the session or login cookie.
919 * @return Bool True if the user is logged in, false otherwise.
921 private function loadFromSession() {
922 global $wgExternalAuthType, $wgAutocreatePolicy;
925 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
926 if ( $result !== null ) {
930 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
931 $extUser = ExternalUser
::newFromCookie();
933 # TODO: Automatically create the user here (or probably a bit
934 # lower down, in fact)
938 $request = $this->getRequest();
940 $cookieId = $request->getCookie( 'UserID' );
941 $sessId = $request->getSessionData( 'wsUserID' );
943 if ( $cookieId !== null ) {
944 $sId = intval( $cookieId );
945 if( $sessId !== null && $cookieId != $sessId ) {
946 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
947 cookie user ID ($sId) don't match!" );
950 $request->setSessionData( 'wsUserID', $sId );
951 } elseif ( $sessId !== null && $sessId != 0 ) {
957 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
958 $sName = $request->getSessionData( 'wsUserName' );
959 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
960 $sName = $request->getCookie( 'UserName' );
961 $request->setSessionData( 'wsUserName', $sName );
966 $proposedUser = User
::newFromId( $sId );
967 if ( !$proposedUser->isLoggedIn() ) {
972 global $wgBlockDisablesLogin;
973 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
974 # User blocked and we've disabled blocked user logins
978 if ( $request->getSessionData( 'wsToken' ) ) {
979 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
981 } elseif ( $request->getCookie( 'Token' ) ) {
982 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
985 # No session or persistent login cookie
989 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
990 $this->loadFromUserObject( $proposedUser );
991 $request->setSessionData( 'wsToken', $this->mToken
);
992 wfDebug( "User: logged in from $from\n" );
995 # Invalid credentials
996 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1002 * Load user and user_group data from the database.
1003 * $this->mId must be set, this is how the user is identified.
1005 * @return Bool True if the user exists, false if the user is anonymous
1007 public function loadFromDatabase() {
1009 $this->mId
= intval( $this->mId
);
1011 /** Anonymous user */
1013 $this->loadDefaults();
1017 $dbr = wfGetDB( DB_MASTER
);
1018 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1020 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1022 if ( $s !== false ) {
1023 # Initialise user table data
1024 $this->loadFromRow( $s );
1025 $this->mGroups
= null; // deferred
1026 $this->getEditCount(); // revalidation for nulls
1031 $this->loadDefaults();
1037 * Initialize this object from a row from the user table.
1039 * @param $row Array Row from the user table to load.
1040 * @param $data Array Further user data to load into the object
1042 * user_groups Array with groups out of the user_groups table
1043 * user_properties Array with properties out of the user_properties table
1045 public function loadFromRow( $row, $data = null ) {
1048 $this->mGroups
= null; // deferred
1050 if ( isset( $row->user_name
) ) {
1051 $this->mName
= $row->user_name
;
1052 $this->mFrom
= 'name';
1053 $this->setItemLoaded( 'name' );
1058 if ( isset( $row->user_real_name
) ) {
1059 $this->mRealName
= $row->user_real_name
;
1060 $this->setItemLoaded( 'realname' );
1065 if ( isset( $row->user_id
) ) {
1066 $this->mId
= intval( $row->user_id
);
1067 $this->mFrom
= 'id';
1068 $this->setItemLoaded( 'id' );
1073 if ( isset( $row->user_editcount
) ) {
1074 $this->mEditCount
= $row->user_editcount
;
1079 if ( isset( $row->user_password
) ) {
1080 $this->mPassword
= $row->user_password
;
1081 $this->mNewpassword
= $row->user_newpassword
;
1082 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1083 $this->mEmail
= $row->user_email
;
1084 if ( isset( $row->user_options
) ) {
1085 $this->decodeOptions( $row->user_options
);
1087 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1088 $this->mToken
= $row->user_token
;
1089 if ( $this->mToken
== '' ) {
1090 $this->mToken
= null;
1092 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1093 $this->mEmailToken
= $row->user_email_token
;
1094 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1095 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1101 $this->mLoadedItems
= true;
1104 if ( is_array( $data ) ) {
1105 if ( is_array( $data['user_groups'] ) ) {
1106 $this->mGroups
= $data['user_groups'];
1108 if ( is_array( $data['user_properties'] ) ) {
1109 $this->loadOptions( $data['user_properties'] );
1115 * Load the data for this user object from another user object.
1119 protected function loadFromUserObject( $user ) {
1121 $user->loadGroups();
1122 $user->loadOptions();
1123 foreach ( self
::$mCacheVars as $var ) {
1124 $this->$var = $user->$var;
1129 * Load the groups from the database if they aren't already loaded.
1131 private function loadGroups() {
1132 if ( is_null( $this->mGroups
) ) {
1133 $dbr = wfGetDB( DB_MASTER
);
1134 $res = $dbr->select( 'user_groups',
1135 array( 'ug_group' ),
1136 array( 'ug_user' => $this->mId
),
1138 $this->mGroups
= array();
1139 foreach ( $res as $row ) {
1140 $this->mGroups
[] = $row->ug_group
;
1146 * Add the user to the group if he/she meets given criteria.
1148 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1149 * possible to remove manually via Special:UserRights. In such case it
1150 * will not be re-added automatically. The user will also not lose the
1151 * group if they no longer meet the criteria.
1153 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1155 * @return array Array of groups the user has been promoted to.
1157 * @see $wgAutopromoteOnce
1159 public function addAutopromoteOnceGroups( $event ) {
1160 global $wgAutopromoteOnceLogInRC;
1162 $toPromote = array();
1163 if ( $this->getId() ) {
1164 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1165 if ( count( $toPromote ) ) {
1166 $oldGroups = $this->getGroups(); // previous groups
1167 foreach ( $toPromote as $group ) {
1168 $this->addGroup( $group );
1170 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1172 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1173 $log->addEntry( 'autopromote',
1174 $this->getUserPage(),
1176 // These group names are "list to texted"-ed in class LogPage.
1177 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1185 * Clear various cached data stored in this object. The cache of the user table
1186 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1188 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1189 * given source. May be "name", "id", "defaults", "session", or false for
1192 public function clearInstanceCache( $reloadFrom = false ) {
1193 $this->mNewtalk
= -1;
1194 $this->mDatePreference
= null;
1195 $this->mBlockedby
= -1; # Unset
1196 $this->mHash
= false;
1197 $this->mRights
= null;
1198 $this->mEffectiveGroups
= null;
1199 $this->mImplicitGroups
= null;
1200 $this->mOptions
= null;
1201 $this->mOptionsLoaded
= false;
1202 $this->mEditCount
= null;
1204 if ( $reloadFrom ) {
1205 $this->mLoadedItems
= array();
1206 $this->mFrom
= $reloadFrom;
1211 * Combine the language default options with any site-specific options
1212 * and add the default language variants.
1214 * @return Array of String options
1216 public static function getDefaultOptions() {
1217 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1219 static $defOpt = null;
1220 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1221 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1222 // mid-request and see that change reflected in the return value of this function.
1223 // Which is insane and would never happen during normal MW operation
1227 $defOpt = $wgDefaultUserOptions;
1228 # default language setting
1229 $defOpt['variant'] = $wgContLang->getCode();
1230 $defOpt['language'] = $wgContLang->getCode();
1231 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1232 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1234 $defOpt['skin'] = $wgDefaultSkin;
1236 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1242 * Get a given default option value.
1244 * @param $opt String Name of option to retrieve
1245 * @return String Default option value
1247 public static function getDefaultOption( $opt ) {
1248 $defOpts = self
::getDefaultOptions();
1249 if( isset( $defOpts[$opt] ) ) {
1250 return $defOpts[$opt];
1258 * Get blocking information
1259 * @param $bFromSlave Bool Whether to check the slave database first. To
1260 * improve performance, non-critical checks are done
1261 * against slaves. Check when actually saving should be
1262 * done against master.
1264 private function getBlockedStatus( $bFromSlave = true ) {
1265 global $wgProxyWhitelist, $wgUser;
1267 if ( -1 != $this->mBlockedby
) {
1271 wfProfileIn( __METHOD__
);
1272 wfDebug( __METHOD__
.": checking...\n" );
1274 // Initialize data...
1275 // Otherwise something ends up stomping on $this->mBlockedby when
1276 // things get lazy-loaded later, causing false positive block hits
1277 // due to -1 !== 0. Probably session-related... Nothing should be
1278 // overwriting mBlockedby, surely?
1281 # We only need to worry about passing the IP address to the Block generator if the
1282 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1283 # know which IP address they're actually coming from
1284 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1285 $ip = $this->getRequest()->getIP();
1291 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1294 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1295 && !in_array( $ip, $wgProxyWhitelist ) )
1298 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1300 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1301 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1302 $block->setTarget( $ip );
1303 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1305 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1306 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1307 $block->setTarget( $ip );
1311 if ( $block instanceof Block
) {
1312 wfDebug( __METHOD__
. ": Found block.\n" );
1313 $this->mBlock
= $block;
1314 $this->mBlockedby
= $block->getByName();
1315 $this->mBlockreason
= $block->mReason
;
1316 $this->mHideName
= $block->mHideName
;
1317 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1319 $this->mBlockedby
= '';
1320 $this->mHideName
= 0;
1321 $this->mAllowUsertalk
= false;
1325 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1327 wfProfileOut( __METHOD__
);
1331 * Whether the given IP is in a DNS blacklist.
1333 * @param $ip String IP to check
1334 * @param $checkWhitelist Bool: whether to check the whitelist first
1335 * @return Bool True if blacklisted.
1337 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1338 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1339 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1341 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1344 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1347 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1348 return $this->inDnsBlacklist( $ip, $urls );
1352 * Whether the given IP is in a given DNS blacklist.
1354 * @param $ip String IP to check
1355 * @param $bases String|Array of Strings: URL of the DNS blacklist
1356 * @return Bool True if blacklisted.
1358 public function inDnsBlacklist( $ip, $bases ) {
1359 wfProfileIn( __METHOD__
);
1362 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1363 if( IP
::isIPv4( $ip ) ) {
1364 # Reverse IP, bug 21255
1365 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1367 foreach( (array)$bases as $base ) {
1369 # If we have an access key, use that too (ProjectHoneypot, etc.)
1370 if( is_array( $base ) ) {
1371 if( count( $base ) >= 2 ) {
1372 # Access key is 1, base URL is 0
1373 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1375 $host = "$ipReversed.{$base[0]}";
1378 $host = "$ipReversed.$base";
1382 $ipList = gethostbynamel( $host );
1385 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1389 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1394 wfProfileOut( __METHOD__
);
1399 * Check if an IP address is in the local proxy list
1405 public static function isLocallyBlockedProxy( $ip ) {
1406 global $wgProxyList;
1408 if ( !$wgProxyList ) {
1411 wfProfileIn( __METHOD__
);
1413 if ( !is_array( $wgProxyList ) ) {
1414 # Load from the specified file
1415 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1418 if ( !is_array( $wgProxyList ) ) {
1420 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1422 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1423 # Old-style flipped proxy list
1428 wfProfileOut( __METHOD__
);
1433 * Is this user subject to rate limiting?
1435 * @return Bool True if rate limited
1437 public function isPingLimitable() {
1438 global $wgRateLimitsExcludedIPs;
1439 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1440 // No other good way currently to disable rate limits
1441 // for specific IPs. :P
1442 // But this is a crappy hack and should die.
1445 return !$this->isAllowed('noratelimit');
1449 * Primitive rate limits: enforce maximum actions per time period
1450 * to put a brake on flooding.
1452 * @note When using a shared cache like memcached, IP-address
1453 * last-hit counters will be shared across wikis.
1455 * @param $action String Action to enforce; 'edit' if unspecified
1456 * @return Bool True if a rate limiter was tripped
1458 public function pingLimiter( $action = 'edit' ) {
1459 # Call the 'PingLimiter' hook
1461 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1465 global $wgRateLimits;
1466 if( !isset( $wgRateLimits[$action] ) ) {
1470 # Some groups shouldn't trigger the ping limiter, ever
1471 if( !$this->isPingLimitable() )
1474 global $wgMemc, $wgRateLimitLog;
1475 wfProfileIn( __METHOD__
);
1477 $limits = $wgRateLimits[$action];
1479 $id = $this->getId();
1480 $ip = $this->getRequest()->getIP();
1483 if( isset( $limits['anon'] ) && $id == 0 ) {
1484 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1487 if( isset( $limits['user'] ) && $id != 0 ) {
1488 $userLimit = $limits['user'];
1490 if( $this->isNewbie() ) {
1491 if( isset( $limits['newbie'] ) && $id != 0 ) {
1492 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1494 if( isset( $limits['ip'] ) ) {
1495 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1498 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1499 $subnet = $matches[1];
1500 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1503 // Check for group-specific permissions
1504 // If more than one group applies, use the group with the highest limit
1505 foreach ( $this->getGroups() as $group ) {
1506 if ( isset( $limits[$group] ) ) {
1507 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1508 $userLimit = $limits[$group];
1512 // Set the user limit key
1513 if ( $userLimit !== false ) {
1514 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1515 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1519 foreach( $keys as $key => $limit ) {
1520 list( $max, $period ) = $limit;
1521 $summary = "(limit $max in {$period}s)";
1522 $count = $wgMemc->get( $key );
1525 if( $count >= $max ) {
1526 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1527 if( $wgRateLimitLog ) {
1528 wfSuppressWarnings();
1529 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1530 wfRestoreWarnings();
1534 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1537 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1538 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1540 $wgMemc->incr( $key );
1543 wfProfileOut( __METHOD__
);
1548 * Check if user is blocked
1550 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1551 * @return Bool True if blocked, false otherwise
1553 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1554 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1558 * Get the block affecting the user, or null if the user is not blocked
1560 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1561 * @return Block|null
1563 public function getBlock( $bFromSlave = true ){
1564 $this->getBlockedStatus( $bFromSlave );
1565 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1569 * Check if user is blocked from editing a particular article
1571 * @param $title Title to check
1572 * @param $bFromSlave Bool whether to check the slave database instead of the master
1575 function isBlockedFrom( $title, $bFromSlave = false ) {
1576 global $wgBlockAllowsUTEdit;
1577 wfProfileIn( __METHOD__
);
1579 $blocked = $this->isBlocked( $bFromSlave );
1580 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1581 # If a user's name is suppressed, they cannot make edits anywhere
1582 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1583 $title->getNamespace() == NS_USER_TALK
) {
1585 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1588 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1590 wfProfileOut( __METHOD__
);
1595 * If user is blocked, return the name of the user who placed the block
1596 * @return String name of blocker
1598 public function blockedBy() {
1599 $this->getBlockedStatus();
1600 return $this->mBlockedby
;
1604 * If user is blocked, return the specified reason for the block
1605 * @return String Blocking reason
1607 public function blockedFor() {
1608 $this->getBlockedStatus();
1609 return $this->mBlockreason
;
1613 * If user is blocked, return the ID for the block
1614 * @return Int Block ID
1616 public function getBlockId() {
1617 $this->getBlockedStatus();
1618 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1622 * Check if user is blocked on all wikis.
1623 * Do not use for actual edit permission checks!
1624 * This is intented for quick UI checks.
1626 * @param $ip String IP address, uses current client if none given
1627 * @return Bool True if blocked, false otherwise
1629 public function isBlockedGlobally( $ip = '' ) {
1630 if( $this->mBlockedGlobally
!== null ) {
1631 return $this->mBlockedGlobally
;
1633 // User is already an IP?
1634 if( IP
::isIPAddress( $this->getName() ) ) {
1635 $ip = $this->getName();
1637 $ip = $this->getRequest()->getIP();
1640 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1641 $this->mBlockedGlobally
= (bool)$blocked;
1642 return $this->mBlockedGlobally
;
1646 * Check if user account is locked
1648 * @return Bool True if locked, false otherwise
1650 public function isLocked() {
1651 if( $this->mLocked
!== null ) {
1652 return $this->mLocked
;
1655 $authUser = $wgAuth->getUserInstance( $this );
1656 $this->mLocked
= (bool)$authUser->isLocked();
1657 return $this->mLocked
;
1661 * Check if user account is hidden
1663 * @return Bool True if hidden, false otherwise
1665 public function isHidden() {
1666 if( $this->mHideName
!== null ) {
1667 return $this->mHideName
;
1669 $this->getBlockedStatus();
1670 if( !$this->mHideName
) {
1672 $authUser = $wgAuth->getUserInstance( $this );
1673 $this->mHideName
= (bool)$authUser->isHidden();
1675 return $this->mHideName
;
1679 * Get the user's ID.
1680 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1682 public function getId() {
1683 if( $this->mId
=== null && $this->mName
!== null
1684 && User
::isIP( $this->mName
) ) {
1685 // Special case, we know the user is anonymous
1687 } elseif( !$this->isItemLoaded( 'id' ) ) {
1688 // Don't load if this was initialized from an ID
1695 * Set the user and reload all fields according to a given ID
1696 * @param $v Int User ID to reload
1698 public function setId( $v ) {
1700 $this->clearInstanceCache( 'id' );
1704 * Get the user name, or the IP of an anonymous user
1705 * @return String User's name or IP address
1707 public function getName() {
1708 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1709 # Special case optimisation
1710 return $this->mName
;
1713 if ( $this->mName
=== false ) {
1715 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1717 return $this->mName
;
1722 * Set the user name.
1724 * This does not reload fields from the database according to the given
1725 * name. Rather, it is used to create a temporary "nonexistent user" for
1726 * later addition to the database. It can also be used to set the IP
1727 * address for an anonymous user to something other than the current
1730 * @note User::newFromName() has rougly the same function, when the named user
1732 * @param $str String New user name to set
1734 public function setName( $str ) {
1736 $this->mName
= $str;
1740 * Get the user's name escaped by underscores.
1741 * @return String Username escaped by underscores.
1743 public function getTitleKey() {
1744 return str_replace( ' ', '_', $this->getName() );
1748 * Check if the user has new messages.
1749 * @return Bool True if the user has new messages
1751 public function getNewtalk() {
1754 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1755 if( $this->mNewtalk
=== -1 ) {
1756 $this->mNewtalk
= false; # reset talk page status
1758 # Check memcached separately for anons, who have no
1759 # entire User object stored in there.
1761 global $wgDisableAnonTalk;
1762 if( $wgDisableAnonTalk ) {
1763 // Anon newtalk disabled by configuration.
1764 $this->mNewtalk
= false;
1767 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1768 $newtalk = $wgMemc->get( $key );
1769 if( strval( $newtalk ) !== '' ) {
1770 $this->mNewtalk
= (bool)$newtalk;
1772 // Since we are caching this, make sure it is up to date by getting it
1774 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1775 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1779 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1783 return (bool)$this->mNewtalk
;
1787 * Return the talk page(s) this user has new messages on.
1788 * @return Array of String page URLs
1790 public function getNewMessageLinks() {
1792 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1794 } elseif( !$this->getNewtalk() ) {
1797 $utp = $this->getTalkPage();
1798 $dbr = wfGetDB( DB_SLAVE
);
1799 // Get the "last viewed rev" timestamp from the oldest message notification
1800 $timestamp = $dbr->selectField( 'user_newtalk',
1801 'MIN(user_last_timestamp)',
1802 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1804 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1805 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1809 * Internal uncached check for new messages
1812 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1813 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1814 * @param $fromMaster Bool true to fetch from the master, false for a slave
1815 * @return Bool True if the user has new messages
1817 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1818 if ( $fromMaster ) {
1819 $db = wfGetDB( DB_MASTER
);
1821 $db = wfGetDB( DB_SLAVE
);
1823 $ok = $db->selectField( 'user_newtalk', $field,
1824 array( $field => $id ), __METHOD__
);
1825 return $ok !== false;
1829 * Add or update the new messages flag
1830 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1831 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1832 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1833 * @return Bool True if successful, false otherwise
1835 protected function updateNewtalk( $field, $id, $curRev = null ) {
1836 // Get timestamp of the talk page revision prior to the current one
1837 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1838 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1839 // Mark the user as having new messages since this revision
1840 $dbw = wfGetDB( DB_MASTER
);
1841 $dbw->insert( 'user_newtalk',
1842 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1845 if ( $dbw->affectedRows() ) {
1846 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1849 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1855 * Clear the new messages flag for the given user
1856 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1857 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1858 * @return Bool True if successful, false otherwise
1860 protected function deleteNewtalk( $field, $id ) {
1861 $dbw = wfGetDB( DB_MASTER
);
1862 $dbw->delete( 'user_newtalk',
1863 array( $field => $id ),
1865 if ( $dbw->affectedRows() ) {
1866 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1869 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1875 * Update the 'You have new messages!' status.
1876 * @param $val Bool Whether the user has new messages
1877 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1879 public function setNewtalk( $val, $curRev = null ) {
1880 if( wfReadOnly() ) {
1885 $this->mNewtalk
= $val;
1887 if( $this->isAnon() ) {
1889 $id = $this->getName();
1892 $id = $this->getId();
1897 $changed = $this->updateNewtalk( $field, $id, $curRev );
1899 $changed = $this->deleteNewtalk( $field, $id );
1902 if( $this->isAnon() ) {
1903 // Anons have a separate memcached space, since
1904 // user records aren't kept for them.
1905 $key = wfMemcKey( 'newtalk', 'ip', $id );
1906 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1909 $this->invalidateCache();
1914 * Generate a current or new-future timestamp to be stored in the
1915 * user_touched field when we update things.
1916 * @return String Timestamp in TS_MW format
1918 private static function newTouchedTimestamp() {
1919 global $wgClockSkewFudge;
1920 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1924 * Clear user data from memcached.
1925 * Use after applying fun updates to the database; caller's
1926 * responsibility to update user_touched if appropriate.
1928 * Called implicitly from invalidateCache() and saveSettings().
1930 private function clearSharedCache() {
1934 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1939 * Immediately touch the user data cache for this account.
1940 * Updates user_touched field, and removes account data from memcached
1941 * for reload on the next hit.
1943 public function invalidateCache() {
1944 if( wfReadOnly() ) {
1949 $this->mTouched
= self
::newTouchedTimestamp();
1951 $dbw = wfGetDB( DB_MASTER
);
1953 // Prevent contention slams by checking user_touched first
1954 $now = $dbw->timestamp( $this->mTouched
);
1955 $needsPurge = $dbw->selectField( 'user', '1',
1956 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1958 if ( $needsPurge ) {
1959 $dbw->update( 'user',
1960 array( 'user_touched' => $now ),
1961 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1966 $this->clearSharedCache();
1971 * Validate the cache for this account.
1972 * @param $timestamp String A timestamp in TS_MW format
1976 public function validateCache( $timestamp ) {
1978 return ( $timestamp >= $this->mTouched
);
1982 * Get the user touched timestamp
1983 * @return String timestamp
1985 public function getTouched() {
1987 return $this->mTouched
;
1991 * Set the password and reset the random token.
1992 * Calls through to authentication plugin if necessary;
1993 * will have no effect if the auth plugin refuses to
1994 * pass the change through or if the legal password
1997 * As a special case, setting the password to null
1998 * wipes it, so the account cannot be logged in until
1999 * a new password is set, for instance via e-mail.
2001 * @param $str String New password to set
2002 * @throws PasswordError on failure
2006 public function setPassword( $str ) {
2009 if( $str !== null ) {
2010 if( !$wgAuth->allowPasswordChange() ) {
2011 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2014 if( !$this->isValidPassword( $str ) ) {
2015 global $wgMinimalPasswordLength;
2016 $valid = $this->getPasswordValidity( $str );
2017 if ( is_array( $valid ) ) {
2018 $message = array_shift( $valid );
2022 $params = array( $wgMinimalPasswordLength );
2024 throw new PasswordError( wfMessage( $message, $params )->text() );
2028 if( !$wgAuth->setPassword( $this, $str ) ) {
2029 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2032 $this->setInternalPassword( $str );
2038 * Set the password and reset the random token unconditionally.
2040 * @param $str String New password to set
2042 public function setInternalPassword( $str ) {
2046 if( $str === null ) {
2047 // Save an invalid hash...
2048 $this->mPassword
= '';
2050 $this->mPassword
= self
::crypt( $str );
2052 $this->mNewpassword
= '';
2053 $this->mNewpassTime
= null;
2057 * Get the user's current token.
2058 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2059 * @return String Token
2061 public function getToken( $forceCreation = true ) {
2063 if ( !$this->mToken
&& $forceCreation ) {
2066 return $this->mToken
;
2070 * Set the random token (used for persistent authentication)
2071 * Called from loadDefaults() among other places.
2073 * @param $token String|bool If specified, set the token to this value
2075 public function setToken( $token = false ) {
2078 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2080 $this->mToken
= $token;
2085 * Set the password for a password reminder or new account email
2087 * @param $str String New password to set
2088 * @param $throttle Bool If true, reset the throttle timestamp to the present
2090 public function setNewpassword( $str, $throttle = true ) {
2092 $this->mNewpassword
= self
::crypt( $str );
2094 $this->mNewpassTime
= wfTimestampNow();
2099 * Has password reminder email been sent within the last
2100 * $wgPasswordReminderResendTime hours?
2103 public function isPasswordReminderThrottled() {
2104 global $wgPasswordReminderResendTime;
2106 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2109 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2110 return time() < $expiry;
2114 * Get the user's e-mail address
2115 * @return String User's email address
2117 public function getEmail() {
2119 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2120 return $this->mEmail
;
2124 * Get the timestamp of the user's e-mail authentication
2125 * @return String TS_MW timestamp
2127 public function getEmailAuthenticationTimestamp() {
2129 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2130 return $this->mEmailAuthenticated
;
2134 * Set the user's e-mail address
2135 * @param $str String New e-mail address
2137 public function setEmail( $str ) {
2139 if( $str == $this->mEmail
) {
2142 $this->mEmail
= $str;
2143 $this->invalidateEmail();
2144 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2148 * Set the user's e-mail address and a confirmation mail if needed.
2151 * @param $str String New e-mail address
2154 public function setEmailWithConfirmation( $str ) {
2155 global $wgEnableEmail, $wgEmailAuthentication;
2157 if ( !$wgEnableEmail ) {
2158 return Status
::newFatal( 'emaildisabled' );
2161 $oldaddr = $this->getEmail();
2162 if ( $str === $oldaddr ) {
2163 return Status
::newGood( true );
2166 $this->setEmail( $str );
2168 if ( $str !== '' && $wgEmailAuthentication ) {
2169 # Send a confirmation request to the new address if needed
2170 $type = $oldaddr != '' ?
'changed' : 'set';
2171 $result = $this->sendConfirmationMail( $type );
2172 if ( $result->isGood() ) {
2173 # Say the the caller that a confirmation mail has been sent
2174 $result->value
= 'eauth';
2177 $result = Status
::newGood( true );
2184 * Get the user's real name
2185 * @return String User's real name
2187 public function getRealName() {
2188 if ( !$this->isItemLoaded( 'realname' ) ) {
2192 return $this->mRealName
;
2196 * Set the user's real name
2197 * @param $str String New real name
2199 public function setRealName( $str ) {
2201 $this->mRealName
= $str;
2205 * Get the user's current setting for a given option.
2207 * @param $oname String The option to check
2208 * @param $defaultOverride String A default value returned if the option does not exist
2209 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2210 * @return String User's current value for the option
2211 * @see getBoolOption()
2212 * @see getIntOption()
2214 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2215 global $wgHiddenPrefs;
2216 $this->loadOptions();
2218 if ( is_null( $this->mOptions
) ) {
2219 if($defaultOverride != '') {
2220 return $defaultOverride;
2222 $this->mOptions
= User
::getDefaultOptions();
2225 # We want 'disabled' preferences to always behave as the default value for
2226 # users, even if they have set the option explicitly in their settings (ie they
2227 # set it, and then it was disabled removing their ability to change it). But
2228 # we don't want to erase the preferences in the database in case the preference
2229 # is re-enabled again. So don't touch $mOptions, just override the returned value
2230 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2231 return self
::getDefaultOption( $oname );
2234 if ( array_key_exists( $oname, $this->mOptions
) ) {
2235 return $this->mOptions
[$oname];
2237 return $defaultOverride;
2242 * Get all user's options
2246 public function getOptions() {
2247 global $wgHiddenPrefs;
2248 $this->loadOptions();
2249 $options = $this->mOptions
;
2251 # We want 'disabled' preferences to always behave as the default value for
2252 # users, even if they have set the option explicitly in their settings (ie they
2253 # set it, and then it was disabled removing their ability to change it). But
2254 # we don't want to erase the preferences in the database in case the preference
2255 # is re-enabled again. So don't touch $mOptions, just override the returned value
2256 foreach( $wgHiddenPrefs as $pref ){
2257 $default = self
::getDefaultOption( $pref );
2258 if( $default !== null ){
2259 $options[$pref] = $default;
2267 * Get the user's current setting for a given option, as a boolean value.
2269 * @param $oname String The option to check
2270 * @return Bool User's current value for the option
2273 public function getBoolOption( $oname ) {
2274 return (bool)$this->getOption( $oname );
2278 * Get the user's current setting for a given option, as a boolean value.
2280 * @param $oname String The option to check
2281 * @param $defaultOverride Int A default value returned if the option does not exist
2282 * @return Int User's current value for the option
2285 public function getIntOption( $oname, $defaultOverride=0 ) {
2286 $val = $this->getOption( $oname );
2288 $val = $defaultOverride;
2290 return intval( $val );
2294 * Set the given option for a user.
2296 * @param $oname String The option to set
2297 * @param $val mixed New value to set
2299 public function setOption( $oname, $val ) {
2301 $this->loadOptions();
2303 // Explicitly NULL values should refer to defaults
2304 if( is_null( $val ) ) {
2305 $defaultOption = self
::getDefaultOption( $oname );
2306 if( !is_null( $defaultOption ) ) {
2307 $val = $defaultOption;
2311 $this->mOptions
[$oname] = $val;
2315 * Reset all options to the site defaults
2317 public function resetOptions() {
2320 $this->mOptions
= self
::getDefaultOptions();
2321 $this->mOptionsLoaded
= true;
2325 * Get the user's preferred date format.
2326 * @return String User's preferred date format
2328 public function getDatePreference() {
2329 // Important migration for old data rows
2330 if ( is_null( $this->mDatePreference
) ) {
2332 $value = $this->getOption( 'date' );
2333 $map = $wgLang->getDatePreferenceMigrationMap();
2334 if ( isset( $map[$value] ) ) {
2335 $value = $map[$value];
2337 $this->mDatePreference
= $value;
2339 return $this->mDatePreference
;
2343 * Get the user preferred stub threshold
2347 public function getStubThreshold() {
2348 global $wgMaxArticleSize; # Maximum article size, in Kb
2349 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2350 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2351 # If they have set an impossible value, disable the preference
2352 # so we can use the parser cache again.
2359 * Get the permissions this user has.
2360 * @return Array of String permission names
2362 public function getRights() {
2363 if ( is_null( $this->mRights
) ) {
2364 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2365 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2366 // Force reindexation of rights when a hook has unset one of them
2367 $this->mRights
= array_values( $this->mRights
);
2369 return $this->mRights
;
2373 * Get the list of explicit group memberships this user has.
2374 * The implicit * and user groups are not included.
2375 * @return Array of String internal group names
2377 public function getGroups() {
2379 $this->loadGroups();
2380 return $this->mGroups
;
2384 * Get the list of implicit group memberships this user has.
2385 * This includes all explicit groups, plus 'user' if logged in,
2386 * '*' for all accounts, and autopromoted groups
2387 * @param $recache Bool Whether to avoid the cache
2388 * @return Array of String internal group names
2390 public function getEffectiveGroups( $recache = false ) {
2391 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2392 wfProfileIn( __METHOD__
);
2393 $this->mEffectiveGroups
= array_unique( array_merge(
2394 $this->getGroups(), // explicit groups
2395 $this->getAutomaticGroups( $recache ) // implicit groups
2397 # Hook for additional groups
2398 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2399 wfProfileOut( __METHOD__
);
2401 return $this->mEffectiveGroups
;
2405 * Get the list of implicit group memberships this user has.
2406 * This includes 'user' if logged in, '*' for all accounts,
2407 * and autopromoted groups
2408 * @param $recache Bool Whether to avoid the cache
2409 * @return Array of String internal group names
2411 public function getAutomaticGroups( $recache = false ) {
2412 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2413 wfProfileIn( __METHOD__
);
2414 $this->mImplicitGroups
= array( '*' );
2415 if ( $this->getId() ) {
2416 $this->mImplicitGroups
[] = 'user';
2418 $this->mImplicitGroups
= array_unique( array_merge(
2419 $this->mImplicitGroups
,
2420 Autopromote
::getAutopromoteGroups( $this )
2424 # Assure data consistency with rights/groups,
2425 # as getEffectiveGroups() depends on this function
2426 $this->mEffectiveGroups
= null;
2428 wfProfileOut( __METHOD__
);
2430 return $this->mImplicitGroups
;
2434 * Returns the groups the user has belonged to.
2436 * The user may still belong to the returned groups. Compare with getGroups().
2438 * The function will not return groups the user had belonged to before MW 1.17
2440 * @return array Names of the groups the user has belonged to.
2442 public function getFormerGroups() {
2443 if( is_null( $this->mFormerGroups
) ) {
2444 $dbr = wfGetDB( DB_MASTER
);
2445 $res = $dbr->select( 'user_former_groups',
2446 array( 'ufg_group' ),
2447 array( 'ufg_user' => $this->mId
),
2449 $this->mFormerGroups
= array();
2450 foreach( $res as $row ) {
2451 $this->mFormerGroups
[] = $row->ufg_group
;
2454 return $this->mFormerGroups
;
2458 * Get the user's edit count.
2461 public function getEditCount() {
2462 if( $this->getId() ) {
2463 if ( !isset( $this->mEditCount
) ) {
2464 /* Populate the count, if it has not been populated yet */
2465 wfProfileIn( __METHOD__
);
2466 $dbr = wfGetDB( DB_SLAVE
);
2467 // check if the user_editcount field has been initialized
2468 $count = $dbr->selectField(
2469 'user', 'user_editcount',
2470 array( 'user_id' => $this->mId
),
2474 if( $count === null ) {
2475 // it has not been initialized. do so.
2476 $count = $this->initEditCount();
2478 wfProfileOut( __METHOD__
);
2479 $this->mEditCount
= $count;
2481 return $this->mEditCount
;
2489 * Add the user to the given group.
2490 * This takes immediate effect.
2491 * @param $group String Name of the group to add
2493 public function addGroup( $group ) {
2494 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2495 $dbw = wfGetDB( DB_MASTER
);
2496 if( $this->getId() ) {
2497 $dbw->insert( 'user_groups',
2499 'ug_user' => $this->getID(),
2500 'ug_group' => $group,
2503 array( 'IGNORE' ) );
2506 $this->loadGroups();
2507 $this->mGroups
[] = $group;
2508 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2510 $this->invalidateCache();
2514 * Remove the user from the given group.
2515 * This takes immediate effect.
2516 * @param $group String Name of the group to remove
2518 public function removeGroup( $group ) {
2520 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2521 $dbw = wfGetDB( DB_MASTER
);
2522 $dbw->delete( 'user_groups',
2524 'ug_user' => $this->getID(),
2525 'ug_group' => $group,
2527 // Remember that the user was in this group
2528 $dbw->insert( 'user_former_groups',
2530 'ufg_user' => $this->getID(),
2531 'ufg_group' => $group,
2534 array( 'IGNORE' ) );
2536 $this->loadGroups();
2537 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2538 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2540 $this->invalidateCache();
2544 * Get whether the user is logged in
2547 public function isLoggedIn() {
2548 return $this->getID() != 0;
2552 * Get whether the user is anonymous
2555 public function isAnon() {
2556 return !$this->isLoggedIn();
2560 * Check if user is allowed to access a feature / make an action
2562 * @internal param \String $varargs permissions to test
2563 * @return Boolean: True if user is allowed to perform *any* of the given actions
2567 public function isAllowedAny( /*...*/ ){
2568 $permissions = func_get_args();
2569 foreach( $permissions as $permission ){
2570 if( $this->isAllowed( $permission ) ){
2579 * @internal param $varargs string
2580 * @return bool True if the user is allowed to perform *all* of the given actions
2582 public function isAllowedAll( /*...*/ ){
2583 $permissions = func_get_args();
2584 foreach( $permissions as $permission ){
2585 if( !$this->isAllowed( $permission ) ){
2593 * Internal mechanics of testing a permission
2594 * @param $action String
2597 public function isAllowed( $action = '' ) {
2598 if ( $action === '' ) {
2599 return true; // In the spirit of DWIM
2601 # Patrolling may not be enabled
2602 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2603 global $wgUseRCPatrol, $wgUseNPPatrol;
2604 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2607 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2608 # by misconfiguration: 0 == 'foo'
2609 return in_array( $action, $this->getRights(), true );
2613 * Check whether to enable recent changes patrol features for this user
2614 * @return Boolean: True or false
2616 public function useRCPatrol() {
2617 global $wgUseRCPatrol;
2618 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2622 * Check whether to enable new pages patrol features for this user
2623 * @return Bool True or false
2625 public function useNPPatrol() {
2626 global $wgUseRCPatrol, $wgUseNPPatrol;
2627 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2631 * Get the WebRequest object to use with this object
2633 * @return WebRequest
2635 public function getRequest() {
2636 if ( $this->mRequest
) {
2637 return $this->mRequest
;
2645 * Get the current skin, loading it if required
2646 * @return Skin The current skin
2647 * @todo FIXME: Need to check the old failback system [AV]
2648 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2650 public function getSkin() {
2651 wfDeprecated( __METHOD__
, '1.18' );
2652 return RequestContext
::getMain()->getSkin();
2656 * Get a WatchedItem for this user and $title.
2658 * @param $title Title
2659 * @return WatchedItem
2661 public function getWatchedItem( $title ) {
2662 $key = $title->getNamespace() . ':' . $title->getDBkey();
2664 if ( isset( $this->mWatchedItems
[$key] ) ) {
2665 return $this->mWatchedItems
[$key];
2668 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2669 $this->mWatchedItems
= array();
2672 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2673 return $this->mWatchedItems
[$key];
2677 * Check the watched status of an article.
2678 * @param $title Title of the article to look at
2681 public function isWatched( $title ) {
2682 return $this->getWatchedItem( $title )->isWatched();
2687 * @param $title Title of the article to look at
2689 public function addWatch( $title ) {
2690 $this->getWatchedItem( $title )->addWatch();
2691 $this->invalidateCache();
2695 * Stop watching an article.
2696 * @param $title Title of the article to look at
2698 public function removeWatch( $title ) {
2699 $this->getWatchedItem( $title )->removeWatch();
2700 $this->invalidateCache();
2704 * Clear the user's notification timestamp for the given title.
2705 * If e-notif e-mails are on, they will receive notification mails on
2706 * the next change of the page if it's watched etc.
2707 * @param $title Title of the article to look at
2709 public function clearNotification( &$title ) {
2710 global $wgUseEnotif, $wgShowUpdatedMarker;
2712 # Do nothing if the database is locked to writes
2713 if( wfReadOnly() ) {
2717 if( $title->getNamespace() == NS_USER_TALK
&&
2718 $title->getText() == $this->getName() ) {
2719 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2721 $this->setNewtalk( false );
2724 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2728 if( $this->isAnon() ) {
2729 // Nothing else to do...
2733 // Only update the timestamp if the page is being watched.
2734 // The query to find out if it is watched is cached both in memcached and per-invocation,
2735 // and when it does have to be executed, it can be on a slave
2736 // If this is the user's newtalk page, we always update the timestamp
2738 if ( $title->getNamespace() == NS_USER_TALK
&&
2739 $title->getText() == $this->getName() )
2744 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2748 * Resets all of the given user's page-change notification timestamps.
2749 * If e-notif e-mails are on, they will receive notification mails on
2750 * the next change of any watched page.
2752 public function clearAllNotifications() {
2753 global $wgUseEnotif, $wgShowUpdatedMarker;
2754 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2755 $this->setNewtalk( false );
2758 $id = $this->getId();
2760 $dbw = wfGetDB( DB_MASTER
);
2761 $dbw->update( 'watchlist',
2763 'wl_notificationtimestamp' => null
2764 ), array( /* WHERE */
2768 # We also need to clear here the "you have new message" notification for the own user_talk page
2769 # This is cleared one page view later in Article::viewUpdates();
2774 * Set this user's options from an encoded string
2775 * @param $str String Encoded options to import
2777 * @deprecated in 1.19 due to removal of user_options from the user table
2779 private function decodeOptions( $str ) {
2780 wfDeprecated( __METHOD__
, '1.19' );
2784 $this->mOptionsLoaded
= true;
2785 $this->mOptionOverrides
= array();
2787 // If an option is not set in $str, use the default value
2788 $this->mOptions
= self
::getDefaultOptions();
2790 $a = explode( "\n", $str );
2791 foreach ( $a as $s ) {
2793 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2794 $this->mOptions
[$m[1]] = $m[2];
2795 $this->mOptionOverrides
[$m[1]] = $m[2];
2801 * Set a cookie on the user's client. Wrapper for
2802 * WebResponse::setCookie
2803 * @param $name String Name of the cookie to set
2804 * @param $value String Value to set
2805 * @param $exp Int Expiration time, as a UNIX time value;
2806 * if 0 or not specified, use the default $wgCookieExpiration
2807 * @param $secure Bool
2808 * true: Force setting the secure attribute when setting the cookie
2809 * false: Force NOT setting the secure attribute when setting the cookie
2810 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
2812 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
2813 $this->getRequest()->response()->setcookie( $name, $value, $exp, null, null, $secure );
2817 * Clear a cookie on the user's client
2818 * @param $name String Name of the cookie to clear
2820 protected function clearCookie( $name ) {
2821 $this->setCookie( $name, '', time() - 86400 );
2825 * Set the default cookies for this session on the user's client.
2827 * @param $request WebRequest object to use; $wgRequest will be used if null
2829 * @param $secure Whether to force secure/insecure cookies or use default
2831 public function setCookies( $request = null, $secure = null ) {
2832 if ( $request === null ) {
2833 $request = $this->getRequest();
2837 if ( 0 == $this->mId
) return;
2838 if ( !$this->mToken
) {
2839 // When token is empty or NULL generate a new one and then save it to the database
2840 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2841 // Simply by setting every cell in the user_token column to NULL and letting them be
2842 // regenerated as users log back into the wiki.
2844 $this->saveSettings();
2847 'wsUserID' => $this->mId
,
2848 'wsToken' => $this->mToken
,
2849 'wsUserName' => $this->getName()
2852 'UserID' => $this->mId
,
2853 'UserName' => $this->getName(),
2855 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2856 $cookies['Token'] = $this->mToken
;
2858 $cookies['Token'] = false;
2861 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2863 foreach ( $session as $name => $value ) {
2864 $request->setSessionData( $name, $value );
2866 foreach ( $cookies as $name => $value ) {
2867 if ( $value === false ) {
2868 $this->clearCookie( $name );
2870 $this->setCookie( $name, $value, 0, $secure );
2875 * If wpStickHTTPS was selected, also set an insecure cookie that
2876 * will cause the site to redirect the user to HTTPS, if they access
2877 * it over HTTP. Bug 29898.
2879 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
2880 $this->setCookie( 'forceHTTPS', 'true', time() +
2592000, false ); //30 days
2885 * Log this user out.
2887 public function logout() {
2888 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2894 * Clear the user's cookies and session, and reset the instance cache.
2897 public function doLogout() {
2898 $this->clearInstanceCache( 'defaults' );
2900 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2902 $this->clearCookie( 'UserID' );
2903 $this->clearCookie( 'Token' );
2904 $this->clearCookie( 'forceHTTPS' );
2906 # Remember when user logged out, to prevent seeing cached pages
2907 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2911 * Save this user's settings into the database.
2912 * @todo Only rarely do all these fields need to be set!
2914 public function saveSettings() {
2918 if ( wfReadOnly() ) { return; }
2919 if ( 0 == $this->mId
) { return; }
2921 $this->mTouched
= self
::newTouchedTimestamp();
2922 if ( !$wgAuth->allowSetLocalPassword() ) {
2923 $this->mPassword
= '';
2926 $dbw = wfGetDB( DB_MASTER
);
2927 $dbw->update( 'user',
2929 'user_name' => $this->mName
,
2930 'user_password' => $this->mPassword
,
2931 'user_newpassword' => $this->mNewpassword
,
2932 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2933 'user_real_name' => $this->mRealName
,
2934 'user_email' => $this->mEmail
,
2935 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2936 'user_touched' => $dbw->timestamp( $this->mTouched
),
2937 'user_token' => strval( $this->mToken
),
2938 'user_email_token' => $this->mEmailToken
,
2939 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2940 ), array( /* WHERE */
2941 'user_id' => $this->mId
2945 $this->saveOptions();
2947 wfRunHooks( 'UserSaveSettings', array( $this ) );
2948 $this->clearSharedCache();
2949 $this->getUserPage()->invalidateCache();
2953 * If only this user's username is known, and it exists, return the user ID.
2956 public function idForName() {
2957 $s = trim( $this->getName() );
2958 if ( $s === '' ) return 0;
2960 $dbr = wfGetDB( DB_SLAVE
);
2961 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2962 if ( $id === false ) {
2969 * Add a user to the database, return the user object
2971 * @param $name String Username to add
2972 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2973 * - password The user's password hash. Password logins will be disabled if this is omitted.
2974 * - newpassword Hash for a temporary password that has been mailed to the user
2975 * - email The user's email address
2976 * - email_authenticated The email authentication timestamp
2977 * - real_name The user's real name
2978 * - options An associative array of non-default options
2979 * - token Random authentication token. Do not set.
2980 * - registration Registration timestamp. Do not set.
2982 * @return User object, or null if the username already exists
2984 public static function createNew( $name, $params = array() ) {
2987 if ( isset( $params['options'] ) ) {
2988 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2989 unset( $params['options'] );
2991 $dbw = wfGetDB( DB_MASTER
);
2992 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2995 'user_id' => $seqVal,
2996 'user_name' => $name,
2997 'user_password' => $user->mPassword
,
2998 'user_newpassword' => $user->mNewpassword
,
2999 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
3000 'user_email' => $user->mEmail
,
3001 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3002 'user_real_name' => $user->mRealName
,
3003 'user_token' => strval( $user->mToken
),
3004 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3005 'user_editcount' => 0,
3006 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3008 foreach ( $params as $name => $value ) {
3009 $fields["user_$name"] = $value;
3011 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3012 if ( $dbw->affectedRows() ) {
3013 $newUser = User
::newFromId( $dbw->insertId() );
3021 * Add this existing user object to the database. If the user already
3022 * exists, a fatal status object is returned, and the user object is
3023 * initialised with the data from the database.
3025 * Previously, this function generated a DB error due to a key conflict
3026 * if the user already existed. Many extension callers use this function
3027 * in code along the lines of:
3029 * $user = User::newFromName( $name );
3030 * if ( !$user->isLoggedIn() ) {
3031 * $user->addToDatabase();
3033 * // do something with $user...
3035 * However, this was vulnerable to a race condition (bug 16020). By
3036 * initialising the user object if the user exists, we aim to support this
3037 * calling sequence as far as possible.
3039 * Note that if the user exists, this function will acquire a write lock,
3040 * so it is still advisable to make the call conditional on isLoggedIn(),
3041 * and to commit the transaction after calling.
3045 public function addToDatabase() {
3048 $this->mTouched
= self
::newTouchedTimestamp();
3050 $dbw = wfGetDB( DB_MASTER
);
3051 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3052 $dbw->insert( 'user',
3054 'user_id' => $seqVal,
3055 'user_name' => $this->mName
,
3056 'user_password' => $this->mPassword
,
3057 'user_newpassword' => $this->mNewpassword
,
3058 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3059 'user_email' => $this->mEmail
,
3060 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3061 'user_real_name' => $this->mRealName
,
3062 'user_token' => strval( $this->mToken
),
3063 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3064 'user_editcount' => 0,
3065 'user_touched' => $dbw->timestamp( $this->mTouched
),
3069 if ( !$dbw->affectedRows() ) {
3070 $this->mId
= $dbw->selectField( 'user', 'user_id',
3071 array( 'user_name' => $this->mName
), __METHOD__
);
3074 if ( $this->loadFromDatabase() ) {
3079 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3080 "to insert a user row, but then it doesn't exist when we select it!" );
3082 return Status
::newFatal( 'userexists' );
3084 $this->mId
= $dbw->insertId();
3086 // Clear instance cache other than user table data, which is already accurate
3087 $this->clearInstanceCache();
3089 $this->saveOptions();
3090 return Status
::newGood();
3094 * If this user is logged-in and blocked,
3095 * block any IP address they've successfully logged in from.
3096 * @return bool A block was spread
3098 public function spreadAnyEditBlock() {
3099 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3100 return $this->spreadBlock();
3106 * If this (non-anonymous) user is blocked,
3107 * block the IP address they've successfully logged in from.
3108 * @return bool A block was spread
3110 protected function spreadBlock() {
3111 wfDebug( __METHOD__
. "()\n" );
3113 if ( $this->mId
== 0 ) {
3117 $userblock = Block
::newFromTarget( $this->getName() );
3118 if ( !$userblock ) {
3122 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3126 * Generate a string which will be different for any combination of
3127 * user options which would produce different parser output.
3128 * This will be used as part of the hash key for the parser cache,
3129 * so users with the same options can share the same cached data
3132 * Extensions which require it should install 'PageRenderingHash' hook,
3133 * which will give them a chance to modify this key based on their own
3136 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3137 * @return String Page rendering hash
3139 public function getPageRenderingHash() {
3140 wfDeprecated( __METHOD__
, '1.17' );
3142 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3144 return $this->mHash
;
3147 // stubthreshold is only included below for completeness,
3148 // since it disables the parser cache, its value will always
3149 // be 0 when this function is called by parsercache.
3151 $confstr = $this->getOption( 'math' );
3152 $confstr .= '!' . $this->getStubThreshold();
3153 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3154 $confstr .= '!' . $this->getDatePreference();
3156 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3157 $confstr .= '!' . $wgLang->getCode();
3158 $confstr .= '!' . $this->getOption( 'thumbsize' );
3159 // add in language specific options, if any
3160 $extra = $wgContLang->getExtraHashOptions();
3163 // Since the skin could be overloading link(), it should be
3164 // included here but in practice, none of our skins do that.
3166 $confstr .= $wgRenderHashAppend;
3168 // Give a chance for extensions to modify the hash, if they have
3169 // extra options or other effects on the parser cache.
3170 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3172 // Make it a valid memcached key fragment
3173 $confstr = str_replace( ' ', '_', $confstr );
3174 $this->mHash
= $confstr;
3179 * Get whether the user is explicitly blocked from account creation.
3180 * @return Bool|Block
3182 public function isBlockedFromCreateAccount() {
3183 $this->getBlockedStatus();
3184 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3185 return $this->mBlock
;
3188 # bug 13611: if the IP address the user is trying to create an account from is
3189 # blocked with createaccount disabled, prevent new account creation there even
3190 # when the user is logged in
3191 if( $this->mBlockedFromCreateAccount
=== false ){
3192 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3194 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3195 ?
$this->mBlockedFromCreateAccount
3200 * Get whether the user is blocked from using Special:Emailuser.
3203 public function isBlockedFromEmailuser() {
3204 $this->getBlockedStatus();
3205 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3209 * Get whether the user is allowed to create an account.
3212 function isAllowedToCreateAccount() {
3213 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3217 * Get this user's personal page title.
3219 * @return Title: User's personal page title
3221 public function getUserPage() {
3222 return Title
::makeTitle( NS_USER
, $this->getName() );
3226 * Get this user's talk page title.
3228 * @return Title: User's talk page title
3230 public function getTalkPage() {
3231 $title = $this->getUserPage();
3232 return $title->getTalkPage();
3236 * Determine whether the user is a newbie. Newbies are either
3237 * anonymous IPs, or the most recently created accounts.
3240 public function isNewbie() {
3241 return !$this->isAllowed( 'autoconfirmed' );
3245 * Check to see if the given clear-text password is one of the accepted passwords
3246 * @param $password String: user password.
3247 * @return Boolean: True if the given password is correct, otherwise False.
3249 public function checkPassword( $password ) {
3250 global $wgAuth, $wgLegacyEncoding;
3253 // Even though we stop people from creating passwords that
3254 // are shorter than this, doesn't mean people wont be able
3255 // to. Certain authentication plugins do NOT want to save
3256 // domain passwords in a mysql database, so we should
3257 // check this (in case $wgAuth->strict() is false).
3258 if( !$this->isValidPassword( $password ) ) {
3262 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3264 } elseif( $wgAuth->strict() ) {
3265 /* Auth plugin doesn't allow local authentication */
3267 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3268 /* Auth plugin doesn't allow local authentication for this user name */
3271 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3273 } elseif ( $wgLegacyEncoding ) {
3274 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3275 # Check for this with iconv
3276 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3277 if ( $cp1252Password != $password &&
3278 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3287 * Check if the given clear-text password matches the temporary password
3288 * sent by e-mail for password reset operations.
3290 * @param $plaintext string
3292 * @return Boolean: True if matches, false otherwise
3294 public function checkTemporaryPassword( $plaintext ) {
3295 global $wgNewPasswordExpiry;
3298 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3299 if ( is_null( $this->mNewpassTime
) ) {
3302 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3303 return ( time() < $expiry );
3310 * Alias for getEditToken.
3311 * @deprecated since 1.19, use getEditToken instead.
3313 * @param $salt String|Array of Strings Optional function-specific data for hashing
3314 * @param $request WebRequest object to use or null to use $wgRequest
3315 * @return String The new edit token
3317 public function editToken( $salt = '', $request = null ) {
3318 wfDeprecated( __METHOD__
, '1.19' );
3319 return $this->getEditToken( $salt, $request );
3323 * Initialize (if necessary) and return a session token value
3324 * which can be used in edit forms to show that the user's
3325 * login credentials aren't being hijacked with a foreign form
3330 * @param $salt String|Array of Strings Optional function-specific data for hashing
3331 * @param $request WebRequest object to use or null to use $wgRequest
3332 * @return String The new edit token
3334 public function getEditToken( $salt = '', $request = null ) {
3335 if ( $request == null ) {
3336 $request = $this->getRequest();
3339 if ( $this->isAnon() ) {
3340 return EDIT_TOKEN_SUFFIX
;
3342 $token = $request->getSessionData( 'wsEditToken' );
3343 if ( $token === null ) {
3344 $token = MWCryptRand
::generateHex( 32 );
3345 $request->setSessionData( 'wsEditToken', $token );
3347 if( is_array( $salt ) ) {
3348 $salt = implode( '|', $salt );
3350 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3355 * Generate a looking random token for various uses.
3357 * @param $salt String Optional salt value
3358 * @return String The new random token
3359 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3361 public static function generateToken( $salt = '' ) {
3362 return MWCryptRand
::generateHex( 32 );
3366 * Check given value against the token value stored in the session.
3367 * A match should confirm that the form was submitted from the
3368 * user's own login session, not a form submission from a third-party
3371 * @param $val String Input value to compare
3372 * @param $salt String Optional function-specific data for hashing
3373 * @param $request WebRequest object to use or null to use $wgRequest
3374 * @return Boolean: Whether the token matches
3376 public function matchEditToken( $val, $salt = '', $request = null ) {
3377 $sessionToken = $this->getEditToken( $salt, $request );
3378 if ( $val != $sessionToken ) {
3379 wfDebug( "User::matchEditToken: broken session data\n" );
3381 return $val == $sessionToken;
3385 * Check given value against the token value stored in the session,
3386 * ignoring the suffix.
3388 * @param $val String Input value to compare
3389 * @param $salt String Optional function-specific data for hashing
3390 * @param $request WebRequest object to use or null to use $wgRequest
3391 * @return Boolean: Whether the token matches
3393 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3394 $sessionToken = $this->getEditToken( $salt, $request );
3395 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3399 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3400 * mail to the user's given address.
3402 * @param $type String: message to send, either "created", "changed" or "set"
3403 * @return Status object
3405 public function sendConfirmationMail( $type = 'created' ) {
3407 $expiration = null; // gets passed-by-ref and defined in next line.
3408 $token = $this->confirmationToken( $expiration );
3409 $url = $this->confirmationTokenUrl( $token );
3410 $invalidateURL = $this->invalidationTokenUrl( $token );
3411 $this->saveSettings();
3413 if ( $type == 'created' ||
$type === false ) {
3414 $message = 'confirmemail_body';
3415 } elseif ( $type === true ) {
3416 $message = 'confirmemail_body_changed';
3418 $message = 'confirmemail_body_' . $type;
3421 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3422 wfMessage( $message,
3423 $this->getRequest()->getIP(),
3426 $wgLang->timeanddate( $expiration, false ),
3428 $wgLang->date( $expiration, false ),
3429 $wgLang->time( $expiration, false ) )->text() );
3433 * Send an e-mail to this user's account. Does not check for
3434 * confirmed status or validity.
3436 * @param $subject String Message subject
3437 * @param $body String Message body
3438 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3439 * @param $replyto String Reply-To address
3442 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3443 if( is_null( $from ) ) {
3444 global $wgPasswordSender, $wgPasswordSenderName;
3445 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3447 $sender = new MailAddress( $from );
3450 $to = new MailAddress( $this );
3451 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3455 * Generate, store, and return a new e-mail confirmation code.
3456 * A hash (unsalted, since it's used as a key) is stored.
3458 * @note Call saveSettings() after calling this function to commit
3459 * this change to the database.
3461 * @param &$expiration \mixed Accepts the expiration time
3462 * @return String New token
3464 private function confirmationToken( &$expiration ) {
3465 global $wgUserEmailConfirmationTokenExpiry;
3467 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3468 $expiration = wfTimestamp( TS_MW
, $expires );
3470 $token = MWCryptRand
::generateHex( 32 );
3471 $hash = md5( $token );
3472 $this->mEmailToken
= $hash;
3473 $this->mEmailTokenExpires
= $expiration;
3478 * Return a URL the user can use to confirm their email address.
3479 * @param $token String Accepts the email confirmation token
3480 * @return String New token URL
3482 private function confirmationTokenUrl( $token ) {
3483 return $this->getTokenUrl( 'ConfirmEmail', $token );
3487 * Return a URL the user can use to invalidate their email address.
3488 * @param $token String Accepts the email confirmation token
3489 * @return String New token URL
3491 private function invalidationTokenUrl( $token ) {
3492 return $this->getTokenUrl( 'InvalidateEmail', $token );
3496 * Internal function to format the e-mail validation/invalidation URLs.
3497 * This uses a quickie hack to use the
3498 * hardcoded English names of the Special: pages, for ASCII safety.
3500 * @note Since these URLs get dropped directly into emails, using the
3501 * short English names avoids insanely long URL-encoded links, which
3502 * also sometimes can get corrupted in some browsers/mailers
3503 * (bug 6957 with Gmail and Internet Explorer).
3505 * @param $page String Special page
3506 * @param $token String Token
3507 * @return String Formatted URL
3509 protected function getTokenUrl( $page, $token ) {
3510 // Hack to bypass localization of 'Special:'
3511 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3512 return $title->getCanonicalUrl();
3516 * Mark the e-mail address confirmed.
3518 * @note Call saveSettings() after calling this function to commit the change.
3522 public function confirmEmail() {
3523 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3524 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3529 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3530 * address if it was already confirmed.
3532 * @note Call saveSettings() after calling this function to commit the change.
3533 * @return bool Returns true
3535 function invalidateEmail() {
3537 $this->mEmailToken
= null;
3538 $this->mEmailTokenExpires
= null;
3539 $this->setEmailAuthenticationTimestamp( null );
3540 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3545 * Set the e-mail authentication timestamp.
3546 * @param $timestamp String TS_MW timestamp
3548 function setEmailAuthenticationTimestamp( $timestamp ) {
3550 $this->mEmailAuthenticated
= $timestamp;
3551 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3555 * Is this user allowed to send e-mails within limits of current
3556 * site configuration?
3559 public function canSendEmail() {
3560 global $wgEnableEmail, $wgEnableUserEmail;
3561 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3564 $canSend = $this->isEmailConfirmed();
3565 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3570 * Is this user allowed to receive e-mails within limits of current
3571 * site configuration?
3574 public function canReceiveEmail() {
3575 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3579 * Is this user's e-mail address valid-looking and confirmed within
3580 * limits of the current site configuration?
3582 * @note If $wgEmailAuthentication is on, this may require the user to have
3583 * confirmed their address by returning a code or using a password
3584 * sent to the address from the wiki.
3588 public function isEmailConfirmed() {
3589 global $wgEmailAuthentication;
3592 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3593 if( $this->isAnon() ) {
3596 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3599 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3609 * Check whether there is an outstanding request for e-mail confirmation.
3612 public function isEmailConfirmationPending() {
3613 global $wgEmailAuthentication;
3614 return $wgEmailAuthentication &&
3615 !$this->isEmailConfirmed() &&
3616 $this->mEmailToken
&&
3617 $this->mEmailTokenExpires
> wfTimestamp();
3621 * Get the timestamp of account creation.
3623 * @return String|Bool Timestamp of account creation, or false for
3624 * non-existent/anonymous user accounts.
3626 public function getRegistration() {
3627 if ( $this->isAnon() ) {
3631 return $this->mRegistration
;
3635 * Get the timestamp of the first edit
3637 * @return String|Bool Timestamp of first edit, or false for
3638 * non-existent/anonymous user accounts.
3640 public function getFirstEditTimestamp() {
3641 if( $this->getId() == 0 ) {
3642 return false; // anons
3644 $dbr = wfGetDB( DB_SLAVE
);
3645 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3646 array( 'rev_user' => $this->getId() ),
3648 array( 'ORDER BY' => 'rev_timestamp ASC' )
3651 return false; // no edits
3653 return wfTimestamp( TS_MW
, $time );
3657 * Get the permissions associated with a given list of groups
3659 * @param $groups Array of Strings List of internal group names
3660 * @return Array of Strings List of permission key names for given groups combined
3662 public static function getGroupPermissions( $groups ) {
3663 global $wgGroupPermissions, $wgRevokePermissions;
3665 // grant every granted permission first
3666 foreach( $groups as $group ) {
3667 if( isset( $wgGroupPermissions[$group] ) ) {
3668 $rights = array_merge( $rights,
3669 // array_filter removes empty items
3670 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3673 // now revoke the revoked permissions
3674 foreach( $groups as $group ) {
3675 if( isset( $wgRevokePermissions[$group] ) ) {
3676 $rights = array_diff( $rights,
3677 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3680 return array_unique( $rights );
3684 * Get all the groups who have a given permission
3686 * @param $role String Role to check
3687 * @return Array of Strings List of internal group names with the given permission
3689 public static function getGroupsWithPermission( $role ) {
3690 global $wgGroupPermissions;
3691 $allowedGroups = array();
3692 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
3693 if ( self
::groupHasPermission( $group, $role ) ) {
3694 $allowedGroups[] = $group;
3697 return $allowedGroups;
3701 * Check, if the given group has the given permission
3703 * @param $group String Group to check
3704 * @param $role String Role to check
3707 public static function groupHasPermission( $group, $role ) {
3708 global $wgGroupPermissions, $wgRevokePermissions;
3709 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
3710 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
3714 * Get the localized descriptive name for a group, if it exists
3716 * @param $group String Internal group name
3717 * @return String Localized descriptive group name
3719 public static function getGroupName( $group ) {
3720 $msg = wfMessage( "group-$group" );
3721 return $msg->isBlank() ?
$group : $msg->text();
3725 * Get the localized descriptive name for a member of a group, if it exists
3727 * @param $group String Internal group name
3728 * @param $username String Username for gender (since 1.19)
3729 * @return String Localized name for group member
3731 public static function getGroupMember( $group, $username = '#' ) {
3732 $msg = wfMessage( "group-$group-member", $username );
3733 return $msg->isBlank() ?
$group : $msg->text();
3737 * Return the set of defined explicit groups.
3738 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3739 * are not included, as they are defined automatically, not in the database.
3740 * @return Array of internal group names
3742 public static function getAllGroups() {
3743 global $wgGroupPermissions, $wgRevokePermissions;
3745 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3746 self
::getImplicitGroups()
3751 * Get a list of all available permissions.
3752 * @return Array of permission names
3754 public static function getAllRights() {
3755 if ( self
::$mAllRights === false ) {
3756 global $wgAvailableRights;
3757 if ( count( $wgAvailableRights ) ) {
3758 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3760 self
::$mAllRights = self
::$mCoreRights;
3762 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3764 return self
::$mAllRights;
3768 * Get a list of implicit groups
3769 * @return Array of Strings Array of internal group names
3771 public static function getImplicitGroups() {
3772 global $wgImplicitGroups;
3773 $groups = $wgImplicitGroups;
3774 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3779 * Get the title of a page describing a particular group
3781 * @param $group String Internal group name
3782 * @return Title|Bool Title of the page if it exists, false otherwise
3784 public static function getGroupPage( $group ) {
3785 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3786 if( $msg->exists() ) {
3787 $title = Title
::newFromText( $msg->text() );
3788 if( is_object( $title ) )
3795 * Create a link to the group in HTML, if available;
3796 * else return the group name.
3798 * @param $group String Internal name of the group
3799 * @param $text String The text of the link
3800 * @return String HTML link to the group
3802 public static function makeGroupLinkHTML( $group, $text = '' ) {
3804 $text = self
::getGroupName( $group );
3806 $title = self
::getGroupPage( $group );
3808 return Linker
::link( $title, htmlspecialchars( $text ) );
3815 * Create a link to the group in Wikitext, if available;
3816 * else return the group name.
3818 * @param $group String Internal name of the group
3819 * @param $text String The text of the link
3820 * @return String Wikilink to the group
3822 public static function makeGroupLinkWiki( $group, $text = '' ) {
3824 $text = self
::getGroupName( $group );
3826 $title = self
::getGroupPage( $group );
3828 $page = $title->getPrefixedText();
3829 return "[[$page|$text]]";
3836 * Returns an array of the groups that a particular group can add/remove.
3838 * @param $group String: the group to check for whether it can add/remove
3839 * @return Array array( 'add' => array( addablegroups ),
3840 * 'remove' => array( removablegroups ),
3841 * 'add-self' => array( addablegroups to self),
3842 * 'remove-self' => array( removable groups from self) )
3844 public static function changeableByGroup( $group ) {
3845 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3847 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3848 if( empty( $wgAddGroups[$group] ) ) {
3849 // Don't add anything to $groups
3850 } elseif( $wgAddGroups[$group] === true ) {
3851 // You get everything
3852 $groups['add'] = self
::getAllGroups();
3853 } elseif( is_array( $wgAddGroups[$group] ) ) {
3854 $groups['add'] = $wgAddGroups[$group];
3857 // Same thing for remove
3858 if( empty( $wgRemoveGroups[$group] ) ) {
3859 } elseif( $wgRemoveGroups[$group] === true ) {
3860 $groups['remove'] = self
::getAllGroups();
3861 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3862 $groups['remove'] = $wgRemoveGroups[$group];
3865 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3866 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3867 foreach( $wgGroupsAddToSelf as $key => $value ) {
3868 if( is_int( $key ) ) {
3869 $wgGroupsAddToSelf['user'][] = $value;
3874 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3875 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3876 if( is_int( $key ) ) {
3877 $wgGroupsRemoveFromSelf['user'][] = $value;
3882 // Now figure out what groups the user can add to him/herself
3883 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3884 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3885 // No idea WHY this would be used, but it's there
3886 $groups['add-self'] = User
::getAllGroups();
3887 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3888 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3891 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3892 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3893 $groups['remove-self'] = User
::getAllGroups();
3894 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3895 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3902 * Returns an array of groups that this user can add and remove
3903 * @return Array array( 'add' => array( addablegroups ),
3904 * 'remove' => array( removablegroups ),
3905 * 'add-self' => array( addablegroups to self),
3906 * 'remove-self' => array( removable groups from self) )
3908 public function changeableGroups() {
3909 if( $this->isAllowed( 'userrights' ) ) {
3910 // This group gives the right to modify everything (reverse-
3911 // compatibility with old "userrights lets you change
3913 // Using array_merge to make the groups reindexed
3914 $all = array_merge( User
::getAllGroups() );
3918 'add-self' => array(),
3919 'remove-self' => array()
3923 // Okay, it's not so simple, we will have to go through the arrays
3926 'remove' => array(),
3927 'add-self' => array(),
3928 'remove-self' => array()
3930 $addergroups = $this->getEffectiveGroups();
3932 foreach( $addergroups as $addergroup ) {
3933 $groups = array_merge_recursive(
3934 $groups, $this->changeableByGroup( $addergroup )
3936 $groups['add'] = array_unique( $groups['add'] );
3937 $groups['remove'] = array_unique( $groups['remove'] );
3938 $groups['add-self'] = array_unique( $groups['add-self'] );
3939 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3945 * Increment the user's edit-count field.
3946 * Will have no effect for anonymous users.
3948 public function incEditCount() {
3949 if( !$this->isAnon() ) {
3950 $dbw = wfGetDB( DB_MASTER
);
3953 array( 'user_editcount=user_editcount+1' ),
3954 array( 'user_id' => $this->getId() ),
3958 // Lazy initialization check...
3959 if( $dbw->affectedRows() == 0 ) {
3960 // Now here's a goddamn hack...
3961 $dbr = wfGetDB( DB_SLAVE
);
3962 if( $dbr !== $dbw ) {
3963 // If we actually have a slave server, the count is
3964 // at least one behind because the current transaction
3965 // has not been committed and replicated.
3966 $this->initEditCount( 1 );
3968 // But if DB_SLAVE is selecting the master, then the
3969 // count we just read includes the revision that was
3970 // just added in the working transaction.
3971 $this->initEditCount();
3975 // edit count in user cache too
3976 $this->invalidateCache();
3980 * Initialize user_editcount from data out of the revision table
3982 * @param $add Integer Edits to add to the count from the revision table
3983 * @return Integer Number of edits
3985 protected function initEditCount( $add = 0 ) {
3986 // Pull from a slave to be less cruel to servers
3987 // Accuracy isn't the point anyway here
3988 $dbr = wfGetDB( DB_SLAVE
);
3989 $count = $dbr->selectField(
3992 array( 'rev_user' => $this->getId() ),
3995 $count = $count +
$add;
3997 $dbw = wfGetDB( DB_MASTER
);
4000 array( 'user_editcount' => $count ),
4001 array( 'user_id' => $this->getId() ),
4009 * Get the description of a given right
4011 * @param $right String Right to query
4012 * @return String Localized description of the right
4014 public static function getRightDescription( $right ) {
4015 $key = "right-$right";
4016 $msg = wfMessage( $key );
4017 return $msg->isBlank() ?
$right : $msg->text();
4021 * Make an old-style password hash
4023 * @param $password String Plain-text password
4024 * @param $userId String User ID
4025 * @return String Password hash
4027 public static function oldCrypt( $password, $userId ) {
4028 global $wgPasswordSalt;
4029 if ( $wgPasswordSalt ) {
4030 return md5( $userId . '-' . md5( $password ) );
4032 return md5( $password );
4037 * Make a new-style password hash
4039 * @param $password String Plain-text password
4040 * @param bool|string $salt Optional salt, may be random or the user ID.
4042 * If unspecified or false, will generate one automatically
4043 * @return String Password hash
4045 public static function crypt( $password, $salt = false ) {
4046 global $wgPasswordSalt;
4049 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
4053 if( $wgPasswordSalt ) {
4054 if ( $salt === false ) {
4055 $salt = MWCryptRand
::generateHex( 8 );
4057 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
4059 return ':A:' . md5( $password );
4064 * Compare a password hash with a plain-text password. Requires the user
4065 * ID if there's a chance that the hash is an old-style hash.
4067 * @param $hash String Password hash
4068 * @param $password String Plain-text password to compare
4069 * @param $userId String|bool User ID for old-style password salt
4073 public static function comparePasswords( $hash, $password, $userId = false ) {
4074 $type = substr( $hash, 0, 3 );
4077 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4081 if ( $type == ':A:' ) {
4083 return md5( $password ) === substr( $hash, 3 );
4084 } elseif ( $type == ':B:' ) {
4086 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4087 return md5( $salt.'-'.md5( $password ) ) === $realHash;
4090 return self
::oldCrypt( $password, $userId ) === $hash;
4095 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
4097 * @param $byEmail Boolean: account made by email?
4098 * @param $reason String: user supplied reason
4100 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4102 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
4103 global $wgUser, $wgContLang, $wgNewUserLog;
4104 if( empty( $wgNewUserLog ) ) {
4105 return true; // disabled
4108 if( $this->getName() == $wgUser->getName() ) {
4111 $action = 'create2';
4113 if ( $reason === '' ) {
4114 $reason = wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text();
4116 $reason = $wgContLang->commaList( array(
4117 $reason, wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text() ) );
4121 $log = new LogPage( 'newusers' );
4122 return (int)$log->addEntry(
4124 $this->getUserPage(),
4126 array( $this->getId() )
4131 * Add an autocreate newuser log entry for this user
4132 * Used by things like CentralAuth and perhaps other authplugins.
4136 public function addNewUserLogEntryAutoCreate() {
4137 global $wgNewUserLog;
4138 if( !$wgNewUserLog ) {
4139 return true; // disabled
4141 $log = new LogPage( 'newusers', false );
4142 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4147 * Load the user options either from cache, the database or an array
4149 * @param $data Rows for the current user out of the user_properties table
4151 protected function loadOptions( $data = null ) {
4156 if ( $this->mOptionsLoaded
) {
4160 $this->mOptions
= self
::getDefaultOptions();
4162 if ( !$this->getId() ) {
4163 // For unlogged-in users, load language/variant options from request.
4164 // There's no need to do it for logged-in users: they can set preferences,
4165 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4166 // so don't override user's choice (especially when the user chooses site default).
4167 $variant = $wgContLang->getDefaultVariant();
4168 $this->mOptions
['variant'] = $variant;
4169 $this->mOptions
['language'] = $variant;
4170 $this->mOptionsLoaded
= true;
4174 // Maybe load from the object
4175 if ( !is_null( $this->mOptionOverrides
) ) {
4176 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4177 foreach( $this->mOptionOverrides
as $key => $value ) {
4178 $this->mOptions
[$key] = $value;
4181 if( !is_array( $data ) ) {
4182 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4183 // Load from database
4184 $dbr = wfGetDB( DB_SLAVE
);
4186 $res = $dbr->select(
4188 array( 'up_property', 'up_value' ),
4189 array( 'up_user' => $this->getId() ),
4193 $this->mOptionOverrides
= array();
4195 foreach ( $res as $row ) {
4196 $data[$row->up_property
] = $row->up_value
;
4199 foreach ( $data as $property => $value ) {
4200 $this->mOptionOverrides
[$property] = $value;
4201 $this->mOptions
[$property] = $value;
4205 $this->mOptionsLoaded
= true;
4207 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4213 protected function saveOptions() {
4214 global $wgAllowPrefChange;
4216 $this->loadOptions();
4218 // Not using getOptions(), to keep hidden preferences in database
4219 $saveOptions = $this->mOptions
;
4221 // Allow hooks to abort, for instance to save to a global profile.
4222 // Reset options to default state before saving.
4223 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4227 $extuser = ExternalUser
::newFromUser( $this );
4228 $userId = $this->getId();
4229 $insert_rows = array();
4230 foreach( $saveOptions as $key => $value ) {
4231 # Don't bother storing default values
4232 $defaultOption = self
::getDefaultOption( $key );
4233 if ( ( is_null( $defaultOption ) &&
4234 !( $value === false ||
is_null( $value ) ) ) ||
4235 $value != $defaultOption ) {
4236 $insert_rows[] = array(
4237 'up_user' => $userId,
4238 'up_property' => $key,
4239 'up_value' => $value,
4242 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4243 switch ( $wgAllowPrefChange[$key] ) {
4249 $extuser->setPref( $key, $value );
4254 $dbw = wfGetDB( DB_MASTER
);
4255 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4256 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4260 * Provide an array of HTML5 attributes to put on an input element
4261 * intended for the user to enter a new password. This may include
4262 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4264 * Do *not* use this when asking the user to enter his current password!
4265 * Regardless of configuration, users may have invalid passwords for whatever
4266 * reason (e.g., they were set before requirements were tightened up).
4267 * Only use it when asking for a new password, like on account creation or
4270 * Obviously, you still need to do server-side checking.
4272 * NOTE: A combination of bugs in various browsers means that this function
4273 * actually just returns array() unconditionally at the moment. May as
4274 * well keep it around for when the browser bugs get fixed, though.
4276 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4278 * @return array Array of HTML attributes suitable for feeding to
4279 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4280 * That will potentially output invalid XHTML 1.0 Transitional, and will
4281 * get confused by the boolean attribute syntax used.)
4283 public static function passwordChangeInputAttribs() {
4284 global $wgMinimalPasswordLength;
4286 if ( $wgMinimalPasswordLength == 0 ) {
4290 # Note that the pattern requirement will always be satisfied if the
4291 # input is empty, so we need required in all cases.
4293 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4294 # if e-mail confirmation is being used. Since HTML5 input validation
4295 # is b0rked anyway in some browsers, just return nothing. When it's
4296 # re-enabled, fix this code to not output required for e-mail
4298 #$ret = array( 'required' );
4301 # We can't actually do this right now, because Opera 9.6 will print out
4302 # the entered password visibly in its error message! When other
4303 # browsers add support for this attribute, or Opera fixes its support,
4304 # we can add support with a version check to avoid doing this on Opera
4305 # versions where it will be a problem. Reported to Opera as
4306 # DSK-262266, but they don't have a public bug tracker for us to follow.
4308 if ( $wgMinimalPasswordLength > 1 ) {
4309 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4310 $ret['title'] = wfMessage( 'passwordtooshort' )
4311 ->numParams( $wgMinimalPasswordLength )->text();
4319 * Return the list of user fields that should be selected to create
4320 * a new user object.
4323 public static function selectFields() {
4330 'user_newpass_time',
4334 'user_email_authenticated',
4336 'user_email_token_expires',
4337 'user_registration',