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(
126 'editusercssjs', #deprecated
138 'move-rootuserpages',
142 'override-export-depth',
162 'userrights-interwiki',
166 * String Cached results of getAllRights()
168 static $mAllRights = false;
170 /** @name Cache variables */
172 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
173 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
174 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
175 $mGroups, $mOptionOverrides;
179 * Bool Whether the cache variables have been loaded.
185 * Array with already loaded items or true if all items have been loaded.
187 private $mLoadedItems = array();
191 * String Initialization data source if mLoadedItems!==true. May be one of:
192 * - 'defaults' anonymous user initialised from class defaults
193 * - 'name' initialise from mName
194 * - 'id' initialise from mId
195 * - 'session' log in from cookies or session if possible
197 * Use the User::newFrom*() family of functions to set this.
202 * Lazy-initialized variables, invalidated with clearInstanceCache
204 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
205 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
206 $mLocked, $mHideName, $mOptions;
226 private $mBlockedFromCreateAccount = false;
231 private $mWatchedItems = array();
233 static $idCacheByName = array();
236 * Lightweight constructor for an anonymous user.
237 * Use the User::newFrom* factory functions for other kinds of users.
241 * @see newFromConfirmationCode()
242 * @see newFromSession()
245 function __construct() {
246 $this->clearInstanceCache( 'defaults' );
252 function __toString(){
253 return $this->getName();
257 * Load the user table data for this object from the source given by mFrom.
259 public function load() {
260 if ( $this->mLoadedItems
=== true ) {
263 wfProfileIn( __METHOD__
);
265 # Set it now to avoid infinite recursion in accessors
266 $this->mLoadedItems
= true;
268 switch ( $this->mFrom
) {
270 $this->loadDefaults();
273 $this->mId
= self
::idFromName( $this->mName
);
275 # Nonexistent user placeholder object
276 $this->loadDefaults( $this->mName
);
285 $this->loadFromSession();
286 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
289 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
291 wfProfileOut( __METHOD__
);
295 * Load user table data, given mId has already been set.
296 * @return Bool false if the ID does not exist, true otherwise
298 public function loadFromId() {
300 if ( $this->mId
== 0 ) {
301 $this->loadDefaults();
306 $key = wfMemcKey( 'user', 'id', $this->mId
);
307 $data = $wgMemc->get( $key );
308 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
309 # Object is expired, load from DB
314 wfDebug( "User: cache miss for user {$this->mId}\n" );
316 if ( !$this->loadFromDatabase() ) {
317 # Can't load from ID, user is anonymous
320 $this->saveToCache();
322 wfDebug( "User: got user {$this->mId} from cache\n" );
324 foreach ( self
::$mCacheVars as $name ) {
325 $this->$name = $data[$name];
332 * Save user data to the shared cache
334 public function saveToCache() {
337 $this->loadOptions();
338 if ( $this->isAnon() ) {
339 // Anonymous users are uncached
343 foreach ( self
::$mCacheVars as $name ) {
344 $data[$name] = $this->$name;
346 $data['mVersion'] = MW_USER_VERSION
;
347 $key = wfMemcKey( 'user', 'id', $this->mId
);
349 $wgMemc->set( $key, $data );
352 /** @name newFrom*() static factory methods */
356 * Static factory method for creation from username.
358 * This is slightly less efficient than newFromId(), so use newFromId() if
359 * you have both an ID and a name handy.
361 * @param $name String Username, validated by Title::newFromText()
362 * @param $validate String|Bool Validate username. Takes the same parameters as
363 * User::getCanonicalName(), except that true is accepted as an alias
364 * for 'valid', for BC.
366 * @return User object, or false if the username is invalid
367 * (e.g. if it contains illegal characters or is an IP address). If the
368 * username is not present in the database, the result will be a user object
369 * with a name, zero user ID and default settings.
371 public static function newFromName( $name, $validate = 'valid' ) {
372 if ( $validate === true ) {
375 $name = self
::getCanonicalName( $name, $validate );
376 if ( $name === false ) {
379 # Create unloaded user object
383 $u->setItemLoaded( 'name' );
389 * Static factory method for creation from a given user ID.
391 * @param $id Int Valid user ID
392 * @return User The corresponding User object
394 public static function newFromId( $id ) {
398 $u->setItemLoaded( 'id' );
403 * Factory method to fetch whichever user has a given email confirmation code.
404 * This code is generated when an account is created or its e-mail address
407 * If the code is invalid or has expired, returns NULL.
409 * @param $code String Confirmation code
410 * @return User object, or null
412 public static function newFromConfirmationCode( $code ) {
413 $dbr = wfGetDB( DB_SLAVE
);
414 $id = $dbr->selectField( 'user', 'user_id', array(
415 'user_email_token' => md5( $code ),
416 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
418 if( $id !== false ) {
419 return User
::newFromId( $id );
426 * Create a new user object using data from session or cookies. If the
427 * login credentials are invalid, the result is an anonymous user.
429 * @param $request WebRequest object to use; $wgRequest will be used if
431 * @return User object
433 public static function newFromSession( WebRequest
$request = null ) {
435 $user->mFrom
= 'session';
436 $user->mRequest
= $request;
441 * Create a new user object from a user row.
442 * The row should have the following fields from the user table in it:
443 * - either user_name or user_id to load further data if needed (or both)
445 * - all other fields (email, password, etc.)
446 * It is useless to provide the remaining fields if either user_id,
447 * user_name and user_real_name are not provided because the whole row
448 * will be loaded once more from the database when accessing them.
450 * @param $row Array A row from the user table
453 public static function newFromRow( $row ) {
455 $user->loadFromRow( $row );
462 * Get the username corresponding to a given user ID
463 * @param $id Int User ID
464 * @return String|bool The corresponding username
466 public static function whoIs( $id ) {
467 $dbr = wfGetDB( DB_SLAVE
);
468 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
472 * Get the real name of a user given their user ID
474 * @param $id Int User ID
475 * @return String|bool The corresponding user's real name
477 public static function whoIsReal( $id ) {
478 $dbr = wfGetDB( DB_SLAVE
);
479 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
483 * Get database id given a user name
484 * @param $name String Username
485 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
487 public static function idFromName( $name ) {
488 $nt = Title
::makeTitleSafe( NS_USER
, $name );
489 if( is_null( $nt ) ) {
494 if ( isset( self
::$idCacheByName[$name] ) ) {
495 return self
::$idCacheByName[$name];
498 $dbr = wfGetDB( DB_SLAVE
);
499 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
501 if ( $s === false ) {
504 $result = $s->user_id
;
507 self
::$idCacheByName[$name] = $result;
509 if ( count( self
::$idCacheByName ) > 1000 ) {
510 self
::$idCacheByName = array();
517 * Reset the cache used in idFromName(). For use in tests.
519 public static function resetIdByNameCache() {
520 self
::$idCacheByName = array();
524 * Does the string match an anonymous IPv4 address?
526 * This function exists for username validation, in order to reject
527 * usernames which are similar in form to IP addresses. Strings such
528 * as 300.300.300.300 will return true because it looks like an IP
529 * address, despite not being strictly valid.
531 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
532 * address because the usemod software would "cloak" anonymous IP
533 * addresses like this, if we allowed accounts like this to be created
534 * new users could get the old edits of these anonymous users.
536 * @param $name String to match
539 public static function isIP( $name ) {
540 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
544 * Is the input a valid username?
546 * Checks if the input is a valid username, we don't want an empty string,
547 * an IP address, anything that containins slashes (would mess up subpages),
548 * is longer than the maximum allowed username size or doesn't begin with
551 * @param $name String to match
554 public static function isValidUserName( $name ) {
555 global $wgContLang, $wgMaxNameChars;
558 || User
::isIP( $name )
559 ||
strpos( $name, '/' ) !== false
560 ||
strlen( $name ) > $wgMaxNameChars
561 ||
$name != $wgContLang->ucfirst( $name ) ) {
562 wfDebugLog( 'username', __METHOD__
.
563 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
568 // Ensure that the name can't be misresolved as a different title,
569 // such as with extra namespace keys at the start.
570 $parsed = Title
::newFromText( $name );
571 if( is_null( $parsed )
572 ||
$parsed->getNamespace()
573 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
574 wfDebugLog( 'username', __METHOD__
.
575 ": '$name' invalid due to ambiguous prefixes" );
579 // Check an additional blacklist of troublemaker characters.
580 // Should these be merged into the title char list?
581 $unicodeBlacklist = '/[' .
582 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
583 '\x{00a0}' . # non-breaking space
584 '\x{2000}-\x{200f}' . # various whitespace
585 '\x{2028}-\x{202f}' . # breaks and control chars
586 '\x{3000}' . # ideographic space
587 '\x{e000}-\x{f8ff}' . # private use
589 if( preg_match( $unicodeBlacklist, $name ) ) {
590 wfDebugLog( 'username', __METHOD__
.
591 ": '$name' invalid due to blacklisted characters" );
599 * Usernames which fail to pass this function will be blocked
600 * from user login and new account registrations, but may be used
601 * internally by batch processes.
603 * If an account already exists in this form, login will be blocked
604 * by a failure to pass this function.
606 * @param $name String to match
609 public static function isUsableName( $name ) {
610 global $wgReservedUsernames;
611 // Must be a valid username, obviously ;)
612 if ( !self
::isValidUserName( $name ) ) {
616 static $reservedUsernames = false;
617 if ( !$reservedUsernames ) {
618 $reservedUsernames = $wgReservedUsernames;
619 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
622 // Certain names may be reserved for batch processes.
623 foreach ( $reservedUsernames as $reserved ) {
624 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
625 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
627 if ( $reserved == $name ) {
635 * Usernames which fail to pass this function will be blocked
636 * from new account registrations, but may be used internally
637 * either by batch processes or by user accounts which have
638 * already been created.
640 * Additional blacklisting may be added here rather than in
641 * isValidUserName() to avoid disrupting existing accounts.
643 * @param $name String to match
646 public static function isCreatableName( $name ) {
647 global $wgInvalidUsernameCharacters;
649 // Ensure that the username isn't longer than 235 bytes, so that
650 // (at least for the builtin skins) user javascript and css files
651 // will work. (bug 23080)
652 if( strlen( $name ) > 235 ) {
653 wfDebugLog( 'username', __METHOD__
.
654 ": '$name' invalid due to length" );
658 // Preg yells if you try to give it an empty string
659 if( $wgInvalidUsernameCharacters !== '' ) {
660 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
661 wfDebugLog( 'username', __METHOD__
.
662 ": '$name' invalid due to wgInvalidUsernameCharacters" );
667 return self
::isUsableName( $name );
671 * Is the input a valid password for this user?
673 * @param $password String Desired password
676 public function isValidPassword( $password ) {
677 //simple boolean wrapper for getPasswordValidity
678 return $this->getPasswordValidity( $password ) === true;
682 * Given unvalidated password input, return error message on failure.
684 * @param $password String Desired password
685 * @return mixed: true on success, string or array of error message on failure
687 public function getPasswordValidity( $password ) {
688 global $wgMinimalPasswordLength, $wgContLang;
690 static $blockedLogins = array(
691 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
692 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
695 $result = false; //init $result to false for the internal checks
697 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
700 if ( $result === false ) {
701 if( strlen( $password ) < $wgMinimalPasswordLength ) {
702 return 'passwordtooshort';
703 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
704 return 'password-name-match';
705 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
706 return 'password-login-forbidden';
708 //it seems weird returning true here, but this is because of the
709 //initialization of $result to false above. If the hook is never run or it
710 //doesn't modify $result, then we will likely get down into this if with
714 } elseif( $result === true ) {
717 return $result; //the isValidPassword hook set a string $result and returned true
722 * Does a string look like an e-mail address?
724 * This validates an email address using an HTML5 specification found at:
725 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
726 * Which as of 2011-01-24 says:
728 * A valid e-mail address is a string that matches the ABNF production
729 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
730 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
733 * This function is an implementation of the specification as requested in
736 * Client-side forms will use the same standard validation rules via JS or
737 * HTML 5 validation; additional restrictions can be enforced server-side
738 * by extensions via the 'isValidEmailAddr' hook.
740 * Note that this validation doesn't 100% match RFC 2822, but is believed
741 * to be liberal enough for wide use. Some invalid addresses will still
742 * pass validation here.
744 * @param $addr String E-mail address
746 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
748 public static function isValidEmailAddr( $addr ) {
749 wfDeprecated( __METHOD__
, '1.18' );
750 return Sanitizer
::validateEmail( $addr );
754 * Given unvalidated user input, return a canonical username, or false if
755 * the username is invalid.
756 * @param $name String User input
757 * @param $validate String|Bool type of validation to use:
758 * - false No validation
759 * - 'valid' Valid for batch processes
760 * - 'usable' Valid for batch processes and login
761 * - 'creatable' Valid for batch processes, login and account creation
763 * @return bool|string
765 public static function getCanonicalName( $name, $validate = 'valid' ) {
766 # Force usernames to capital
768 $name = $wgContLang->ucfirst( $name );
770 # Reject names containing '#'; these will be cleaned up
771 # with title normalisation, but then it's too late to
773 if( strpos( $name, '#' ) !== false )
776 # Clean up name according to title rules
777 $t = ( $validate === 'valid' ) ?
778 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
779 # Check for invalid titles
780 if( is_null( $t ) ) {
784 # Reject various classes of invalid names
786 $name = $wgAuth->getCanonicalName( $t->getText() );
788 switch ( $validate ) {
792 if ( !User
::isValidUserName( $name ) ) {
797 if ( !User
::isUsableName( $name ) ) {
802 if ( !User
::isCreatableName( $name ) ) {
807 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
813 * Count the number of edits of a user
814 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
816 * @param $uid Int User ID to check
817 * @return Int the user's edit count
819 public static function edits( $uid ) {
820 wfProfileIn( __METHOD__
);
821 $dbr = wfGetDB( DB_SLAVE
);
822 // check if the user_editcount field has been initialized
823 $field = $dbr->selectField(
824 'user', 'user_editcount',
825 array( 'user_id' => $uid ),
829 if( $field === null ) { // it has not been initialized. do so.
830 $dbw = wfGetDB( DB_MASTER
);
831 $count = $dbr->selectField(
832 'revision', 'count(*)',
833 array( 'rev_user' => $uid ),
838 array( 'user_editcount' => $count ),
839 array( 'user_id' => $uid ),
845 wfProfileOut( __METHOD__
);
850 * Return a random password.
852 * @return String new random password
854 public static function randomPassword() {
855 global $wgMinimalPasswordLength;
856 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
857 $length = max( 10, $wgMinimalPasswordLength );
858 // Multiply by 1.25 to get the number of hex characters we need
859 $length = $length * 1.25;
860 // Generate random hex chars
861 $hex = MWCryptRand
::generateHex( $length );
862 // Convert from base 16 to base 32 to get a proper password like string
863 return wfBaseConvert( $hex, 16, 32 );
867 * Set cached properties to default.
869 * @note This no longer clears uncached lazy-initialised properties;
870 * the constructor does that instead.
872 * @param $name string
874 public function loadDefaults( $name = false ) {
875 wfProfileIn( __METHOD__
);
878 $this->mName
= $name;
879 $this->mRealName
= '';
880 $this->mPassword
= $this->mNewpassword
= '';
881 $this->mNewpassTime
= null;
883 $this->mOptionOverrides
= null;
884 $this->mOptionsLoaded
= false;
886 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
887 if( $loggedOut !== null ) {
888 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
890 $this->mTouched
= '0'; # Allow any pages to be cached
893 $this->mToken
= null; // Don't run cryptographic functions till we need a token
894 $this->mEmailAuthenticated
= null;
895 $this->mEmailToken
= '';
896 $this->mEmailTokenExpires
= null;
897 $this->mRegistration
= wfTimestamp( TS_MW
);
898 $this->mGroups
= array();
900 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
902 wfProfileOut( __METHOD__
);
906 * Return whether an item has been loaded.
908 * @param $item String: item to check. Current possibilities:
912 * @param $all String: 'all' to check if the whole object has been loaded
913 * or any other string to check if only the item is available (e.g.
917 public function isItemLoaded( $item, $all = 'all' ) {
918 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
919 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
923 * Set that an item has been loaded
925 * @param $item String
927 private function setItemLoaded( $item ) {
928 if ( is_array( $this->mLoadedItems
) ) {
929 $this->mLoadedItems
[$item] = true;
934 * Load user data from the session or login cookie. If there are no valid
935 * credentials, initialises the user as an anonymous user.
936 * @return Bool True if the user is logged in, false otherwise.
938 private function loadFromSession() {
939 global $wgExternalAuthType, $wgAutocreatePolicy;
942 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
943 if ( $result !== null ) {
947 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
948 $extUser = ExternalUser
::newFromCookie();
950 # TODO: Automatically create the user here (or probably a bit
951 # lower down, in fact)
955 $request = $this->getRequest();
957 $cookieId = $request->getCookie( 'UserID' );
958 $sessId = $request->getSessionData( 'wsUserID' );
960 if ( $cookieId !== null ) {
961 $sId = intval( $cookieId );
962 if( $sessId !== null && $cookieId != $sessId ) {
963 $this->loadDefaults(); // Possible collision!
964 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
965 cookie user ID ($sId) don't match!" );
968 $request->setSessionData( 'wsUserID', $sId );
969 } elseif ( $sessId !== null && $sessId != 0 ) {
972 $this->loadDefaults();
976 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
977 $sName = $request->getSessionData( 'wsUserName' );
978 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
979 $sName = $request->getCookie( 'UserName' );
980 $request->setSessionData( 'wsUserName', $sName );
982 $this->loadDefaults();
986 $proposedUser = User
::newFromId( $sId );
987 if ( !$proposedUser->isLoggedIn() ) {
989 $this->loadDefaults();
993 global $wgBlockDisablesLogin;
994 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
995 # User blocked and we've disabled blocked user logins
996 $this->loadDefaults();
1000 if ( $request->getSessionData( 'wsToken' ) ) {
1001 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
1003 } elseif ( $request->getCookie( 'Token' ) ) {
1004 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
1007 # No session or persistent login cookie
1008 $this->loadDefaults();
1012 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1013 $this->loadFromUserObject( $proposedUser );
1014 $request->setSessionData( 'wsToken', $this->mToken
);
1015 wfDebug( "User: logged in from $from\n" );
1018 # Invalid credentials
1019 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1020 $this->loadDefaults();
1026 * Load user and user_group data from the database.
1027 * $this->mId must be set, this is how the user is identified.
1029 * @return Bool True if the user exists, false if the user is anonymous
1031 public function loadFromDatabase() {
1033 $this->mId
= intval( $this->mId
);
1035 /** Anonymous user */
1037 $this->loadDefaults();
1041 $dbr = wfGetDB( DB_MASTER
);
1042 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1044 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1046 if ( $s !== false ) {
1047 # Initialise user table data
1048 $this->loadFromRow( $s );
1049 $this->mGroups
= null; // deferred
1050 $this->getEditCount(); // revalidation for nulls
1055 $this->loadDefaults();
1061 * Initialize this object from a row from the user table.
1063 * @param $row Array Row from the user table to load.
1065 public function loadFromRow( $row ) {
1068 $this->mGroups
= null; // deferred
1070 if ( isset( $row->user_name
) ) {
1071 $this->mName
= $row->user_name
;
1072 $this->mFrom
= 'name';
1073 $this->setItemLoaded( 'name' );
1078 if ( isset( $row->user_real_name
) ) {
1079 $this->mRealName
= $row->user_real_name
;
1080 $this->setItemLoaded( 'realname' );
1085 if ( isset( $row->user_id
) ) {
1086 $this->mId
= intval( $row->user_id
);
1087 $this->mFrom
= 'id';
1088 $this->setItemLoaded( 'id' );
1093 if ( isset( $row->user_editcount
) ) {
1094 $this->mEditCount
= $row->user_editcount
;
1099 if ( isset( $row->user_password
) ) {
1100 $this->mPassword
= $row->user_password
;
1101 $this->mNewpassword
= $row->user_newpassword
;
1102 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1103 $this->mEmail
= $row->user_email
;
1104 if ( isset( $row->user_options
) ) {
1105 $this->decodeOptions( $row->user_options
);
1107 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1108 $this->mToken
= $row->user_token
;
1109 if ( $this->mToken
== '' ) {
1110 $this->mToken
= null;
1112 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1113 $this->mEmailToken
= $row->user_email_token
;
1114 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1115 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1121 $this->mLoadedItems
= true;
1126 * Load the data for this user object from another user object.
1130 protected function loadFromUserObject( $user ) {
1132 $user->loadGroups();
1133 $user->loadOptions();
1134 foreach ( self
::$mCacheVars as $var ) {
1135 $this->$var = $user->$var;
1140 * Load the groups from the database if they aren't already loaded.
1142 private function loadGroups() {
1143 if ( is_null( $this->mGroups
) ) {
1144 $dbr = wfGetDB( DB_MASTER
);
1145 $res = $dbr->select( 'user_groups',
1146 array( 'ug_group' ),
1147 array( 'ug_user' => $this->mId
),
1149 $this->mGroups
= array();
1150 foreach ( $res as $row ) {
1151 $this->mGroups
[] = $row->ug_group
;
1157 * Add the user to the group if he/she meets given criteria.
1159 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1160 * possible to remove manually via Special:UserRights. In such case it
1161 * will not be re-added automatically. The user will also not lose the
1162 * group if they no longer meet the criteria.
1164 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1166 * @return array Array of groups the user has been promoted to.
1168 * @see $wgAutopromoteOnce
1170 public function addAutopromoteOnceGroups( $event ) {
1171 global $wgAutopromoteOnceLogInRC;
1173 $toPromote = array();
1174 if ( $this->getId() ) {
1175 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1176 if ( count( $toPromote ) ) {
1177 $oldGroups = $this->getGroups(); // previous groups
1178 foreach ( $toPromote as $group ) {
1179 $this->addGroup( $group );
1181 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1183 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1184 $log->addEntry( 'autopromote',
1185 $this->getUserPage(),
1187 // These group names are "list to texted"-ed in class LogPage.
1188 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1196 * Clear various cached data stored in this object.
1197 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1198 * given source. May be "name", "id", "defaults", "session", or false for
1201 public function clearInstanceCache( $reloadFrom = false ) {
1202 $this->mNewtalk
= -1;
1203 $this->mDatePreference
= null;
1204 $this->mBlockedby
= -1; # Unset
1205 $this->mHash
= false;
1206 $this->mRights
= null;
1207 $this->mEffectiveGroups
= null;
1208 $this->mImplicitGroups
= null;
1209 $this->mOptions
= null;
1211 if ( $reloadFrom ) {
1212 $this->mLoadedItems
= array();
1213 $this->mFrom
= $reloadFrom;
1218 * Combine the language default options with any site-specific options
1219 * and add the default language variants.
1221 * @return Array of String options
1223 public static function getDefaultOptions() {
1224 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1226 $defOpt = $wgDefaultUserOptions;
1227 # default language setting
1228 $variant = $wgContLang->getDefaultVariant();
1229 $defOpt['variant'] = $variant;
1230 $defOpt['language'] = $variant;
1231 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1232 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1234 $defOpt['skin'] = $wgDefaultSkin;
1236 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1237 // but that breaks the parser tests because they rely on being able to change $wgContLang
1238 // mid-request and see that change reflected in the return value of this function.
1239 // Which is insane and would never happen during normal MW operation, but is also not
1240 // likely to get fixed unless and until we context-ify everything.
1241 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1242 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1248 * Get a given default option value.
1250 * @param $opt String Name of option to retrieve
1251 * @return String Default option value
1253 public static function getDefaultOption( $opt ) {
1254 $defOpts = self
::getDefaultOptions();
1255 if( isset( $defOpts[$opt] ) ) {
1256 return $defOpts[$opt];
1264 * Get blocking information
1265 * @param $bFromSlave Bool Whether to check the slave database first. To
1266 * improve performance, non-critical checks are done
1267 * against slaves. Check when actually saving should be
1268 * done against master.
1270 private function getBlockedStatus( $bFromSlave = true ) {
1271 global $wgProxyWhitelist, $wgUser;
1273 if ( -1 != $this->mBlockedby
) {
1277 wfProfileIn( __METHOD__
);
1278 wfDebug( __METHOD__
.": checking...\n" );
1280 // Initialize data...
1281 // Otherwise something ends up stomping on $this->mBlockedby when
1282 // things get lazy-loaded later, causing false positive block hits
1283 // due to -1 !== 0. Probably session-related... Nothing should be
1284 // overwriting mBlockedby, surely?
1287 # We only need to worry about passing the IP address to the Block generator if the
1288 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1289 # know which IP address they're actually coming from
1290 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1291 $ip = $this->getRequest()->getIP();
1297 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1300 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1301 && !in_array( $ip, $wgProxyWhitelist ) )
1304 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1306 $block->setBlocker( wfMsg( 'proxyblocker' ) );
1307 $block->mReason
= wfMsg( 'proxyblockreason' );
1308 $block->setTarget( $ip );
1309 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1311 $block->setBlocker( wfMsg( 'sorbs' ) );
1312 $block->mReason
= wfMsg( 'sorbsreason' );
1313 $block->setTarget( $ip );
1317 if ( $block instanceof Block
) {
1318 wfDebug( __METHOD__
. ": Found block.\n" );
1319 $this->mBlock
= $block;
1320 $this->mBlockedby
= $block->getByName();
1321 $this->mBlockreason
= $block->mReason
;
1322 $this->mHideName
= $block->mHideName
;
1323 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1325 $this->mBlockedby
= '';
1326 $this->mHideName
= 0;
1327 $this->mAllowUsertalk
= false;
1331 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1333 wfProfileOut( __METHOD__
);
1337 * Whether the given IP is in a DNS blacklist.
1339 * @param $ip String IP to check
1340 * @param $checkWhitelist Bool: whether to check the whitelist first
1341 * @return Bool True if blacklisted.
1343 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1344 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1345 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1347 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1350 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1353 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1354 return $this->inDnsBlacklist( $ip, $urls );
1358 * Whether the given IP is in a given DNS blacklist.
1360 * @param $ip String IP to check
1361 * @param $bases String|Array of Strings: URL of the DNS blacklist
1362 * @return Bool True if blacklisted.
1364 public function inDnsBlacklist( $ip, $bases ) {
1365 wfProfileIn( __METHOD__
);
1368 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1369 if( IP
::isIPv4( $ip ) ) {
1370 # Reverse IP, bug 21255
1371 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1373 foreach( (array)$bases as $base ) {
1375 # If we have an access key, use that too (ProjectHoneypot, etc.)
1376 if( is_array( $base ) ) {
1377 if( count( $base ) >= 2 ) {
1378 # Access key is 1, base URL is 0
1379 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1381 $host = "$ipReversed.{$base[0]}";
1384 $host = "$ipReversed.$base";
1388 $ipList = gethostbynamel( $host );
1391 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1395 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1400 wfProfileOut( __METHOD__
);
1405 * Check if an IP address is in the local proxy list
1411 public static function isLocallyBlockedProxy( $ip ) {
1412 global $wgProxyList;
1414 if ( !$wgProxyList ) {
1417 wfProfileIn( __METHOD__
);
1419 if ( !is_array( $wgProxyList ) ) {
1420 # Load from the specified file
1421 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1424 if ( !is_array( $wgProxyList ) ) {
1426 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1428 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1429 # Old-style flipped proxy list
1434 wfProfileOut( __METHOD__
);
1439 * Is this user subject to rate limiting?
1441 * @return Bool True if rate limited
1443 public function isPingLimitable() {
1444 global $wgRateLimitsExcludedIPs;
1445 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1446 // No other good way currently to disable rate limits
1447 // for specific IPs. :P
1448 // But this is a crappy hack and should die.
1451 return !$this->isAllowed('noratelimit');
1455 * Primitive rate limits: enforce maximum actions per time period
1456 * to put a brake on flooding.
1458 * @note When using a shared cache like memcached, IP-address
1459 * last-hit counters will be shared across wikis.
1461 * @param $action String Action to enforce; 'edit' if unspecified
1462 * @return Bool True if a rate limiter was tripped
1464 public function pingLimiter( $action = 'edit' ) {
1465 # Call the 'PingLimiter' hook
1467 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1471 global $wgRateLimits;
1472 if( !isset( $wgRateLimits[$action] ) ) {
1476 # Some groups shouldn't trigger the ping limiter, ever
1477 if( !$this->isPingLimitable() )
1480 global $wgMemc, $wgRateLimitLog;
1481 wfProfileIn( __METHOD__
);
1483 $limits = $wgRateLimits[$action];
1485 $id = $this->getId();
1486 $ip = $this->getRequest()->getIP();
1489 if( isset( $limits['anon'] ) && $id == 0 ) {
1490 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1493 if( isset( $limits['user'] ) && $id != 0 ) {
1494 $userLimit = $limits['user'];
1496 if( $this->isNewbie() ) {
1497 if( isset( $limits['newbie'] ) && $id != 0 ) {
1498 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1500 if( isset( $limits['ip'] ) ) {
1501 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1504 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1505 $subnet = $matches[1];
1506 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1509 // Check for group-specific permissions
1510 // If more than one group applies, use the group with the highest limit
1511 foreach ( $this->getGroups() as $group ) {
1512 if ( isset( $limits[$group] ) ) {
1513 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1514 $userLimit = $limits[$group];
1518 // Set the user limit key
1519 if ( $userLimit !== false ) {
1520 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1521 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1525 foreach( $keys as $key => $limit ) {
1526 list( $max, $period ) = $limit;
1527 $summary = "(limit $max in {$period}s)";
1528 $count = $wgMemc->get( $key );
1531 if( $count >= $max ) {
1532 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1533 if( $wgRateLimitLog ) {
1534 wfSuppressWarnings();
1535 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1536 wfRestoreWarnings();
1540 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1543 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1544 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1546 $wgMemc->incr( $key );
1549 wfProfileOut( __METHOD__
);
1554 * Check if user is blocked
1556 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1557 * @return Bool True if blocked, false otherwise
1559 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1560 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1564 * Get the block affecting the user, or null if the user is not blocked
1566 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1567 * @return Block|null
1569 public function getBlock( $bFromSlave = true ){
1570 $this->getBlockedStatus( $bFromSlave );
1571 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1575 * Check if user is blocked from editing a particular article
1577 * @param $title Title to check
1578 * @param $bFromSlave Bool whether to check the slave database instead of the master
1581 function isBlockedFrom( $title, $bFromSlave = false ) {
1582 global $wgBlockAllowsUTEdit;
1583 wfProfileIn( __METHOD__
);
1585 $blocked = $this->isBlocked( $bFromSlave );
1586 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1587 # If a user's name is suppressed, they cannot make edits anywhere
1588 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1589 $title->getNamespace() == NS_USER_TALK
) {
1591 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1594 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1596 wfProfileOut( __METHOD__
);
1601 * If user is blocked, return the name of the user who placed the block
1602 * @return String name of blocker
1604 public function blockedBy() {
1605 $this->getBlockedStatus();
1606 return $this->mBlockedby
;
1610 * If user is blocked, return the specified reason for the block
1611 * @return String Blocking reason
1613 public function blockedFor() {
1614 $this->getBlockedStatus();
1615 return $this->mBlockreason
;
1619 * If user is blocked, return the ID for the block
1620 * @return Int Block ID
1622 public function getBlockId() {
1623 $this->getBlockedStatus();
1624 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1628 * Check if user is blocked on all wikis.
1629 * Do not use for actual edit permission checks!
1630 * This is intented for quick UI checks.
1632 * @param $ip String IP address, uses current client if none given
1633 * @return Bool True if blocked, false otherwise
1635 public function isBlockedGlobally( $ip = '' ) {
1636 if( $this->mBlockedGlobally
!== null ) {
1637 return $this->mBlockedGlobally
;
1639 // User is already an IP?
1640 if( IP
::isIPAddress( $this->getName() ) ) {
1641 $ip = $this->getName();
1643 $ip = $this->getRequest()->getIP();
1646 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1647 $this->mBlockedGlobally
= (bool)$blocked;
1648 return $this->mBlockedGlobally
;
1652 * Check if user account is locked
1654 * @return Bool True if locked, false otherwise
1656 public function isLocked() {
1657 if( $this->mLocked
!== null ) {
1658 return $this->mLocked
;
1661 $authUser = $wgAuth->getUserInstance( $this );
1662 $this->mLocked
= (bool)$authUser->isLocked();
1663 return $this->mLocked
;
1667 * Check if user account is hidden
1669 * @return Bool True if hidden, false otherwise
1671 public function isHidden() {
1672 if( $this->mHideName
!== null ) {
1673 return $this->mHideName
;
1675 $this->getBlockedStatus();
1676 if( !$this->mHideName
) {
1678 $authUser = $wgAuth->getUserInstance( $this );
1679 $this->mHideName
= (bool)$authUser->isHidden();
1681 return $this->mHideName
;
1685 * Get the user's ID.
1686 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1688 public function getId() {
1689 if( $this->mId
=== null && $this->mName
!== null
1690 && User
::isIP( $this->mName
) ) {
1691 // Special case, we know the user is anonymous
1693 } elseif( !$this->isItemLoaded( 'id' ) ) {
1694 // Don't load if this was initialized from an ID
1701 * Set the user and reload all fields according to a given ID
1702 * @param $v Int User ID to reload
1704 public function setId( $v ) {
1706 $this->clearInstanceCache( 'id' );
1710 * Get the user name, or the IP of an anonymous user
1711 * @return String User's name or IP address
1713 public function getName() {
1714 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1715 # Special case optimisation
1716 return $this->mName
;
1719 if ( $this->mName
=== false ) {
1721 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1723 return $this->mName
;
1728 * Set the user name.
1730 * This does not reload fields from the database according to the given
1731 * name. Rather, it is used to create a temporary "nonexistent user" for
1732 * later addition to the database. It can also be used to set the IP
1733 * address for an anonymous user to something other than the current
1736 * @note User::newFromName() has rougly the same function, when the named user
1738 * @param $str String New user name to set
1740 public function setName( $str ) {
1742 $this->mName
= $str;
1746 * Get the user's name escaped by underscores.
1747 * @return String Username escaped by underscores.
1749 public function getTitleKey() {
1750 return str_replace( ' ', '_', $this->getName() );
1754 * Check if the user has new messages.
1755 * @return Bool True if the user has new messages
1757 public function getNewtalk() {
1760 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1761 if( $this->mNewtalk
=== -1 ) {
1762 $this->mNewtalk
= false; # reset talk page status
1764 # Check memcached separately for anons, who have no
1765 # entire User object stored in there.
1768 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1769 $newtalk = $wgMemc->get( $key );
1770 if( strval( $newtalk ) !== '' ) {
1771 $this->mNewtalk
= (bool)$newtalk;
1773 // Since we are caching this, make sure it is up to date by getting it
1775 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1776 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1779 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1783 return (bool)$this->mNewtalk
;
1787 * Return the talk page(s) this user has new messages on.
1788 * @return Array of String page URLs
1790 public function getNewMessageLinks() {
1792 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1794 } elseif( !$this->getNewtalk() ) {
1797 $utp = $this->getTalkPage();
1798 $dbr = wfGetDB( DB_SLAVE
);
1799 // Get the "last viewed rev" timestamp from the oldest message notification
1800 $timestamp = $dbr->selectField( 'user_newtalk',
1801 'MIN(user_last_timestamp)',
1802 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1804 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1805 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1809 * Internal uncached check for new messages
1812 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1813 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1814 * @param $fromMaster Bool true to fetch from the master, false for a slave
1815 * @return Bool True if the user has new messages
1817 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1818 if ( $fromMaster ) {
1819 $db = wfGetDB( DB_MASTER
);
1821 $db = wfGetDB( DB_SLAVE
);
1823 $ok = $db->selectField( 'user_newtalk', $field,
1824 array( $field => $id ), __METHOD__
);
1825 return $ok !== false;
1829 * Add or update the new messages flag
1830 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1831 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1832 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1833 * @return Bool True if successful, false otherwise
1835 protected function updateNewtalk( $field, $id, $curRev = null ) {
1836 // Get timestamp of the talk page revision prior to the current one
1837 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1838 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1839 // Mark the user as having new messages since this revision
1840 $dbw = wfGetDB( DB_MASTER
);
1841 $dbw->insert( 'user_newtalk',
1842 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1845 if ( $dbw->affectedRows() ) {
1846 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1849 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1855 * Clear the new messages flag for the given user
1856 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1857 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1858 * @return Bool True if successful, false otherwise
1860 protected function deleteNewtalk( $field, $id ) {
1861 $dbw = wfGetDB( DB_MASTER
);
1862 $dbw->delete( 'user_newtalk',
1863 array( $field => $id ),
1865 if ( $dbw->affectedRows() ) {
1866 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1869 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1875 * Update the 'You have new messages!' status.
1876 * @param $val Bool Whether the user has new messages
1877 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1879 public function setNewtalk( $val, $curRev = null ) {
1880 if( wfReadOnly() ) {
1885 $this->mNewtalk
= $val;
1887 if( $this->isAnon() ) {
1889 $id = $this->getName();
1892 $id = $this->getId();
1897 $changed = $this->updateNewtalk( $field, $id, $curRev );
1899 $changed = $this->deleteNewtalk( $field, $id );
1902 if( $this->isAnon() ) {
1903 // Anons have a separate memcached space, since
1904 // user records aren't kept for them.
1905 $key = wfMemcKey( 'newtalk', 'ip', $id );
1906 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1909 $this->invalidateCache();
1914 * Generate a current or new-future timestamp to be stored in the
1915 * user_touched field when we update things.
1916 * @return String Timestamp in TS_MW format
1918 private static function newTouchedTimestamp() {
1919 global $wgClockSkewFudge;
1920 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1924 * Clear user data from memcached.
1925 * Use after applying fun updates to the database; caller's
1926 * responsibility to update user_touched if appropriate.
1928 * Called implicitly from invalidateCache() and saveSettings().
1930 private function clearSharedCache() {
1934 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1939 * Immediately touch the user data cache for this account.
1940 * Updates user_touched field, and removes account data from memcached
1941 * for reload on the next hit.
1943 public function invalidateCache() {
1944 if( wfReadOnly() ) {
1949 $this->mTouched
= self
::newTouchedTimestamp();
1951 $dbw = wfGetDB( DB_MASTER
);
1953 // Prevent contention slams by checking user_touched first
1954 $now = $dbw->timestamp( $this->mTouched
);
1955 $needsPurge = $dbw->selectField( 'user', '1',
1956 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1958 if ( $needsPurge ) {
1959 $dbw->update( 'user',
1960 array( 'user_touched' => $now ),
1961 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1966 $this->clearSharedCache();
1971 * Validate the cache for this account.
1972 * @param $timestamp String A timestamp in TS_MW format
1976 public function validateCache( $timestamp ) {
1978 return ( $timestamp >= $this->mTouched
);
1982 * Get the user touched timestamp
1983 * @return String timestamp
1985 public function getTouched() {
1987 return $this->mTouched
;
1991 * Set the password and reset the random token.
1992 * Calls through to authentication plugin if necessary;
1993 * will have no effect if the auth plugin refuses to
1994 * pass the change through or if the legal password
1997 * As a special case, setting the password to null
1998 * wipes it, so the account cannot be logged in until
1999 * a new password is set, for instance via e-mail.
2001 * @param $str String New password to set
2002 * @throws PasswordError on failure
2006 public function setPassword( $str ) {
2009 if( $str !== null ) {
2010 if( !$wgAuth->allowPasswordChange() ) {
2011 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
2014 if( !$this->isValidPassword( $str ) ) {
2015 global $wgMinimalPasswordLength;
2016 $valid = $this->getPasswordValidity( $str );
2017 if ( is_array( $valid ) ) {
2018 $message = array_shift( $valid );
2022 $params = array( $wgMinimalPasswordLength );
2024 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
2028 if( !$wgAuth->setPassword( $this, $str ) ) {
2029 throw new PasswordError( wfMsg( 'externaldberror' ) );
2032 $this->setInternalPassword( $str );
2038 * Set the password and reset the random token unconditionally.
2040 * @param $str String New password to set
2042 public function setInternalPassword( $str ) {
2046 if( $str === null ) {
2047 // Save an invalid hash...
2048 $this->mPassword
= '';
2050 $this->mPassword
= self
::crypt( $str );
2052 $this->mNewpassword
= '';
2053 $this->mNewpassTime
= null;
2057 * Get the user's current token.
2058 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2059 * @return String Token
2061 public function getToken( $forceCreation = true ) {
2063 if ( !$this->mToken
&& $forceCreation ) {
2066 return $this->mToken
;
2070 * Set the random token (used for persistent authentication)
2071 * Called from loadDefaults() among other places.
2073 * @param $token String|bool If specified, set the token to this value
2075 public function setToken( $token = false ) {
2078 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2080 $this->mToken
= $token;
2085 * Set the password for a password reminder or new account email
2087 * @param $str String New password to set
2088 * @param $throttle Bool If true, reset the throttle timestamp to the present
2090 public function setNewpassword( $str, $throttle = true ) {
2092 $this->mNewpassword
= self
::crypt( $str );
2094 $this->mNewpassTime
= wfTimestampNow();
2099 * Has password reminder email been sent within the last
2100 * $wgPasswordReminderResendTime hours?
2103 public function isPasswordReminderThrottled() {
2104 global $wgPasswordReminderResendTime;
2106 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2109 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2110 return time() < $expiry;
2114 * Get the user's e-mail address
2115 * @return String User's email address
2117 public function getEmail() {
2119 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2120 return $this->mEmail
;
2124 * Get the timestamp of the user's e-mail authentication
2125 * @return String TS_MW timestamp
2127 public function getEmailAuthenticationTimestamp() {
2129 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2130 return $this->mEmailAuthenticated
;
2134 * Set the user's e-mail address
2135 * @param $str String New e-mail address
2137 public function setEmail( $str ) {
2139 if( $str == $this->mEmail
) {
2142 $this->mEmail
= $str;
2143 $this->invalidateEmail();
2144 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2148 * Set the user's e-mail address and a confirmation mail if needed.
2151 * @param $str String New e-mail address
2154 public function setEmailWithConfirmation( $str ) {
2155 global $wgEnableEmail, $wgEmailAuthentication;
2157 if ( !$wgEnableEmail ) {
2158 return Status
::newFatal( 'emaildisabled' );
2161 $oldaddr = $this->getEmail();
2162 if ( $str === $oldaddr ) {
2163 return Status
::newGood( true );
2166 $this->setEmail( $str );
2168 if ( $str !== '' && $wgEmailAuthentication ) {
2169 # Send a confirmation request to the new address if needed
2170 $type = $oldaddr != '' ?
'changed' : 'set';
2171 $result = $this->sendConfirmationMail( $type );
2172 if ( $result->isGood() ) {
2173 # Say the the caller that a confirmation mail has been sent
2174 $result->value
= 'eauth';
2177 $result = Status
::newGood( true );
2184 * Get the user's real name
2185 * @return String User's real name
2187 public function getRealName() {
2188 if ( !$this->isItemLoaded( 'realname' ) ) {
2192 return $this->mRealName
;
2196 * Set the user's real name
2197 * @param $str String New real name
2199 public function setRealName( $str ) {
2201 $this->mRealName
= $str;
2205 * Get the user's current setting for a given option.
2207 * @param $oname String The option to check
2208 * @param $defaultOverride String A default value returned if the option does not exist
2209 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2210 * @return String User's current value for the option
2211 * @see getBoolOption()
2212 * @see getIntOption()
2214 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2215 global $wgHiddenPrefs;
2216 $this->loadOptions();
2218 if ( is_null( $this->mOptions
) ) {
2219 if($defaultOverride != '') {
2220 return $defaultOverride;
2222 $this->mOptions
= User
::getDefaultOptions();
2225 # We want 'disabled' preferences to always behave as the default value for
2226 # users, even if they have set the option explicitly in their settings (ie they
2227 # set it, and then it was disabled removing their ability to change it). But
2228 # we don't want to erase the preferences in the database in case the preference
2229 # is re-enabled again. So don't touch $mOptions, just override the returned value
2230 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2231 return self
::getDefaultOption( $oname );
2234 if ( array_key_exists( $oname, $this->mOptions
) ) {
2235 return $this->mOptions
[$oname];
2237 return $defaultOverride;
2242 * Get all user's options
2246 public function getOptions() {
2247 global $wgHiddenPrefs;
2248 $this->loadOptions();
2249 $options = $this->mOptions
;
2251 # We want 'disabled' preferences to always behave as the default value for
2252 # users, even if they have set the option explicitly in their settings (ie they
2253 # set it, and then it was disabled removing their ability to change it). But
2254 # we don't want to erase the preferences in the database in case the preference
2255 # is re-enabled again. So don't touch $mOptions, just override the returned value
2256 foreach( $wgHiddenPrefs as $pref ){
2257 $default = self
::getDefaultOption( $pref );
2258 if( $default !== null ){
2259 $options[$pref] = $default;
2267 * Get the user's current setting for a given option, as a boolean value.
2269 * @param $oname String The option to check
2270 * @return Bool User's current value for the option
2273 public function getBoolOption( $oname ) {
2274 return (bool)$this->getOption( $oname );
2278 * Get the user's current setting for a given option, as a boolean value.
2280 * @param $oname String The option to check
2281 * @param $defaultOverride Int A default value returned if the option does not exist
2282 * @return Int User's current value for the option
2285 public function getIntOption( $oname, $defaultOverride=0 ) {
2286 $val = $this->getOption( $oname );
2288 $val = $defaultOverride;
2290 return intval( $val );
2294 * Set the given option for a user.
2296 * @param $oname String The option to set
2297 * @param $val mixed New value to set
2299 public function setOption( $oname, $val ) {
2301 $this->loadOptions();
2303 // Explicitly NULL values should refer to defaults
2304 if( is_null( $val ) ) {
2305 $defaultOption = self
::getDefaultOption( $oname );
2306 if( !is_null( $defaultOption ) ) {
2307 $val = $defaultOption;
2311 $this->mOptions
[$oname] = $val;
2315 * Reset all options to the site defaults
2317 public function resetOptions() {
2320 $this->mOptions
= self
::getDefaultOptions();
2321 $this->mOptionsLoaded
= true;
2325 * Get the user's preferred date format.
2326 * @return String User's preferred date format
2328 public function getDatePreference() {
2329 // Important migration for old data rows
2330 if ( is_null( $this->mDatePreference
) ) {
2332 $value = $this->getOption( 'date' );
2333 $map = $wgLang->getDatePreferenceMigrationMap();
2334 if ( isset( $map[$value] ) ) {
2335 $value = $map[$value];
2337 $this->mDatePreference
= $value;
2339 return $this->mDatePreference
;
2343 * Get the user preferred stub threshold
2347 public function getStubThreshold() {
2348 global $wgMaxArticleSize; # Maximum article size, in Kb
2349 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2350 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2351 # If they have set an impossible value, disable the preference
2352 # so we can use the parser cache again.
2359 * Get the permissions this user has.
2360 * @return Array of String permission names
2362 public function getRights() {
2363 if ( is_null( $this->mRights
) ) {
2364 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2365 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2366 // Force reindexation of rights when a hook has unset one of them
2367 $this->mRights
= array_values( $this->mRights
);
2369 return $this->mRights
;
2373 * Get the list of explicit group memberships this user has.
2374 * The implicit * and user groups are not included.
2375 * @return Array of String internal group names
2377 public function getGroups() {
2379 $this->loadGroups();
2380 return $this->mGroups
;
2384 * Get the list of implicit group memberships this user has.
2385 * This includes all explicit groups, plus 'user' if logged in,
2386 * '*' for all accounts, and autopromoted groups
2387 * @param $recache Bool Whether to avoid the cache
2388 * @return Array of String internal group names
2390 public function getEffectiveGroups( $recache = false ) {
2391 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2392 wfProfileIn( __METHOD__
);
2393 $this->mEffectiveGroups
= array_unique( array_merge(
2394 $this->getGroups(), // explicit groups
2395 $this->getAutomaticGroups( $recache ) // implicit groups
2397 # Hook for additional groups
2398 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2399 wfProfileOut( __METHOD__
);
2401 return $this->mEffectiveGroups
;
2405 * Get the list of implicit group memberships this user has.
2406 * This includes 'user' if logged in, '*' for all accounts,
2407 * and autopromoted groups
2408 * @param $recache Bool Whether to avoid the cache
2409 * @return Array of String internal group names
2411 public function getAutomaticGroups( $recache = false ) {
2412 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2413 wfProfileIn( __METHOD__
);
2414 $this->mImplicitGroups
= array( '*' );
2415 if ( $this->getId() ) {
2416 $this->mImplicitGroups
[] = 'user';
2418 $this->mImplicitGroups
= array_unique( array_merge(
2419 $this->mImplicitGroups
,
2420 Autopromote
::getAutopromoteGroups( $this )
2424 # Assure data consistency with rights/groups,
2425 # as getEffectiveGroups() depends on this function
2426 $this->mEffectiveGroups
= null;
2428 wfProfileOut( __METHOD__
);
2430 return $this->mImplicitGroups
;
2434 * Returns the groups the user has belonged to.
2436 * The user may still belong to the returned groups. Compare with getGroups().
2438 * The function will not return groups the user had belonged to before MW 1.17
2440 * @return array Names of the groups the user has belonged to.
2442 public function getFormerGroups() {
2443 if( is_null( $this->mFormerGroups
) ) {
2444 $dbr = wfGetDB( DB_MASTER
);
2445 $res = $dbr->select( 'user_former_groups',
2446 array( 'ufg_group' ),
2447 array( 'ufg_user' => $this->mId
),
2449 $this->mFormerGroups
= array();
2450 foreach( $res as $row ) {
2451 $this->mFormerGroups
[] = $row->ufg_group
;
2454 return $this->mFormerGroups
;
2458 * Get the user's edit count.
2461 public function getEditCount() {
2462 if( $this->getId() ) {
2463 if ( !isset( $this->mEditCount
) ) {
2464 /* Populate the count, if it has not been populated yet */
2465 $this->mEditCount
= User
::edits( $this->mId
);
2467 return $this->mEditCount
;
2475 * Add the user to the given group.
2476 * This takes immediate effect.
2477 * @param $group String Name of the group to add
2479 public function addGroup( $group ) {
2480 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2481 $dbw = wfGetDB( DB_MASTER
);
2482 if( $this->getId() ) {
2483 $dbw->insert( 'user_groups',
2485 'ug_user' => $this->getID(),
2486 'ug_group' => $group,
2489 array( 'IGNORE' ) );
2492 $this->loadGroups();
2493 $this->mGroups
[] = $group;
2494 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2496 $this->invalidateCache();
2500 * Remove the user from the given group.
2501 * This takes immediate effect.
2502 * @param $group String Name of the group to remove
2504 public function removeGroup( $group ) {
2506 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2507 $dbw = wfGetDB( DB_MASTER
);
2508 $dbw->delete( 'user_groups',
2510 'ug_user' => $this->getID(),
2511 'ug_group' => $group,
2513 // Remember that the user was in this group
2514 $dbw->insert( 'user_former_groups',
2516 'ufg_user' => $this->getID(),
2517 'ufg_group' => $group,
2520 array( 'IGNORE' ) );
2522 $this->loadGroups();
2523 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2524 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2526 $this->invalidateCache();
2530 * Get whether the user is logged in
2533 public function isLoggedIn() {
2534 return $this->getID() != 0;
2538 * Get whether the user is anonymous
2541 public function isAnon() {
2542 return !$this->isLoggedIn();
2546 * Check if user is allowed to access a feature / make an action
2548 * @internal param \String $varargs permissions to test
2549 * @return Boolean: True if user is allowed to perform *any* of the given actions
2553 public function isAllowedAny( /*...*/ ){
2554 $permissions = func_get_args();
2555 foreach( $permissions as $permission ){
2556 if( $this->isAllowed( $permission ) ){
2565 * @internal param $varargs string
2566 * @return bool True if the user is allowed to perform *all* of the given actions
2568 public function isAllowedAll( /*...*/ ){
2569 $permissions = func_get_args();
2570 foreach( $permissions as $permission ){
2571 if( !$this->isAllowed( $permission ) ){
2579 * Internal mechanics of testing a permission
2580 * @param $action String
2583 public function isAllowed( $action = '' ) {
2584 if ( $action === '' ) {
2585 return true; // In the spirit of DWIM
2587 # Patrolling may not be enabled
2588 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2589 global $wgUseRCPatrol, $wgUseNPPatrol;
2590 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2593 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2594 # by misconfiguration: 0 == 'foo'
2595 return in_array( $action, $this->getRights(), true );
2599 * Check whether to enable recent changes patrol features for this user
2600 * @return Boolean: True or false
2602 public function useRCPatrol() {
2603 global $wgUseRCPatrol;
2604 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2608 * Check whether to enable new pages patrol features for this user
2609 * @return Bool True or false
2611 public function useNPPatrol() {
2612 global $wgUseRCPatrol, $wgUseNPPatrol;
2613 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2617 * Get the WebRequest object to use with this object
2619 * @return WebRequest
2621 public function getRequest() {
2622 if ( $this->mRequest
) {
2623 return $this->mRequest
;
2631 * Get the current skin, loading it if required
2632 * @return Skin The current skin
2633 * @todo FIXME: Need to check the old failback system [AV]
2634 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2636 public function getSkin() {
2637 wfDeprecated( __METHOD__
, '1.18' );
2638 return RequestContext
::getMain()->getSkin();
2642 * Get a WatchedItem for this user and $title.
2644 * @param $title Title
2645 * @return WatchedItem
2647 public function getWatchedItem( $title ) {
2648 $key = $title->getNamespace() . ':' . $title->getDBkey();
2650 if ( isset( $this->mWatchedItems
[$key] ) ) {
2651 return $this->mWatchedItems
[$key];
2654 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2655 $this->mWatchedItems
= array();
2658 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2659 return $this->mWatchedItems
[$key];
2663 * Check the watched status of an article.
2664 * @param $title Title of the article to look at
2667 public function isWatched( $title ) {
2668 return $this->getWatchedItem( $title )->isWatched();
2673 * @param $title Title of the article to look at
2675 public function addWatch( $title ) {
2676 $this->getWatchedItem( $title )->addWatch();
2677 $this->invalidateCache();
2681 * Stop watching an article.
2682 * @param $title Title of the article to look at
2684 public function removeWatch( $title ) {
2685 $this->getWatchedItem( $title )->removeWatch();
2686 $this->invalidateCache();
2690 * Clear the user's notification timestamp for the given title.
2691 * If e-notif e-mails are on, they will receive notification mails on
2692 * the next change of the page if it's watched etc.
2693 * @param $title Title of the article to look at
2695 public function clearNotification( &$title ) {
2696 global $wgUseEnotif, $wgShowUpdatedMarker;
2698 # Do nothing if the database is locked to writes
2699 if( wfReadOnly() ) {
2703 if( $title->getNamespace() == NS_USER_TALK
&&
2704 $title->getText() == $this->getName() ) {
2705 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2707 $this->setNewtalk( false );
2710 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2714 if( $this->isAnon() ) {
2715 // Nothing else to do...
2719 // Only update the timestamp if the page is being watched.
2720 // The query to find out if it is watched is cached both in memcached and per-invocation,
2721 // and when it does have to be executed, it can be on a slave
2722 // If this is the user's newtalk page, we always update the timestamp
2724 if ( $title->getNamespace() == NS_USER_TALK
&&
2725 $title->getText() == $this->getName() )
2730 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2734 * Resets all of the given user's page-change notification timestamps.
2735 * If e-notif e-mails are on, they will receive notification mails on
2736 * the next change of any watched page.
2738 public function clearAllNotifications() {
2739 global $wgUseEnotif, $wgShowUpdatedMarker;
2740 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2741 $this->setNewtalk( false );
2744 $id = $this->getId();
2746 $dbw = wfGetDB( DB_MASTER
);
2747 $dbw->update( 'watchlist',
2749 'wl_notificationtimestamp' => null
2750 ), array( /* WHERE */
2754 # We also need to clear here the "you have new message" notification for the own user_talk page
2755 # This is cleared one page view later in Article::viewUpdates();
2760 * Set this user's options from an encoded string
2761 * @param $str String Encoded options to import
2763 * @deprecated in 1.19 due to removal of user_options from the user table
2765 private function decodeOptions( $str ) {
2766 wfDeprecated( __METHOD__
, '1.19' );
2770 $this->mOptionsLoaded
= true;
2771 $this->mOptionOverrides
= array();
2773 // If an option is not set in $str, use the default value
2774 $this->mOptions
= self
::getDefaultOptions();
2776 $a = explode( "\n", $str );
2777 foreach ( $a as $s ) {
2779 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2780 $this->mOptions
[$m[1]] = $m[2];
2781 $this->mOptionOverrides
[$m[1]] = $m[2];
2787 * Set a cookie on the user's client. Wrapper for
2788 * WebResponse::setCookie
2789 * @param $name String Name of the cookie to set
2790 * @param $value String Value to set
2791 * @param $exp Int Expiration time, as a UNIX time value;
2792 * if 0 or not specified, use the default $wgCookieExpiration
2794 protected function setCookie( $name, $value, $exp = 0 ) {
2795 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2799 * Clear a cookie on the user's client
2800 * @param $name String Name of the cookie to clear
2802 protected function clearCookie( $name ) {
2803 $this->setCookie( $name, '', time() - 86400 );
2807 * Set the default cookies for this session on the user's client.
2809 * @param $request WebRequest object to use; $wgRequest will be used if null
2812 public function setCookies( $request = null ) {
2813 if ( $request === null ) {
2814 $request = $this->getRequest();
2818 if ( 0 == $this->mId
) return;
2819 if ( !$this->mToken
) {
2820 // When token is empty or NULL generate a new one and then save it to the database
2821 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2822 // Simply by setting every cell in the user_token column to NULL and letting them be
2823 // regenerated as users log back into the wiki.
2825 $this->saveSettings();
2828 'wsUserID' => $this->mId
,
2829 'wsToken' => $this->mToken
,
2830 'wsUserName' => $this->getName()
2833 'UserID' => $this->mId
,
2834 'UserName' => $this->getName(),
2836 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2837 $cookies['Token'] = $this->mToken
;
2839 $cookies['Token'] = false;
2842 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2844 foreach ( $session as $name => $value ) {
2845 $request->setSessionData( $name, $value );
2847 foreach ( $cookies as $name => $value ) {
2848 if ( $value === false ) {
2849 $this->clearCookie( $name );
2851 $this->setCookie( $name, $value );
2857 * Log this user out.
2859 public function logout() {
2860 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2866 * Clear the user's cookies and session, and reset the instance cache.
2869 public function doLogout() {
2870 $this->clearInstanceCache( 'defaults' );
2872 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2874 $this->clearCookie( 'UserID' );
2875 $this->clearCookie( 'Token' );
2877 # Remember when user logged out, to prevent seeing cached pages
2878 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2882 * Save this user's settings into the database.
2883 * @todo Only rarely do all these fields need to be set!
2885 public function saveSettings() {
2887 if ( wfReadOnly() ) { return; }
2888 if ( 0 == $this->mId
) { return; }
2890 $this->mTouched
= self
::newTouchedTimestamp();
2892 $dbw = wfGetDB( DB_MASTER
);
2893 $dbw->update( 'user',
2895 'user_name' => $this->mName
,
2896 'user_password' => $this->mPassword
,
2897 'user_newpassword' => $this->mNewpassword
,
2898 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2899 'user_real_name' => $this->mRealName
,
2900 'user_email' => $this->mEmail
,
2901 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2902 'user_touched' => $dbw->timestamp( $this->mTouched
),
2903 'user_token' => strval( $this->mToken
),
2904 'user_email_token' => $this->mEmailToken
,
2905 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2906 ), array( /* WHERE */
2907 'user_id' => $this->mId
2911 $this->saveOptions();
2913 wfRunHooks( 'UserSaveSettings', array( $this ) );
2914 $this->clearSharedCache();
2915 $this->getUserPage()->invalidateCache();
2919 * If only this user's username is known, and it exists, return the user ID.
2922 public function idForName() {
2923 $s = trim( $this->getName() );
2924 if ( $s === '' ) return 0;
2926 $dbr = wfGetDB( DB_SLAVE
);
2927 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2928 if ( $id === false ) {
2935 * Add a user to the database, return the user object
2937 * @param $name String Username to add
2938 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2939 * - password The user's password hash. Password logins will be disabled if this is omitted.
2940 * - newpassword Hash for a temporary password that has been mailed to the user
2941 * - email The user's email address
2942 * - email_authenticated The email authentication timestamp
2943 * - real_name The user's real name
2944 * - options An associative array of non-default options
2945 * - token Random authentication token. Do not set.
2946 * - registration Registration timestamp. Do not set.
2948 * @return User object, or null if the username already exists
2950 public static function createNew( $name, $params = array() ) {
2953 if ( isset( $params['options'] ) ) {
2954 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2955 unset( $params['options'] );
2957 $dbw = wfGetDB( DB_MASTER
);
2958 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2961 'user_id' => $seqVal,
2962 'user_name' => $name,
2963 'user_password' => $user->mPassword
,
2964 'user_newpassword' => $user->mNewpassword
,
2965 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2966 'user_email' => $user->mEmail
,
2967 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2968 'user_real_name' => $user->mRealName
,
2969 'user_token' => strval( $user->mToken
),
2970 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2971 'user_editcount' => 0,
2972 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
2974 foreach ( $params as $name => $value ) {
2975 $fields["user_$name"] = $value;
2977 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2978 if ( $dbw->affectedRows() ) {
2979 $newUser = User
::newFromId( $dbw->insertId() );
2987 * Add this existing user object to the database
2989 public function addToDatabase() {
2992 $this->mTouched
= self
::newTouchedTimestamp();
2994 $dbw = wfGetDB( DB_MASTER
);
2995 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2996 $dbw->insert( 'user',
2998 'user_id' => $seqVal,
2999 'user_name' => $this->mName
,
3000 'user_password' => $this->mPassword
,
3001 'user_newpassword' => $this->mNewpassword
,
3002 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3003 'user_email' => $this->mEmail
,
3004 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3005 'user_real_name' => $this->mRealName
,
3006 'user_token' => strval( $this->mToken
),
3007 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3008 'user_editcount' => 0,
3009 'user_touched' => $dbw->timestamp( $this->mTouched
),
3012 $this->mId
= $dbw->insertId();
3014 // Clear instance cache other than user table data, which is already accurate
3015 $this->clearInstanceCache();
3017 $this->saveOptions();
3021 * If this user is logged-in and blocked,
3022 * block any IP address they've successfully logged in from.
3023 * @return bool A block was spread
3025 public function spreadAnyEditBlock() {
3026 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3027 return $this->spreadBlock();
3033 * If this (non-anonymous) user is blocked,
3034 * block the IP address they've successfully logged in from.
3035 * @return bool A block was spread
3037 protected function spreadBlock() {
3038 wfDebug( __METHOD__
. "()\n" );
3040 if ( $this->mId
== 0 ) {
3044 $userblock = Block
::newFromTarget( $this->getName() );
3045 if ( !$userblock ) {
3049 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3053 * Generate a string which will be different for any combination of
3054 * user options which would produce different parser output.
3055 * This will be used as part of the hash key for the parser cache,
3056 * so users with the same options can share the same cached data
3059 * Extensions which require it should install 'PageRenderingHash' hook,
3060 * which will give them a chance to modify this key based on their own
3063 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3064 * @return String Page rendering hash
3066 public function getPageRenderingHash() {
3067 wfDeprecated( __METHOD__
, '1.17' );
3069 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3071 return $this->mHash
;
3074 // stubthreshold is only included below for completeness,
3075 // since it disables the parser cache, its value will always
3076 // be 0 when this function is called by parsercache.
3078 $confstr = $this->getOption( 'math' );
3079 $confstr .= '!' . $this->getStubThreshold();
3080 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3081 $confstr .= '!' . $this->getDatePreference();
3083 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3084 $confstr .= '!' . $wgLang->getCode();
3085 $confstr .= '!' . $this->getOption( 'thumbsize' );
3086 // add in language specific options, if any
3087 $extra = $wgContLang->getExtraHashOptions();
3090 // Since the skin could be overloading link(), it should be
3091 // included here but in practice, none of our skins do that.
3093 $confstr .= $wgRenderHashAppend;
3095 // Give a chance for extensions to modify the hash, if they have
3096 // extra options or other effects on the parser cache.
3097 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3099 // Make it a valid memcached key fragment
3100 $confstr = str_replace( ' ', '_', $confstr );
3101 $this->mHash
= $confstr;
3106 * Get whether the user is explicitly blocked from account creation.
3107 * @return Bool|Block
3109 public function isBlockedFromCreateAccount() {
3110 $this->getBlockedStatus();
3111 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3112 return $this->mBlock
;
3115 # bug 13611: if the IP address the user is trying to create an account from is
3116 # blocked with createaccount disabled, prevent new account creation there even
3117 # when the user is logged in
3118 if( $this->mBlockedFromCreateAccount
=== false ){
3119 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3121 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3122 ?
$this->mBlockedFromCreateAccount
3127 * Get whether the user is blocked from using Special:Emailuser.
3130 public function isBlockedFromEmailuser() {
3131 $this->getBlockedStatus();
3132 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3136 * Get whether the user is allowed to create an account.
3139 function isAllowedToCreateAccount() {
3140 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3144 * Get this user's personal page title.
3146 * @return Title: User's personal page title
3148 public function getUserPage() {
3149 return Title
::makeTitle( NS_USER
, $this->getName() );
3153 * Get this user's talk page title.
3155 * @return Title: User's talk page title
3157 public function getTalkPage() {
3158 $title = $this->getUserPage();
3159 return $title->getTalkPage();
3163 * Determine whether the user is a newbie. Newbies are either
3164 * anonymous IPs, or the most recently created accounts.
3167 public function isNewbie() {
3168 return !$this->isAllowed( 'autoconfirmed' );
3172 * Check to see if the given clear-text password is one of the accepted passwords
3173 * @param $password String: user password.
3174 * @return Boolean: True if the given password is correct, otherwise False.
3176 public function checkPassword( $password ) {
3177 global $wgAuth, $wgLegacyEncoding;
3180 // Even though we stop people from creating passwords that
3181 // are shorter than this, doesn't mean people wont be able
3182 // to. Certain authentication plugins do NOT want to save
3183 // domain passwords in a mysql database, so we should
3184 // check this (in case $wgAuth->strict() is false).
3185 if( !$this->isValidPassword( $password ) ) {
3189 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3191 } elseif( $wgAuth->strict() ) {
3192 /* Auth plugin doesn't allow local authentication */
3194 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3195 /* Auth plugin doesn't allow local authentication for this user name */
3198 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3200 } elseif ( $wgLegacyEncoding ) {
3201 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3202 # Check for this with iconv
3203 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3204 if ( $cp1252Password != $password &&
3205 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3214 * Check if the given clear-text password matches the temporary password
3215 * sent by e-mail for password reset operations.
3217 * @param $plaintext string
3219 * @return Boolean: True if matches, false otherwise
3221 public function checkTemporaryPassword( $plaintext ) {
3222 global $wgNewPasswordExpiry;
3225 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3226 if ( is_null( $this->mNewpassTime
) ) {
3229 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3230 return ( time() < $expiry );
3237 * Alias for getEditToken.
3238 * @deprecated since 1.19, use getEditToken instead.
3240 * @param $salt String|Array of Strings Optional function-specific data for hashing
3241 * @param $request WebRequest object to use or null to use $wgRequest
3242 * @return String The new edit token
3244 public function editToken( $salt = '', $request = null ) {
3245 wfDeprecated( __METHOD__
, '1.19' );
3246 return $this->getEditToken( $salt, $request );
3250 * Initialize (if necessary) and return a session token value
3251 * which can be used in edit forms to show that the user's
3252 * login credentials aren't being hijacked with a foreign form
3257 * @param $salt String|Array of Strings Optional function-specific data for hashing
3258 * @param $request WebRequest object to use or null to use $wgRequest
3259 * @return String The new edit token
3261 public function getEditToken( $salt = '', $request = null ) {
3262 if ( $request == null ) {
3263 $request = $this->getRequest();
3266 if ( $this->isAnon() ) {
3267 return EDIT_TOKEN_SUFFIX
;
3269 $token = $request->getSessionData( 'wsEditToken' );
3270 if ( $token === null ) {
3271 $token = MWCryptRand
::generateHex( 32 );
3272 $request->setSessionData( 'wsEditToken', $token );
3274 if( is_array( $salt ) ) {
3275 $salt = implode( '|', $salt );
3277 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3282 * Generate a looking random token for various uses.
3284 * @param $salt String Optional salt value
3285 * @return String The new random token
3286 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3288 public static function generateToken( $salt = '' ) {
3289 return MWCryptRand
::generateHex( 32 );
3293 * Check given value against the token value stored in the session.
3294 * A match should confirm that the form was submitted from the
3295 * user's own login session, not a form submission from a third-party
3298 * @param $val String Input value to compare
3299 * @param $salt String Optional function-specific data for hashing
3300 * @param $request WebRequest object to use or null to use $wgRequest
3301 * @return Boolean: Whether the token matches
3303 public function matchEditToken( $val, $salt = '', $request = null ) {
3304 $sessionToken = $this->getEditToken( $salt, $request );
3305 if ( $val != $sessionToken ) {
3306 wfDebug( "User::matchEditToken: broken session data\n" );
3308 return $val == $sessionToken;
3312 * Check given value against the token value stored in the session,
3313 * ignoring the suffix.
3315 * @param $val String Input value to compare
3316 * @param $salt String Optional function-specific data for hashing
3317 * @param $request WebRequest object to use or null to use $wgRequest
3318 * @return Boolean: Whether the token matches
3320 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3321 $sessionToken = $this->getEditToken( $salt, $request );
3322 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3326 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3327 * mail to the user's given address.
3329 * @param $type String: message to send, either "created", "changed" or "set"
3330 * @return Status object
3332 public function sendConfirmationMail( $type = 'created' ) {
3334 $expiration = null; // gets passed-by-ref and defined in next line.
3335 $token = $this->confirmationToken( $expiration );
3336 $url = $this->confirmationTokenUrl( $token );
3337 $invalidateURL = $this->invalidationTokenUrl( $token );
3338 $this->saveSettings();
3340 if ( $type == 'created' ||
$type === false ) {
3341 $message = 'confirmemail_body';
3342 } elseif ( $type === true ) {
3343 $message = 'confirmemail_body_changed';
3345 $message = 'confirmemail_body_' . $type;
3348 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3350 $this->getRequest()->getIP(),
3353 $wgLang->timeanddate( $expiration, false ),
3355 $wgLang->date( $expiration, false ),
3356 $wgLang->time( $expiration, false ) ) );
3360 * Send an e-mail to this user's account. Does not check for
3361 * confirmed status or validity.
3363 * @param $subject String Message subject
3364 * @param $body String Message body
3365 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3366 * @param $replyto String Reply-To address
3369 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3370 if( is_null( $from ) ) {
3371 global $wgPasswordSender, $wgPasswordSenderName;
3372 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3374 $sender = new MailAddress( $from );
3377 $to = new MailAddress( $this );
3378 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3382 * Generate, store, and return a new e-mail confirmation code.
3383 * A hash (unsalted, since it's used as a key) is stored.
3385 * @note Call saveSettings() after calling this function to commit
3386 * this change to the database.
3388 * @param &$expiration \mixed Accepts the expiration time
3389 * @return String New token
3391 private function confirmationToken( &$expiration ) {
3392 global $wgUserEmailConfirmationTokenExpiry;
3394 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3395 $expiration = wfTimestamp( TS_MW
, $expires );
3397 $token = MWCryptRand
::generateHex( 32 );
3398 $hash = md5( $token );
3399 $this->mEmailToken
= $hash;
3400 $this->mEmailTokenExpires
= $expiration;
3405 * Return a URL the user can use to confirm their email address.
3406 * @param $token String Accepts the email confirmation token
3407 * @return String New token URL
3409 private function confirmationTokenUrl( $token ) {
3410 return $this->getTokenUrl( 'ConfirmEmail', $token );
3414 * Return a URL the user can use to invalidate their email address.
3415 * @param $token String Accepts the email confirmation token
3416 * @return String New token URL
3418 private function invalidationTokenUrl( $token ) {
3419 return $this->getTokenUrl( 'InvalidateEmail', $token );
3423 * Internal function to format the e-mail validation/invalidation URLs.
3424 * This uses a quickie hack to use the
3425 * hardcoded English names of the Special: pages, for ASCII safety.
3427 * @note Since these URLs get dropped directly into emails, using the
3428 * short English names avoids insanely long URL-encoded links, which
3429 * also sometimes can get corrupted in some browsers/mailers
3430 * (bug 6957 with Gmail and Internet Explorer).
3432 * @param $page String Special page
3433 * @param $token String Token
3434 * @return String Formatted URL
3436 protected function getTokenUrl( $page, $token ) {
3437 // Hack to bypass localization of 'Special:'
3438 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3439 return $title->getCanonicalUrl();
3443 * Mark the e-mail address confirmed.
3445 * @note Call saveSettings() after calling this function to commit the change.
3449 public function confirmEmail() {
3450 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3451 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3456 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3457 * address if it was already confirmed.
3459 * @note Call saveSettings() after calling this function to commit the change.
3460 * @return bool Returns true
3462 function invalidateEmail() {
3464 $this->mEmailToken
= null;
3465 $this->mEmailTokenExpires
= null;
3466 $this->setEmailAuthenticationTimestamp( null );
3467 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3472 * Set the e-mail authentication timestamp.
3473 * @param $timestamp String TS_MW timestamp
3475 function setEmailAuthenticationTimestamp( $timestamp ) {
3477 $this->mEmailAuthenticated
= $timestamp;
3478 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3482 * Is this user allowed to send e-mails within limits of current
3483 * site configuration?
3486 public function canSendEmail() {
3487 global $wgEnableEmail, $wgEnableUserEmail;
3488 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3491 $canSend = $this->isEmailConfirmed();
3492 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3497 * Is this user allowed to receive e-mails within limits of current
3498 * site configuration?
3501 public function canReceiveEmail() {
3502 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3506 * Is this user's e-mail address valid-looking and confirmed within
3507 * limits of the current site configuration?
3509 * @note If $wgEmailAuthentication is on, this may require the user to have
3510 * confirmed their address by returning a code or using a password
3511 * sent to the address from the wiki.
3515 public function isEmailConfirmed() {
3516 global $wgEmailAuthentication;
3519 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3520 if( $this->isAnon() ) {
3523 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3526 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3536 * Check whether there is an outstanding request for e-mail confirmation.
3539 public function isEmailConfirmationPending() {
3540 global $wgEmailAuthentication;
3541 return $wgEmailAuthentication &&
3542 !$this->isEmailConfirmed() &&
3543 $this->mEmailToken
&&
3544 $this->mEmailTokenExpires
> wfTimestamp();
3548 * Get the timestamp of account creation.
3550 * @return String|Bool Timestamp of account creation, or false for
3551 * non-existent/anonymous user accounts.
3553 public function getRegistration() {
3554 if ( $this->isAnon() ) {
3558 return $this->mRegistration
;
3562 * Get the timestamp of the first edit
3564 * @return String|Bool Timestamp of first edit, or false for
3565 * non-existent/anonymous user accounts.
3567 public function getFirstEditTimestamp() {
3568 if( $this->getId() == 0 ) {
3569 return false; // anons
3571 $dbr = wfGetDB( DB_SLAVE
);
3572 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3573 array( 'rev_user' => $this->getId() ),
3575 array( 'ORDER BY' => 'rev_timestamp ASC' )
3578 return false; // no edits
3580 return wfTimestamp( TS_MW
, $time );
3584 * Get the permissions associated with a given list of groups
3586 * @param $groups Array of Strings List of internal group names
3587 * @return Array of Strings List of permission key names for given groups combined
3589 public static function getGroupPermissions( $groups ) {
3590 global $wgGroupPermissions, $wgRevokePermissions;
3592 // grant every granted permission first
3593 foreach( $groups as $group ) {
3594 if( isset( $wgGroupPermissions[$group] ) ) {
3595 $rights = array_merge( $rights,
3596 // array_filter removes empty items
3597 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3600 // now revoke the revoked permissions
3601 foreach( $groups as $group ) {
3602 if( isset( $wgRevokePermissions[$group] ) ) {
3603 $rights = array_diff( $rights,
3604 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3607 return array_unique( $rights );
3611 * Get all the groups who have a given permission
3613 * @param $role String Role to check
3614 * @return Array of Strings List of internal group names with the given permission
3616 public static function getGroupsWithPermission( $role ) {
3617 global $wgGroupPermissions;
3618 $allowedGroups = array();
3619 foreach ( $wgGroupPermissions as $group => $rights ) {
3620 if ( isset( $rights[$role] ) && $rights[$role] ) {
3621 $allowedGroups[] = $group;
3624 return $allowedGroups;
3628 * Get the localized descriptive name for a group, if it exists
3630 * @param $group String Internal group name
3631 * @return String Localized descriptive group name
3633 public static function getGroupName( $group ) {
3634 $msg = wfMessage( "group-$group" );
3635 return $msg->isBlank() ?
$group : $msg->text();
3639 * Get the localized descriptive name for a member of a group, if it exists
3641 * @param $group String Internal group name
3642 * @param $username String Username for gender (since 1.19)
3643 * @return String Localized name for group member
3645 public static function getGroupMember( $group, $username = '#' ) {
3646 $msg = wfMessage( "group-$group-member", $username );
3647 return $msg->isBlank() ?
$group : $msg->text();
3651 * Return the set of defined explicit groups.
3652 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3653 * are not included, as they are defined automatically, not in the database.
3654 * @return Array of internal group names
3656 public static function getAllGroups() {
3657 global $wgGroupPermissions, $wgRevokePermissions;
3659 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3660 self
::getImplicitGroups()
3665 * Get a list of all available permissions.
3666 * @return Array of permission names
3668 public static function getAllRights() {
3669 if ( self
::$mAllRights === false ) {
3670 global $wgAvailableRights;
3671 if ( count( $wgAvailableRights ) ) {
3672 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3674 self
::$mAllRights = self
::$mCoreRights;
3676 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3678 return self
::$mAllRights;
3682 * Get a list of implicit groups
3683 * @return Array of Strings Array of internal group names
3685 public static function getImplicitGroups() {
3686 global $wgImplicitGroups;
3687 $groups = $wgImplicitGroups;
3688 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3693 * Get the title of a page describing a particular group
3695 * @param $group String Internal group name
3696 * @return Title|Bool Title of the page if it exists, false otherwise
3698 public static function getGroupPage( $group ) {
3699 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3700 if( $msg->exists() ) {
3701 $title = Title
::newFromText( $msg->text() );
3702 if( is_object( $title ) )
3709 * Create a link to the group in HTML, if available;
3710 * else return the group name.
3712 * @param $group String Internal name of the group
3713 * @param $text String The text of the link
3714 * @return String HTML link to the group
3716 public static function makeGroupLinkHTML( $group, $text = '' ) {
3718 $text = self
::getGroupName( $group );
3720 $title = self
::getGroupPage( $group );
3722 return Linker
::link( $title, htmlspecialchars( $text ) );
3729 * Create a link to the group in Wikitext, if available;
3730 * else return the group name.
3732 * @param $group String Internal name of the group
3733 * @param $text String The text of the link
3734 * @return String Wikilink to the group
3736 public static function makeGroupLinkWiki( $group, $text = '' ) {
3738 $text = self
::getGroupName( $group );
3740 $title = self
::getGroupPage( $group );
3742 $page = $title->getPrefixedText();
3743 return "[[$page|$text]]";
3750 * Returns an array of the groups that a particular group can add/remove.
3752 * @param $group String: the group to check for whether it can add/remove
3753 * @return Array array( 'add' => array( addablegroups ),
3754 * 'remove' => array( removablegroups ),
3755 * 'add-self' => array( addablegroups to self),
3756 * 'remove-self' => array( removable groups from self) )
3758 public static function changeableByGroup( $group ) {
3759 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3761 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3762 if( empty( $wgAddGroups[$group] ) ) {
3763 // Don't add anything to $groups
3764 } elseif( $wgAddGroups[$group] === true ) {
3765 // You get everything
3766 $groups['add'] = self
::getAllGroups();
3767 } elseif( is_array( $wgAddGroups[$group] ) ) {
3768 $groups['add'] = $wgAddGroups[$group];
3771 // Same thing for remove
3772 if( empty( $wgRemoveGroups[$group] ) ) {
3773 } elseif( $wgRemoveGroups[$group] === true ) {
3774 $groups['remove'] = self
::getAllGroups();
3775 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3776 $groups['remove'] = $wgRemoveGroups[$group];
3779 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3780 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3781 foreach( $wgGroupsAddToSelf as $key => $value ) {
3782 if( is_int( $key ) ) {
3783 $wgGroupsAddToSelf['user'][] = $value;
3788 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3789 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3790 if( is_int( $key ) ) {
3791 $wgGroupsRemoveFromSelf['user'][] = $value;
3796 // Now figure out what groups the user can add to him/herself
3797 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3798 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3799 // No idea WHY this would be used, but it's there
3800 $groups['add-self'] = User
::getAllGroups();
3801 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3802 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3805 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3806 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3807 $groups['remove-self'] = User
::getAllGroups();
3808 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3809 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3816 * Returns an array of groups that this user can add and remove
3817 * @return Array array( 'add' => array( addablegroups ),
3818 * 'remove' => array( removablegroups ),
3819 * 'add-self' => array( addablegroups to self),
3820 * 'remove-self' => array( removable groups from self) )
3822 public function changeableGroups() {
3823 if( $this->isAllowed( 'userrights' ) ) {
3824 // This group gives the right to modify everything (reverse-
3825 // compatibility with old "userrights lets you change
3827 // Using array_merge to make the groups reindexed
3828 $all = array_merge( User
::getAllGroups() );
3832 'add-self' => array(),
3833 'remove-self' => array()
3837 // Okay, it's not so simple, we will have to go through the arrays
3840 'remove' => array(),
3841 'add-self' => array(),
3842 'remove-self' => array()
3844 $addergroups = $this->getEffectiveGroups();
3846 foreach( $addergroups as $addergroup ) {
3847 $groups = array_merge_recursive(
3848 $groups, $this->changeableByGroup( $addergroup )
3850 $groups['add'] = array_unique( $groups['add'] );
3851 $groups['remove'] = array_unique( $groups['remove'] );
3852 $groups['add-self'] = array_unique( $groups['add-self'] );
3853 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3859 * Increment the user's edit-count field.
3860 * Will have no effect for anonymous users.
3862 public function incEditCount() {
3863 if( !$this->isAnon() ) {
3864 $dbw = wfGetDB( DB_MASTER
);
3865 $dbw->update( 'user',
3866 array( 'user_editcount=user_editcount+1' ),
3867 array( 'user_id' => $this->getId() ),
3870 // Lazy initialization check...
3871 if( $dbw->affectedRows() == 0 ) {
3872 // Pull from a slave to be less cruel to servers
3873 // Accuracy isn't the point anyway here
3874 $dbr = wfGetDB( DB_SLAVE
);
3875 $count = $dbr->selectField( 'revision',
3877 array( 'rev_user' => $this->getId() ),
3880 // Now here's a goddamn hack...
3881 if( $dbr !== $dbw ) {
3882 // If we actually have a slave server, the count is
3883 // at least one behind because the current transaction
3884 // has not been committed and replicated.
3887 // But if DB_SLAVE is selecting the master, then the
3888 // count we just read includes the revision that was
3889 // just added in the working transaction.
3892 $dbw->update( 'user',
3893 array( 'user_editcount' => $count ),
3894 array( 'user_id' => $this->getId() ),
3898 // edit count in user cache too
3899 $this->invalidateCache();
3903 * Get the description of a given right
3905 * @param $right String Right to query
3906 * @return String Localized description of the right
3908 public static function getRightDescription( $right ) {
3909 $key = "right-$right";
3910 $msg = wfMessage( $key );
3911 return $msg->isBlank() ?
$right : $msg->text();
3915 * Make an old-style password hash
3917 * @param $password String Plain-text password
3918 * @param $userId String User ID
3919 * @return String Password hash
3921 public static function oldCrypt( $password, $userId ) {
3922 global $wgPasswordSalt;
3923 if ( $wgPasswordSalt ) {
3924 return md5( $userId . '-' . md5( $password ) );
3926 return md5( $password );
3931 * Make a new-style password hash
3933 * @param $password String Plain-text password
3934 * @param bool|string $salt Optional salt, may be random or the user ID.
3936 * If unspecified or false, will generate one automatically
3937 * @return String Password hash
3939 public static function crypt( $password, $salt = false ) {
3940 global $wgPasswordSalt;
3943 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3947 if( $wgPasswordSalt ) {
3948 if ( $salt === false ) {
3949 $salt = MWCryptRand
::generateHex( 8 );
3951 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3953 return ':A:' . md5( $password );
3958 * Compare a password hash with a plain-text password. Requires the user
3959 * ID if there's a chance that the hash is an old-style hash.
3961 * @param $hash String Password hash
3962 * @param $password String Plain-text password to compare
3963 * @param $userId String|bool User ID for old-style password salt
3967 public static function comparePasswords( $hash, $password, $userId = false ) {
3968 $type = substr( $hash, 0, 3 );
3971 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3975 if ( $type == ':A:' ) {
3977 return md5( $password ) === substr( $hash, 3 );
3978 } elseif ( $type == ':B:' ) {
3980 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3981 return md5( $salt.'-'.md5( $password ) ) === $realHash;
3984 return self
::oldCrypt( $password, $userId ) === $hash;
3989 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
3991 * @param $byEmail Boolean: account made by email?
3992 * @param $reason String: user supplied reason
3994 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
3996 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3997 global $wgUser, $wgContLang, $wgNewUserLog;
3998 if( empty( $wgNewUserLog ) ) {
3999 return true; // disabled
4002 if( $this->getName() == $wgUser->getName() ) {
4005 $action = 'create2';
4007 if ( $reason === '' ) {
4008 $reason = wfMsgForContent( 'newuserlog-byemail' );
4010 $reason = $wgContLang->commaList( array(
4011 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
4015 $log = new LogPage( 'newusers' );
4016 return (int)$log->addEntry(
4018 $this->getUserPage(),
4020 array( $this->getId() )
4025 * Add an autocreate newuser log entry for this user
4026 * Used by things like CentralAuth and perhaps other authplugins.
4030 public function addNewUserLogEntryAutoCreate() {
4031 global $wgNewUserLog;
4032 if( !$wgNewUserLog ) {
4033 return true; // disabled
4035 $log = new LogPage( 'newusers', false );
4036 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4043 protected function loadOptions() {
4045 if ( $this->mOptionsLoaded ||
!$this->getId() )
4048 $this->mOptions
= self
::getDefaultOptions();
4050 // Maybe load from the object
4051 if ( !is_null( $this->mOptionOverrides
) ) {
4052 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4053 foreach( $this->mOptionOverrides
as $key => $value ) {
4054 $this->mOptions
[$key] = $value;
4057 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4058 // Load from database
4059 $dbr = wfGetDB( DB_SLAVE
);
4061 $res = $dbr->select(
4063 array( 'up_property', 'up_value' ),
4064 array( 'up_user' => $this->getId() ),
4068 $this->mOptionOverrides
= array();
4069 foreach ( $res as $row ) {
4070 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4071 $this->mOptions
[$row->up_property
] = $row->up_value
;
4075 $this->mOptionsLoaded
= true;
4077 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4083 protected function saveOptions() {
4084 global $wgAllowPrefChange;
4086 $this->loadOptions();
4088 // Not using getOptions(), to keep hidden preferences in database
4089 $saveOptions = $this->mOptions
;
4091 // Allow hooks to abort, for instance to save to a global profile.
4092 // Reset options to default state before saving.
4093 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4097 $extuser = ExternalUser
::newFromUser( $this );
4098 $userId = $this->getId();
4099 $insert_rows = array();
4100 foreach( $saveOptions as $key => $value ) {
4101 # Don't bother storing default values
4102 $defaultOption = self
::getDefaultOption( $key );
4103 if ( ( is_null( $defaultOption ) &&
4104 !( $value === false ||
is_null( $value ) ) ) ||
4105 $value != $defaultOption ) {
4106 $insert_rows[] = array(
4107 'up_user' => $userId,
4108 'up_property' => $key,
4109 'up_value' => $value,
4112 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4113 switch ( $wgAllowPrefChange[$key] ) {
4119 $extuser->setPref( $key, $value );
4124 $dbw = wfGetDB( DB_MASTER
);
4125 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4126 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4130 * Provide an array of HTML5 attributes to put on an input element
4131 * intended for the user to enter a new password. This may include
4132 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4134 * Do *not* use this when asking the user to enter his current password!
4135 * Regardless of configuration, users may have invalid passwords for whatever
4136 * reason (e.g., they were set before requirements were tightened up).
4137 * Only use it when asking for a new password, like on account creation or
4140 * Obviously, you still need to do server-side checking.
4142 * NOTE: A combination of bugs in various browsers means that this function
4143 * actually just returns array() unconditionally at the moment. May as
4144 * well keep it around for when the browser bugs get fixed, though.
4146 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4148 * @return array Array of HTML attributes suitable for feeding to
4149 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4150 * That will potentially output invalid XHTML 1.0 Transitional, and will
4151 * get confused by the boolean attribute syntax used.)
4153 public static function passwordChangeInputAttribs() {
4154 global $wgMinimalPasswordLength;
4156 if ( $wgMinimalPasswordLength == 0 ) {
4160 # Note that the pattern requirement will always be satisfied if the
4161 # input is empty, so we need required in all cases.
4163 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4164 # if e-mail confirmation is being used. Since HTML5 input validation
4165 # is b0rked anyway in some browsers, just return nothing. When it's
4166 # re-enabled, fix this code to not output required for e-mail
4168 #$ret = array( 'required' );
4171 # We can't actually do this right now, because Opera 9.6 will print out
4172 # the entered password visibly in its error message! When other
4173 # browsers add support for this attribute, or Opera fixes its support,
4174 # we can add support with a version check to avoid doing this on Opera
4175 # versions where it will be a problem. Reported to Opera as
4176 # DSK-262266, but they don't have a public bug tracker for us to follow.
4178 if ( $wgMinimalPasswordLength > 1 ) {
4179 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4180 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4181 $wgMinimalPasswordLength );
4189 * Return the list of user fields that should be selected to create
4190 * a new user object.
4193 public static function selectFields() {
4200 'user_newpass_time',
4204 'user_email_authenticated',
4206 'user_email_token_expires',
4207 'user_registration',