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',
163 'userrights-interwiki',
167 * String Cached results of getAllRights()
169 static $mAllRights = false;
171 /** @name Cache variables */
173 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
174 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
175 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
176 $mGroups, $mOptionOverrides;
180 * Bool Whether the cache variables have been loaded.
186 * Array with already loaded items or true if all items have been loaded.
188 private $mLoadedItems = array();
192 * String Initialization data source if mLoadedItems!==true. May be one of:
193 * - 'defaults' anonymous user initialised from class defaults
194 * - 'name' initialise from mName
195 * - 'id' initialise from mId
196 * - 'session' log in from cookies or session if possible
198 * Use the User::newFrom*() family of functions to set this.
203 * Lazy-initialized variables, invalidated with clearInstanceCache
205 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
206 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
207 $mLocked, $mHideName, $mOptions;
227 private $mBlockedFromCreateAccount = false;
232 private $mWatchedItems = array();
234 static $idCacheByName = array();
237 * Lightweight constructor for an anonymous user.
238 * Use the User::newFrom* factory functions for other kinds of users.
242 * @see newFromConfirmationCode()
243 * @see newFromSession()
246 function __construct() {
247 $this->clearInstanceCache( 'defaults' );
253 function __toString(){
254 return $this->getName();
258 * Load the user table data for this object from the source given by mFrom.
260 public function load() {
261 if ( $this->mLoadedItems
=== true ) {
264 wfProfileIn( __METHOD__
);
266 # Set it now to avoid infinite recursion in accessors
267 $this->mLoadedItems
= true;
269 switch ( $this->mFrom
) {
271 $this->loadDefaults();
274 $this->mId
= self
::idFromName( $this->mName
);
276 # Nonexistent user placeholder object
277 $this->loadDefaults( $this->mName
);
286 $this->loadFromSession();
287 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
290 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
292 wfProfileOut( __METHOD__
);
296 * Load user table data, given mId has already been set.
297 * @return Bool false if the ID does not exist, true otherwise
299 public function loadFromId() {
301 if ( $this->mId
== 0 ) {
302 $this->loadDefaults();
307 $key = wfMemcKey( 'user', 'id', $this->mId
);
308 $data = $wgMemc->get( $key );
309 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
310 # Object is expired, load from DB
315 wfDebug( "User: cache miss for user {$this->mId}\n" );
317 if ( !$this->loadFromDatabase() ) {
318 # Can't load from ID, user is anonymous
321 $this->saveToCache();
323 wfDebug( "User: got user {$this->mId} from cache\n" );
325 foreach ( self
::$mCacheVars as $name ) {
326 $this->$name = $data[$name];
333 * Save user data to the shared cache
335 public function saveToCache() {
338 $this->loadOptions();
339 if ( $this->isAnon() ) {
340 // Anonymous users are uncached
344 foreach ( self
::$mCacheVars as $name ) {
345 $data[$name] = $this->$name;
347 $data['mVersion'] = MW_USER_VERSION
;
348 $key = wfMemcKey( 'user', 'id', $this->mId
);
350 $wgMemc->set( $key, $data );
353 /** @name newFrom*() static factory methods */
357 * Static factory method for creation from username.
359 * This is slightly less efficient than newFromId(), so use newFromId() if
360 * you have both an ID and a name handy.
362 * @param $name String Username, validated by Title::newFromText()
363 * @param $validate String|Bool Validate username. Takes the same parameters as
364 * User::getCanonicalName(), except that true is accepted as an alias
365 * for 'valid', for BC.
367 * @return User object, or false if the username is invalid
368 * (e.g. if it contains illegal characters or is an IP address). If the
369 * username is not present in the database, the result will be a user object
370 * with a name, zero user ID and default settings.
372 public static function newFromName( $name, $validate = 'valid' ) {
373 if ( $validate === true ) {
376 $name = self
::getCanonicalName( $name, $validate );
377 if ( $name === false ) {
380 # Create unloaded user object
384 $u->setItemLoaded( 'name' );
390 * Static factory method for creation from a given user ID.
392 * @param $id Int Valid user ID
393 * @return User The corresponding User object
395 public static function newFromId( $id ) {
399 $u->setItemLoaded( 'id' );
404 * Factory method to fetch whichever user has a given email confirmation code.
405 * This code is generated when an account is created or its e-mail address
408 * If the code is invalid or has expired, returns NULL.
410 * @param $code String Confirmation code
411 * @return User object, or null
413 public static function newFromConfirmationCode( $code ) {
414 $dbr = wfGetDB( DB_SLAVE
);
415 $id = $dbr->selectField( 'user', 'user_id', array(
416 'user_email_token' => md5( $code ),
417 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
419 if( $id !== false ) {
420 return User
::newFromId( $id );
427 * Create a new user object using data from session or cookies. If the
428 * login credentials are invalid, the result is an anonymous user.
430 * @param $request WebRequest object to use; $wgRequest will be used if
432 * @return User object
434 public static function newFromSession( WebRequest
$request = null ) {
436 $user->mFrom
= 'session';
437 $user->mRequest
= $request;
442 * Create a new user object from a user row.
443 * The row should have the following fields from the user table in it:
444 * - either user_name or user_id to load further data if needed (or both)
446 * - all other fields (email, password, etc.)
447 * It is useless to provide the remaining fields if either user_id,
448 * user_name and user_real_name are not provided because the whole row
449 * will be loaded once more from the database when accessing them.
451 * @param $row Array A row from the user table
454 public static function newFromRow( $row ) {
456 $user->loadFromRow( $row );
463 * Get the username corresponding to a given user ID
464 * @param $id Int User ID
465 * @return String|bool The corresponding username
467 public static function whoIs( $id ) {
468 $dbr = wfGetDB( DB_SLAVE
);
469 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
473 * Get the real name of a user given their user ID
475 * @param $id Int User ID
476 * @return String|bool The corresponding user's real name
478 public static function whoIsReal( $id ) {
479 $dbr = wfGetDB( DB_SLAVE
);
480 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
484 * Get database id given a user name
485 * @param $name String Username
486 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
488 public static function idFromName( $name ) {
489 $nt = Title
::makeTitleSafe( NS_USER
, $name );
490 if( is_null( $nt ) ) {
495 if ( isset( self
::$idCacheByName[$name] ) ) {
496 return self
::$idCacheByName[$name];
499 $dbr = wfGetDB( DB_SLAVE
);
500 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
502 if ( $s === false ) {
505 $result = $s->user_id
;
508 self
::$idCacheByName[$name] = $result;
510 if ( count( self
::$idCacheByName ) > 1000 ) {
511 self
::$idCacheByName = array();
518 * Reset the cache used in idFromName(). For use in tests.
520 public static function resetIdByNameCache() {
521 self
::$idCacheByName = array();
525 * Does the string match an anonymous IPv4 address?
527 * This function exists for username validation, in order to reject
528 * usernames which are similar in form to IP addresses. Strings such
529 * as 300.300.300.300 will return true because it looks like an IP
530 * address, despite not being strictly valid.
532 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
533 * address because the usemod software would "cloak" anonymous IP
534 * addresses like this, if we allowed accounts like this to be created
535 * new users could get the old edits of these anonymous users.
537 * @param $name String to match
540 public static function isIP( $name ) {
541 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
545 * Is the input a valid username?
547 * Checks if the input is a valid username, we don't want an empty string,
548 * an IP address, anything that containins slashes (would mess up subpages),
549 * is longer than the maximum allowed username size or doesn't begin with
552 * @param $name String to match
555 public static function isValidUserName( $name ) {
556 global $wgContLang, $wgMaxNameChars;
559 || User
::isIP( $name )
560 ||
strpos( $name, '/' ) !== false
561 ||
strlen( $name ) > $wgMaxNameChars
562 ||
$name != $wgContLang->ucfirst( $name ) ) {
563 wfDebugLog( 'username', __METHOD__
.
564 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
569 // Ensure that the name can't be misresolved as a different title,
570 // such as with extra namespace keys at the start.
571 $parsed = Title
::newFromText( $name );
572 if( is_null( $parsed )
573 ||
$parsed->getNamespace()
574 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
575 wfDebugLog( 'username', __METHOD__
.
576 ": '$name' invalid due to ambiguous prefixes" );
580 // Check an additional blacklist of troublemaker characters.
581 // Should these be merged into the title char list?
582 $unicodeBlacklist = '/[' .
583 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
584 '\x{00a0}' . # non-breaking space
585 '\x{2000}-\x{200f}' . # various whitespace
586 '\x{2028}-\x{202f}' . # breaks and control chars
587 '\x{3000}' . # ideographic space
588 '\x{e000}-\x{f8ff}' . # private use
590 if( preg_match( $unicodeBlacklist, $name ) ) {
591 wfDebugLog( 'username', __METHOD__
.
592 ": '$name' invalid due to blacklisted characters" );
600 * Usernames which fail to pass this function will be blocked
601 * from user login and new account registrations, but may be used
602 * internally by batch processes.
604 * If an account already exists in this form, login will be blocked
605 * by a failure to pass this function.
607 * @param $name String to match
610 public static function isUsableName( $name ) {
611 global $wgReservedUsernames;
612 // Must be a valid username, obviously ;)
613 if ( !self
::isValidUserName( $name ) ) {
617 static $reservedUsernames = false;
618 if ( !$reservedUsernames ) {
619 $reservedUsernames = $wgReservedUsernames;
620 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
623 // Certain names may be reserved for batch processes.
624 foreach ( $reservedUsernames as $reserved ) {
625 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
626 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
628 if ( $reserved == $name ) {
636 * Usernames which fail to pass this function will be blocked
637 * from new account registrations, but may be used internally
638 * either by batch processes or by user accounts which have
639 * already been created.
641 * Additional blacklisting may be added here rather than in
642 * isValidUserName() to avoid disrupting existing accounts.
644 * @param $name String to match
647 public static function isCreatableName( $name ) {
648 global $wgInvalidUsernameCharacters;
650 // Ensure that the username isn't longer than 235 bytes, so that
651 // (at least for the builtin skins) user javascript and css files
652 // will work. (bug 23080)
653 if( strlen( $name ) > 235 ) {
654 wfDebugLog( 'username', __METHOD__
.
655 ": '$name' invalid due to length" );
659 // Preg yells if you try to give it an empty string
660 if( $wgInvalidUsernameCharacters !== '' ) {
661 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
662 wfDebugLog( 'username', __METHOD__
.
663 ": '$name' invalid due to wgInvalidUsernameCharacters" );
668 return self
::isUsableName( $name );
672 * Is the input a valid password for this user?
674 * @param $password String Desired password
677 public function isValidPassword( $password ) {
678 //simple boolean wrapper for getPasswordValidity
679 return $this->getPasswordValidity( $password ) === true;
683 * Given unvalidated password input, return error message on failure.
685 * @param $password String Desired password
686 * @return mixed: true on success, string or array of error message on failure
688 public function getPasswordValidity( $password ) {
689 global $wgMinimalPasswordLength, $wgContLang;
691 static $blockedLogins = array(
692 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
693 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
696 $result = false; //init $result to false for the internal checks
698 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
701 if ( $result === false ) {
702 if( strlen( $password ) < $wgMinimalPasswordLength ) {
703 return 'passwordtooshort';
704 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
705 return 'password-name-match';
706 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
707 return 'password-login-forbidden';
709 //it seems weird returning true here, but this is because of the
710 //initialization of $result to false above. If the hook is never run or it
711 //doesn't modify $result, then we will likely get down into this if with
715 } elseif( $result === true ) {
718 return $result; //the isValidPassword hook set a string $result and returned true
723 * Does a string look like an e-mail address?
725 * This validates an email address using an HTML5 specification found at:
726 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
727 * Which as of 2011-01-24 says:
729 * A valid e-mail address is a string that matches the ABNF production
730 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
731 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
734 * This function is an implementation of the specification as requested in
737 * Client-side forms will use the same standard validation rules via JS or
738 * HTML 5 validation; additional restrictions can be enforced server-side
739 * by extensions via the 'isValidEmailAddr' hook.
741 * Note that this validation doesn't 100% match RFC 2822, but is believed
742 * to be liberal enough for wide use. Some invalid addresses will still
743 * pass validation here.
745 * @param $addr String E-mail address
747 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
749 public static function isValidEmailAddr( $addr ) {
750 wfDeprecated( __METHOD__
, '1.18' );
751 return Sanitizer
::validateEmail( $addr );
755 * Given unvalidated user input, return a canonical username, or false if
756 * the username is invalid.
757 * @param $name String User input
758 * @param $validate String|Bool type of validation to use:
759 * - false No validation
760 * - 'valid' Valid for batch processes
761 * - 'usable' Valid for batch processes and login
762 * - 'creatable' Valid for batch processes, login and account creation
764 * @return bool|string
766 public static function getCanonicalName( $name, $validate = 'valid' ) {
767 # Force usernames to capital
769 $name = $wgContLang->ucfirst( $name );
771 # Reject names containing '#'; these will be cleaned up
772 # with title normalisation, but then it's too late to
774 if( strpos( $name, '#' ) !== false )
777 # Clean up name according to title rules
778 $t = ( $validate === 'valid' ) ?
779 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
780 # Check for invalid titles
781 if( is_null( $t ) ) {
785 # Reject various classes of invalid names
787 $name = $wgAuth->getCanonicalName( $t->getText() );
789 switch ( $validate ) {
793 if ( !User
::isValidUserName( $name ) ) {
798 if ( !User
::isUsableName( $name ) ) {
803 if ( !User
::isCreatableName( $name ) ) {
808 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
814 * Count the number of edits of a user
815 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
817 * @param $uid Int User ID to check
818 * @return Int the user's edit count
820 public static function edits( $uid ) {
821 wfProfileIn( __METHOD__
);
822 $dbr = wfGetDB( DB_SLAVE
);
823 // check if the user_editcount field has been initialized
824 $field = $dbr->selectField(
825 'user', 'user_editcount',
826 array( 'user_id' => $uid ),
830 if( $field === null ) { // it has not been initialized. do so.
831 $dbw = wfGetDB( DB_MASTER
);
832 $count = $dbr->selectField(
833 'revision', 'count(*)',
834 array( 'rev_user' => $uid ),
839 array( 'user_editcount' => $count ),
840 array( 'user_id' => $uid ),
846 wfProfileOut( __METHOD__
);
851 * Return a random password.
853 * @return String new random password
855 public static function randomPassword() {
856 global $wgMinimalPasswordLength;
857 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
858 $length = max( 10, $wgMinimalPasswordLength );
859 // Multiply by 1.25 to get the number of hex characters we need
860 $length = $length * 1.25;
861 // Generate random hex chars
862 $hex = MWCryptRand
::generateHex( $length );
863 // Convert from base 16 to base 32 to get a proper password like string
864 return wfBaseConvert( $hex, 16, 32 );
868 * Set cached properties to default.
870 * @note This no longer clears uncached lazy-initialised properties;
871 * the constructor does that instead.
873 * @param $name string
875 public function loadDefaults( $name = false ) {
876 wfProfileIn( __METHOD__
);
879 $this->mName
= $name;
880 $this->mRealName
= '';
881 $this->mPassword
= $this->mNewpassword
= '';
882 $this->mNewpassTime
= null;
884 $this->mOptionOverrides
= null;
885 $this->mOptionsLoaded
= false;
887 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
888 if( $loggedOut !== null ) {
889 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
891 $this->mTouched
= '0'; # Allow any pages to be cached
894 $this->mToken
= null; // Don't run cryptographic functions till we need a token
895 $this->mEmailAuthenticated
= null;
896 $this->mEmailToken
= '';
897 $this->mEmailTokenExpires
= null;
898 $this->mRegistration
= wfTimestamp( TS_MW
);
899 $this->mGroups
= array();
901 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
903 wfProfileOut( __METHOD__
);
907 * Return whether an item has been loaded.
909 * @param $item String: item to check. Current possibilities:
913 * @param $all String: 'all' to check if the whole object has been loaded
914 * or any other string to check if only the item is available (e.g.
918 public function isItemLoaded( $item, $all = 'all' ) {
919 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
920 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
924 * Set that an item has been loaded
926 * @param $item String
928 private function setItemLoaded( $item ) {
929 if ( is_array( $this->mLoadedItems
) ) {
930 $this->mLoadedItems
[$item] = true;
935 * Load user data from the session or login cookie. If there are no valid
936 * credentials, initialises the user as an anonymous user.
937 * @return Bool True if the user is logged in, false otherwise.
939 private function loadFromSession() {
940 global $wgExternalAuthType, $wgAutocreatePolicy;
943 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
944 if ( $result !== null ) {
948 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
949 $extUser = ExternalUser
::newFromCookie();
951 # TODO: Automatically create the user here (or probably a bit
952 # lower down, in fact)
956 $request = $this->getRequest();
958 $cookieId = $request->getCookie( 'UserID' );
959 $sessId = $request->getSessionData( 'wsUserID' );
961 if ( $cookieId !== null ) {
962 $sId = intval( $cookieId );
963 if( $sessId !== null && $cookieId != $sessId ) {
964 $this->loadDefaults(); // Possible collision!
965 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
966 cookie user ID ($sId) don't match!" );
969 $request->setSessionData( 'wsUserID', $sId );
970 } elseif ( $sessId !== null && $sessId != 0 ) {
973 $this->loadDefaults();
977 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
978 $sName = $request->getSessionData( 'wsUserName' );
979 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
980 $sName = $request->getCookie( 'UserName' );
981 $request->setSessionData( 'wsUserName', $sName );
983 $this->loadDefaults();
987 $proposedUser = User
::newFromId( $sId );
988 if ( !$proposedUser->isLoggedIn() ) {
990 $this->loadDefaults();
994 global $wgBlockDisablesLogin;
995 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
996 # User blocked and we've disabled blocked user logins
997 $this->loadDefaults();
1001 if ( $request->getSessionData( 'wsToken' ) ) {
1002 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
1004 } elseif ( $request->getCookie( 'Token' ) ) {
1005 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
1008 # No session or persistent login cookie
1009 $this->loadDefaults();
1013 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1014 $this->loadFromUserObject( $proposedUser );
1015 $request->setSessionData( 'wsToken', $this->mToken
);
1016 wfDebug( "User: logged in from $from\n" );
1019 # Invalid credentials
1020 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1021 $this->loadDefaults();
1027 * Load user and user_group data from the database.
1028 * $this->mId must be set, this is how the user is identified.
1030 * @return Bool True if the user exists, false if the user is anonymous
1032 public function loadFromDatabase() {
1034 $this->mId
= intval( $this->mId
);
1036 /** Anonymous user */
1038 $this->loadDefaults();
1042 $dbr = wfGetDB( DB_MASTER
);
1043 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1045 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1047 if ( $s !== false ) {
1048 # Initialise user table data
1049 $this->loadFromRow( $s );
1050 $this->mGroups
= null; // deferred
1051 $this->getEditCount(); // revalidation for nulls
1056 $this->loadDefaults();
1062 * Initialize this object from a row from the user table.
1064 * @param $row Array Row from the user table to load.
1066 public function loadFromRow( $row ) {
1069 $this->mGroups
= null; // deferred
1071 if ( isset( $row->user_name
) ) {
1072 $this->mName
= $row->user_name
;
1073 $this->mFrom
= 'name';
1074 $this->setItemLoaded( 'name' );
1079 if ( isset( $row->user_real_name
) ) {
1080 $this->mRealName
= $row->user_real_name
;
1081 $this->setItemLoaded( 'realname' );
1086 if ( isset( $row->user_id
) ) {
1087 $this->mId
= intval( $row->user_id
);
1088 $this->mFrom
= 'id';
1089 $this->setItemLoaded( 'id' );
1094 if ( isset( $row->user_editcount
) ) {
1095 $this->mEditCount
= $row->user_editcount
;
1100 if ( isset( $row->user_password
) ) {
1101 $this->mPassword
= $row->user_password
;
1102 $this->mNewpassword
= $row->user_newpassword
;
1103 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1104 $this->mEmail
= $row->user_email
;
1105 if ( isset( $row->user_options
) ) {
1106 $this->decodeOptions( $row->user_options
);
1108 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1109 $this->mToken
= $row->user_token
;
1110 if ( $this->mToken
== '' ) {
1111 $this->mToken
= null;
1113 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1114 $this->mEmailToken
= $row->user_email_token
;
1115 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1116 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1122 $this->mLoadedItems
= true;
1127 * Load the data for this user object from another user object.
1131 protected function loadFromUserObject( $user ) {
1133 $user->loadGroups();
1134 $user->loadOptions();
1135 foreach ( self
::$mCacheVars as $var ) {
1136 $this->$var = $user->$var;
1141 * Load the groups from the database if they aren't already loaded.
1143 private function loadGroups() {
1144 if ( is_null( $this->mGroups
) ) {
1145 $dbr = wfGetDB( DB_MASTER
);
1146 $res = $dbr->select( 'user_groups',
1147 array( 'ug_group' ),
1148 array( 'ug_user' => $this->mId
),
1150 $this->mGroups
= array();
1151 foreach ( $res as $row ) {
1152 $this->mGroups
[] = $row->ug_group
;
1158 * Add the user to the group if he/she meets given criteria.
1160 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1161 * possible to remove manually via Special:UserRights. In such case it
1162 * will not be re-added automatically. The user will also not lose the
1163 * group if they no longer meet the criteria.
1165 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1167 * @return array Array of groups the user has been promoted to.
1169 * @see $wgAutopromoteOnce
1171 public function addAutopromoteOnceGroups( $event ) {
1172 global $wgAutopromoteOnceLogInRC;
1174 $toPromote = array();
1175 if ( $this->getId() ) {
1176 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1177 if ( count( $toPromote ) ) {
1178 $oldGroups = $this->getGroups(); // previous groups
1179 foreach ( $toPromote as $group ) {
1180 $this->addGroup( $group );
1182 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1184 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1185 $log->addEntry( 'autopromote',
1186 $this->getUserPage(),
1188 // These group names are "list to texted"-ed in class LogPage.
1189 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1197 * Clear various cached data stored in this object.
1198 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1199 * given source. May be "name", "id", "defaults", "session", or false for
1202 public function clearInstanceCache( $reloadFrom = false ) {
1203 $this->mNewtalk
= -1;
1204 $this->mDatePreference
= null;
1205 $this->mBlockedby
= -1; # Unset
1206 $this->mHash
= false;
1207 $this->mRights
= null;
1208 $this->mEffectiveGroups
= null;
1209 $this->mImplicitGroups
= null;
1210 $this->mOptions
= null;
1212 if ( $reloadFrom ) {
1213 $this->mLoadedItems
= array();
1214 $this->mFrom
= $reloadFrom;
1219 * Combine the language default options with any site-specific options
1220 * and add the default language variants.
1222 * @return Array of String options
1224 public static function getDefaultOptions() {
1225 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1227 $defOpt = $wgDefaultUserOptions;
1228 # default language setting
1229 $variant = $wgContLang->getDefaultVariant();
1230 $defOpt['variant'] = $variant;
1231 $defOpt['language'] = $variant;
1232 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1233 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1235 $defOpt['skin'] = $wgDefaultSkin;
1237 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1238 // but that breaks the parser tests because they rely on being able to change $wgContLang
1239 // mid-request and see that change reflected in the return value of this function.
1240 // Which is insane and would never happen during normal MW operation, but is also not
1241 // likely to get fixed unless and until we context-ify everything.
1242 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1243 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1249 * Get a given default option value.
1251 * @param $opt String Name of option to retrieve
1252 * @return String Default option value
1254 public static function getDefaultOption( $opt ) {
1255 $defOpts = self
::getDefaultOptions();
1256 if( isset( $defOpts[$opt] ) ) {
1257 return $defOpts[$opt];
1265 * Get blocking information
1266 * @param $bFromSlave Bool Whether to check the slave database first. To
1267 * improve performance, non-critical checks are done
1268 * against slaves. Check when actually saving should be
1269 * done against master.
1271 private function getBlockedStatus( $bFromSlave = true ) {
1272 global $wgProxyWhitelist, $wgUser;
1274 if ( -1 != $this->mBlockedby
) {
1278 wfProfileIn( __METHOD__
);
1279 wfDebug( __METHOD__
.": checking...\n" );
1281 // Initialize data...
1282 // Otherwise something ends up stomping on $this->mBlockedby when
1283 // things get lazy-loaded later, causing false positive block hits
1284 // due to -1 !== 0. Probably session-related... Nothing should be
1285 // overwriting mBlockedby, surely?
1288 # We only need to worry about passing the IP address to the Block generator if the
1289 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1290 # know which IP address they're actually coming from
1291 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1292 $ip = $this->getRequest()->getIP();
1298 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1301 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1302 && !in_array( $ip, $wgProxyWhitelist ) )
1305 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1307 $block->setBlocker( wfMsg( 'proxyblocker' ) );
1308 $block->mReason
= wfMsg( 'proxyblockreason' );
1309 $block->setTarget( $ip );
1310 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1312 $block->setBlocker( wfMsg( 'sorbs' ) );
1313 $block->mReason
= wfMsg( 'sorbsreason' );
1314 $block->setTarget( $ip );
1318 if ( $block instanceof Block
) {
1319 wfDebug( __METHOD__
. ": Found block.\n" );
1320 $this->mBlock
= $block;
1321 $this->mBlockedby
= $block->getByName();
1322 $this->mBlockreason
= $block->mReason
;
1323 $this->mHideName
= $block->mHideName
;
1324 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1326 $this->mBlockedby
= '';
1327 $this->mHideName
= 0;
1328 $this->mAllowUsertalk
= false;
1332 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1334 wfProfileOut( __METHOD__
);
1338 * Whether the given IP is in a DNS blacklist.
1340 * @param $ip String IP to check
1341 * @param $checkWhitelist Bool: whether to check the whitelist first
1342 * @return Bool True if blacklisted.
1344 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1345 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1346 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1348 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1351 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1354 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1355 return $this->inDnsBlacklist( $ip, $urls );
1359 * Whether the given IP is in a given DNS blacklist.
1361 * @param $ip String IP to check
1362 * @param $bases String|Array of Strings: URL of the DNS blacklist
1363 * @return Bool True if blacklisted.
1365 public function inDnsBlacklist( $ip, $bases ) {
1366 wfProfileIn( __METHOD__
);
1369 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1370 if( IP
::isIPv4( $ip ) ) {
1371 # Reverse IP, bug 21255
1372 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1374 foreach( (array)$bases as $base ) {
1376 # If we have an access key, use that too (ProjectHoneypot, etc.)
1377 if( is_array( $base ) ) {
1378 if( count( $base ) >= 2 ) {
1379 # Access key is 1, base URL is 0
1380 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1382 $host = "$ipReversed.{$base[0]}";
1385 $host = "$ipReversed.$base";
1389 $ipList = gethostbynamel( $host );
1392 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1396 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1401 wfProfileOut( __METHOD__
);
1406 * Check if an IP address is in the local proxy list
1412 public static function isLocallyBlockedProxy( $ip ) {
1413 global $wgProxyList;
1415 if ( !$wgProxyList ) {
1418 wfProfileIn( __METHOD__
);
1420 if ( !is_array( $wgProxyList ) ) {
1421 # Load from the specified file
1422 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1425 if ( !is_array( $wgProxyList ) ) {
1427 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1429 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1430 # Old-style flipped proxy list
1435 wfProfileOut( __METHOD__
);
1440 * Is this user subject to rate limiting?
1442 * @return Bool True if rate limited
1444 public function isPingLimitable() {
1445 global $wgRateLimitsExcludedIPs;
1446 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1447 // No other good way currently to disable rate limits
1448 // for specific IPs. :P
1449 // But this is a crappy hack and should die.
1452 return !$this->isAllowed('noratelimit');
1456 * Primitive rate limits: enforce maximum actions per time period
1457 * to put a brake on flooding.
1459 * @note When using a shared cache like memcached, IP-address
1460 * last-hit counters will be shared across wikis.
1462 * @param $action String Action to enforce; 'edit' if unspecified
1463 * @return Bool True if a rate limiter was tripped
1465 public function pingLimiter( $action = 'edit' ) {
1466 # Call the 'PingLimiter' hook
1468 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1472 global $wgRateLimits;
1473 if( !isset( $wgRateLimits[$action] ) ) {
1477 # Some groups shouldn't trigger the ping limiter, ever
1478 if( !$this->isPingLimitable() )
1481 global $wgMemc, $wgRateLimitLog;
1482 wfProfileIn( __METHOD__
);
1484 $limits = $wgRateLimits[$action];
1486 $id = $this->getId();
1487 $ip = $this->getRequest()->getIP();
1490 if( isset( $limits['anon'] ) && $id == 0 ) {
1491 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1494 if( isset( $limits['user'] ) && $id != 0 ) {
1495 $userLimit = $limits['user'];
1497 if( $this->isNewbie() ) {
1498 if( isset( $limits['newbie'] ) && $id != 0 ) {
1499 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1501 if( isset( $limits['ip'] ) ) {
1502 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1505 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1506 $subnet = $matches[1];
1507 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1510 // Check for group-specific permissions
1511 // If more than one group applies, use the group with the highest limit
1512 foreach ( $this->getGroups() as $group ) {
1513 if ( isset( $limits[$group] ) ) {
1514 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1515 $userLimit = $limits[$group];
1519 // Set the user limit key
1520 if ( $userLimit !== false ) {
1521 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1522 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1526 foreach( $keys as $key => $limit ) {
1527 list( $max, $period ) = $limit;
1528 $summary = "(limit $max in {$period}s)";
1529 $count = $wgMemc->get( $key );
1532 if( $count >= $max ) {
1533 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1534 if( $wgRateLimitLog ) {
1535 wfSuppressWarnings();
1536 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1537 wfRestoreWarnings();
1541 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1544 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1545 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1547 $wgMemc->incr( $key );
1550 wfProfileOut( __METHOD__
);
1555 * Check if user is blocked
1557 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1558 * @return Bool True if blocked, false otherwise
1560 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1561 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1565 * Get the block affecting the user, or null if the user is not blocked
1567 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1568 * @return Block|null
1570 public function getBlock( $bFromSlave = true ){
1571 $this->getBlockedStatus( $bFromSlave );
1572 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1576 * Check if user is blocked from editing a particular article
1578 * @param $title Title to check
1579 * @param $bFromSlave Bool whether to check the slave database instead of the master
1582 function isBlockedFrom( $title, $bFromSlave = false ) {
1583 global $wgBlockAllowsUTEdit;
1584 wfProfileIn( __METHOD__
);
1586 $blocked = $this->isBlocked( $bFromSlave );
1587 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1588 # If a user's name is suppressed, they cannot make edits anywhere
1589 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1590 $title->getNamespace() == NS_USER_TALK
) {
1592 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1595 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1597 wfProfileOut( __METHOD__
);
1602 * If user is blocked, return the name of the user who placed the block
1603 * @return String name of blocker
1605 public function blockedBy() {
1606 $this->getBlockedStatus();
1607 return $this->mBlockedby
;
1611 * If user is blocked, return the specified reason for the block
1612 * @return String Blocking reason
1614 public function blockedFor() {
1615 $this->getBlockedStatus();
1616 return $this->mBlockreason
;
1620 * If user is blocked, return the ID for the block
1621 * @return Int Block ID
1623 public function getBlockId() {
1624 $this->getBlockedStatus();
1625 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1629 * Check if user is blocked on all wikis.
1630 * Do not use for actual edit permission checks!
1631 * This is intented for quick UI checks.
1633 * @param $ip String IP address, uses current client if none given
1634 * @return Bool True if blocked, false otherwise
1636 public function isBlockedGlobally( $ip = '' ) {
1637 if( $this->mBlockedGlobally
!== null ) {
1638 return $this->mBlockedGlobally
;
1640 // User is already an IP?
1641 if( IP
::isIPAddress( $this->getName() ) ) {
1642 $ip = $this->getName();
1644 $ip = $this->getRequest()->getIP();
1647 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1648 $this->mBlockedGlobally
= (bool)$blocked;
1649 return $this->mBlockedGlobally
;
1653 * Check if user account is locked
1655 * @return Bool True if locked, false otherwise
1657 public function isLocked() {
1658 if( $this->mLocked
!== null ) {
1659 return $this->mLocked
;
1662 $authUser = $wgAuth->getUserInstance( $this );
1663 $this->mLocked
= (bool)$authUser->isLocked();
1664 return $this->mLocked
;
1668 * Check if user account is hidden
1670 * @return Bool True if hidden, false otherwise
1672 public function isHidden() {
1673 if( $this->mHideName
!== null ) {
1674 return $this->mHideName
;
1676 $this->getBlockedStatus();
1677 if( !$this->mHideName
) {
1679 $authUser = $wgAuth->getUserInstance( $this );
1680 $this->mHideName
= (bool)$authUser->isHidden();
1682 return $this->mHideName
;
1686 * Get the user's ID.
1687 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1689 public function getId() {
1690 if( $this->mId
=== null && $this->mName
!== null
1691 && User
::isIP( $this->mName
) ) {
1692 // Special case, we know the user is anonymous
1694 } elseif( !$this->isItemLoaded( 'id' ) ) {
1695 // Don't load if this was initialized from an ID
1702 * Set the user and reload all fields according to a given ID
1703 * @param $v Int User ID to reload
1705 public function setId( $v ) {
1707 $this->clearInstanceCache( 'id' );
1711 * Get the user name, or the IP of an anonymous user
1712 * @return String User's name or IP address
1714 public function getName() {
1715 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1716 # Special case optimisation
1717 return $this->mName
;
1720 if ( $this->mName
=== false ) {
1722 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1724 return $this->mName
;
1729 * Set the user name.
1731 * This does not reload fields from the database according to the given
1732 * name. Rather, it is used to create a temporary "nonexistent user" for
1733 * later addition to the database. It can also be used to set the IP
1734 * address for an anonymous user to something other than the current
1737 * @note User::newFromName() has rougly the same function, when the named user
1739 * @param $str String New user name to set
1741 public function setName( $str ) {
1743 $this->mName
= $str;
1747 * Get the user's name escaped by underscores.
1748 * @return String Username escaped by underscores.
1750 public function getTitleKey() {
1751 return str_replace( ' ', '_', $this->getName() );
1755 * Check if the user has new messages.
1756 * @return Bool True if the user has new messages
1758 public function getNewtalk() {
1761 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1762 if( $this->mNewtalk
=== -1 ) {
1763 $this->mNewtalk
= false; # reset talk page status
1765 # Check memcached separately for anons, who have no
1766 # entire User object stored in there.
1769 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1770 $newtalk = $wgMemc->get( $key );
1771 if( strval( $newtalk ) !== '' ) {
1772 $this->mNewtalk
= (bool)$newtalk;
1774 // Since we are caching this, make sure it is up to date by getting it
1776 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1777 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1780 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1784 return (bool)$this->mNewtalk
;
1788 * Return the talk page(s) this user has new messages on.
1789 * @return Array of String page URLs
1791 public function getNewMessageLinks() {
1793 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1795 } elseif( !$this->getNewtalk() ) {
1798 $utp = $this->getTalkPage();
1799 $dbr = wfGetDB( DB_SLAVE
);
1800 // Get the "last viewed rev" timestamp from the oldest message notification
1801 $timestamp = $dbr->selectField( 'user_newtalk',
1802 'MIN(user_last_timestamp)',
1803 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1805 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1806 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1810 * Internal uncached check for new messages
1813 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1814 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1815 * @param $fromMaster Bool true to fetch from the master, false for a slave
1816 * @return Bool True if the user has new messages
1818 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1819 if ( $fromMaster ) {
1820 $db = wfGetDB( DB_MASTER
);
1822 $db = wfGetDB( DB_SLAVE
);
1824 $ok = $db->selectField( 'user_newtalk', $field,
1825 array( $field => $id ), __METHOD__
);
1826 return $ok !== false;
1830 * Add or update the new messages flag
1831 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1832 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1833 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1834 * @return Bool True if successful, false otherwise
1836 protected function updateNewtalk( $field, $id, $curRev = null ) {
1837 // Get timestamp of the talk page revision prior to the current one
1838 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1839 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1840 // Mark the user as having new messages since this revision
1841 $dbw = wfGetDB( DB_MASTER
);
1842 $dbw->insert( 'user_newtalk',
1843 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1846 if ( $dbw->affectedRows() ) {
1847 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1850 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1856 * Clear the new messages flag for the given user
1857 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1858 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1859 * @return Bool True if successful, false otherwise
1861 protected function deleteNewtalk( $field, $id ) {
1862 $dbw = wfGetDB( DB_MASTER
);
1863 $dbw->delete( 'user_newtalk',
1864 array( $field => $id ),
1866 if ( $dbw->affectedRows() ) {
1867 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1870 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1876 * Update the 'You have new messages!' status.
1877 * @param $val Bool Whether the user has new messages
1878 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1880 public function setNewtalk( $val, $curRev = null ) {
1881 if( wfReadOnly() ) {
1886 $this->mNewtalk
= $val;
1888 if( $this->isAnon() ) {
1890 $id = $this->getName();
1893 $id = $this->getId();
1898 $changed = $this->updateNewtalk( $field, $id, $curRev );
1900 $changed = $this->deleteNewtalk( $field, $id );
1903 if( $this->isAnon() ) {
1904 // Anons have a separate memcached space, since
1905 // user records aren't kept for them.
1906 $key = wfMemcKey( 'newtalk', 'ip', $id );
1907 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1910 $this->invalidateCache();
1915 * Generate a current or new-future timestamp to be stored in the
1916 * user_touched field when we update things.
1917 * @return String Timestamp in TS_MW format
1919 private static function newTouchedTimestamp() {
1920 global $wgClockSkewFudge;
1921 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1925 * Clear user data from memcached.
1926 * Use after applying fun updates to the database; caller's
1927 * responsibility to update user_touched if appropriate.
1929 * Called implicitly from invalidateCache() and saveSettings().
1931 private function clearSharedCache() {
1935 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1940 * Immediately touch the user data cache for this account.
1941 * Updates user_touched field, and removes account data from memcached
1942 * for reload on the next hit.
1944 public function invalidateCache() {
1945 if( wfReadOnly() ) {
1950 $this->mTouched
= self
::newTouchedTimestamp();
1952 $dbw = wfGetDB( DB_MASTER
);
1954 // Prevent contention slams by checking user_touched first
1955 $now = $dbw->timestamp( $this->mTouched
);
1956 $needsPurge = $dbw->selectField( 'user', '1',
1957 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1959 if ( $needsPurge ) {
1960 $dbw->update( 'user',
1961 array( 'user_touched' => $now ),
1962 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1967 $this->clearSharedCache();
1972 * Validate the cache for this account.
1973 * @param $timestamp String A timestamp in TS_MW format
1977 public function validateCache( $timestamp ) {
1979 return ( $timestamp >= $this->mTouched
);
1983 * Get the user touched timestamp
1984 * @return String timestamp
1986 public function getTouched() {
1988 return $this->mTouched
;
1992 * Set the password and reset the random token.
1993 * Calls through to authentication plugin if necessary;
1994 * will have no effect if the auth plugin refuses to
1995 * pass the change through or if the legal password
1998 * As a special case, setting the password to null
1999 * wipes it, so the account cannot be logged in until
2000 * a new password is set, for instance via e-mail.
2002 * @param $str String New password to set
2003 * @throws PasswordError on failure
2007 public function setPassword( $str ) {
2010 if( $str !== null ) {
2011 if( !$wgAuth->allowPasswordChange() ) {
2012 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
2015 if( !$this->isValidPassword( $str ) ) {
2016 global $wgMinimalPasswordLength;
2017 $valid = $this->getPasswordValidity( $str );
2018 if ( is_array( $valid ) ) {
2019 $message = array_shift( $valid );
2023 $params = array( $wgMinimalPasswordLength );
2025 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
2029 if( !$wgAuth->setPassword( $this, $str ) ) {
2030 throw new PasswordError( wfMsg( 'externaldberror' ) );
2033 $this->setInternalPassword( $str );
2039 * Set the password and reset the random token unconditionally.
2041 * @param $str String New password to set
2043 public function setInternalPassword( $str ) {
2047 if( $str === null ) {
2048 // Save an invalid hash...
2049 $this->mPassword
= '';
2051 $this->mPassword
= self
::crypt( $str );
2053 $this->mNewpassword
= '';
2054 $this->mNewpassTime
= null;
2058 * Get the user's current token.
2059 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2060 * @return String Token
2062 public function getToken( $forceCreation = true ) {
2064 if ( !$this->mToken
&& $forceCreation ) {
2067 return $this->mToken
;
2071 * Set the random token (used for persistent authentication)
2072 * Called from loadDefaults() among other places.
2074 * @param $token String|bool If specified, set the token to this value
2076 public function setToken( $token = false ) {
2079 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2081 $this->mToken
= $token;
2086 * Set the password for a password reminder or new account email
2088 * @param $str String New password to set
2089 * @param $throttle Bool If true, reset the throttle timestamp to the present
2091 public function setNewpassword( $str, $throttle = true ) {
2093 $this->mNewpassword
= self
::crypt( $str );
2095 $this->mNewpassTime
= wfTimestampNow();
2100 * Has password reminder email been sent within the last
2101 * $wgPasswordReminderResendTime hours?
2104 public function isPasswordReminderThrottled() {
2105 global $wgPasswordReminderResendTime;
2107 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2110 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2111 return time() < $expiry;
2115 * Get the user's e-mail address
2116 * @return String User's email address
2118 public function getEmail() {
2120 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2121 return $this->mEmail
;
2125 * Get the timestamp of the user's e-mail authentication
2126 * @return String TS_MW timestamp
2128 public function getEmailAuthenticationTimestamp() {
2130 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2131 return $this->mEmailAuthenticated
;
2135 * Set the user's e-mail address
2136 * @param $str String New e-mail address
2138 public function setEmail( $str ) {
2140 if( $str == $this->mEmail
) {
2143 $this->mEmail
= $str;
2144 $this->invalidateEmail();
2145 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2149 * Set the user's e-mail address and a confirmation mail if needed.
2152 * @param $str String New e-mail address
2155 public function setEmailWithConfirmation( $str ) {
2156 global $wgEnableEmail, $wgEmailAuthentication;
2158 if ( !$wgEnableEmail ) {
2159 return Status
::newFatal( 'emaildisabled' );
2162 $oldaddr = $this->getEmail();
2163 if ( $str === $oldaddr ) {
2164 return Status
::newGood( true );
2167 $this->setEmail( $str );
2169 if ( $str !== '' && $wgEmailAuthentication ) {
2170 # Send a confirmation request to the new address if needed
2171 $type = $oldaddr != '' ?
'changed' : 'set';
2172 $result = $this->sendConfirmationMail( $type );
2173 if ( $result->isGood() ) {
2174 # Say the the caller that a confirmation mail has been sent
2175 $result->value
= 'eauth';
2178 $result = Status
::newGood( true );
2185 * Get the user's real name
2186 * @return String User's real name
2188 public function getRealName() {
2189 if ( !$this->isItemLoaded( 'realname' ) ) {
2193 return $this->mRealName
;
2197 * Set the user's real name
2198 * @param $str String New real name
2200 public function setRealName( $str ) {
2202 $this->mRealName
= $str;
2206 * Get the user's current setting for a given option.
2208 * @param $oname String The option to check
2209 * @param $defaultOverride String A default value returned if the option does not exist
2210 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2211 * @return String User's current value for the option
2212 * @see getBoolOption()
2213 * @see getIntOption()
2215 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2216 global $wgHiddenPrefs;
2217 $this->loadOptions();
2219 if ( is_null( $this->mOptions
) ) {
2220 if($defaultOverride != '') {
2221 return $defaultOverride;
2223 $this->mOptions
= User
::getDefaultOptions();
2226 # We want 'disabled' preferences to always behave as the default value for
2227 # users, even if they have set the option explicitly in their settings (ie they
2228 # set it, and then it was disabled removing their ability to change it). But
2229 # we don't want to erase the preferences in the database in case the preference
2230 # is re-enabled again. So don't touch $mOptions, just override the returned value
2231 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2232 return self
::getDefaultOption( $oname );
2235 if ( array_key_exists( $oname, $this->mOptions
) ) {
2236 return $this->mOptions
[$oname];
2238 return $defaultOverride;
2243 * Get all user's options
2247 public function getOptions() {
2248 global $wgHiddenPrefs;
2249 $this->loadOptions();
2250 $options = $this->mOptions
;
2252 # We want 'disabled' preferences to always behave as the default value for
2253 # users, even if they have set the option explicitly in their settings (ie they
2254 # set it, and then it was disabled removing their ability to change it). But
2255 # we don't want to erase the preferences in the database in case the preference
2256 # is re-enabled again. So don't touch $mOptions, just override the returned value
2257 foreach( $wgHiddenPrefs as $pref ){
2258 $default = self
::getDefaultOption( $pref );
2259 if( $default !== null ){
2260 $options[$pref] = $default;
2268 * Get the user's current setting for a given option, as a boolean value.
2270 * @param $oname String The option to check
2271 * @return Bool User's current value for the option
2274 public function getBoolOption( $oname ) {
2275 return (bool)$this->getOption( $oname );
2279 * Get the user's current setting for a given option, as a boolean value.
2281 * @param $oname String The option to check
2282 * @param $defaultOverride Int A default value returned if the option does not exist
2283 * @return Int User's current value for the option
2286 public function getIntOption( $oname, $defaultOverride=0 ) {
2287 $val = $this->getOption( $oname );
2289 $val = $defaultOverride;
2291 return intval( $val );
2295 * Set the given option for a user.
2297 * @param $oname String The option to set
2298 * @param $val mixed New value to set
2300 public function setOption( $oname, $val ) {
2302 $this->loadOptions();
2304 // Explicitly NULL values should refer to defaults
2305 if( is_null( $val ) ) {
2306 $defaultOption = self
::getDefaultOption( $oname );
2307 if( !is_null( $defaultOption ) ) {
2308 $val = $defaultOption;
2312 $this->mOptions
[$oname] = $val;
2316 * Reset all options to the site defaults
2318 public function resetOptions() {
2321 $this->mOptions
= self
::getDefaultOptions();
2322 $this->mOptionsLoaded
= true;
2326 * Get the user's preferred date format.
2327 * @return String User's preferred date format
2329 public function getDatePreference() {
2330 // Important migration for old data rows
2331 if ( is_null( $this->mDatePreference
) ) {
2333 $value = $this->getOption( 'date' );
2334 $map = $wgLang->getDatePreferenceMigrationMap();
2335 if ( isset( $map[$value] ) ) {
2336 $value = $map[$value];
2338 $this->mDatePreference
= $value;
2340 return $this->mDatePreference
;
2344 * Get the user preferred stub threshold
2348 public function getStubThreshold() {
2349 global $wgMaxArticleSize; # Maximum article size, in Kb
2350 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2351 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2352 # If they have set an impossible value, disable the preference
2353 # so we can use the parser cache again.
2360 * Get the permissions this user has.
2361 * @return Array of String permission names
2363 public function getRights() {
2364 if ( is_null( $this->mRights
) ) {
2365 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2366 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2367 // Force reindexation of rights when a hook has unset one of them
2368 $this->mRights
= array_values( $this->mRights
);
2370 return $this->mRights
;
2374 * Get the list of explicit group memberships this user has.
2375 * The implicit * and user groups are not included.
2376 * @return Array of String internal group names
2378 public function getGroups() {
2380 $this->loadGroups();
2381 return $this->mGroups
;
2385 * Get the list of implicit group memberships this user has.
2386 * This includes all explicit groups, plus 'user' if logged in,
2387 * '*' for all accounts, and autopromoted groups
2388 * @param $recache Bool Whether to avoid the cache
2389 * @return Array of String internal group names
2391 public function getEffectiveGroups( $recache = false ) {
2392 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2393 wfProfileIn( __METHOD__
);
2394 $this->mEffectiveGroups
= array_unique( array_merge(
2395 $this->getGroups(), // explicit groups
2396 $this->getAutomaticGroups( $recache ) // implicit groups
2398 # Hook for additional groups
2399 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2400 wfProfileOut( __METHOD__
);
2402 return $this->mEffectiveGroups
;
2406 * Get the list of implicit group memberships this user has.
2407 * This includes 'user' if logged in, '*' for all accounts,
2408 * and autopromoted groups
2409 * @param $recache Bool Whether to avoid the cache
2410 * @return Array of String internal group names
2412 public function getAutomaticGroups( $recache = false ) {
2413 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2414 wfProfileIn( __METHOD__
);
2415 $this->mImplicitGroups
= array( '*' );
2416 if ( $this->getId() ) {
2417 $this->mImplicitGroups
[] = 'user';
2419 $this->mImplicitGroups
= array_unique( array_merge(
2420 $this->mImplicitGroups
,
2421 Autopromote
::getAutopromoteGroups( $this )
2425 # Assure data consistency with rights/groups,
2426 # as getEffectiveGroups() depends on this function
2427 $this->mEffectiveGroups
= null;
2429 wfProfileOut( __METHOD__
);
2431 return $this->mImplicitGroups
;
2435 * Returns the groups the user has belonged to.
2437 * The user may still belong to the returned groups. Compare with getGroups().
2439 * The function will not return groups the user had belonged to before MW 1.17
2441 * @return array Names of the groups the user has belonged to.
2443 public function getFormerGroups() {
2444 if( is_null( $this->mFormerGroups
) ) {
2445 $dbr = wfGetDB( DB_MASTER
);
2446 $res = $dbr->select( 'user_former_groups',
2447 array( 'ufg_group' ),
2448 array( 'ufg_user' => $this->mId
),
2450 $this->mFormerGroups
= array();
2451 foreach( $res as $row ) {
2452 $this->mFormerGroups
[] = $row->ufg_group
;
2455 return $this->mFormerGroups
;
2459 * Get the user's edit count.
2462 public function getEditCount() {
2463 if( $this->getId() ) {
2464 if ( !isset( $this->mEditCount
) ) {
2465 /* Populate the count, if it has not been populated yet */
2466 $this->mEditCount
= User
::edits( $this->mId
);
2468 return $this->mEditCount
;
2476 * Add the user to the given group.
2477 * This takes immediate effect.
2478 * @param $group String Name of the group to add
2480 public function addGroup( $group ) {
2481 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2482 $dbw = wfGetDB( DB_MASTER
);
2483 if( $this->getId() ) {
2484 $dbw->insert( 'user_groups',
2486 'ug_user' => $this->getID(),
2487 'ug_group' => $group,
2490 array( 'IGNORE' ) );
2493 $this->loadGroups();
2494 $this->mGroups
[] = $group;
2495 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2497 $this->invalidateCache();
2501 * Remove the user from the given group.
2502 * This takes immediate effect.
2503 * @param $group String Name of the group to remove
2505 public function removeGroup( $group ) {
2507 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2508 $dbw = wfGetDB( DB_MASTER
);
2509 $dbw->delete( 'user_groups',
2511 'ug_user' => $this->getID(),
2512 'ug_group' => $group,
2514 // Remember that the user was in this group
2515 $dbw->insert( 'user_former_groups',
2517 'ufg_user' => $this->getID(),
2518 'ufg_group' => $group,
2521 array( 'IGNORE' ) );
2523 $this->loadGroups();
2524 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2525 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2527 $this->invalidateCache();
2531 * Get whether the user is logged in
2534 public function isLoggedIn() {
2535 return $this->getID() != 0;
2539 * Get whether the user is anonymous
2542 public function isAnon() {
2543 return !$this->isLoggedIn();
2547 * Check if user is allowed to access a feature / make an action
2549 * @internal param \String $varargs permissions to test
2550 * @return Boolean: True if user is allowed to perform *any* of the given actions
2554 public function isAllowedAny( /*...*/ ){
2555 $permissions = func_get_args();
2556 foreach( $permissions as $permission ){
2557 if( $this->isAllowed( $permission ) ){
2566 * @internal param $varargs string
2567 * @return bool True if the user is allowed to perform *all* of the given actions
2569 public function isAllowedAll( /*...*/ ){
2570 $permissions = func_get_args();
2571 foreach( $permissions as $permission ){
2572 if( !$this->isAllowed( $permission ) ){
2580 * Internal mechanics of testing a permission
2581 * @param $action String
2584 public function isAllowed( $action = '' ) {
2585 if ( $action === '' ) {
2586 return true; // In the spirit of DWIM
2588 # Patrolling may not be enabled
2589 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2590 global $wgUseRCPatrol, $wgUseNPPatrol;
2591 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2594 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2595 # by misconfiguration: 0 == 'foo'
2596 return in_array( $action, $this->getRights(), true );
2600 * Check whether to enable recent changes patrol features for this user
2601 * @return Boolean: True or false
2603 public function useRCPatrol() {
2604 global $wgUseRCPatrol;
2605 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2609 * Check whether to enable new pages patrol features for this user
2610 * @return Bool True or false
2612 public function useNPPatrol() {
2613 global $wgUseRCPatrol, $wgUseNPPatrol;
2614 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2618 * Get the WebRequest object to use with this object
2620 * @return WebRequest
2622 public function getRequest() {
2623 if ( $this->mRequest
) {
2624 return $this->mRequest
;
2632 * Get the current skin, loading it if required
2633 * @return Skin The current skin
2634 * @todo FIXME: Need to check the old failback system [AV]
2635 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2637 public function getSkin() {
2638 wfDeprecated( __METHOD__
, '1.18' );
2639 return RequestContext
::getMain()->getSkin();
2643 * Get a WatchedItem for this user and $title.
2645 * @param $title Title
2646 * @return WatchedItem
2648 public function getWatchedItem( $title ) {
2649 $key = $title->getNamespace() . ':' . $title->getDBkey();
2651 if ( isset( $this->mWatchedItems
[$key] ) ) {
2652 return $this->mWatchedItems
[$key];
2655 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2656 $this->mWatchedItems
= array();
2659 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2660 return $this->mWatchedItems
[$key];
2664 * Check the watched status of an article.
2665 * @param $title Title of the article to look at
2668 public function isWatched( $title ) {
2669 return $this->getWatchedItem( $title )->isWatched();
2674 * @param $title Title of the article to look at
2676 public function addWatch( $title ) {
2677 $this->getWatchedItem( $title )->addWatch();
2678 $this->invalidateCache();
2682 * Stop watching an article.
2683 * @param $title Title of the article to look at
2685 public function removeWatch( $title ) {
2686 $this->getWatchedItem( $title )->removeWatch();
2687 $this->invalidateCache();
2691 * Clear the user's notification timestamp for the given title.
2692 * If e-notif e-mails are on, they will receive notification mails on
2693 * the next change of the page if it's watched etc.
2694 * @param $title Title of the article to look at
2696 public function clearNotification( &$title ) {
2697 global $wgUseEnotif, $wgShowUpdatedMarker;
2699 # Do nothing if the database is locked to writes
2700 if( wfReadOnly() ) {
2704 if( $title->getNamespace() == NS_USER_TALK
&&
2705 $title->getText() == $this->getName() ) {
2706 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2708 $this->setNewtalk( false );
2711 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2715 if( $this->isAnon() ) {
2716 // Nothing else to do...
2720 // Only update the timestamp if the page is being watched.
2721 // The query to find out if it is watched is cached both in memcached and per-invocation,
2722 // and when it does have to be executed, it can be on a slave
2723 // If this is the user's newtalk page, we always update the timestamp
2725 if ( $title->getNamespace() == NS_USER_TALK
&&
2726 $title->getText() == $this->getName() )
2731 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2735 * Resets all of the given user's page-change notification timestamps.
2736 * If e-notif e-mails are on, they will receive notification mails on
2737 * the next change of any watched page.
2739 public function clearAllNotifications() {
2740 global $wgUseEnotif, $wgShowUpdatedMarker;
2741 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2742 $this->setNewtalk( false );
2745 $id = $this->getId();
2747 $dbw = wfGetDB( DB_MASTER
);
2748 $dbw->update( 'watchlist',
2750 'wl_notificationtimestamp' => null
2751 ), array( /* WHERE */
2755 # We also need to clear here the "you have new message" notification for the own user_talk page
2756 # This is cleared one page view later in Article::viewUpdates();
2761 * Set this user's options from an encoded string
2762 * @param $str String Encoded options to import
2764 * @deprecated in 1.19 due to removal of user_options from the user table
2766 private function decodeOptions( $str ) {
2767 wfDeprecated( __METHOD__
, '1.19' );
2771 $this->mOptionsLoaded
= true;
2772 $this->mOptionOverrides
= array();
2774 // If an option is not set in $str, use the default value
2775 $this->mOptions
= self
::getDefaultOptions();
2777 $a = explode( "\n", $str );
2778 foreach ( $a as $s ) {
2780 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2781 $this->mOptions
[$m[1]] = $m[2];
2782 $this->mOptionOverrides
[$m[1]] = $m[2];
2788 * Set a cookie on the user's client. Wrapper for
2789 * WebResponse::setCookie
2790 * @param $name String Name of the cookie to set
2791 * @param $value String Value to set
2792 * @param $exp Int Expiration time, as a UNIX time value;
2793 * if 0 or not specified, use the default $wgCookieExpiration
2795 protected function setCookie( $name, $value, $exp = 0 ) {
2796 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2800 * Clear a cookie on the user's client
2801 * @param $name String Name of the cookie to clear
2803 protected function clearCookie( $name ) {
2804 $this->setCookie( $name, '', time() - 86400 );
2808 * Set the default cookies for this session on the user's client.
2810 * @param $request WebRequest object to use; $wgRequest will be used if null
2813 public function setCookies( $request = null ) {
2814 if ( $request === null ) {
2815 $request = $this->getRequest();
2819 if ( 0 == $this->mId
) return;
2820 if ( !$this->mToken
) {
2821 // When token is empty or NULL generate a new one and then save it to the database
2822 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2823 // Simply by setting every cell in the user_token column to NULL and letting them be
2824 // regenerated as users log back into the wiki.
2826 $this->saveSettings();
2829 'wsUserID' => $this->mId
,
2830 'wsToken' => $this->mToken
,
2831 'wsUserName' => $this->getName()
2834 'UserID' => $this->mId
,
2835 'UserName' => $this->getName(),
2837 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2838 $cookies['Token'] = $this->mToken
;
2840 $cookies['Token'] = false;
2843 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2845 foreach ( $session as $name => $value ) {
2846 $request->setSessionData( $name, $value );
2848 foreach ( $cookies as $name => $value ) {
2849 if ( $value === false ) {
2850 $this->clearCookie( $name );
2852 $this->setCookie( $name, $value );
2858 * Log this user out.
2860 public function logout() {
2861 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2867 * Clear the user's cookies and session, and reset the instance cache.
2870 public function doLogout() {
2871 $this->clearInstanceCache( 'defaults' );
2873 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2875 $this->clearCookie( 'UserID' );
2876 $this->clearCookie( 'Token' );
2878 # Remember when user logged out, to prevent seeing cached pages
2879 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2883 * Save this user's settings into the database.
2884 * @todo Only rarely do all these fields need to be set!
2886 public function saveSettings() {
2888 if ( wfReadOnly() ) { return; }
2889 if ( 0 == $this->mId
) { return; }
2891 $this->mTouched
= self
::newTouchedTimestamp();
2893 $dbw = wfGetDB( DB_MASTER
);
2894 $dbw->update( 'user',
2896 'user_name' => $this->mName
,
2897 'user_password' => $this->mPassword
,
2898 'user_newpassword' => $this->mNewpassword
,
2899 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2900 'user_real_name' => $this->mRealName
,
2901 'user_email' => $this->mEmail
,
2902 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2903 'user_touched' => $dbw->timestamp( $this->mTouched
),
2904 'user_token' => strval( $this->mToken
),
2905 'user_email_token' => $this->mEmailToken
,
2906 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2907 ), array( /* WHERE */
2908 'user_id' => $this->mId
2912 $this->saveOptions();
2914 wfRunHooks( 'UserSaveSettings', array( $this ) );
2915 $this->clearSharedCache();
2916 $this->getUserPage()->invalidateCache();
2920 * If only this user's username is known, and it exists, return the user ID.
2923 public function idForName() {
2924 $s = trim( $this->getName() );
2925 if ( $s === '' ) return 0;
2927 $dbr = wfGetDB( DB_SLAVE
);
2928 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2929 if ( $id === false ) {
2936 * Add a user to the database, return the user object
2938 * @param $name String Username to add
2939 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2940 * - password The user's password hash. Password logins will be disabled if this is omitted.
2941 * - newpassword Hash for a temporary password that has been mailed to the user
2942 * - email The user's email address
2943 * - email_authenticated The email authentication timestamp
2944 * - real_name The user's real name
2945 * - options An associative array of non-default options
2946 * - token Random authentication token. Do not set.
2947 * - registration Registration timestamp. Do not set.
2949 * @return User object, or null if the username already exists
2951 public static function createNew( $name, $params = array() ) {
2954 if ( isset( $params['options'] ) ) {
2955 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2956 unset( $params['options'] );
2958 $dbw = wfGetDB( DB_MASTER
);
2959 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2962 'user_id' => $seqVal,
2963 'user_name' => $name,
2964 'user_password' => $user->mPassword
,
2965 'user_newpassword' => $user->mNewpassword
,
2966 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2967 'user_email' => $user->mEmail
,
2968 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2969 'user_real_name' => $user->mRealName
,
2970 'user_token' => strval( $user->mToken
),
2971 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2972 'user_editcount' => 0,
2973 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
2975 foreach ( $params as $name => $value ) {
2976 $fields["user_$name"] = $value;
2978 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2979 if ( $dbw->affectedRows() ) {
2980 $newUser = User
::newFromId( $dbw->insertId() );
2988 * Add this existing user object to the database
2990 public function addToDatabase() {
2993 $this->mTouched
= self
::newTouchedTimestamp();
2995 $dbw = wfGetDB( DB_MASTER
);
2996 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2997 $dbw->insert( 'user',
2999 'user_id' => $seqVal,
3000 'user_name' => $this->mName
,
3001 'user_password' => $this->mPassword
,
3002 'user_newpassword' => $this->mNewpassword
,
3003 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3004 'user_email' => $this->mEmail
,
3005 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3006 'user_real_name' => $this->mRealName
,
3007 'user_token' => strval( $this->mToken
),
3008 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3009 'user_editcount' => 0,
3010 'user_touched' => $dbw->timestamp( $this->mTouched
),
3013 $this->mId
= $dbw->insertId();
3015 // Clear instance cache other than user table data, which is already accurate
3016 $this->clearInstanceCache();
3018 $this->saveOptions();
3022 * If this user is logged-in and blocked,
3023 * block any IP address they've successfully logged in from.
3024 * @return bool A block was spread
3026 public function spreadAnyEditBlock() {
3027 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3028 return $this->spreadBlock();
3034 * If this (non-anonymous) user is blocked,
3035 * block the IP address they've successfully logged in from.
3036 * @return bool A block was spread
3038 protected function spreadBlock() {
3039 wfDebug( __METHOD__
. "()\n" );
3041 if ( $this->mId
== 0 ) {
3045 $userblock = Block
::newFromTarget( $this->getName() );
3046 if ( !$userblock ) {
3050 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3054 * Generate a string which will be different for any combination of
3055 * user options which would produce different parser output.
3056 * This will be used as part of the hash key for the parser cache,
3057 * so users with the same options can share the same cached data
3060 * Extensions which require it should install 'PageRenderingHash' hook,
3061 * which will give them a chance to modify this key based on their own
3064 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3065 * @return String Page rendering hash
3067 public function getPageRenderingHash() {
3068 wfDeprecated( __METHOD__
, '1.17' );
3070 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3072 return $this->mHash
;
3075 // stubthreshold is only included below for completeness,
3076 // since it disables the parser cache, its value will always
3077 // be 0 when this function is called by parsercache.
3079 $confstr = $this->getOption( 'math' );
3080 $confstr .= '!' . $this->getStubThreshold();
3081 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3082 $confstr .= '!' . $this->getDatePreference();
3084 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3085 $confstr .= '!' . $wgLang->getCode();
3086 $confstr .= '!' . $this->getOption( 'thumbsize' );
3087 // add in language specific options, if any
3088 $extra = $wgContLang->getExtraHashOptions();
3091 // Since the skin could be overloading link(), it should be
3092 // included here but in practice, none of our skins do that.
3094 $confstr .= $wgRenderHashAppend;
3096 // Give a chance for extensions to modify the hash, if they have
3097 // extra options or other effects on the parser cache.
3098 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3100 // Make it a valid memcached key fragment
3101 $confstr = str_replace( ' ', '_', $confstr );
3102 $this->mHash
= $confstr;
3107 * Get whether the user is explicitly blocked from account creation.
3108 * @return Bool|Block
3110 public function isBlockedFromCreateAccount() {
3111 $this->getBlockedStatus();
3112 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3113 return $this->mBlock
;
3116 # bug 13611: if the IP address the user is trying to create an account from is
3117 # blocked with createaccount disabled, prevent new account creation there even
3118 # when the user is logged in
3119 if( $this->mBlockedFromCreateAccount
=== false ){
3120 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3122 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3123 ?
$this->mBlockedFromCreateAccount
3128 * Get whether the user is blocked from using Special:Emailuser.
3131 public function isBlockedFromEmailuser() {
3132 $this->getBlockedStatus();
3133 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3137 * Get whether the user is allowed to create an account.
3140 function isAllowedToCreateAccount() {
3141 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3145 * Get this user's personal page title.
3147 * @return Title: User's personal page title
3149 public function getUserPage() {
3150 return Title
::makeTitle( NS_USER
, $this->getName() );
3154 * Get this user's talk page title.
3156 * @return Title: User's talk page title
3158 public function getTalkPage() {
3159 $title = $this->getUserPage();
3160 return $title->getTalkPage();
3164 * Determine whether the user is a newbie. Newbies are either
3165 * anonymous IPs, or the most recently created accounts.
3168 public function isNewbie() {
3169 return !$this->isAllowed( 'autoconfirmed' );
3173 * Check to see if the given clear-text password is one of the accepted passwords
3174 * @param $password String: user password.
3175 * @return Boolean: True if the given password is correct, otherwise False.
3177 public function checkPassword( $password ) {
3178 global $wgAuth, $wgLegacyEncoding;
3181 // Even though we stop people from creating passwords that
3182 // are shorter than this, doesn't mean people wont be able
3183 // to. Certain authentication plugins do NOT want to save
3184 // domain passwords in a mysql database, so we should
3185 // check this (in case $wgAuth->strict() is false).
3186 if( !$this->isValidPassword( $password ) ) {
3190 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3192 } elseif( $wgAuth->strict() ) {
3193 /* Auth plugin doesn't allow local authentication */
3195 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3196 /* Auth plugin doesn't allow local authentication for this user name */
3199 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3201 } elseif ( $wgLegacyEncoding ) {
3202 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3203 # Check for this with iconv
3204 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3205 if ( $cp1252Password != $password &&
3206 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3215 * Check if the given clear-text password matches the temporary password
3216 * sent by e-mail for password reset operations.
3218 * @param $plaintext string
3220 * @return Boolean: True if matches, false otherwise
3222 public function checkTemporaryPassword( $plaintext ) {
3223 global $wgNewPasswordExpiry;
3226 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3227 if ( is_null( $this->mNewpassTime
) ) {
3230 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3231 return ( time() < $expiry );
3238 * Alias for getEditToken.
3239 * @deprecated since 1.19, use getEditToken instead.
3241 * @param $salt String|Array of Strings Optional function-specific data for hashing
3242 * @param $request WebRequest object to use or null to use $wgRequest
3243 * @return String The new edit token
3245 public function editToken( $salt = '', $request = null ) {
3246 wfDeprecated( __METHOD__
, '1.19' );
3247 return $this->getEditToken( $salt, $request );
3251 * Initialize (if necessary) and return a session token value
3252 * which can be used in edit forms to show that the user's
3253 * login credentials aren't being hijacked with a foreign form
3258 * @param $salt String|Array of Strings Optional function-specific data for hashing
3259 * @param $request WebRequest object to use or null to use $wgRequest
3260 * @return String The new edit token
3262 public function getEditToken( $salt = '', $request = null ) {
3263 if ( $request == null ) {
3264 $request = $this->getRequest();
3267 if ( $this->isAnon() ) {
3268 return EDIT_TOKEN_SUFFIX
;
3270 $token = $request->getSessionData( 'wsEditToken' );
3271 if ( $token === null ) {
3272 $token = MWCryptRand
::generateHex( 32 );
3273 $request->setSessionData( 'wsEditToken', $token );
3275 if( is_array( $salt ) ) {
3276 $salt = implode( '|', $salt );
3278 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3283 * Generate a looking random token for various uses.
3285 * @param $salt String Optional salt value
3286 * @return String The new random token
3287 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3289 public static function generateToken( $salt = '' ) {
3290 return MWCryptRand
::generateHex( 32 );
3294 * Check given value against the token value stored in the session.
3295 * A match should confirm that the form was submitted from the
3296 * user's own login session, not a form submission from a third-party
3299 * @param $val String Input value to compare
3300 * @param $salt String Optional function-specific data for hashing
3301 * @param $request WebRequest object to use or null to use $wgRequest
3302 * @return Boolean: Whether the token matches
3304 public function matchEditToken( $val, $salt = '', $request = null ) {
3305 $sessionToken = $this->getEditToken( $salt, $request );
3306 if ( $val != $sessionToken ) {
3307 wfDebug( "User::matchEditToken: broken session data\n" );
3309 return $val == $sessionToken;
3313 * Check given value against the token value stored in the session,
3314 * ignoring the suffix.
3316 * @param $val String Input value to compare
3317 * @param $salt String Optional function-specific data for hashing
3318 * @param $request WebRequest object to use or null to use $wgRequest
3319 * @return Boolean: Whether the token matches
3321 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3322 $sessionToken = $this->getEditToken( $salt, $request );
3323 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3327 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3328 * mail to the user's given address.
3330 * @param $type String: message to send, either "created", "changed" or "set"
3331 * @return Status object
3333 public function sendConfirmationMail( $type = 'created' ) {
3335 $expiration = null; // gets passed-by-ref and defined in next line.
3336 $token = $this->confirmationToken( $expiration );
3337 $url = $this->confirmationTokenUrl( $token );
3338 $invalidateURL = $this->invalidationTokenUrl( $token );
3339 $this->saveSettings();
3341 if ( $type == 'created' ||
$type === false ) {
3342 $message = 'confirmemail_body';
3343 } elseif ( $type === true ) {
3344 $message = 'confirmemail_body_changed';
3346 $message = 'confirmemail_body_' . $type;
3349 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3351 $this->getRequest()->getIP(),
3354 $wgLang->timeanddate( $expiration, false ),
3356 $wgLang->date( $expiration, false ),
3357 $wgLang->time( $expiration, false ) ) );
3361 * Send an e-mail to this user's account. Does not check for
3362 * confirmed status or validity.
3364 * @param $subject String Message subject
3365 * @param $body String Message body
3366 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3367 * @param $replyto String Reply-To address
3370 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3371 if( is_null( $from ) ) {
3372 global $wgPasswordSender, $wgPasswordSenderName;
3373 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3375 $sender = new MailAddress( $from );
3378 $to = new MailAddress( $this );
3379 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3383 * Generate, store, and return a new e-mail confirmation code.
3384 * A hash (unsalted, since it's used as a key) is stored.
3386 * @note Call saveSettings() after calling this function to commit
3387 * this change to the database.
3389 * @param &$expiration \mixed Accepts the expiration time
3390 * @return String New token
3392 private function confirmationToken( &$expiration ) {
3393 global $wgUserEmailConfirmationTokenExpiry;
3395 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3396 $expiration = wfTimestamp( TS_MW
, $expires );
3398 $token = MWCryptRand
::generateHex( 32 );
3399 $hash = md5( $token );
3400 $this->mEmailToken
= $hash;
3401 $this->mEmailTokenExpires
= $expiration;
3406 * Return a URL the user can use to confirm their email address.
3407 * @param $token String Accepts the email confirmation token
3408 * @return String New token URL
3410 private function confirmationTokenUrl( $token ) {
3411 return $this->getTokenUrl( 'ConfirmEmail', $token );
3415 * Return a URL the user can use to invalidate their email address.
3416 * @param $token String Accepts the email confirmation token
3417 * @return String New token URL
3419 private function invalidationTokenUrl( $token ) {
3420 return $this->getTokenUrl( 'InvalidateEmail', $token );
3424 * Internal function to format the e-mail validation/invalidation URLs.
3425 * This uses a quickie hack to use the
3426 * hardcoded English names of the Special: pages, for ASCII safety.
3428 * @note Since these URLs get dropped directly into emails, using the
3429 * short English names avoids insanely long URL-encoded links, which
3430 * also sometimes can get corrupted in some browsers/mailers
3431 * (bug 6957 with Gmail and Internet Explorer).
3433 * @param $page String Special page
3434 * @param $token String Token
3435 * @return String Formatted URL
3437 protected function getTokenUrl( $page, $token ) {
3438 // Hack to bypass localization of 'Special:'
3439 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3440 return $title->getCanonicalUrl();
3444 * Mark the e-mail address confirmed.
3446 * @note Call saveSettings() after calling this function to commit the change.
3450 public function confirmEmail() {
3451 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3452 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3457 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3458 * address if it was already confirmed.
3460 * @note Call saveSettings() after calling this function to commit the change.
3461 * @return bool Returns true
3463 function invalidateEmail() {
3465 $this->mEmailToken
= null;
3466 $this->mEmailTokenExpires
= null;
3467 $this->setEmailAuthenticationTimestamp( null );
3468 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3473 * Set the e-mail authentication timestamp.
3474 * @param $timestamp String TS_MW timestamp
3476 function setEmailAuthenticationTimestamp( $timestamp ) {
3478 $this->mEmailAuthenticated
= $timestamp;
3479 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3483 * Is this user allowed to send e-mails within limits of current
3484 * site configuration?
3487 public function canSendEmail() {
3488 global $wgEnableEmail, $wgEnableUserEmail;
3489 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3492 $canSend = $this->isEmailConfirmed();
3493 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3498 * Is this user allowed to receive e-mails within limits of current
3499 * site configuration?
3502 public function canReceiveEmail() {
3503 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3507 * Is this user's e-mail address valid-looking and confirmed within
3508 * limits of the current site configuration?
3510 * @note If $wgEmailAuthentication is on, this may require the user to have
3511 * confirmed their address by returning a code or using a password
3512 * sent to the address from the wiki.
3516 public function isEmailConfirmed() {
3517 global $wgEmailAuthentication;
3520 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3521 if( $this->isAnon() ) {
3524 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3527 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3537 * Check whether there is an outstanding request for e-mail confirmation.
3540 public function isEmailConfirmationPending() {
3541 global $wgEmailAuthentication;
3542 return $wgEmailAuthentication &&
3543 !$this->isEmailConfirmed() &&
3544 $this->mEmailToken
&&
3545 $this->mEmailTokenExpires
> wfTimestamp();
3549 * Get the timestamp of account creation.
3551 * @return String|Bool Timestamp of account creation, or false for
3552 * non-existent/anonymous user accounts.
3554 public function getRegistration() {
3555 if ( $this->isAnon() ) {
3559 return $this->mRegistration
;
3563 * Get the timestamp of the first edit
3565 * @return String|Bool Timestamp of first edit, or false for
3566 * non-existent/anonymous user accounts.
3568 public function getFirstEditTimestamp() {
3569 if( $this->getId() == 0 ) {
3570 return false; // anons
3572 $dbr = wfGetDB( DB_SLAVE
);
3573 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3574 array( 'rev_user' => $this->getId() ),
3576 array( 'ORDER BY' => 'rev_timestamp ASC' )
3579 return false; // no edits
3581 return wfTimestamp( TS_MW
, $time );
3585 * Get the permissions associated with a given list of groups
3587 * @param $groups Array of Strings List of internal group names
3588 * @return Array of Strings List of permission key names for given groups combined
3590 public static function getGroupPermissions( $groups ) {
3591 global $wgGroupPermissions, $wgRevokePermissions;
3593 // grant every granted permission first
3594 foreach( $groups as $group ) {
3595 if( isset( $wgGroupPermissions[$group] ) ) {
3596 $rights = array_merge( $rights,
3597 // array_filter removes empty items
3598 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3601 // now revoke the revoked permissions
3602 foreach( $groups as $group ) {
3603 if( isset( $wgRevokePermissions[$group] ) ) {
3604 $rights = array_diff( $rights,
3605 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3608 return array_unique( $rights );
3612 * Get all the groups who have a given permission
3614 * @param $role String Role to check
3615 * @return Array of Strings List of internal group names with the given permission
3617 public static function getGroupsWithPermission( $role ) {
3618 global $wgGroupPermissions;
3619 $allowedGroups = array();
3620 foreach ( $wgGroupPermissions as $group => $rights ) {
3621 if ( isset( $rights[$role] ) && $rights[$role] ) {
3622 $allowedGroups[] = $group;
3625 return $allowedGroups;
3629 * Get the localized descriptive name for a group, if it exists
3631 * @param $group String Internal group name
3632 * @return String Localized descriptive group name
3634 public static function getGroupName( $group ) {
3635 $msg = wfMessage( "group-$group" );
3636 return $msg->isBlank() ?
$group : $msg->text();
3640 * Get the localized descriptive name for a member of a group, if it exists
3642 * @param $group String Internal group name
3643 * @param $username String Username for gender (since 1.19)
3644 * @return String Localized name for group member
3646 public static function getGroupMember( $group, $username = '#' ) {
3647 $msg = wfMessage( "group-$group-member", $username );
3648 return $msg->isBlank() ?
$group : $msg->text();
3652 * Return the set of defined explicit groups.
3653 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3654 * are not included, as they are defined automatically, not in the database.
3655 * @return Array of internal group names
3657 public static function getAllGroups() {
3658 global $wgGroupPermissions, $wgRevokePermissions;
3660 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3661 self
::getImplicitGroups()
3666 * Get a list of all available permissions.
3667 * @return Array of permission names
3669 public static function getAllRights() {
3670 if ( self
::$mAllRights === false ) {
3671 global $wgAvailableRights;
3672 if ( count( $wgAvailableRights ) ) {
3673 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3675 self
::$mAllRights = self
::$mCoreRights;
3677 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3679 return self
::$mAllRights;
3683 * Get a list of implicit groups
3684 * @return Array of Strings Array of internal group names
3686 public static function getImplicitGroups() {
3687 global $wgImplicitGroups;
3688 $groups = $wgImplicitGroups;
3689 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3694 * Get the title of a page describing a particular group
3696 * @param $group String Internal group name
3697 * @return Title|Bool Title of the page if it exists, false otherwise
3699 public static function getGroupPage( $group ) {
3700 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3701 if( $msg->exists() ) {
3702 $title = Title
::newFromText( $msg->text() );
3703 if( is_object( $title ) )
3710 * Create a link to the group in HTML, if available;
3711 * else return the group name.
3713 * @param $group String Internal name of the group
3714 * @param $text String The text of the link
3715 * @return String HTML link to the group
3717 public static function makeGroupLinkHTML( $group, $text = '' ) {
3719 $text = self
::getGroupName( $group );
3721 $title = self
::getGroupPage( $group );
3723 return Linker
::link( $title, htmlspecialchars( $text ) );
3730 * Create a link to the group in Wikitext, if available;
3731 * else return the group name.
3733 * @param $group String Internal name of the group
3734 * @param $text String The text of the link
3735 * @return String Wikilink to the group
3737 public static function makeGroupLinkWiki( $group, $text = '' ) {
3739 $text = self
::getGroupName( $group );
3741 $title = self
::getGroupPage( $group );
3743 $page = $title->getPrefixedText();
3744 return "[[$page|$text]]";
3751 * Returns an array of the groups that a particular group can add/remove.
3753 * @param $group String: the group to check for whether it can add/remove
3754 * @return Array array( 'add' => array( addablegroups ),
3755 * 'remove' => array( removablegroups ),
3756 * 'add-self' => array( addablegroups to self),
3757 * 'remove-self' => array( removable groups from self) )
3759 public static function changeableByGroup( $group ) {
3760 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3762 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3763 if( empty( $wgAddGroups[$group] ) ) {
3764 // Don't add anything to $groups
3765 } elseif( $wgAddGroups[$group] === true ) {
3766 // You get everything
3767 $groups['add'] = self
::getAllGroups();
3768 } elseif( is_array( $wgAddGroups[$group] ) ) {
3769 $groups['add'] = $wgAddGroups[$group];
3772 // Same thing for remove
3773 if( empty( $wgRemoveGroups[$group] ) ) {
3774 } elseif( $wgRemoveGroups[$group] === true ) {
3775 $groups['remove'] = self
::getAllGroups();
3776 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3777 $groups['remove'] = $wgRemoveGroups[$group];
3780 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3781 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3782 foreach( $wgGroupsAddToSelf as $key => $value ) {
3783 if( is_int( $key ) ) {
3784 $wgGroupsAddToSelf['user'][] = $value;
3789 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3790 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3791 if( is_int( $key ) ) {
3792 $wgGroupsRemoveFromSelf['user'][] = $value;
3797 // Now figure out what groups the user can add to him/herself
3798 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3799 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3800 // No idea WHY this would be used, but it's there
3801 $groups['add-self'] = User
::getAllGroups();
3802 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3803 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3806 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3807 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3808 $groups['remove-self'] = User
::getAllGroups();
3809 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3810 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3817 * Returns an array of groups that this user can add and remove
3818 * @return Array array( 'add' => array( addablegroups ),
3819 * 'remove' => array( removablegroups ),
3820 * 'add-self' => array( addablegroups to self),
3821 * 'remove-self' => array( removable groups from self) )
3823 public function changeableGroups() {
3824 if( $this->isAllowed( 'userrights' ) ) {
3825 // This group gives the right to modify everything (reverse-
3826 // compatibility with old "userrights lets you change
3828 // Using array_merge to make the groups reindexed
3829 $all = array_merge( User
::getAllGroups() );
3833 'add-self' => array(),
3834 'remove-self' => array()
3838 // Okay, it's not so simple, we will have to go through the arrays
3841 'remove' => array(),
3842 'add-self' => array(),
3843 'remove-self' => array()
3845 $addergroups = $this->getEffectiveGroups();
3847 foreach( $addergroups as $addergroup ) {
3848 $groups = array_merge_recursive(
3849 $groups, $this->changeableByGroup( $addergroup )
3851 $groups['add'] = array_unique( $groups['add'] );
3852 $groups['remove'] = array_unique( $groups['remove'] );
3853 $groups['add-self'] = array_unique( $groups['add-self'] );
3854 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3860 * Increment the user's edit-count field.
3861 * Will have no effect for anonymous users.
3863 public function incEditCount() {
3864 if( !$this->isAnon() ) {
3865 $dbw = wfGetDB( DB_MASTER
);
3866 $dbw->update( 'user',
3867 array( 'user_editcount=user_editcount+1' ),
3868 array( 'user_id' => $this->getId() ),
3871 // Lazy initialization check...
3872 if( $dbw->affectedRows() == 0 ) {
3873 // Pull from a slave to be less cruel to servers
3874 // Accuracy isn't the point anyway here
3875 $dbr = wfGetDB( DB_SLAVE
);
3876 $count = $dbr->selectField( 'revision',
3878 array( 'rev_user' => $this->getId() ),
3881 // Now here's a goddamn hack...
3882 if( $dbr !== $dbw ) {
3883 // If we actually have a slave server, the count is
3884 // at least one behind because the current transaction
3885 // has not been committed and replicated.
3888 // But if DB_SLAVE is selecting the master, then the
3889 // count we just read includes the revision that was
3890 // just added in the working transaction.
3893 $dbw->update( 'user',
3894 array( 'user_editcount' => $count ),
3895 array( 'user_id' => $this->getId() ),
3899 // edit count in user cache too
3900 $this->invalidateCache();
3904 * Get the description of a given right
3906 * @param $right String Right to query
3907 * @return String Localized description of the right
3909 public static function getRightDescription( $right ) {
3910 $key = "right-$right";
3911 $msg = wfMessage( $key );
3912 return $msg->isBlank() ?
$right : $msg->text();
3916 * Make an old-style password hash
3918 * @param $password String Plain-text password
3919 * @param $userId String User ID
3920 * @return String Password hash
3922 public static function oldCrypt( $password, $userId ) {
3923 global $wgPasswordSalt;
3924 if ( $wgPasswordSalt ) {
3925 return md5( $userId . '-' . md5( $password ) );
3927 return md5( $password );
3932 * Make a new-style password hash
3934 * @param $password String Plain-text password
3935 * @param bool|string $salt Optional salt, may be random or the user ID.
3937 * If unspecified or false, will generate one automatically
3938 * @return String Password hash
3940 public static function crypt( $password, $salt = false ) {
3941 global $wgPasswordSalt;
3944 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3948 if( $wgPasswordSalt ) {
3949 if ( $salt === false ) {
3950 $salt = MWCryptRand
::generateHex( 8 );
3952 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3954 return ':A:' . md5( $password );
3959 * Compare a password hash with a plain-text password. Requires the user
3960 * ID if there's a chance that the hash is an old-style hash.
3962 * @param $hash String Password hash
3963 * @param $password String Plain-text password to compare
3964 * @param $userId String|bool User ID for old-style password salt
3968 public static function comparePasswords( $hash, $password, $userId = false ) {
3969 $type = substr( $hash, 0, 3 );
3972 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3976 if ( $type == ':A:' ) {
3978 return md5( $password ) === substr( $hash, 3 );
3979 } elseif ( $type == ':B:' ) {
3981 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3982 return md5( $salt.'-'.md5( $password ) ) === $realHash;
3985 return self
::oldCrypt( $password, $userId ) === $hash;
3990 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
3992 * @param $byEmail Boolean: account made by email?
3993 * @param $reason String: user supplied reason
3995 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
3997 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3998 global $wgUser, $wgContLang, $wgNewUserLog;
3999 if( empty( $wgNewUserLog ) ) {
4000 return true; // disabled
4003 if( $this->getName() == $wgUser->getName() ) {
4006 $action = 'create2';
4008 if ( $reason === '' ) {
4009 $reason = wfMsgForContent( 'newuserlog-byemail' );
4011 $reason = $wgContLang->commaList( array(
4012 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
4016 $log = new LogPage( 'newusers' );
4017 return (int)$log->addEntry(
4019 $this->getUserPage(),
4021 array( $this->getId() )
4026 * Add an autocreate newuser log entry for this user
4027 * Used by things like CentralAuth and perhaps other authplugins.
4031 public function addNewUserLogEntryAutoCreate() {
4032 global $wgNewUserLog;
4033 if( !$wgNewUserLog ) {
4034 return true; // disabled
4036 $log = new LogPage( 'newusers', false );
4037 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4044 protected function loadOptions() {
4046 if ( $this->mOptionsLoaded ||
!$this->getId() )
4049 $this->mOptions
= self
::getDefaultOptions();
4051 // Maybe load from the object
4052 if ( !is_null( $this->mOptionOverrides
) ) {
4053 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4054 foreach( $this->mOptionOverrides
as $key => $value ) {
4055 $this->mOptions
[$key] = $value;
4058 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4059 // Load from database
4060 $dbr = wfGetDB( DB_SLAVE
);
4062 $res = $dbr->select(
4064 array( 'up_property', 'up_value' ),
4065 array( 'up_user' => $this->getId() ),
4069 $this->mOptionOverrides
= array();
4070 foreach ( $res as $row ) {
4071 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4072 $this->mOptions
[$row->up_property
] = $row->up_value
;
4076 $this->mOptionsLoaded
= true;
4078 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4084 protected function saveOptions() {
4085 global $wgAllowPrefChange;
4087 $this->loadOptions();
4089 // Not using getOptions(), to keep hidden preferences in database
4090 $saveOptions = $this->mOptions
;
4092 // Allow hooks to abort, for instance to save to a global profile.
4093 // Reset options to default state before saving.
4094 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4098 $extuser = ExternalUser
::newFromUser( $this );
4099 $userId = $this->getId();
4100 $insert_rows = array();
4101 foreach( $saveOptions as $key => $value ) {
4102 # Don't bother storing default values
4103 $defaultOption = self
::getDefaultOption( $key );
4104 if ( ( is_null( $defaultOption ) &&
4105 !( $value === false ||
is_null( $value ) ) ) ||
4106 $value != $defaultOption ) {
4107 $insert_rows[] = array(
4108 'up_user' => $userId,
4109 'up_property' => $key,
4110 'up_value' => $value,
4113 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4114 switch ( $wgAllowPrefChange[$key] ) {
4120 $extuser->setPref( $key, $value );
4125 $dbw = wfGetDB( DB_MASTER
);
4126 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4127 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4131 * Provide an array of HTML5 attributes to put on an input element
4132 * intended for the user to enter a new password. This may include
4133 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4135 * Do *not* use this when asking the user to enter his current password!
4136 * Regardless of configuration, users may have invalid passwords for whatever
4137 * reason (e.g., they were set before requirements were tightened up).
4138 * Only use it when asking for a new password, like on account creation or
4141 * Obviously, you still need to do server-side checking.
4143 * NOTE: A combination of bugs in various browsers means that this function
4144 * actually just returns array() unconditionally at the moment. May as
4145 * well keep it around for when the browser bugs get fixed, though.
4147 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4149 * @return array Array of HTML attributes suitable for feeding to
4150 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4151 * That will potentially output invalid XHTML 1.0 Transitional, and will
4152 * get confused by the boolean attribute syntax used.)
4154 public static function passwordChangeInputAttribs() {
4155 global $wgMinimalPasswordLength;
4157 if ( $wgMinimalPasswordLength == 0 ) {
4161 # Note that the pattern requirement will always be satisfied if the
4162 # input is empty, so we need required in all cases.
4164 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4165 # if e-mail confirmation is being used. Since HTML5 input validation
4166 # is b0rked anyway in some browsers, just return nothing. When it's
4167 # re-enabled, fix this code to not output required for e-mail
4169 #$ret = array( 'required' );
4172 # We can't actually do this right now, because Opera 9.6 will print out
4173 # the entered password visibly in its error message! When other
4174 # browsers add support for this attribute, or Opera fixes its support,
4175 # we can add support with a version check to avoid doing this on Opera
4176 # versions where it will be a problem. Reported to Opera as
4177 # DSK-262266, but they don't have a public bug tracker for us to follow.
4179 if ( $wgMinimalPasswordLength > 1 ) {
4180 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4181 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4182 $wgMinimalPasswordLength );
4190 * Return the list of user fields that should be selected to create
4191 * a new user object.
4194 public static function selectFields() {
4201 'user_newpass_time',
4205 'user_email_authenticated',
4207 'user_email_token_expires',
4208 'user_registration',