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 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1173 $logEntry->setPerformer( $this );
1174 $logEntry->setTarget( $this->getUserPage() );
1175 $logEntry->setParameters( array(
1176 '4::oldgroups' => $oldGroups,
1177 '5::newgroups' => $newGroups,
1179 $logid = $logEntry->insert();
1180 if ( $wgAutopromoteOnceLogInRC ) {
1181 $logEntry->publish( $logid );
1189 * Clear various cached data stored in this object. The cache of the user table
1190 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1192 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1193 * given source. May be "name", "id", "defaults", "session", or false for
1196 public function clearInstanceCache( $reloadFrom = false ) {
1197 $this->mNewtalk
= -1;
1198 $this->mDatePreference
= null;
1199 $this->mBlockedby
= -1; # Unset
1200 $this->mHash
= false;
1201 $this->mRights
= null;
1202 $this->mEffectiveGroups
= null;
1203 $this->mImplicitGroups
= null;
1204 $this->mOptions
= null;
1205 $this->mOptionsLoaded
= false;
1206 $this->mEditCount
= null;
1208 if ( $reloadFrom ) {
1209 $this->mLoadedItems
= array();
1210 $this->mFrom
= $reloadFrom;
1215 * Combine the language default options with any site-specific options
1216 * and add the default language variants.
1218 * @return Array of String options
1220 public static function getDefaultOptions() {
1221 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1223 static $defOpt = null;
1224 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1225 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1226 // mid-request and see that change reflected in the return value of this function.
1227 // Which is insane and would never happen during normal MW operation
1231 $defOpt = $wgDefaultUserOptions;
1232 # default language setting
1233 $defOpt['variant'] = $wgContLang->getCode();
1234 $defOpt['language'] = $wgContLang->getCode();
1235 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1236 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1238 $defOpt['skin'] = $wgDefaultSkin;
1240 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1246 * Get a given default option value.
1248 * @param $opt String Name of option to retrieve
1249 * @return String Default option value
1251 public static function getDefaultOption( $opt ) {
1252 $defOpts = self
::getDefaultOptions();
1253 if( isset( $defOpts[$opt] ) ) {
1254 return $defOpts[$opt];
1262 * Get blocking information
1263 * @param $bFromSlave Bool Whether to check the slave database first. To
1264 * improve performance, non-critical checks are done
1265 * against slaves. Check when actually saving should be
1266 * done against master.
1268 private function getBlockedStatus( $bFromSlave = true ) {
1269 global $wgProxyWhitelist, $wgUser;
1271 if ( -1 != $this->mBlockedby
) {
1275 wfProfileIn( __METHOD__
);
1276 wfDebug( __METHOD__
.": checking...\n" );
1278 // Initialize data...
1279 // Otherwise something ends up stomping on $this->mBlockedby when
1280 // things get lazy-loaded later, causing false positive block hits
1281 // due to -1 !== 0. Probably session-related... Nothing should be
1282 // overwriting mBlockedby, surely?
1285 # We only need to worry about passing the IP address to the Block generator if the
1286 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1287 # know which IP address they're actually coming from
1288 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1289 $ip = $this->getRequest()->getIP();
1295 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1298 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1299 && !in_array( $ip, $wgProxyWhitelist ) )
1302 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1304 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1305 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1306 $block->setTarget( $ip );
1307 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1309 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1310 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1311 $block->setTarget( $ip );
1315 if ( $block instanceof Block
) {
1316 wfDebug( __METHOD__
. ": Found block.\n" );
1317 $this->mBlock
= $block;
1318 $this->mBlockedby
= $block->getByName();
1319 $this->mBlockreason
= $block->mReason
;
1320 $this->mHideName
= $block->mHideName
;
1321 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1323 $this->mBlockedby
= '';
1324 $this->mHideName
= 0;
1325 $this->mAllowUsertalk
= false;
1329 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1331 wfProfileOut( __METHOD__
);
1335 * Whether the given IP is in a DNS blacklist.
1337 * @param $ip String IP to check
1338 * @param $checkWhitelist Bool: whether to check the whitelist first
1339 * @return Bool True if blacklisted.
1341 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1342 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1343 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1345 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1348 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1351 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1352 return $this->inDnsBlacklist( $ip, $urls );
1356 * Whether the given IP is in a given DNS blacklist.
1358 * @param $ip String IP to check
1359 * @param $bases String|Array of Strings: URL of the DNS blacklist
1360 * @return Bool True if blacklisted.
1362 public function inDnsBlacklist( $ip, $bases ) {
1363 wfProfileIn( __METHOD__
);
1366 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1367 if( IP
::isIPv4( $ip ) ) {
1368 # Reverse IP, bug 21255
1369 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1371 foreach( (array)$bases as $base ) {
1373 # If we have an access key, use that too (ProjectHoneypot, etc.)
1374 if( is_array( $base ) ) {
1375 if( count( $base ) >= 2 ) {
1376 # Access key is 1, base URL is 0
1377 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1379 $host = "$ipReversed.{$base[0]}";
1382 $host = "$ipReversed.$base";
1386 $ipList = gethostbynamel( $host );
1389 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1393 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1398 wfProfileOut( __METHOD__
);
1403 * Check if an IP address is in the local proxy list
1409 public static function isLocallyBlockedProxy( $ip ) {
1410 global $wgProxyList;
1412 if ( !$wgProxyList ) {
1415 wfProfileIn( __METHOD__
);
1417 if ( !is_array( $wgProxyList ) ) {
1418 # Load from the specified file
1419 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1422 if ( !is_array( $wgProxyList ) ) {
1424 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1426 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1427 # Old-style flipped proxy list
1432 wfProfileOut( __METHOD__
);
1437 * Is this user subject to rate limiting?
1439 * @return Bool True if rate limited
1441 public function isPingLimitable() {
1442 global $wgRateLimitsExcludedIPs;
1443 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1444 // No other good way currently to disable rate limits
1445 // for specific IPs. :P
1446 // But this is a crappy hack and should die.
1449 return !$this->isAllowed('noratelimit');
1453 * Primitive rate limits: enforce maximum actions per time period
1454 * to put a brake on flooding.
1456 * @note When using a shared cache like memcached, IP-address
1457 * last-hit counters will be shared across wikis.
1459 * @param $action String Action to enforce; 'edit' if unspecified
1460 * @return Bool True if a rate limiter was tripped
1462 public function pingLimiter( $action = 'edit' ) {
1463 # Call the 'PingLimiter' hook
1465 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1469 global $wgRateLimits;
1470 if( !isset( $wgRateLimits[$action] ) ) {
1474 # Some groups shouldn't trigger the ping limiter, ever
1475 if( !$this->isPingLimitable() )
1478 global $wgMemc, $wgRateLimitLog;
1479 wfProfileIn( __METHOD__
);
1481 $limits = $wgRateLimits[$action];
1483 $id = $this->getId();
1484 $ip = $this->getRequest()->getIP();
1487 if( isset( $limits['anon'] ) && $id == 0 ) {
1488 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1491 if( isset( $limits['user'] ) && $id != 0 ) {
1492 $userLimit = $limits['user'];
1494 if( $this->isNewbie() ) {
1495 if( isset( $limits['newbie'] ) && $id != 0 ) {
1496 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1498 if( isset( $limits['ip'] ) ) {
1499 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1502 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1503 $subnet = $matches[1];
1504 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1507 // Check for group-specific permissions
1508 // If more than one group applies, use the group with the highest limit
1509 foreach ( $this->getGroups() as $group ) {
1510 if ( isset( $limits[$group] ) ) {
1511 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1512 $userLimit = $limits[$group];
1516 // Set the user limit key
1517 if ( $userLimit !== false ) {
1518 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1519 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1523 foreach( $keys as $key => $limit ) {
1524 list( $max, $period ) = $limit;
1525 $summary = "(limit $max in {$period}s)";
1526 $count = $wgMemc->get( $key );
1529 if( $count >= $max ) {
1530 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1531 if( $wgRateLimitLog ) {
1532 wfSuppressWarnings();
1533 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1534 wfRestoreWarnings();
1538 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1541 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1542 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1544 $wgMemc->incr( $key );
1547 wfProfileOut( __METHOD__
);
1552 * Check if user is blocked
1554 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1555 * @return Bool True if blocked, false otherwise
1557 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1558 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1562 * Get the block affecting the user, or null if the user is not blocked
1564 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1565 * @return Block|null
1567 public function getBlock( $bFromSlave = true ){
1568 $this->getBlockedStatus( $bFromSlave );
1569 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1573 * Check if user is blocked from editing a particular article
1575 * @param $title Title to check
1576 * @param $bFromSlave Bool whether to check the slave database instead of the master
1579 function isBlockedFrom( $title, $bFromSlave = false ) {
1580 global $wgBlockAllowsUTEdit;
1581 wfProfileIn( __METHOD__
);
1583 $blocked = $this->isBlocked( $bFromSlave );
1584 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1585 # If a user's name is suppressed, they cannot make edits anywhere
1586 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1587 $title->getNamespace() == NS_USER_TALK
) {
1589 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1592 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1594 wfProfileOut( __METHOD__
);
1599 * If user is blocked, return the name of the user who placed the block
1600 * @return String name of blocker
1602 public function blockedBy() {
1603 $this->getBlockedStatus();
1604 return $this->mBlockedby
;
1608 * If user is blocked, return the specified reason for the block
1609 * @return String Blocking reason
1611 public function blockedFor() {
1612 $this->getBlockedStatus();
1613 return $this->mBlockreason
;
1617 * If user is blocked, return the ID for the block
1618 * @return Int Block ID
1620 public function getBlockId() {
1621 $this->getBlockedStatus();
1622 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1626 * Check if user is blocked on all wikis.
1627 * Do not use for actual edit permission checks!
1628 * This is intented for quick UI checks.
1630 * @param $ip String IP address, uses current client if none given
1631 * @return Bool True if blocked, false otherwise
1633 public function isBlockedGlobally( $ip = '' ) {
1634 if( $this->mBlockedGlobally
!== null ) {
1635 return $this->mBlockedGlobally
;
1637 // User is already an IP?
1638 if( IP
::isIPAddress( $this->getName() ) ) {
1639 $ip = $this->getName();
1641 $ip = $this->getRequest()->getIP();
1644 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1645 $this->mBlockedGlobally
= (bool)$blocked;
1646 return $this->mBlockedGlobally
;
1650 * Check if user account is locked
1652 * @return Bool True if locked, false otherwise
1654 public function isLocked() {
1655 if( $this->mLocked
!== null ) {
1656 return $this->mLocked
;
1659 $authUser = $wgAuth->getUserInstance( $this );
1660 $this->mLocked
= (bool)$authUser->isLocked();
1661 return $this->mLocked
;
1665 * Check if user account is hidden
1667 * @return Bool True if hidden, false otherwise
1669 public function isHidden() {
1670 if( $this->mHideName
!== null ) {
1671 return $this->mHideName
;
1673 $this->getBlockedStatus();
1674 if( !$this->mHideName
) {
1676 $authUser = $wgAuth->getUserInstance( $this );
1677 $this->mHideName
= (bool)$authUser->isHidden();
1679 return $this->mHideName
;
1683 * Get the user's ID.
1684 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1686 public function getId() {
1687 if( $this->mId
=== null && $this->mName
!== null
1688 && User
::isIP( $this->mName
) ) {
1689 // Special case, we know the user is anonymous
1691 } elseif( !$this->isItemLoaded( 'id' ) ) {
1692 // Don't load if this was initialized from an ID
1699 * Set the user and reload all fields according to a given ID
1700 * @param $v Int User ID to reload
1702 public function setId( $v ) {
1704 $this->clearInstanceCache( 'id' );
1708 * Get the user name, or the IP of an anonymous user
1709 * @return String User's name or IP address
1711 public function getName() {
1712 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1713 # Special case optimisation
1714 return $this->mName
;
1717 if ( $this->mName
=== false ) {
1719 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1721 return $this->mName
;
1726 * Set the user name.
1728 * This does not reload fields from the database according to the given
1729 * name. Rather, it is used to create a temporary "nonexistent user" for
1730 * later addition to the database. It can also be used to set the IP
1731 * address for an anonymous user to something other than the current
1734 * @note User::newFromName() has rougly the same function, when the named user
1736 * @param $str String New user name to set
1738 public function setName( $str ) {
1740 $this->mName
= $str;
1744 * Get the user's name escaped by underscores.
1745 * @return String Username escaped by underscores.
1747 public function getTitleKey() {
1748 return str_replace( ' ', '_', $this->getName() );
1752 * Check if the user has new messages.
1753 * @return Bool True if the user has new messages
1755 public function getNewtalk() {
1758 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1759 if( $this->mNewtalk
=== -1 ) {
1760 $this->mNewtalk
= false; # reset talk page status
1762 # Check memcached separately for anons, who have no
1763 # entire User object stored in there.
1765 global $wgDisableAnonTalk;
1766 if( $wgDisableAnonTalk ) {
1767 // Anon newtalk disabled by configuration.
1768 $this->mNewtalk
= false;
1771 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1772 $newtalk = $wgMemc->get( $key );
1773 if( strval( $newtalk ) !== '' ) {
1774 $this->mNewtalk
= (bool)$newtalk;
1776 // Since we are caching this, make sure it is up to date by getting it
1778 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1779 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1783 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1787 return (bool)$this->mNewtalk
;
1791 * Return the talk page(s) this user has new messages on.
1792 * @return Array of String page URLs
1794 public function getNewMessageLinks() {
1796 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1798 } elseif( !$this->getNewtalk() ) {
1801 $utp = $this->getTalkPage();
1802 $dbr = wfGetDB( DB_SLAVE
);
1803 // Get the "last viewed rev" timestamp from the oldest message notification
1804 $timestamp = $dbr->selectField( 'user_newtalk',
1805 'MIN(user_last_timestamp)',
1806 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1808 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1809 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1813 * Internal uncached check for new messages
1816 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1817 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1818 * @param $fromMaster Bool true to fetch from the master, false for a slave
1819 * @return Bool True if the user has new messages
1821 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1822 if ( $fromMaster ) {
1823 $db = wfGetDB( DB_MASTER
);
1825 $db = wfGetDB( DB_SLAVE
);
1827 $ok = $db->selectField( 'user_newtalk', $field,
1828 array( $field => $id ), __METHOD__
);
1829 return $ok !== false;
1833 * Add or update the new messages flag
1834 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1835 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1836 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1837 * @return Bool True if successful, false otherwise
1839 protected function updateNewtalk( $field, $id, $curRev = null ) {
1840 // Get timestamp of the talk page revision prior to the current one
1841 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1842 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1843 // Mark the user as having new messages since this revision
1844 $dbw = wfGetDB( DB_MASTER
);
1845 $dbw->insert( 'user_newtalk',
1846 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1849 if ( $dbw->affectedRows() ) {
1850 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1853 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1859 * Clear the new messages flag for the given user
1860 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1861 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1862 * @return Bool True if successful, false otherwise
1864 protected function deleteNewtalk( $field, $id ) {
1865 $dbw = wfGetDB( DB_MASTER
);
1866 $dbw->delete( 'user_newtalk',
1867 array( $field => $id ),
1869 if ( $dbw->affectedRows() ) {
1870 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1873 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1879 * Update the 'You have new messages!' status.
1880 * @param $val Bool Whether the user has new messages
1881 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1883 public function setNewtalk( $val, $curRev = null ) {
1884 if( wfReadOnly() ) {
1889 $this->mNewtalk
= $val;
1891 if( $this->isAnon() ) {
1893 $id = $this->getName();
1896 $id = $this->getId();
1901 $changed = $this->updateNewtalk( $field, $id, $curRev );
1903 $changed = $this->deleteNewtalk( $field, $id );
1906 if( $this->isAnon() ) {
1907 // Anons have a separate memcached space, since
1908 // user records aren't kept for them.
1909 $key = wfMemcKey( 'newtalk', 'ip', $id );
1910 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1913 $this->invalidateCache();
1918 * Generate a current or new-future timestamp to be stored in the
1919 * user_touched field when we update things.
1920 * @return String Timestamp in TS_MW format
1922 private static function newTouchedTimestamp() {
1923 global $wgClockSkewFudge;
1924 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1928 * Clear user data from memcached.
1929 * Use after applying fun updates to the database; caller's
1930 * responsibility to update user_touched if appropriate.
1932 * Called implicitly from invalidateCache() and saveSettings().
1934 private function clearSharedCache() {
1938 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1943 * Immediately touch the user data cache for this account.
1944 * Updates user_touched field, and removes account data from memcached
1945 * for reload on the next hit.
1947 public function invalidateCache() {
1948 if( wfReadOnly() ) {
1953 $this->mTouched
= self
::newTouchedTimestamp();
1955 $dbw = wfGetDB( DB_MASTER
);
1957 // Prevent contention slams by checking user_touched first
1958 $now = $dbw->timestamp( $this->mTouched
);
1959 $needsPurge = $dbw->selectField( 'user', '1',
1960 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1962 if ( $needsPurge ) {
1963 $dbw->update( 'user',
1964 array( 'user_touched' => $now ),
1965 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1970 $this->clearSharedCache();
1975 * Validate the cache for this account.
1976 * @param $timestamp String A timestamp in TS_MW format
1980 public function validateCache( $timestamp ) {
1982 return ( $timestamp >= $this->mTouched
);
1986 * Get the user touched timestamp
1987 * @return String timestamp
1989 public function getTouched() {
1991 return $this->mTouched
;
1995 * Set the password and reset the random token.
1996 * Calls through to authentication plugin if necessary;
1997 * will have no effect if the auth plugin refuses to
1998 * pass the change through or if the legal password
2001 * As a special case, setting the password to null
2002 * wipes it, so the account cannot be logged in until
2003 * a new password is set, for instance via e-mail.
2005 * @param $str String New password to set
2006 * @throws PasswordError on failure
2010 public function setPassword( $str ) {
2013 if( $str !== null ) {
2014 if( !$wgAuth->allowPasswordChange() ) {
2015 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2018 if( !$this->isValidPassword( $str ) ) {
2019 global $wgMinimalPasswordLength;
2020 $valid = $this->getPasswordValidity( $str );
2021 if ( is_array( $valid ) ) {
2022 $message = array_shift( $valid );
2026 $params = array( $wgMinimalPasswordLength );
2028 throw new PasswordError( wfMessage( $message, $params )->text() );
2032 if( !$wgAuth->setPassword( $this, $str ) ) {
2033 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2036 $this->setInternalPassword( $str );
2042 * Set the password and reset the random token unconditionally.
2044 * @param $str String New password to set
2046 public function setInternalPassword( $str ) {
2050 if( $str === null ) {
2051 // Save an invalid hash...
2052 $this->mPassword
= '';
2054 $this->mPassword
= self
::crypt( $str );
2056 $this->mNewpassword
= '';
2057 $this->mNewpassTime
= null;
2061 * Get the user's current token.
2062 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2063 * @return String Token
2065 public function getToken( $forceCreation = true ) {
2067 if ( !$this->mToken
&& $forceCreation ) {
2070 return $this->mToken
;
2074 * Set the random token (used for persistent authentication)
2075 * Called from loadDefaults() among other places.
2077 * @param $token String|bool If specified, set the token to this value
2079 public function setToken( $token = false ) {
2082 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2084 $this->mToken
= $token;
2089 * Set the password for a password reminder or new account email
2091 * @param $str String New password to set
2092 * @param $throttle Bool If true, reset the throttle timestamp to the present
2094 public function setNewpassword( $str, $throttle = true ) {
2096 $this->mNewpassword
= self
::crypt( $str );
2098 $this->mNewpassTime
= wfTimestampNow();
2103 * Has password reminder email been sent within the last
2104 * $wgPasswordReminderResendTime hours?
2107 public function isPasswordReminderThrottled() {
2108 global $wgPasswordReminderResendTime;
2110 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2113 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2114 return time() < $expiry;
2118 * Get the user's e-mail address
2119 * @return String User's email address
2121 public function getEmail() {
2123 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2124 return $this->mEmail
;
2128 * Get the timestamp of the user's e-mail authentication
2129 * @return String TS_MW timestamp
2131 public function getEmailAuthenticationTimestamp() {
2133 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2134 return $this->mEmailAuthenticated
;
2138 * Set the user's e-mail address
2139 * @param $str String New e-mail address
2141 public function setEmail( $str ) {
2143 if( $str == $this->mEmail
) {
2146 $this->mEmail
= $str;
2147 $this->invalidateEmail();
2148 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2152 * Set the user's e-mail address and a confirmation mail if needed.
2155 * @param $str String New e-mail address
2158 public function setEmailWithConfirmation( $str ) {
2159 global $wgEnableEmail, $wgEmailAuthentication;
2161 if ( !$wgEnableEmail ) {
2162 return Status
::newFatal( 'emaildisabled' );
2165 $oldaddr = $this->getEmail();
2166 if ( $str === $oldaddr ) {
2167 return Status
::newGood( true );
2170 $this->setEmail( $str );
2172 if ( $str !== '' && $wgEmailAuthentication ) {
2173 # Send a confirmation request to the new address if needed
2174 $type = $oldaddr != '' ?
'changed' : 'set';
2175 $result = $this->sendConfirmationMail( $type );
2176 if ( $result->isGood() ) {
2177 # Say the the caller that a confirmation mail has been sent
2178 $result->value
= 'eauth';
2181 $result = Status
::newGood( true );
2188 * Get the user's real name
2189 * @return String User's real name
2191 public function getRealName() {
2192 if ( !$this->isItemLoaded( 'realname' ) ) {
2196 return $this->mRealName
;
2200 * Set the user's real name
2201 * @param $str String New real name
2203 public function setRealName( $str ) {
2205 $this->mRealName
= $str;
2209 * Get the user's current setting for a given option.
2211 * @param $oname String The option to check
2212 * @param $defaultOverride String A default value returned if the option does not exist
2213 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2214 * @return String User's current value for the option
2215 * @see getBoolOption()
2216 * @see getIntOption()
2218 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2219 global $wgHiddenPrefs;
2220 $this->loadOptions();
2222 # We want 'disabled' preferences to always behave as the default value for
2223 # users, even if they have set the option explicitly in their settings (ie they
2224 # set it, and then it was disabled removing their ability to change it). But
2225 # we don't want to erase the preferences in the database in case the preference
2226 # is re-enabled again. So don't touch $mOptions, just override the returned value
2227 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2228 return self
::getDefaultOption( $oname );
2231 if ( array_key_exists( $oname, $this->mOptions
) ) {
2232 return $this->mOptions
[$oname];
2234 return $defaultOverride;
2239 * Get all user's options
2243 public function getOptions() {
2244 global $wgHiddenPrefs;
2245 $this->loadOptions();
2246 $options = $this->mOptions
;
2248 # We want 'disabled' preferences to always behave as the default value for
2249 # users, even if they have set the option explicitly in their settings (ie they
2250 # set it, and then it was disabled removing their ability to change it). But
2251 # we don't want to erase the preferences in the database in case the preference
2252 # is re-enabled again. So don't touch $mOptions, just override the returned value
2253 foreach( $wgHiddenPrefs as $pref ){
2254 $default = self
::getDefaultOption( $pref );
2255 if( $default !== null ){
2256 $options[$pref] = $default;
2264 * Get the user's current setting for a given option, as a boolean value.
2266 * @param $oname String The option to check
2267 * @return Bool User's current value for the option
2270 public function getBoolOption( $oname ) {
2271 return (bool)$this->getOption( $oname );
2275 * Get the user's current setting for a given option, as a boolean value.
2277 * @param $oname String The option to check
2278 * @param $defaultOverride Int A default value returned if the option does not exist
2279 * @return Int User's current value for the option
2282 public function getIntOption( $oname, $defaultOverride=0 ) {
2283 $val = $this->getOption( $oname );
2285 $val = $defaultOverride;
2287 return intval( $val );
2291 * Set the given option for a user.
2293 * @param $oname String The option to set
2294 * @param $val mixed New value to set
2296 public function setOption( $oname, $val ) {
2297 $this->loadOptions();
2299 // Explicitly NULL values should refer to defaults
2300 if( is_null( $val ) ) {
2301 $val = self
::getDefaultOption( $oname );
2304 $this->mOptions
[$oname] = $val;
2308 * Reset all options to the site defaults
2310 public function resetOptions() {
2313 $this->mOptions
= self
::getDefaultOptions();
2314 $this->mOptionsLoaded
= true;
2318 * Get the user's preferred date format.
2319 * @return String User's preferred date format
2321 public function getDatePreference() {
2322 // Important migration for old data rows
2323 if ( is_null( $this->mDatePreference
) ) {
2325 $value = $this->getOption( 'date' );
2326 $map = $wgLang->getDatePreferenceMigrationMap();
2327 if ( isset( $map[$value] ) ) {
2328 $value = $map[$value];
2330 $this->mDatePreference
= $value;
2332 return $this->mDatePreference
;
2336 * Get the user preferred stub threshold
2340 public function getStubThreshold() {
2341 global $wgMaxArticleSize; # Maximum article size, in Kb
2342 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2343 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2344 # If they have set an impossible value, disable the preference
2345 # so we can use the parser cache again.
2352 * Get the permissions this user has.
2353 * @return Array of String permission names
2355 public function getRights() {
2356 if ( is_null( $this->mRights
) ) {
2357 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2358 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2359 // Force reindexation of rights when a hook has unset one of them
2360 $this->mRights
= array_values( $this->mRights
);
2362 return $this->mRights
;
2366 * Get the list of explicit group memberships this user has.
2367 * The implicit * and user groups are not included.
2368 * @return Array of String internal group names
2370 public function getGroups() {
2372 $this->loadGroups();
2373 return $this->mGroups
;
2377 * Get the list of implicit group memberships this user has.
2378 * This includes all explicit groups, plus 'user' if logged in,
2379 * '*' for all accounts, and autopromoted groups
2380 * @param $recache Bool Whether to avoid the cache
2381 * @return Array of String internal group names
2383 public function getEffectiveGroups( $recache = false ) {
2384 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2385 wfProfileIn( __METHOD__
);
2386 $this->mEffectiveGroups
= array_unique( array_merge(
2387 $this->getGroups(), // explicit groups
2388 $this->getAutomaticGroups( $recache ) // implicit groups
2390 # Hook for additional groups
2391 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2392 wfProfileOut( __METHOD__
);
2394 return $this->mEffectiveGroups
;
2398 * Get the list of implicit group memberships this user has.
2399 * This includes 'user' if logged in, '*' for all accounts,
2400 * and autopromoted groups
2401 * @param $recache Bool Whether to avoid the cache
2402 * @return Array of String internal group names
2404 public function getAutomaticGroups( $recache = false ) {
2405 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2406 wfProfileIn( __METHOD__
);
2407 $this->mImplicitGroups
= array( '*' );
2408 if ( $this->getId() ) {
2409 $this->mImplicitGroups
[] = 'user';
2411 $this->mImplicitGroups
= array_unique( array_merge(
2412 $this->mImplicitGroups
,
2413 Autopromote
::getAutopromoteGroups( $this )
2417 # Assure data consistency with rights/groups,
2418 # as getEffectiveGroups() depends on this function
2419 $this->mEffectiveGroups
= null;
2421 wfProfileOut( __METHOD__
);
2423 return $this->mImplicitGroups
;
2427 * Returns the groups the user has belonged to.
2429 * The user may still belong to the returned groups. Compare with getGroups().
2431 * The function will not return groups the user had belonged to before MW 1.17
2433 * @return array Names of the groups the user has belonged to.
2435 public function getFormerGroups() {
2436 if( is_null( $this->mFormerGroups
) ) {
2437 $dbr = wfGetDB( DB_MASTER
);
2438 $res = $dbr->select( 'user_former_groups',
2439 array( 'ufg_group' ),
2440 array( 'ufg_user' => $this->mId
),
2442 $this->mFormerGroups
= array();
2443 foreach( $res as $row ) {
2444 $this->mFormerGroups
[] = $row->ufg_group
;
2447 return $this->mFormerGroups
;
2451 * Get the user's edit count.
2454 public function getEditCount() {
2455 if( $this->getId() ) {
2456 if ( !isset( $this->mEditCount
) ) {
2457 /* Populate the count, if it has not been populated yet */
2458 wfProfileIn( __METHOD__
);
2459 $dbr = wfGetDB( DB_SLAVE
);
2460 // check if the user_editcount field has been initialized
2461 $count = $dbr->selectField(
2462 'user', 'user_editcount',
2463 array( 'user_id' => $this->mId
),
2467 if( $count === null ) {
2468 // it has not been initialized. do so.
2469 $count = $this->initEditCount();
2471 wfProfileOut( __METHOD__
);
2472 $this->mEditCount
= intval( $count );
2474 return $this->mEditCount
;
2482 * Add the user to the given group.
2483 * This takes immediate effect.
2484 * @param $group String Name of the group to add
2486 public function addGroup( $group ) {
2487 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2488 $dbw = wfGetDB( DB_MASTER
);
2489 if( $this->getId() ) {
2490 $dbw->insert( 'user_groups',
2492 'ug_user' => $this->getID(),
2493 'ug_group' => $group,
2496 array( 'IGNORE' ) );
2499 $this->loadGroups();
2500 $this->mGroups
[] = $group;
2501 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2503 $this->invalidateCache();
2507 * Remove the user from the given group.
2508 * This takes immediate effect.
2509 * @param $group String Name of the group to remove
2511 public function removeGroup( $group ) {
2513 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2514 $dbw = wfGetDB( DB_MASTER
);
2515 $dbw->delete( 'user_groups',
2517 'ug_user' => $this->getID(),
2518 'ug_group' => $group,
2520 // Remember that the user was in this group
2521 $dbw->insert( 'user_former_groups',
2523 'ufg_user' => $this->getID(),
2524 'ufg_group' => $group,
2527 array( 'IGNORE' ) );
2529 $this->loadGroups();
2530 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2531 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2533 $this->invalidateCache();
2537 * Get whether the user is logged in
2540 public function isLoggedIn() {
2541 return $this->getID() != 0;
2545 * Get whether the user is anonymous
2548 public function isAnon() {
2549 return !$this->isLoggedIn();
2553 * Check if user is allowed to access a feature / make an action
2555 * @internal param \String $varargs permissions to test
2556 * @return Boolean: True if user is allowed to perform *any* of the given actions
2560 public function isAllowedAny( /*...*/ ){
2561 $permissions = func_get_args();
2562 foreach( $permissions as $permission ){
2563 if( $this->isAllowed( $permission ) ){
2572 * @internal param $varargs string
2573 * @return bool True if the user is allowed to perform *all* of the given actions
2575 public function isAllowedAll( /*...*/ ){
2576 $permissions = func_get_args();
2577 foreach( $permissions as $permission ){
2578 if( !$this->isAllowed( $permission ) ){
2586 * Internal mechanics of testing a permission
2587 * @param $action String
2590 public function isAllowed( $action = '' ) {
2591 if ( $action === '' ) {
2592 return true; // In the spirit of DWIM
2594 # Patrolling may not be enabled
2595 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2596 global $wgUseRCPatrol, $wgUseNPPatrol;
2597 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2600 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2601 # by misconfiguration: 0 == 'foo'
2602 return in_array( $action, $this->getRights(), true );
2606 * Check whether to enable recent changes patrol features for this user
2607 * @return Boolean: True or false
2609 public function useRCPatrol() {
2610 global $wgUseRCPatrol;
2611 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2615 * Check whether to enable new pages patrol features for this user
2616 * @return Bool True or false
2618 public function useNPPatrol() {
2619 global $wgUseRCPatrol, $wgUseNPPatrol;
2620 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2624 * Get the WebRequest object to use with this object
2626 * @return WebRequest
2628 public function getRequest() {
2629 if ( $this->mRequest
) {
2630 return $this->mRequest
;
2638 * Get the current skin, loading it if required
2639 * @return Skin The current skin
2640 * @todo FIXME: Need to check the old failback system [AV]
2641 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2643 public function getSkin() {
2644 wfDeprecated( __METHOD__
, '1.18' );
2645 return RequestContext
::getMain()->getSkin();
2649 * Get a WatchedItem for this user and $title.
2651 * @param $title Title
2652 * @return WatchedItem
2654 public function getWatchedItem( $title ) {
2655 $key = $title->getNamespace() . ':' . $title->getDBkey();
2657 if ( isset( $this->mWatchedItems
[$key] ) ) {
2658 return $this->mWatchedItems
[$key];
2661 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2662 $this->mWatchedItems
= array();
2665 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2666 return $this->mWatchedItems
[$key];
2670 * Check the watched status of an article.
2671 * @param $title Title of the article to look at
2674 public function isWatched( $title ) {
2675 return $this->getWatchedItem( $title )->isWatched();
2680 * @param $title Title of the article to look at
2682 public function addWatch( $title ) {
2683 $this->getWatchedItem( $title )->addWatch();
2684 $this->invalidateCache();
2688 * Stop watching an article.
2689 * @param $title Title of the article to look at
2691 public function removeWatch( $title ) {
2692 $this->getWatchedItem( $title )->removeWatch();
2693 $this->invalidateCache();
2697 * Clear the user's notification timestamp for the given title.
2698 * If e-notif e-mails are on, they will receive notification mails on
2699 * the next change of the page if it's watched etc.
2700 * @param $title Title of the article to look at
2702 public function clearNotification( &$title ) {
2703 global $wgUseEnotif, $wgShowUpdatedMarker;
2705 # Do nothing if the database is locked to writes
2706 if( wfReadOnly() ) {
2710 if( $title->getNamespace() == NS_USER_TALK
&&
2711 $title->getText() == $this->getName() ) {
2712 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2714 $this->setNewtalk( false );
2717 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2721 if( $this->isAnon() ) {
2722 // Nothing else to do...
2726 // Only update the timestamp if the page is being watched.
2727 // The query to find out if it is watched is cached both in memcached and per-invocation,
2728 // and when it does have to be executed, it can be on a slave
2729 // If this is the user's newtalk page, we always update the timestamp
2731 if ( $title->getNamespace() == NS_USER_TALK
&&
2732 $title->getText() == $this->getName() )
2737 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2741 * Resets all of the given user's page-change notification timestamps.
2742 * If e-notif e-mails are on, they will receive notification mails on
2743 * the next change of any watched page.
2745 public function clearAllNotifications() {
2746 global $wgUseEnotif, $wgShowUpdatedMarker;
2747 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2748 $this->setNewtalk( false );
2751 $id = $this->getId();
2753 $dbw = wfGetDB( DB_MASTER
);
2754 $dbw->update( 'watchlist',
2756 'wl_notificationtimestamp' => null
2757 ), array( /* WHERE */
2761 # We also need to clear here the "you have new message" notification for the own user_talk page
2762 # This is cleared one page view later in Article::viewUpdates();
2767 * Set this user's options from an encoded string
2768 * @param $str String Encoded options to import
2770 * @deprecated in 1.19 due to removal of user_options from the user table
2772 private function decodeOptions( $str ) {
2773 wfDeprecated( __METHOD__
, '1.19' );
2777 $this->mOptionsLoaded
= true;
2778 $this->mOptionOverrides
= array();
2780 // If an option is not set in $str, use the default value
2781 $this->mOptions
= self
::getDefaultOptions();
2783 $a = explode( "\n", $str );
2784 foreach ( $a as $s ) {
2786 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2787 $this->mOptions
[$m[1]] = $m[2];
2788 $this->mOptionOverrides
[$m[1]] = $m[2];
2794 * Set a cookie on the user's client. Wrapper for
2795 * WebResponse::setCookie
2796 * @param $name String Name of the cookie to set
2797 * @param $value String Value to set
2798 * @param $exp Int Expiration time, as a UNIX time value;
2799 * if 0 or not specified, use the default $wgCookieExpiration
2800 * @param $secure Bool
2801 * true: Force setting the secure attribute when setting the cookie
2802 * false: Force NOT setting the secure attribute when setting the cookie
2803 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
2805 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
2806 $this->getRequest()->response()->setcookie( $name, $value, $exp, null, null, $secure );
2810 * Clear a cookie on the user's client
2811 * @param $name String Name of the cookie to clear
2813 protected function clearCookie( $name ) {
2814 $this->setCookie( $name, '', time() - 86400 );
2818 * Set the default cookies for this session on the user's client.
2820 * @param $request WebRequest object to use; $wgRequest will be used if null
2822 * @param $secure Whether to force secure/insecure cookies or use default
2824 public function setCookies( $request = null, $secure = null ) {
2825 if ( $request === null ) {
2826 $request = $this->getRequest();
2830 if ( 0 == $this->mId
) return;
2831 if ( !$this->mToken
) {
2832 // When token is empty or NULL generate a new one and then save it to the database
2833 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2834 // Simply by setting every cell in the user_token column to NULL and letting them be
2835 // regenerated as users log back into the wiki.
2837 $this->saveSettings();
2840 'wsUserID' => $this->mId
,
2841 'wsToken' => $this->mToken
,
2842 'wsUserName' => $this->getName()
2845 'UserID' => $this->mId
,
2846 'UserName' => $this->getName(),
2848 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2849 $cookies['Token'] = $this->mToken
;
2851 $cookies['Token'] = false;
2854 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2856 foreach ( $session as $name => $value ) {
2857 $request->setSessionData( $name, $value );
2859 foreach ( $cookies as $name => $value ) {
2860 if ( $value === false ) {
2861 $this->clearCookie( $name );
2863 $this->setCookie( $name, $value, 0, $secure );
2868 * If wpStickHTTPS was selected, also set an insecure cookie that
2869 * will cause the site to redirect the user to HTTPS, if they access
2870 * it over HTTP. Bug 29898.
2872 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
2873 $this->setCookie( 'forceHTTPS', 'true', time() +
2592000, false ); //30 days
2878 * Log this user out.
2880 public function logout() {
2881 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2887 * Clear the user's cookies and session, and reset the instance cache.
2890 public function doLogout() {
2891 $this->clearInstanceCache( 'defaults' );
2893 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2895 $this->clearCookie( 'UserID' );
2896 $this->clearCookie( 'Token' );
2897 $this->clearCookie( 'forceHTTPS' );
2899 # Remember when user logged out, to prevent seeing cached pages
2900 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2904 * Save this user's settings into the database.
2905 * @todo Only rarely do all these fields need to be set!
2907 public function saveSettings() {
2911 if ( wfReadOnly() ) { return; }
2912 if ( 0 == $this->mId
) { return; }
2914 $this->mTouched
= self
::newTouchedTimestamp();
2915 if ( !$wgAuth->allowSetLocalPassword() ) {
2916 $this->mPassword
= '';
2919 $dbw = wfGetDB( DB_MASTER
);
2920 $dbw->update( 'user',
2922 'user_name' => $this->mName
,
2923 'user_password' => $this->mPassword
,
2924 'user_newpassword' => $this->mNewpassword
,
2925 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2926 'user_real_name' => $this->mRealName
,
2927 'user_email' => $this->mEmail
,
2928 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2929 'user_touched' => $dbw->timestamp( $this->mTouched
),
2930 'user_token' => strval( $this->mToken
),
2931 'user_email_token' => $this->mEmailToken
,
2932 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2933 ), array( /* WHERE */
2934 'user_id' => $this->mId
2938 $this->saveOptions();
2940 wfRunHooks( 'UserSaveSettings', array( $this ) );
2941 $this->clearSharedCache();
2942 $this->getUserPage()->invalidateCache();
2946 * If only this user's username is known, and it exists, return the user ID.
2949 public function idForName() {
2950 $s = trim( $this->getName() );
2951 if ( $s === '' ) return 0;
2953 $dbr = wfGetDB( DB_SLAVE
);
2954 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2955 if ( $id === false ) {
2962 * Add a user to the database, return the user object
2964 * @param $name String Username to add
2965 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2966 * - password The user's password hash. Password logins will be disabled if this is omitted.
2967 * - newpassword Hash for a temporary password that has been mailed to the user
2968 * - email The user's email address
2969 * - email_authenticated The email authentication timestamp
2970 * - real_name The user's real name
2971 * - options An associative array of non-default options
2972 * - token Random authentication token. Do not set.
2973 * - registration Registration timestamp. Do not set.
2975 * @return User object, or null if the username already exists
2977 public static function createNew( $name, $params = array() ) {
2980 if ( isset( $params['options'] ) ) {
2981 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2982 unset( $params['options'] );
2984 $dbw = wfGetDB( DB_MASTER
);
2985 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2988 'user_id' => $seqVal,
2989 'user_name' => $name,
2990 'user_password' => $user->mPassword
,
2991 'user_newpassword' => $user->mNewpassword
,
2992 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2993 'user_email' => $user->mEmail
,
2994 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2995 'user_real_name' => $user->mRealName
,
2996 'user_token' => strval( $user->mToken
),
2997 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2998 'user_editcount' => 0,
2999 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3001 foreach ( $params as $name => $value ) {
3002 $fields["user_$name"] = $value;
3004 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3005 if ( $dbw->affectedRows() ) {
3006 $newUser = User
::newFromId( $dbw->insertId() );
3014 * Add this existing user object to the database. If the user already
3015 * exists, a fatal status object is returned, and the user object is
3016 * initialised with the data from the database.
3018 * Previously, this function generated a DB error due to a key conflict
3019 * if the user already existed. Many extension callers use this function
3020 * in code along the lines of:
3022 * $user = User::newFromName( $name );
3023 * if ( !$user->isLoggedIn() ) {
3024 * $user->addToDatabase();
3026 * // do something with $user...
3028 * However, this was vulnerable to a race condition (bug 16020). By
3029 * initialising the user object if the user exists, we aim to support this
3030 * calling sequence as far as possible.
3032 * Note that if the user exists, this function will acquire a write lock,
3033 * so it is still advisable to make the call conditional on isLoggedIn(),
3034 * and to commit the transaction after calling.
3038 public function addToDatabase() {
3041 $this->mTouched
= self
::newTouchedTimestamp();
3043 $dbw = wfGetDB( DB_MASTER
);
3044 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3045 $dbw->insert( 'user',
3047 'user_id' => $seqVal,
3048 'user_name' => $this->mName
,
3049 'user_password' => $this->mPassword
,
3050 'user_newpassword' => $this->mNewpassword
,
3051 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3052 'user_email' => $this->mEmail
,
3053 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3054 'user_real_name' => $this->mRealName
,
3055 'user_token' => strval( $this->mToken
),
3056 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3057 'user_editcount' => 0,
3058 'user_touched' => $dbw->timestamp( $this->mTouched
),
3062 if ( !$dbw->affectedRows() ) {
3063 $this->mId
= $dbw->selectField( 'user', 'user_id',
3064 array( 'user_name' => $this->mName
), __METHOD__
);
3067 if ( $this->loadFromDatabase() ) {
3072 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3073 "to insert a user row, but then it doesn't exist when we select it!" );
3075 return Status
::newFatal( 'userexists' );
3077 $this->mId
= $dbw->insertId();
3079 // Clear instance cache other than user table data, which is already accurate
3080 $this->clearInstanceCache();
3082 $this->saveOptions();
3083 return Status
::newGood();
3087 * If this user is logged-in and blocked,
3088 * block any IP address they've successfully logged in from.
3089 * @return bool A block was spread
3091 public function spreadAnyEditBlock() {
3092 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3093 return $this->spreadBlock();
3099 * If this (non-anonymous) user is blocked,
3100 * block the IP address they've successfully logged in from.
3101 * @return bool A block was spread
3103 protected function spreadBlock() {
3104 wfDebug( __METHOD__
. "()\n" );
3106 if ( $this->mId
== 0 ) {
3110 $userblock = Block
::newFromTarget( $this->getName() );
3111 if ( !$userblock ) {
3115 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3119 * Generate a string which will be different for any combination of
3120 * user options which would produce different parser output.
3121 * This will be used as part of the hash key for the parser cache,
3122 * so users with the same options can share the same cached data
3125 * Extensions which require it should install 'PageRenderingHash' hook,
3126 * which will give them a chance to modify this key based on their own
3129 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3130 * @return String Page rendering hash
3132 public function getPageRenderingHash() {
3133 wfDeprecated( __METHOD__
, '1.17' );
3135 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3137 return $this->mHash
;
3140 // stubthreshold is only included below for completeness,
3141 // since it disables the parser cache, its value will always
3142 // be 0 when this function is called by parsercache.
3144 $confstr = $this->getOption( 'math' );
3145 $confstr .= '!' . $this->getStubThreshold();
3146 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3147 $confstr .= '!' . $this->getDatePreference();
3149 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3150 $confstr .= '!' . $wgLang->getCode();
3151 $confstr .= '!' . $this->getOption( 'thumbsize' );
3152 // add in language specific options, if any
3153 $extra = $wgContLang->getExtraHashOptions();
3156 // Since the skin could be overloading link(), it should be
3157 // included here but in practice, none of our skins do that.
3159 $confstr .= $wgRenderHashAppend;
3161 // Give a chance for extensions to modify the hash, if they have
3162 // extra options or other effects on the parser cache.
3163 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3165 // Make it a valid memcached key fragment
3166 $confstr = str_replace( ' ', '_', $confstr );
3167 $this->mHash
= $confstr;
3172 * Get whether the user is explicitly blocked from account creation.
3173 * @return Bool|Block
3175 public function isBlockedFromCreateAccount() {
3176 $this->getBlockedStatus();
3177 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3178 return $this->mBlock
;
3181 # bug 13611: if the IP address the user is trying to create an account from is
3182 # blocked with createaccount disabled, prevent new account creation there even
3183 # when the user is logged in
3184 if( $this->mBlockedFromCreateAccount
=== false ){
3185 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3187 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3188 ?
$this->mBlockedFromCreateAccount
3193 * Get whether the user is blocked from using Special:Emailuser.
3196 public function isBlockedFromEmailuser() {
3197 $this->getBlockedStatus();
3198 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3202 * Get whether the user is allowed to create an account.
3205 function isAllowedToCreateAccount() {
3206 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3210 * Get this user's personal page title.
3212 * @return Title: User's personal page title
3214 public function getUserPage() {
3215 return Title
::makeTitle( NS_USER
, $this->getName() );
3219 * Get this user's talk page title.
3221 * @return Title: User's talk page title
3223 public function getTalkPage() {
3224 $title = $this->getUserPage();
3225 return $title->getTalkPage();
3229 * Determine whether the user is a newbie. Newbies are either
3230 * anonymous IPs, or the most recently created accounts.
3233 public function isNewbie() {
3234 return !$this->isAllowed( 'autoconfirmed' );
3238 * Check to see if the given clear-text password is one of the accepted passwords
3239 * @param $password String: user password.
3240 * @return Boolean: True if the given password is correct, otherwise False.
3242 public function checkPassword( $password ) {
3243 global $wgAuth, $wgLegacyEncoding;
3246 // Even though we stop people from creating passwords that
3247 // are shorter than this, doesn't mean people wont be able
3248 // to. Certain authentication plugins do NOT want to save
3249 // domain passwords in a mysql database, so we should
3250 // check this (in case $wgAuth->strict() is false).
3251 if( !$this->isValidPassword( $password ) ) {
3255 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3257 } elseif( $wgAuth->strict() ) {
3258 /* Auth plugin doesn't allow local authentication */
3260 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3261 /* Auth plugin doesn't allow local authentication for this user name */
3264 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3266 } elseif ( $wgLegacyEncoding ) {
3267 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3268 # Check for this with iconv
3269 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3270 if ( $cp1252Password != $password &&
3271 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3280 * Check if the given clear-text password matches the temporary password
3281 * sent by e-mail for password reset operations.
3283 * @param $plaintext string
3285 * @return Boolean: True if matches, false otherwise
3287 public function checkTemporaryPassword( $plaintext ) {
3288 global $wgNewPasswordExpiry;
3291 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3292 if ( is_null( $this->mNewpassTime
) ) {
3295 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3296 return ( time() < $expiry );
3303 * Alias for getEditToken.
3304 * @deprecated since 1.19, use getEditToken instead.
3306 * @param $salt String|Array of Strings Optional function-specific data for hashing
3307 * @param $request WebRequest object to use or null to use $wgRequest
3308 * @return String The new edit token
3310 public function editToken( $salt = '', $request = null ) {
3311 wfDeprecated( __METHOD__
, '1.19' );
3312 return $this->getEditToken( $salt, $request );
3316 * Initialize (if necessary) and return a session token value
3317 * which can be used in edit forms to show that the user's
3318 * login credentials aren't being hijacked with a foreign form
3323 * @param $salt String|Array of Strings Optional function-specific data for hashing
3324 * @param $request WebRequest object to use or null to use $wgRequest
3325 * @return String The new edit token
3327 public function getEditToken( $salt = '', $request = null ) {
3328 if ( $request == null ) {
3329 $request = $this->getRequest();
3332 if ( $this->isAnon() ) {
3333 return EDIT_TOKEN_SUFFIX
;
3335 $token = $request->getSessionData( 'wsEditToken' );
3336 if ( $token === null ) {
3337 $token = MWCryptRand
::generateHex( 32 );
3338 $request->setSessionData( 'wsEditToken', $token );
3340 if( is_array( $salt ) ) {
3341 $salt = implode( '|', $salt );
3343 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3348 * Generate a looking random token for various uses.
3350 * @param $salt String Optional salt value
3351 * @return String The new random token
3352 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3354 public static function generateToken( $salt = '' ) {
3355 return MWCryptRand
::generateHex( 32 );
3359 * Check given value against the token value stored in the session.
3360 * A match should confirm that the form was submitted from the
3361 * user's own login session, not a form submission from a third-party
3364 * @param $val String Input value to compare
3365 * @param $salt String Optional function-specific data for hashing
3366 * @param $request WebRequest object to use or null to use $wgRequest
3367 * @return Boolean: Whether the token matches
3369 public function matchEditToken( $val, $salt = '', $request = null ) {
3370 $sessionToken = $this->getEditToken( $salt, $request );
3371 if ( $val != $sessionToken ) {
3372 wfDebug( "User::matchEditToken: broken session data\n" );
3374 return $val == $sessionToken;
3378 * Check given value against the token value stored in the session,
3379 * ignoring the suffix.
3381 * @param $val String Input value to compare
3382 * @param $salt String Optional function-specific data for hashing
3383 * @param $request WebRequest object to use or null to use $wgRequest
3384 * @return Boolean: Whether the token matches
3386 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3387 $sessionToken = $this->getEditToken( $salt, $request );
3388 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3392 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3393 * mail to the user's given address.
3395 * @param $type String: message to send, either "created", "changed" or "set"
3396 * @return Status object
3398 public function sendConfirmationMail( $type = 'created' ) {
3400 $expiration = null; // gets passed-by-ref and defined in next line.
3401 $token = $this->confirmationToken( $expiration );
3402 $url = $this->confirmationTokenUrl( $token );
3403 $invalidateURL = $this->invalidationTokenUrl( $token );
3404 $this->saveSettings();
3406 if ( $type == 'created' ||
$type === false ) {
3407 $message = 'confirmemail_body';
3408 } elseif ( $type === true ) {
3409 $message = 'confirmemail_body_changed';
3411 $message = 'confirmemail_body_' . $type;
3414 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3415 wfMessage( $message,
3416 $this->getRequest()->getIP(),
3419 $wgLang->timeanddate( $expiration, false ),
3421 $wgLang->date( $expiration, false ),
3422 $wgLang->time( $expiration, false ) )->text() );
3426 * Send an e-mail to this user's account. Does not check for
3427 * confirmed status or validity.
3429 * @param $subject String Message subject
3430 * @param $body String Message body
3431 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3432 * @param $replyto String Reply-To address
3435 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3436 if( is_null( $from ) ) {
3437 global $wgPasswordSender, $wgPasswordSenderName;
3438 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3440 $sender = new MailAddress( $from );
3443 $to = new MailAddress( $this );
3444 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3448 * Generate, store, and return a new e-mail confirmation code.
3449 * A hash (unsalted, since it's used as a key) is stored.
3451 * @note Call saveSettings() after calling this function to commit
3452 * this change to the database.
3454 * @param &$expiration \mixed Accepts the expiration time
3455 * @return String New token
3457 private function confirmationToken( &$expiration ) {
3458 global $wgUserEmailConfirmationTokenExpiry;
3460 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3461 $expiration = wfTimestamp( TS_MW
, $expires );
3463 $token = MWCryptRand
::generateHex( 32 );
3464 $hash = md5( $token );
3465 $this->mEmailToken
= $hash;
3466 $this->mEmailTokenExpires
= $expiration;
3471 * Return a URL the user can use to confirm their email address.
3472 * @param $token String Accepts the email confirmation token
3473 * @return String New token URL
3475 private function confirmationTokenUrl( $token ) {
3476 return $this->getTokenUrl( 'ConfirmEmail', $token );
3480 * Return a URL the user can use to invalidate their email address.
3481 * @param $token String Accepts the email confirmation token
3482 * @return String New token URL
3484 private function invalidationTokenUrl( $token ) {
3485 return $this->getTokenUrl( 'InvalidateEmail', $token );
3489 * Internal function to format the e-mail validation/invalidation URLs.
3490 * This uses a quickie hack to use the
3491 * hardcoded English names of the Special: pages, for ASCII safety.
3493 * @note Since these URLs get dropped directly into emails, using the
3494 * short English names avoids insanely long URL-encoded links, which
3495 * also sometimes can get corrupted in some browsers/mailers
3496 * (bug 6957 with Gmail and Internet Explorer).
3498 * @param $page String Special page
3499 * @param $token String Token
3500 * @return String Formatted URL
3502 protected function getTokenUrl( $page, $token ) {
3503 // Hack to bypass localization of 'Special:'
3504 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3505 return $title->getCanonicalUrl();
3509 * Mark the e-mail address confirmed.
3511 * @note Call saveSettings() after calling this function to commit the change.
3515 public function confirmEmail() {
3516 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3517 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3522 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3523 * address if it was already confirmed.
3525 * @note Call saveSettings() after calling this function to commit the change.
3526 * @return bool Returns true
3528 function invalidateEmail() {
3530 $this->mEmailToken
= null;
3531 $this->mEmailTokenExpires
= null;
3532 $this->setEmailAuthenticationTimestamp( null );
3533 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3538 * Set the e-mail authentication timestamp.
3539 * @param $timestamp String TS_MW timestamp
3541 function setEmailAuthenticationTimestamp( $timestamp ) {
3543 $this->mEmailAuthenticated
= $timestamp;
3544 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3548 * Is this user allowed to send e-mails within limits of current
3549 * site configuration?
3552 public function canSendEmail() {
3553 global $wgEnableEmail, $wgEnableUserEmail;
3554 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3557 $canSend = $this->isEmailConfirmed();
3558 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3563 * Is this user allowed to receive e-mails within limits of current
3564 * site configuration?
3567 public function canReceiveEmail() {
3568 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3572 * Is this user's e-mail address valid-looking and confirmed within
3573 * limits of the current site configuration?
3575 * @note If $wgEmailAuthentication is on, this may require the user to have
3576 * confirmed their address by returning a code or using a password
3577 * sent to the address from the wiki.
3581 public function isEmailConfirmed() {
3582 global $wgEmailAuthentication;
3585 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3586 if( $this->isAnon() ) {
3589 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3592 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3602 * Check whether there is an outstanding request for e-mail confirmation.
3605 public function isEmailConfirmationPending() {
3606 global $wgEmailAuthentication;
3607 return $wgEmailAuthentication &&
3608 !$this->isEmailConfirmed() &&
3609 $this->mEmailToken
&&
3610 $this->mEmailTokenExpires
> wfTimestamp();
3614 * Get the timestamp of account creation.
3616 * @return String|Bool Timestamp of account creation, or false for
3617 * non-existent/anonymous user accounts.
3619 public function getRegistration() {
3620 if ( $this->isAnon() ) {
3624 return $this->mRegistration
;
3628 * Get the timestamp of the first edit
3630 * @return String|Bool Timestamp of first edit, or false for
3631 * non-existent/anonymous user accounts.
3633 public function getFirstEditTimestamp() {
3634 if( $this->getId() == 0 ) {
3635 return false; // anons
3637 $dbr = wfGetDB( DB_SLAVE
);
3638 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3639 array( 'rev_user' => $this->getId() ),
3641 array( 'ORDER BY' => 'rev_timestamp ASC' )
3644 return false; // no edits
3646 return wfTimestamp( TS_MW
, $time );
3650 * Get the permissions associated with a given list of groups
3652 * @param $groups Array of Strings List of internal group names
3653 * @return Array of Strings List of permission key names for given groups combined
3655 public static function getGroupPermissions( $groups ) {
3656 global $wgGroupPermissions, $wgRevokePermissions;
3658 // grant every granted permission first
3659 foreach( $groups as $group ) {
3660 if( isset( $wgGroupPermissions[$group] ) ) {
3661 $rights = array_merge( $rights,
3662 // array_filter removes empty items
3663 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3666 // now revoke the revoked permissions
3667 foreach( $groups as $group ) {
3668 if( isset( $wgRevokePermissions[$group] ) ) {
3669 $rights = array_diff( $rights,
3670 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3673 return array_unique( $rights );
3677 * Get all the groups who have a given permission
3679 * @param $role String Role to check
3680 * @return Array of Strings List of internal group names with the given permission
3682 public static function getGroupsWithPermission( $role ) {
3683 global $wgGroupPermissions;
3684 $allowedGroups = array();
3685 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
3686 if ( self
::groupHasPermission( $group, $role ) ) {
3687 $allowedGroups[] = $group;
3690 return $allowedGroups;
3694 * Check, if the given group has the given permission
3696 * @param $group String Group to check
3697 * @param $role String Role to check
3700 public static function groupHasPermission( $group, $role ) {
3701 global $wgGroupPermissions, $wgRevokePermissions;
3702 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
3703 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
3707 * Get the localized descriptive name for a group, if it exists
3709 * @param $group String Internal group name
3710 * @return String Localized descriptive group name
3712 public static function getGroupName( $group ) {
3713 $msg = wfMessage( "group-$group" );
3714 return $msg->isBlank() ?
$group : $msg->text();
3718 * Get the localized descriptive name for a member of a group, if it exists
3720 * @param $group String Internal group name
3721 * @param $username String Username for gender (since 1.19)
3722 * @return String Localized name for group member
3724 public static function getGroupMember( $group, $username = '#' ) {
3725 $msg = wfMessage( "group-$group-member", $username );
3726 return $msg->isBlank() ?
$group : $msg->text();
3730 * Return the set of defined explicit groups.
3731 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3732 * are not included, as they are defined automatically, not in the database.
3733 * @return Array of internal group names
3735 public static function getAllGroups() {
3736 global $wgGroupPermissions, $wgRevokePermissions;
3738 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3739 self
::getImplicitGroups()
3744 * Get a list of all available permissions.
3745 * @return Array of permission names
3747 public static function getAllRights() {
3748 if ( self
::$mAllRights === false ) {
3749 global $wgAvailableRights;
3750 if ( count( $wgAvailableRights ) ) {
3751 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3753 self
::$mAllRights = self
::$mCoreRights;
3755 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3757 return self
::$mAllRights;
3761 * Get a list of implicit groups
3762 * @return Array of Strings Array of internal group names
3764 public static function getImplicitGroups() {
3765 global $wgImplicitGroups;
3766 $groups = $wgImplicitGroups;
3767 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3772 * Get the title of a page describing a particular group
3774 * @param $group String Internal group name
3775 * @return Title|Bool Title of the page if it exists, false otherwise
3777 public static function getGroupPage( $group ) {
3778 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3779 if( $msg->exists() ) {
3780 $title = Title
::newFromText( $msg->text() );
3781 if( is_object( $title ) )
3788 * Create a link to the group in HTML, if available;
3789 * else return the group name.
3791 * @param $group String Internal name of the group
3792 * @param $text String The text of the link
3793 * @return String HTML link to the group
3795 public static function makeGroupLinkHTML( $group, $text = '' ) {
3797 $text = self
::getGroupName( $group );
3799 $title = self
::getGroupPage( $group );
3801 return Linker
::link( $title, htmlspecialchars( $text ) );
3808 * Create a link to the group in Wikitext, if available;
3809 * else return the group name.
3811 * @param $group String Internal name of the group
3812 * @param $text String The text of the link
3813 * @return String Wikilink to the group
3815 public static function makeGroupLinkWiki( $group, $text = '' ) {
3817 $text = self
::getGroupName( $group );
3819 $title = self
::getGroupPage( $group );
3821 $page = $title->getPrefixedText();
3822 return "[[$page|$text]]";
3829 * Returns an array of the groups that a particular group can add/remove.
3831 * @param $group String: the group to check for whether it can add/remove
3832 * @return Array array( 'add' => array( addablegroups ),
3833 * 'remove' => array( removablegroups ),
3834 * 'add-self' => array( addablegroups to self),
3835 * 'remove-self' => array( removable groups from self) )
3837 public static function changeableByGroup( $group ) {
3838 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3840 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3841 if( empty( $wgAddGroups[$group] ) ) {
3842 // Don't add anything to $groups
3843 } elseif( $wgAddGroups[$group] === true ) {
3844 // You get everything
3845 $groups['add'] = self
::getAllGroups();
3846 } elseif( is_array( $wgAddGroups[$group] ) ) {
3847 $groups['add'] = $wgAddGroups[$group];
3850 // Same thing for remove
3851 if( empty( $wgRemoveGroups[$group] ) ) {
3852 } elseif( $wgRemoveGroups[$group] === true ) {
3853 $groups['remove'] = self
::getAllGroups();
3854 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3855 $groups['remove'] = $wgRemoveGroups[$group];
3858 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3859 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3860 foreach( $wgGroupsAddToSelf as $key => $value ) {
3861 if( is_int( $key ) ) {
3862 $wgGroupsAddToSelf['user'][] = $value;
3867 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3868 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3869 if( is_int( $key ) ) {
3870 $wgGroupsRemoveFromSelf['user'][] = $value;
3875 // Now figure out what groups the user can add to him/herself
3876 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3877 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3878 // No idea WHY this would be used, but it's there
3879 $groups['add-self'] = User
::getAllGroups();
3880 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3881 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3884 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3885 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3886 $groups['remove-self'] = User
::getAllGroups();
3887 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3888 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3895 * Returns an array of groups that this user can add and remove
3896 * @return Array array( 'add' => array( addablegroups ),
3897 * 'remove' => array( removablegroups ),
3898 * 'add-self' => array( addablegroups to self),
3899 * 'remove-self' => array( removable groups from self) )
3901 public function changeableGroups() {
3902 if( $this->isAllowed( 'userrights' ) ) {
3903 // This group gives the right to modify everything (reverse-
3904 // compatibility with old "userrights lets you change
3906 // Using array_merge to make the groups reindexed
3907 $all = array_merge( User
::getAllGroups() );
3911 'add-self' => array(),
3912 'remove-self' => array()
3916 // Okay, it's not so simple, we will have to go through the arrays
3919 'remove' => array(),
3920 'add-self' => array(),
3921 'remove-self' => array()
3923 $addergroups = $this->getEffectiveGroups();
3925 foreach( $addergroups as $addergroup ) {
3926 $groups = array_merge_recursive(
3927 $groups, $this->changeableByGroup( $addergroup )
3929 $groups['add'] = array_unique( $groups['add'] );
3930 $groups['remove'] = array_unique( $groups['remove'] );
3931 $groups['add-self'] = array_unique( $groups['add-self'] );
3932 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3938 * Increment the user's edit-count field.
3939 * Will have no effect for anonymous users.
3941 public function incEditCount() {
3942 if( !$this->isAnon() ) {
3943 $dbw = wfGetDB( DB_MASTER
);
3946 array( 'user_editcount=user_editcount+1' ),
3947 array( 'user_id' => $this->getId() ),
3951 // Lazy initialization check...
3952 if( $dbw->affectedRows() == 0 ) {
3953 // Now here's a goddamn hack...
3954 $dbr = wfGetDB( DB_SLAVE
);
3955 if( $dbr !== $dbw ) {
3956 // If we actually have a slave server, the count is
3957 // at least one behind because the current transaction
3958 // has not been committed and replicated.
3959 $this->initEditCount( 1 );
3961 // But if DB_SLAVE is selecting the master, then the
3962 // count we just read includes the revision that was
3963 // just added in the working transaction.
3964 $this->initEditCount();
3968 // edit count in user cache too
3969 $this->invalidateCache();
3973 * Initialize user_editcount from data out of the revision table
3975 * @param $add Integer Edits to add to the count from the revision table
3976 * @return Integer Number of edits
3978 protected function initEditCount( $add = 0 ) {
3979 // Pull from a slave to be less cruel to servers
3980 // Accuracy isn't the point anyway here
3981 $dbr = wfGetDB( DB_SLAVE
);
3982 $count = $dbr->selectField(
3985 array( 'rev_user' => $this->getId() ),
3988 $count = $count +
$add;
3990 $dbw = wfGetDB( DB_MASTER
);
3993 array( 'user_editcount' => $count ),
3994 array( 'user_id' => $this->getId() ),
4002 * Get the description of a given right
4004 * @param $right String Right to query
4005 * @return String Localized description of the right
4007 public static function getRightDescription( $right ) {
4008 $key = "right-$right";
4009 $msg = wfMessage( $key );
4010 return $msg->isBlank() ?
$right : $msg->text();
4014 * Make an old-style password hash
4016 * @param $password String Plain-text password
4017 * @param $userId String User ID
4018 * @return String Password hash
4020 public static function oldCrypt( $password, $userId ) {
4021 global $wgPasswordSalt;
4022 if ( $wgPasswordSalt ) {
4023 return md5( $userId . '-' . md5( $password ) );
4025 return md5( $password );
4030 * Make a new-style password hash
4032 * @param $password String Plain-text password
4033 * @param bool|string $salt Optional salt, may be random or the user ID.
4035 * If unspecified or false, will generate one automatically
4036 * @return String Password hash
4038 public static function crypt( $password, $salt = false ) {
4039 global $wgPasswordSalt;
4042 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
4046 if( $wgPasswordSalt ) {
4047 if ( $salt === false ) {
4048 $salt = MWCryptRand
::generateHex( 8 );
4050 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
4052 return ':A:' . md5( $password );
4057 * Compare a password hash with a plain-text password. Requires the user
4058 * ID if there's a chance that the hash is an old-style hash.
4060 * @param $hash String Password hash
4061 * @param $password String Plain-text password to compare
4062 * @param $userId String|bool User ID for old-style password salt
4066 public static function comparePasswords( $hash, $password, $userId = false ) {
4067 $type = substr( $hash, 0, 3 );
4070 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4074 if ( $type == ':A:' ) {
4076 return md5( $password ) === substr( $hash, 3 );
4077 } elseif ( $type == ':B:' ) {
4079 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4080 return md5( $salt.'-'.md5( $password ) ) === $realHash;
4083 return self
::oldCrypt( $password, $userId ) === $hash;
4088 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
4090 * @param $byEmail Boolean: account made by email?
4091 * @param $reason String: user supplied reason
4093 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4095 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
4096 global $wgUser, $wgContLang, $wgNewUserLog;
4097 if( empty( $wgNewUserLog ) ) {
4098 return true; // disabled
4101 if( $this->getName() == $wgUser->getName() ) {
4104 $action = 'create2';
4106 if ( $reason === '' ) {
4107 $reason = wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text();
4109 $reason = $wgContLang->commaList( array(
4110 $reason, wfMessage( 'newuserlog-byemail' )->inContentLanguage()->text() ) );
4114 $log = new LogPage( 'newusers' );
4115 return (int)$log->addEntry(
4117 $this->getUserPage(),
4119 array( $this->getId() )
4124 * Add an autocreate newuser log entry for this user
4125 * Used by things like CentralAuth and perhaps other authplugins.
4129 public function addNewUserLogEntryAutoCreate() {
4130 global $wgNewUserLog;
4131 if( !$wgNewUserLog ) {
4132 return true; // disabled
4134 $log = new LogPage( 'newusers', false );
4135 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4140 * Load the user options either from cache, the database or an array
4142 * @param $data Rows for the current user out of the user_properties table
4144 protected function loadOptions( $data = null ) {
4149 if ( $this->mOptionsLoaded
) {
4153 $this->mOptions
= self
::getDefaultOptions();
4155 if ( !$this->getId() ) {
4156 // For unlogged-in users, load language/variant options from request.
4157 // There's no need to do it for logged-in users: they can set preferences,
4158 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4159 // so don't override user's choice (especially when the user chooses site default).
4160 $variant = $wgContLang->getDefaultVariant();
4161 $this->mOptions
['variant'] = $variant;
4162 $this->mOptions
['language'] = $variant;
4163 $this->mOptionsLoaded
= true;
4167 // Maybe load from the object
4168 if ( !is_null( $this->mOptionOverrides
) ) {
4169 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4170 foreach( $this->mOptionOverrides
as $key => $value ) {
4171 $this->mOptions
[$key] = $value;
4174 if( !is_array( $data ) ) {
4175 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4176 // Load from database
4177 $dbr = wfGetDB( DB_SLAVE
);
4179 $res = $dbr->select(
4181 array( 'up_property', 'up_value' ),
4182 array( 'up_user' => $this->getId() ),
4186 $this->mOptionOverrides
= array();
4188 foreach ( $res as $row ) {
4189 $data[$row->up_property
] = $row->up_value
;
4192 foreach ( $data as $property => $value ) {
4193 $this->mOptionOverrides
[$property] = $value;
4194 $this->mOptions
[$property] = $value;
4198 $this->mOptionsLoaded
= true;
4200 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4206 protected function saveOptions() {
4207 global $wgAllowPrefChange;
4209 $this->loadOptions();
4211 // Not using getOptions(), to keep hidden preferences in database
4212 $saveOptions = $this->mOptions
;
4214 // Allow hooks to abort, for instance to save to a global profile.
4215 // Reset options to default state before saving.
4216 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4220 $extuser = ExternalUser
::newFromUser( $this );
4221 $userId = $this->getId();
4222 $insert_rows = array();
4223 foreach( $saveOptions as $key => $value ) {
4224 # Don't bother storing default values
4225 $defaultOption = self
::getDefaultOption( $key );
4226 if ( ( is_null( $defaultOption ) &&
4227 !( $value === false ||
is_null( $value ) ) ) ||
4228 $value != $defaultOption ) {
4229 $insert_rows[] = array(
4230 'up_user' => $userId,
4231 'up_property' => $key,
4232 'up_value' => $value,
4235 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4236 switch ( $wgAllowPrefChange[$key] ) {
4242 $extuser->setPref( $key, $value );
4247 $dbw = wfGetDB( DB_MASTER
);
4248 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4249 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4253 * Provide an array of HTML5 attributes to put on an input element
4254 * intended for the user to enter a new password. This may include
4255 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4257 * Do *not* use this when asking the user to enter his current password!
4258 * Regardless of configuration, users may have invalid passwords for whatever
4259 * reason (e.g., they were set before requirements were tightened up).
4260 * Only use it when asking for a new password, like on account creation or
4263 * Obviously, you still need to do server-side checking.
4265 * NOTE: A combination of bugs in various browsers means that this function
4266 * actually just returns array() unconditionally at the moment. May as
4267 * well keep it around for when the browser bugs get fixed, though.
4269 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4271 * @return array Array of HTML attributes suitable for feeding to
4272 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4273 * That will potentially output invalid XHTML 1.0 Transitional, and will
4274 * get confused by the boolean attribute syntax used.)
4276 public static function passwordChangeInputAttribs() {
4277 global $wgMinimalPasswordLength;
4279 if ( $wgMinimalPasswordLength == 0 ) {
4283 # Note that the pattern requirement will always be satisfied if the
4284 # input is empty, so we need required in all cases.
4286 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4287 # if e-mail confirmation is being used. Since HTML5 input validation
4288 # is b0rked anyway in some browsers, just return nothing. When it's
4289 # re-enabled, fix this code to not output required for e-mail
4291 #$ret = array( 'required' );
4294 # We can't actually do this right now, because Opera 9.6 will print out
4295 # the entered password visibly in its error message! When other
4296 # browsers add support for this attribute, or Opera fixes its support,
4297 # we can add support with a version check to avoid doing this on Opera
4298 # versions where it will be a problem. Reported to Opera as
4299 # DSK-262266, but they don't have a public bug tracker for us to follow.
4301 if ( $wgMinimalPasswordLength > 1 ) {
4302 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4303 $ret['title'] = wfMessage( 'passwordtooshort' )
4304 ->numParams( $wgMinimalPasswordLength )->text();
4312 * Return the list of user fields that should be selected to create
4313 * a new user object.
4316 public static function selectFields() {
4323 'user_newpass_time',
4327 'user_email_authenticated',
4329 'user_email_token_expires',
4330 'user_registration',