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',
164 'userrights-interwiki',
168 * String Cached results of getAllRights()
170 static $mAllRights = false;
172 /** @name Cache variables */
174 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
175 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
176 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
177 $mGroups, $mOptionOverrides;
181 * Bool Whether the cache variables have been loaded.
187 * Array with already loaded items or true if all items have been loaded.
189 private $mLoadedItems = array();
193 * String Initialization data source if mLoadedItems!==true. May be one of:
194 * - 'defaults' anonymous user initialised from class defaults
195 * - 'name' initialise from mName
196 * - 'id' initialise from mId
197 * - 'session' log in from cookies or session if possible
199 * Use the User::newFrom*() family of functions to set this.
204 * Lazy-initialized variables, invalidated with clearInstanceCache
206 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
207 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
208 $mLocked, $mHideName, $mOptions;
228 private $mBlockedFromCreateAccount = false;
233 private $mWatchedItems = array();
235 static $idCacheByName = array();
238 * Lightweight constructor for an anonymous user.
239 * Use the User::newFrom* factory functions for other kinds of users.
243 * @see newFromConfirmationCode()
244 * @see newFromSession()
247 function __construct() {
248 $this->clearInstanceCache( 'defaults' );
254 function __toString(){
255 return $this->getName();
259 * Load the user table data for this object from the source given by mFrom.
261 public function load() {
262 if ( $this->mLoadedItems
=== true ) {
265 wfProfileIn( __METHOD__
);
267 # Set it now to avoid infinite recursion in accessors
268 $this->mLoadedItems
= true;
270 switch ( $this->mFrom
) {
272 $this->loadDefaults();
275 $this->mId
= self
::idFromName( $this->mName
);
277 # Nonexistent user placeholder object
278 $this->loadDefaults( $this->mName
);
287 $this->loadFromSession();
288 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
291 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
293 wfProfileOut( __METHOD__
);
297 * Load user table data, given mId has already been set.
298 * @return Bool false if the ID does not exist, true otherwise
300 public function loadFromId() {
302 if ( $this->mId
== 0 ) {
303 $this->loadDefaults();
308 $key = wfMemcKey( 'user', 'id', $this->mId
);
309 $data = $wgMemc->get( $key );
310 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
311 # Object is expired, load from DB
316 wfDebug( "User: cache miss for user {$this->mId}\n" );
318 if ( !$this->loadFromDatabase() ) {
319 # Can't load from ID, user is anonymous
322 $this->saveToCache();
324 wfDebug( "User: got user {$this->mId} from cache\n" );
326 foreach ( self
::$mCacheVars as $name ) {
327 $this->$name = $data[$name];
334 * Save user data to the shared cache
336 public function saveToCache() {
339 $this->loadOptions();
340 if ( $this->isAnon() ) {
341 // Anonymous users are uncached
345 foreach ( self
::$mCacheVars as $name ) {
346 $data[$name] = $this->$name;
348 $data['mVersion'] = MW_USER_VERSION
;
349 $key = wfMemcKey( 'user', 'id', $this->mId
);
351 $wgMemc->set( $key, $data );
354 /** @name newFrom*() static factory methods */
358 * Static factory method for creation from username.
360 * This is slightly less efficient than newFromId(), so use newFromId() if
361 * you have both an ID and a name handy.
363 * @param $name String Username, validated by Title::newFromText()
364 * @param $validate String|Bool Validate username. Takes the same parameters as
365 * User::getCanonicalName(), except that true is accepted as an alias
366 * for 'valid', for BC.
368 * @return User object, or false if the username is invalid
369 * (e.g. if it contains illegal characters or is an IP address). If the
370 * username is not present in the database, the result will be a user object
371 * with a name, zero user ID and default settings.
373 public static function newFromName( $name, $validate = 'valid' ) {
374 if ( $validate === true ) {
377 $name = self
::getCanonicalName( $name, $validate );
378 if ( $name === false ) {
381 # Create unloaded user object
385 $u->setItemLoaded( 'name' );
391 * Static factory method for creation from a given user ID.
393 * @param $id Int Valid user ID
394 * @return User The corresponding User object
396 public static function newFromId( $id ) {
400 $u->setItemLoaded( 'id' );
405 * Factory method to fetch whichever user has a given email confirmation code.
406 * This code is generated when an account is created or its e-mail address
409 * If the code is invalid or has expired, returns NULL.
411 * @param $code String Confirmation code
412 * @return User object, or null
414 public static function newFromConfirmationCode( $code ) {
415 $dbr = wfGetDB( DB_SLAVE
);
416 $id = $dbr->selectField( 'user', 'user_id', array(
417 'user_email_token' => md5( $code ),
418 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
420 if( $id !== false ) {
421 return User
::newFromId( $id );
428 * Create a new user object using data from session or cookies. If the
429 * login credentials are invalid, the result is an anonymous user.
431 * @param $request WebRequest object to use; $wgRequest will be used if
433 * @return User object
435 public static function newFromSession( WebRequest
$request = null ) {
437 $user->mFrom
= 'session';
438 $user->mRequest
= $request;
443 * Create a new user object from a user row.
444 * The row should have the following fields from the user table in it:
445 * - either user_name or user_id to load further data if needed (or both)
447 * - all other fields (email, password, etc.)
448 * It is useless to provide the remaining fields if either user_id,
449 * user_name and user_real_name are not provided because the whole row
450 * will be loaded once more from the database when accessing them.
452 * @param $row Array A row from the user table
455 public static function newFromRow( $row ) {
457 $user->loadFromRow( $row );
464 * Get the username corresponding to a given user ID
465 * @param $id Int User ID
466 * @return String|bool The corresponding username
468 public static function whoIs( $id ) {
469 $dbr = wfGetDB( DB_SLAVE
);
470 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
474 * Get the real name of a user given their user ID
476 * @param $id Int User ID
477 * @return String|bool The corresponding user's real name
479 public static function whoIsReal( $id ) {
480 $dbr = wfGetDB( DB_SLAVE
);
481 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
485 * Get database id given a user name
486 * @param $name String Username
487 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
489 public static function idFromName( $name ) {
490 $nt = Title
::makeTitleSafe( NS_USER
, $name );
491 if( is_null( $nt ) ) {
496 if ( isset( self
::$idCacheByName[$name] ) ) {
497 return self
::$idCacheByName[$name];
500 $dbr = wfGetDB( DB_SLAVE
);
501 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
503 if ( $s === false ) {
506 $result = $s->user_id
;
509 self
::$idCacheByName[$name] = $result;
511 if ( count( self
::$idCacheByName ) > 1000 ) {
512 self
::$idCacheByName = array();
519 * Reset the cache used in idFromName(). For use in tests.
521 public static function resetIdByNameCache() {
522 self
::$idCacheByName = array();
526 * Does the string match an anonymous IPv4 address?
528 * This function exists for username validation, in order to reject
529 * usernames which are similar in form to IP addresses. Strings such
530 * as 300.300.300.300 will return true because it looks like an IP
531 * address, despite not being strictly valid.
533 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
534 * address because the usemod software would "cloak" anonymous IP
535 * addresses like this, if we allowed accounts like this to be created
536 * new users could get the old edits of these anonymous users.
538 * @param $name String to match
541 public static function isIP( $name ) {
542 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
546 * Is the input a valid username?
548 * Checks if the input is a valid username, we don't want an empty string,
549 * an IP address, anything that containins slashes (would mess up subpages),
550 * is longer than the maximum allowed username size or doesn't begin with
553 * @param $name String to match
556 public static function isValidUserName( $name ) {
557 global $wgContLang, $wgMaxNameChars;
560 || User
::isIP( $name )
561 ||
strpos( $name, '/' ) !== false
562 ||
strlen( $name ) > $wgMaxNameChars
563 ||
$name != $wgContLang->ucfirst( $name ) ) {
564 wfDebugLog( 'username', __METHOD__
.
565 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
570 // Ensure that the name can't be misresolved as a different title,
571 // such as with extra namespace keys at the start.
572 $parsed = Title
::newFromText( $name );
573 if( is_null( $parsed )
574 ||
$parsed->getNamespace()
575 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
576 wfDebugLog( 'username', __METHOD__
.
577 ": '$name' invalid due to ambiguous prefixes" );
581 // Check an additional blacklist of troublemaker characters.
582 // Should these be merged into the title char list?
583 $unicodeBlacklist = '/[' .
584 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
585 '\x{00a0}' . # non-breaking space
586 '\x{2000}-\x{200f}' . # various whitespace
587 '\x{2028}-\x{202f}' . # breaks and control chars
588 '\x{3000}' . # ideographic space
589 '\x{e000}-\x{f8ff}' . # private use
591 if( preg_match( $unicodeBlacklist, $name ) ) {
592 wfDebugLog( 'username', __METHOD__
.
593 ": '$name' invalid due to blacklisted characters" );
601 * Usernames which fail to pass this function will be blocked
602 * from user login and new account registrations, but may be used
603 * internally by batch processes.
605 * If an account already exists in this form, login will be blocked
606 * by a failure to pass this function.
608 * @param $name String to match
611 public static function isUsableName( $name ) {
612 global $wgReservedUsernames;
613 // Must be a valid username, obviously ;)
614 if ( !self
::isValidUserName( $name ) ) {
618 static $reservedUsernames = false;
619 if ( !$reservedUsernames ) {
620 $reservedUsernames = $wgReservedUsernames;
621 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
624 // Certain names may be reserved for batch processes.
625 foreach ( $reservedUsernames as $reserved ) {
626 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
627 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
629 if ( $reserved == $name ) {
637 * Usernames which fail to pass this function will be blocked
638 * from new account registrations, but may be used internally
639 * either by batch processes or by user accounts which have
640 * already been created.
642 * Additional blacklisting may be added here rather than in
643 * isValidUserName() to avoid disrupting existing accounts.
645 * @param $name String to match
648 public static function isCreatableName( $name ) {
649 global $wgInvalidUsernameCharacters;
651 // Ensure that the username isn't longer than 235 bytes, so that
652 // (at least for the builtin skins) user javascript and css files
653 // will work. (bug 23080)
654 if( strlen( $name ) > 235 ) {
655 wfDebugLog( 'username', __METHOD__
.
656 ": '$name' invalid due to length" );
660 // Preg yells if you try to give it an empty string
661 if( $wgInvalidUsernameCharacters !== '' ) {
662 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
663 wfDebugLog( 'username', __METHOD__
.
664 ": '$name' invalid due to wgInvalidUsernameCharacters" );
669 return self
::isUsableName( $name );
673 * Is the input a valid password for this user?
675 * @param $password String Desired password
678 public function isValidPassword( $password ) {
679 //simple boolean wrapper for getPasswordValidity
680 return $this->getPasswordValidity( $password ) === true;
684 * Given unvalidated password input, return error message on failure.
686 * @param $password String Desired password
687 * @return mixed: true on success, string or array of error message on failure
689 public function getPasswordValidity( $password ) {
690 global $wgMinimalPasswordLength, $wgContLang;
692 static $blockedLogins = array(
693 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
694 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
697 $result = false; //init $result to false for the internal checks
699 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
702 if ( $result === false ) {
703 if( strlen( $password ) < $wgMinimalPasswordLength ) {
704 return 'passwordtooshort';
705 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
706 return 'password-name-match';
707 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
708 return 'password-login-forbidden';
710 //it seems weird returning true here, but this is because of the
711 //initialization of $result to false above. If the hook is never run or it
712 //doesn't modify $result, then we will likely get down into this if with
716 } elseif( $result === true ) {
719 return $result; //the isValidPassword hook set a string $result and returned true
724 * Does a string look like an e-mail address?
726 * This validates an email address using an HTML5 specification found at:
727 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
728 * Which as of 2011-01-24 says:
730 * A valid e-mail address is a string that matches the ABNF production
731 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
732 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
735 * This function is an implementation of the specification as requested in
738 * Client-side forms will use the same standard validation rules via JS or
739 * HTML 5 validation; additional restrictions can be enforced server-side
740 * by extensions via the 'isValidEmailAddr' hook.
742 * Note that this validation doesn't 100% match RFC 2822, but is believed
743 * to be liberal enough for wide use. Some invalid addresses will still
744 * pass validation here.
746 * @param $addr String E-mail address
748 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
750 public static function isValidEmailAddr( $addr ) {
751 wfDeprecated( __METHOD__
, '1.18' );
752 return Sanitizer
::validateEmail( $addr );
756 * Given unvalidated user input, return a canonical username, or false if
757 * the username is invalid.
758 * @param $name String User input
759 * @param $validate String|Bool type of validation to use:
760 * - false No validation
761 * - 'valid' Valid for batch processes
762 * - 'usable' Valid for batch processes and login
763 * - 'creatable' Valid for batch processes, login and account creation
765 * @return bool|string
767 public static function getCanonicalName( $name, $validate = 'valid' ) {
768 # Force usernames to capital
770 $name = $wgContLang->ucfirst( $name );
772 # Reject names containing '#'; these will be cleaned up
773 # with title normalisation, but then it's too late to
775 if( strpos( $name, '#' ) !== false )
778 # Clean up name according to title rules
779 $t = ( $validate === 'valid' ) ?
780 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
781 # Check for invalid titles
782 if( is_null( $t ) ) {
786 # Reject various classes of invalid names
788 $name = $wgAuth->getCanonicalName( $t->getText() );
790 switch ( $validate ) {
794 if ( !User
::isValidUserName( $name ) ) {
799 if ( !User
::isUsableName( $name ) ) {
804 if ( !User
::isCreatableName( $name ) ) {
809 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
815 * Count the number of edits of a user
816 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
818 * @param $uid Int User ID to check
819 * @return Int the user's edit count
821 public static function edits( $uid ) {
822 wfProfileIn( __METHOD__
);
823 $dbr = wfGetDB( DB_SLAVE
);
824 // check if the user_editcount field has been initialized
825 $field = $dbr->selectField(
826 'user', 'user_editcount',
827 array( 'user_id' => $uid ),
831 if( $field === null ) { // it has not been initialized. do so.
832 $dbw = wfGetDB( DB_MASTER
);
833 $count = $dbr->selectField(
834 'revision', 'count(*)',
835 array( 'rev_user' => $uid ),
840 array( 'user_editcount' => $count ),
841 array( 'user_id' => $uid ),
847 wfProfileOut( __METHOD__
);
852 * Return a random password.
854 * @return String new random password
856 public static function randomPassword() {
857 global $wgMinimalPasswordLength;
858 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
859 $length = max( 10, $wgMinimalPasswordLength );
860 // Multiply by 1.25 to get the number of hex characters we need
861 $length = $length * 1.25;
862 // Generate random hex chars
863 $hex = MWCryptRand
::generateHex( $length );
864 // Convert from base 16 to base 32 to get a proper password like string
865 return wfBaseConvert( $hex, 16, 32 );
869 * Set cached properties to default.
871 * @note This no longer clears uncached lazy-initialised properties;
872 * the constructor does that instead.
874 * @param $name string
876 public function loadDefaults( $name = false ) {
877 wfProfileIn( __METHOD__
);
880 $this->mName
= $name;
881 $this->mRealName
= '';
882 $this->mPassword
= $this->mNewpassword
= '';
883 $this->mNewpassTime
= null;
885 $this->mOptionOverrides
= null;
886 $this->mOptionsLoaded
= false;
888 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
889 if( $loggedOut !== null ) {
890 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
892 $this->mTouched
= '0'; # Allow any pages to be cached
895 $this->mToken
= null; // Don't run cryptographic functions till we need a token
896 $this->mEmailAuthenticated
= null;
897 $this->mEmailToken
= '';
898 $this->mEmailTokenExpires
= null;
899 $this->mRegistration
= wfTimestamp( TS_MW
);
900 $this->mGroups
= array();
902 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
904 wfProfileOut( __METHOD__
);
908 * Return whether an item has been loaded.
910 * @param $item String: item to check. Current possibilities:
914 * @param $all String: 'all' to check if the whole object has been loaded
915 * or any other string to check if only the item is available (e.g.
919 public function isItemLoaded( $item, $all = 'all' ) {
920 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
921 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
925 * Set that an item has been loaded
927 * @param $item String
929 private function setItemLoaded( $item ) {
930 if ( is_array( $this->mLoadedItems
) ) {
931 $this->mLoadedItems
[$item] = true;
936 * Load user data from the session or login cookie. If there are no valid
937 * credentials, initialises the user as an anonymous user.
938 * @return Bool True if the user is logged in, false otherwise.
940 private function loadFromSession() {
941 global $wgExternalAuthType, $wgAutocreatePolicy;
944 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
945 if ( $result !== null ) {
949 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
950 $extUser = ExternalUser
::newFromCookie();
952 # TODO: Automatically create the user here (or probably a bit
953 # lower down, in fact)
957 $request = $this->getRequest();
959 $cookieId = $request->getCookie( 'UserID' );
960 $sessId = $request->getSessionData( 'wsUserID' );
962 if ( $cookieId !== null ) {
963 $sId = intval( $cookieId );
964 if( $sessId !== null && $cookieId != $sessId ) {
965 $this->loadDefaults(); // Possible collision!
966 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
967 cookie user ID ($sId) don't match!" );
970 $request->setSessionData( 'wsUserID', $sId );
971 } elseif ( $sessId !== null && $sessId != 0 ) {
974 $this->loadDefaults();
978 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
979 $sName = $request->getSessionData( 'wsUserName' );
980 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
981 $sName = $request->getCookie( 'UserName' );
982 $request->setSessionData( 'wsUserName', $sName );
984 $this->loadDefaults();
988 $proposedUser = User
::newFromId( $sId );
989 if ( !$proposedUser->isLoggedIn() ) {
991 $this->loadDefaults();
995 global $wgBlockDisablesLogin;
996 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
997 # User blocked and we've disabled blocked user logins
998 $this->loadDefaults();
1002 if ( $request->getSessionData( 'wsToken' ) ) {
1003 $passwordCorrect = $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' );
1005 } elseif ( $request->getCookie( 'Token' ) ) {
1006 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
1009 # No session or persistent login cookie
1010 $this->loadDefaults();
1014 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1015 $this->loadFromUserObject( $proposedUser );
1016 $request->setSessionData( 'wsToken', $this->mToken
);
1017 wfDebug( "User: logged in from $from\n" );
1020 # Invalid credentials
1021 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1022 $this->loadDefaults();
1028 * Load user and user_group data from the database.
1029 * $this->mId must be set, this is how the user is identified.
1031 * @return Bool True if the user exists, false if the user is anonymous
1033 public function loadFromDatabase() {
1035 $this->mId
= intval( $this->mId
);
1037 /** Anonymous user */
1039 $this->loadDefaults();
1043 $dbr = wfGetDB( DB_MASTER
);
1044 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1046 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1048 if ( $s !== false ) {
1049 # Initialise user table data
1050 $this->loadFromRow( $s );
1051 $this->mGroups
= null; // deferred
1052 $this->getEditCount(); // revalidation for nulls
1057 $this->loadDefaults();
1063 * Initialize this object from a row from the user table.
1065 * @param $row Array Row from the user table to load.
1067 public function loadFromRow( $row ) {
1070 $this->mGroups
= null; // deferred
1072 if ( isset( $row->user_name
) ) {
1073 $this->mName
= $row->user_name
;
1074 $this->mFrom
= 'name';
1075 $this->setItemLoaded( 'name' );
1080 if ( isset( $row->user_real_name
) ) {
1081 $this->mRealName
= $row->user_real_name
;
1082 $this->setItemLoaded( 'realname' );
1087 if ( isset( $row->user_id
) ) {
1088 $this->mId
= intval( $row->user_id
);
1089 $this->mFrom
= 'id';
1090 $this->setItemLoaded( 'id' );
1095 if ( isset( $row->user_editcount
) ) {
1096 $this->mEditCount
= $row->user_editcount
;
1101 if ( isset( $row->user_password
) ) {
1102 $this->mPassword
= $row->user_password
;
1103 $this->mNewpassword
= $row->user_newpassword
;
1104 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1105 $this->mEmail
= $row->user_email
;
1106 if ( isset( $row->user_options
) ) {
1107 $this->decodeOptions( $row->user_options
);
1109 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1110 $this->mToken
= $row->user_token
;
1111 if ( $this->mToken
== '' ) {
1112 $this->mToken
= null;
1114 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1115 $this->mEmailToken
= $row->user_email_token
;
1116 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1117 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1123 $this->mLoadedItems
= true;
1128 * Load the data for this user object from another user object.
1132 protected function loadFromUserObject( $user ) {
1134 $user->loadGroups();
1135 $user->loadOptions();
1136 foreach ( self
::$mCacheVars as $var ) {
1137 $this->$var = $user->$var;
1142 * Load the groups from the database if they aren't already loaded.
1144 private function loadGroups() {
1145 if ( is_null( $this->mGroups
) ) {
1146 $dbr = wfGetDB( DB_MASTER
);
1147 $res = $dbr->select( 'user_groups',
1148 array( 'ug_group' ),
1149 array( 'ug_user' => $this->mId
),
1151 $this->mGroups
= array();
1152 foreach ( $res as $row ) {
1153 $this->mGroups
[] = $row->ug_group
;
1159 * Add the user to the group if he/she meets given criteria.
1161 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1162 * possible to remove manually via Special:UserRights. In such case it
1163 * will not be re-added automatically. The user will also not lose the
1164 * group if they no longer meet the criteria.
1166 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1168 * @return array Array of groups the user has been promoted to.
1170 * @see $wgAutopromoteOnce
1172 public function addAutopromoteOnceGroups( $event ) {
1173 global $wgAutopromoteOnceLogInRC;
1175 $toPromote = array();
1176 if ( $this->getId() ) {
1177 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1178 if ( count( $toPromote ) ) {
1179 $oldGroups = $this->getGroups(); // previous groups
1180 foreach ( $toPromote as $group ) {
1181 $this->addGroup( $group );
1183 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1185 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1186 $log->addEntry( 'autopromote',
1187 $this->getUserPage(),
1189 // These group names are "list to texted"-ed in class LogPage.
1190 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1198 * Clear various cached data stored in this object.
1199 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1200 * given source. May be "name", "id", "defaults", "session", or false for
1203 public function clearInstanceCache( $reloadFrom = false ) {
1204 $this->mNewtalk
= -1;
1205 $this->mDatePreference
= null;
1206 $this->mBlockedby
= -1; # Unset
1207 $this->mHash
= false;
1208 $this->mRights
= null;
1209 $this->mEffectiveGroups
= null;
1210 $this->mImplicitGroups
= null;
1211 $this->mOptions
= null;
1213 if ( $reloadFrom ) {
1214 $this->mLoadedItems
= array();
1215 $this->mFrom
= $reloadFrom;
1220 * Combine the language default options with any site-specific options
1221 * and add the default language variants.
1223 * @return Array of String options
1225 public static function getDefaultOptions() {
1226 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1228 $defOpt = $wgDefaultUserOptions;
1229 # default language setting
1230 $variant = $wgContLang->getDefaultVariant();
1231 $defOpt['variant'] = $variant;
1232 $defOpt['language'] = $variant;
1233 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1234 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1236 $defOpt['skin'] = $wgDefaultSkin;
1238 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1239 // but that breaks the parser tests because they rely on being able to change $wgContLang
1240 // mid-request and see that change reflected in the return value of this function.
1241 // Which is insane and would never happen during normal MW operation, but is also not
1242 // likely to get fixed unless and until we context-ify everything.
1243 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1244 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1250 * Get a given default option value.
1252 * @param $opt String Name of option to retrieve
1253 * @return String Default option value
1255 public static function getDefaultOption( $opt ) {
1256 $defOpts = self
::getDefaultOptions();
1257 if( isset( $defOpts[$opt] ) ) {
1258 return $defOpts[$opt];
1266 * Get blocking information
1267 * @param $bFromSlave Bool Whether to check the slave database first. To
1268 * improve performance, non-critical checks are done
1269 * against slaves. Check when actually saving should be
1270 * done against master.
1272 private function getBlockedStatus( $bFromSlave = true ) {
1273 global $wgProxyWhitelist, $wgUser;
1275 if ( -1 != $this->mBlockedby
) {
1279 wfProfileIn( __METHOD__
);
1280 wfDebug( __METHOD__
.": checking...\n" );
1282 // Initialize data...
1283 // Otherwise something ends up stomping on $this->mBlockedby when
1284 // things get lazy-loaded later, causing false positive block hits
1285 // due to -1 !== 0. Probably session-related... Nothing should be
1286 // overwriting mBlockedby, surely?
1289 # We only need to worry about passing the IP address to the Block generator if the
1290 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1291 # know which IP address they're actually coming from
1292 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1293 $ip = $this->getRequest()->getIP();
1299 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1302 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1303 && !in_array( $ip, $wgProxyWhitelist ) )
1306 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1308 $block->setBlocker( wfMsg( 'proxyblocker' ) );
1309 $block->mReason
= wfMsg( 'proxyblockreason' );
1310 $block->setTarget( $ip );
1311 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1313 $block->setBlocker( wfMsg( 'sorbs' ) );
1314 $block->mReason
= wfMsg( 'sorbsreason' );
1315 $block->setTarget( $ip );
1319 if ( $block instanceof Block
) {
1320 wfDebug( __METHOD__
. ": Found block.\n" );
1321 $this->mBlock
= $block;
1322 $this->mBlockedby
= $block->getByName();
1323 $this->mBlockreason
= $block->mReason
;
1324 $this->mHideName
= $block->mHideName
;
1325 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1327 $this->mBlockedby
= '';
1328 $this->mHideName
= 0;
1329 $this->mAllowUsertalk
= false;
1333 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1335 wfProfileOut( __METHOD__
);
1339 * Whether the given IP is in a DNS blacklist.
1341 * @param $ip String IP to check
1342 * @param $checkWhitelist Bool: whether to check the whitelist first
1343 * @return Bool True if blacklisted.
1345 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1346 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1347 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1349 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1352 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1355 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1356 return $this->inDnsBlacklist( $ip, $urls );
1360 * Whether the given IP is in a given DNS blacklist.
1362 * @param $ip String IP to check
1363 * @param $bases String|Array of Strings: URL of the DNS blacklist
1364 * @return Bool True if blacklisted.
1366 public function inDnsBlacklist( $ip, $bases ) {
1367 wfProfileIn( __METHOD__
);
1370 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1371 if( IP
::isIPv4( $ip ) ) {
1372 # Reverse IP, bug 21255
1373 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1375 foreach( (array)$bases as $base ) {
1377 # If we have an access key, use that too (ProjectHoneypot, etc.)
1378 if( is_array( $base ) ) {
1379 if( count( $base ) >= 2 ) {
1380 # Access key is 1, base URL is 0
1381 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1383 $host = "$ipReversed.{$base[0]}";
1386 $host = "$ipReversed.$base";
1390 $ipList = gethostbynamel( $host );
1393 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1397 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1402 wfProfileOut( __METHOD__
);
1407 * Check if an IP address is in the local proxy list
1413 public static function isLocallyBlockedProxy( $ip ) {
1414 global $wgProxyList;
1416 if ( !$wgProxyList ) {
1419 wfProfileIn( __METHOD__
);
1421 if ( !is_array( $wgProxyList ) ) {
1422 # Load from the specified file
1423 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1426 if ( !is_array( $wgProxyList ) ) {
1428 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1430 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1431 # Old-style flipped proxy list
1436 wfProfileOut( __METHOD__
);
1441 * Is this user subject to rate limiting?
1443 * @return Bool True if rate limited
1445 public function isPingLimitable() {
1446 global $wgRateLimitsExcludedIPs;
1447 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1448 // No other good way currently to disable rate limits
1449 // for specific IPs. :P
1450 // But this is a crappy hack and should die.
1453 return !$this->isAllowed('noratelimit');
1457 * Primitive rate limits: enforce maximum actions per time period
1458 * to put a brake on flooding.
1460 * @note When using a shared cache like memcached, IP-address
1461 * last-hit counters will be shared across wikis.
1463 * @param $action String Action to enforce; 'edit' if unspecified
1464 * @return Bool True if a rate limiter was tripped
1466 public function pingLimiter( $action = 'edit' ) {
1467 # Call the 'PingLimiter' hook
1469 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1473 global $wgRateLimits;
1474 if( !isset( $wgRateLimits[$action] ) ) {
1478 # Some groups shouldn't trigger the ping limiter, ever
1479 if( !$this->isPingLimitable() )
1482 global $wgMemc, $wgRateLimitLog;
1483 wfProfileIn( __METHOD__
);
1485 $limits = $wgRateLimits[$action];
1487 $id = $this->getId();
1488 $ip = $this->getRequest()->getIP();
1491 if( isset( $limits['anon'] ) && $id == 0 ) {
1492 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1495 if( isset( $limits['user'] ) && $id != 0 ) {
1496 $userLimit = $limits['user'];
1498 if( $this->isNewbie() ) {
1499 if( isset( $limits['newbie'] ) && $id != 0 ) {
1500 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1502 if( isset( $limits['ip'] ) ) {
1503 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1506 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1507 $subnet = $matches[1];
1508 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1511 // Check for group-specific permissions
1512 // If more than one group applies, use the group with the highest limit
1513 foreach ( $this->getGroups() as $group ) {
1514 if ( isset( $limits[$group] ) ) {
1515 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1516 $userLimit = $limits[$group];
1520 // Set the user limit key
1521 if ( $userLimit !== false ) {
1522 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1523 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1527 foreach( $keys as $key => $limit ) {
1528 list( $max, $period ) = $limit;
1529 $summary = "(limit $max in {$period}s)";
1530 $count = $wgMemc->get( $key );
1533 if( $count >= $max ) {
1534 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1535 if( $wgRateLimitLog ) {
1536 wfSuppressWarnings();
1537 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1538 wfRestoreWarnings();
1542 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1545 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1546 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1548 $wgMemc->incr( $key );
1551 wfProfileOut( __METHOD__
);
1556 * Check if user is blocked
1558 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1559 * @return Bool True if blocked, false otherwise
1561 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1562 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1566 * Get the block affecting the user, or null if the user is not blocked
1568 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1569 * @return Block|null
1571 public function getBlock( $bFromSlave = true ){
1572 $this->getBlockedStatus( $bFromSlave );
1573 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1577 * Check if user is blocked from editing a particular article
1579 * @param $title Title to check
1580 * @param $bFromSlave Bool whether to check the slave database instead of the master
1583 function isBlockedFrom( $title, $bFromSlave = false ) {
1584 global $wgBlockAllowsUTEdit;
1585 wfProfileIn( __METHOD__
);
1587 $blocked = $this->isBlocked( $bFromSlave );
1588 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1589 # If a user's name is suppressed, they cannot make edits anywhere
1590 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1591 $title->getNamespace() == NS_USER_TALK
) {
1593 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1596 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1598 wfProfileOut( __METHOD__
);
1603 * If user is blocked, return the name of the user who placed the block
1604 * @return String name of blocker
1606 public function blockedBy() {
1607 $this->getBlockedStatus();
1608 return $this->mBlockedby
;
1612 * If user is blocked, return the specified reason for the block
1613 * @return String Blocking reason
1615 public function blockedFor() {
1616 $this->getBlockedStatus();
1617 return $this->mBlockreason
;
1621 * If user is blocked, return the ID for the block
1622 * @return Int Block ID
1624 public function getBlockId() {
1625 $this->getBlockedStatus();
1626 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1630 * Check if user is blocked on all wikis.
1631 * Do not use for actual edit permission checks!
1632 * This is intented for quick UI checks.
1634 * @param $ip String IP address, uses current client if none given
1635 * @return Bool True if blocked, false otherwise
1637 public function isBlockedGlobally( $ip = '' ) {
1638 if( $this->mBlockedGlobally
!== null ) {
1639 return $this->mBlockedGlobally
;
1641 // User is already an IP?
1642 if( IP
::isIPAddress( $this->getName() ) ) {
1643 $ip = $this->getName();
1645 $ip = $this->getRequest()->getIP();
1648 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1649 $this->mBlockedGlobally
= (bool)$blocked;
1650 return $this->mBlockedGlobally
;
1654 * Check if user account is locked
1656 * @return Bool True if locked, false otherwise
1658 public function isLocked() {
1659 if( $this->mLocked
!== null ) {
1660 return $this->mLocked
;
1663 $authUser = $wgAuth->getUserInstance( $this );
1664 $this->mLocked
= (bool)$authUser->isLocked();
1665 return $this->mLocked
;
1669 * Check if user account is hidden
1671 * @return Bool True if hidden, false otherwise
1673 public function isHidden() {
1674 if( $this->mHideName
!== null ) {
1675 return $this->mHideName
;
1677 $this->getBlockedStatus();
1678 if( !$this->mHideName
) {
1680 $authUser = $wgAuth->getUserInstance( $this );
1681 $this->mHideName
= (bool)$authUser->isHidden();
1683 return $this->mHideName
;
1687 * Get the user's ID.
1688 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1690 public function getId() {
1691 if( $this->mId
=== null && $this->mName
!== null
1692 && User
::isIP( $this->mName
) ) {
1693 // Special case, we know the user is anonymous
1695 } elseif( !$this->isItemLoaded( 'id' ) ) {
1696 // Don't load if this was initialized from an ID
1703 * Set the user and reload all fields according to a given ID
1704 * @param $v Int User ID to reload
1706 public function setId( $v ) {
1708 $this->clearInstanceCache( 'id' );
1712 * Get the user name, or the IP of an anonymous user
1713 * @return String User's name or IP address
1715 public function getName() {
1716 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1717 # Special case optimisation
1718 return $this->mName
;
1721 if ( $this->mName
=== false ) {
1723 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1725 return $this->mName
;
1730 * Set the user name.
1732 * This does not reload fields from the database according to the given
1733 * name. Rather, it is used to create a temporary "nonexistent user" for
1734 * later addition to the database. It can also be used to set the IP
1735 * address for an anonymous user to something other than the current
1738 * @note User::newFromName() has rougly the same function, when the named user
1740 * @param $str String New user name to set
1742 public function setName( $str ) {
1744 $this->mName
= $str;
1748 * Get the user's name escaped by underscores.
1749 * @return String Username escaped by underscores.
1751 public function getTitleKey() {
1752 return str_replace( ' ', '_', $this->getName() );
1756 * Check if the user has new messages.
1757 * @return Bool True if the user has new messages
1759 public function getNewtalk() {
1762 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1763 if( $this->mNewtalk
=== -1 ) {
1764 $this->mNewtalk
= false; # reset talk page status
1766 # Check memcached separately for anons, who have no
1767 # entire User object stored in there.
1770 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1771 $newtalk = $wgMemc->get( $key );
1772 if( strval( $newtalk ) !== '' ) {
1773 $this->mNewtalk
= (bool)$newtalk;
1775 // Since we are caching this, make sure it is up to date by getting it
1777 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1778 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1781 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1785 return (bool)$this->mNewtalk
;
1789 * Return the talk page(s) this user has new messages on.
1790 * @return Array of String page URLs
1792 public function getNewMessageLinks() {
1794 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1796 } elseif( !$this->getNewtalk() ) {
1799 $utp = $this->getTalkPage();
1800 $dbr = wfGetDB( DB_SLAVE
);
1801 // Get the "last viewed rev" timestamp from the oldest message notification
1802 $timestamp = $dbr->selectField( 'user_newtalk',
1803 'MIN(user_last_timestamp)',
1804 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1806 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1807 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1811 * Internal uncached check for new messages
1814 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1815 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1816 * @param $fromMaster Bool true to fetch from the master, false for a slave
1817 * @return Bool True if the user has new messages
1819 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1820 if ( $fromMaster ) {
1821 $db = wfGetDB( DB_MASTER
);
1823 $db = wfGetDB( DB_SLAVE
);
1825 $ok = $db->selectField( 'user_newtalk', $field,
1826 array( $field => $id ), __METHOD__
);
1827 return $ok !== false;
1831 * Add or update the new messages flag
1832 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1833 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1834 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1835 * @return Bool True if successful, false otherwise
1837 protected function updateNewtalk( $field, $id, $curRev = null ) {
1838 // Get timestamp of the talk page revision prior to the current one
1839 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1840 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1841 // Mark the user as having new messages since this revision
1842 $dbw = wfGetDB( DB_MASTER
);
1843 $dbw->insert( 'user_newtalk',
1844 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1847 if ( $dbw->affectedRows() ) {
1848 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1851 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1857 * Clear the new messages flag for the given user
1858 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1859 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1860 * @return Bool True if successful, false otherwise
1862 protected function deleteNewtalk( $field, $id ) {
1863 $dbw = wfGetDB( DB_MASTER
);
1864 $dbw->delete( 'user_newtalk',
1865 array( $field => $id ),
1867 if ( $dbw->affectedRows() ) {
1868 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1871 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1877 * Update the 'You have new messages!' status.
1878 * @param $val Bool Whether the user has new messages
1879 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1881 public function setNewtalk( $val, $curRev = null ) {
1882 if( wfReadOnly() ) {
1887 $this->mNewtalk
= $val;
1889 if( $this->isAnon() ) {
1891 $id = $this->getName();
1894 $id = $this->getId();
1899 $changed = $this->updateNewtalk( $field, $id, $curRev );
1901 $changed = $this->deleteNewtalk( $field, $id );
1904 if( $this->isAnon() ) {
1905 // Anons have a separate memcached space, since
1906 // user records aren't kept for them.
1907 $key = wfMemcKey( 'newtalk', 'ip', $id );
1908 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1911 $this->invalidateCache();
1916 * Generate a current or new-future timestamp to be stored in the
1917 * user_touched field when we update things.
1918 * @return String Timestamp in TS_MW format
1920 private static function newTouchedTimestamp() {
1921 global $wgClockSkewFudge;
1922 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1926 * Clear user data from memcached.
1927 * Use after applying fun updates to the database; caller's
1928 * responsibility to update user_touched if appropriate.
1930 * Called implicitly from invalidateCache() and saveSettings().
1932 private function clearSharedCache() {
1936 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1941 * Immediately touch the user data cache for this account.
1942 * Updates user_touched field, and removes account data from memcached
1943 * for reload on the next hit.
1945 public function invalidateCache() {
1946 if( wfReadOnly() ) {
1951 $this->mTouched
= self
::newTouchedTimestamp();
1953 $dbw = wfGetDB( DB_MASTER
);
1955 // Prevent contention slams by checking user_touched first
1956 $now = $dbw->timestamp( $this->mTouched
);
1957 $needsPurge = $dbw->selectField( 'user', '1',
1958 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1960 if ( $needsPurge ) {
1961 $dbw->update( 'user',
1962 array( 'user_touched' => $now ),
1963 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1968 $this->clearSharedCache();
1973 * Validate the cache for this account.
1974 * @param $timestamp String A timestamp in TS_MW format
1978 public function validateCache( $timestamp ) {
1980 return ( $timestamp >= $this->mTouched
);
1984 * Get the user touched timestamp
1985 * @return String timestamp
1987 public function getTouched() {
1989 return $this->mTouched
;
1993 * Set the password and reset the random token.
1994 * Calls through to authentication plugin if necessary;
1995 * will have no effect if the auth plugin refuses to
1996 * pass the change through or if the legal password
1999 * As a special case, setting the password to null
2000 * wipes it, so the account cannot be logged in until
2001 * a new password is set, for instance via e-mail.
2003 * @param $str String New password to set
2004 * @throws PasswordError on failure
2008 public function setPassword( $str ) {
2011 if( $str !== null ) {
2012 if( !$wgAuth->allowPasswordChange() ) {
2013 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
2016 if( !$this->isValidPassword( $str ) ) {
2017 global $wgMinimalPasswordLength;
2018 $valid = $this->getPasswordValidity( $str );
2019 if ( is_array( $valid ) ) {
2020 $message = array_shift( $valid );
2024 $params = array( $wgMinimalPasswordLength );
2026 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
2030 if( !$wgAuth->setPassword( $this, $str ) ) {
2031 throw new PasswordError( wfMsg( 'externaldberror' ) );
2034 $this->setInternalPassword( $str );
2040 * Set the password and reset the random token unconditionally.
2042 * @param $str String New password to set
2044 public function setInternalPassword( $str ) {
2048 if( $str === null ) {
2049 // Save an invalid hash...
2050 $this->mPassword
= '';
2052 $this->mPassword
= self
::crypt( $str );
2054 $this->mNewpassword
= '';
2055 $this->mNewpassTime
= null;
2059 * Get the user's current token.
2060 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2061 * @return String Token
2063 public function getToken( $forceCreation = true ) {
2065 if ( !$this->mToken
&& $forceCreation ) {
2068 return $this->mToken
;
2072 * Set the random token (used for persistent authentication)
2073 * Called from loadDefaults() among other places.
2075 * @param $token String|bool If specified, set the token to this value
2077 public function setToken( $token = false ) {
2080 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2082 $this->mToken
= $token;
2087 * Set the password for a password reminder or new account email
2089 * @param $str String New password to set
2090 * @param $throttle Bool If true, reset the throttle timestamp to the present
2092 public function setNewpassword( $str, $throttle = true ) {
2094 $this->mNewpassword
= self
::crypt( $str );
2096 $this->mNewpassTime
= wfTimestampNow();
2101 * Has password reminder email been sent within the last
2102 * $wgPasswordReminderResendTime hours?
2105 public function isPasswordReminderThrottled() {
2106 global $wgPasswordReminderResendTime;
2108 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2111 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2112 return time() < $expiry;
2116 * Get the user's e-mail address
2117 * @return String User's email address
2119 public function getEmail() {
2121 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2122 return $this->mEmail
;
2126 * Get the timestamp of the user's e-mail authentication
2127 * @return String TS_MW timestamp
2129 public function getEmailAuthenticationTimestamp() {
2131 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2132 return $this->mEmailAuthenticated
;
2136 * Set the user's e-mail address
2137 * @param $str String New e-mail address
2139 public function setEmail( $str ) {
2141 if( $str == $this->mEmail
) {
2144 $this->mEmail
= $str;
2145 $this->invalidateEmail();
2146 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2150 * Set the user's e-mail address and a confirmation mail if needed.
2153 * @param $str String New e-mail address
2156 public function setEmailWithConfirmation( $str ) {
2157 global $wgEnableEmail, $wgEmailAuthentication;
2159 if ( !$wgEnableEmail ) {
2160 return Status
::newFatal( 'emaildisabled' );
2163 $oldaddr = $this->getEmail();
2164 if ( $str === $oldaddr ) {
2165 return Status
::newGood( true );
2168 $this->setEmail( $str );
2170 if ( $str !== '' && $wgEmailAuthentication ) {
2171 # Send a confirmation request to the new address if needed
2172 $type = $oldaddr != '' ?
'changed' : 'set';
2173 $result = $this->sendConfirmationMail( $type );
2174 if ( $result->isGood() ) {
2175 # Say the the caller that a confirmation mail has been sent
2176 $result->value
= 'eauth';
2179 $result = Status
::newGood( true );
2186 * Get the user's real name
2187 * @return String User's real name
2189 public function getRealName() {
2190 if ( !$this->isItemLoaded( 'realname' ) ) {
2194 return $this->mRealName
;
2198 * Set the user's real name
2199 * @param $str String New real name
2201 public function setRealName( $str ) {
2203 $this->mRealName
= $str;
2207 * Get the user's current setting for a given option.
2209 * @param $oname String The option to check
2210 * @param $defaultOverride String A default value returned if the option does not exist
2211 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2212 * @return String User's current value for the option
2213 * @see getBoolOption()
2214 * @see getIntOption()
2216 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2217 global $wgHiddenPrefs;
2218 $this->loadOptions();
2220 if ( is_null( $this->mOptions
) ) {
2221 if($defaultOverride != '') {
2222 return $defaultOverride;
2224 $this->mOptions
= User
::getDefaultOptions();
2227 # We want 'disabled' preferences to always behave as the default value for
2228 # users, even if they have set the option explicitly in their settings (ie they
2229 # set it, and then it was disabled removing their ability to change it). But
2230 # we don't want to erase the preferences in the database in case the preference
2231 # is re-enabled again. So don't touch $mOptions, just override the returned value
2232 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2233 return self
::getDefaultOption( $oname );
2236 if ( array_key_exists( $oname, $this->mOptions
) ) {
2237 return $this->mOptions
[$oname];
2239 return $defaultOverride;
2244 * Get all user's options
2248 public function getOptions() {
2249 global $wgHiddenPrefs;
2250 $this->loadOptions();
2251 $options = $this->mOptions
;
2253 # We want 'disabled' preferences to always behave as the default value for
2254 # users, even if they have set the option explicitly in their settings (ie they
2255 # set it, and then it was disabled removing their ability to change it). But
2256 # we don't want to erase the preferences in the database in case the preference
2257 # is re-enabled again. So don't touch $mOptions, just override the returned value
2258 foreach( $wgHiddenPrefs as $pref ){
2259 $default = self
::getDefaultOption( $pref );
2260 if( $default !== null ){
2261 $options[$pref] = $default;
2269 * Get the user's current setting for a given option, as a boolean value.
2271 * @param $oname String The option to check
2272 * @return Bool User's current value for the option
2275 public function getBoolOption( $oname ) {
2276 return (bool)$this->getOption( $oname );
2280 * Get the user's current setting for a given option, as a boolean value.
2282 * @param $oname String The option to check
2283 * @param $defaultOverride Int A default value returned if the option does not exist
2284 * @return Int User's current value for the option
2287 public function getIntOption( $oname, $defaultOverride=0 ) {
2288 $val = $this->getOption( $oname );
2290 $val = $defaultOverride;
2292 return intval( $val );
2296 * Set the given option for a user.
2298 * @param $oname String The option to set
2299 * @param $val mixed New value to set
2301 public function setOption( $oname, $val ) {
2303 $this->loadOptions();
2305 // Explicitly NULL values should refer to defaults
2306 if( is_null( $val ) ) {
2307 $defaultOption = self
::getDefaultOption( $oname );
2308 if( !is_null( $defaultOption ) ) {
2309 $val = $defaultOption;
2313 $this->mOptions
[$oname] = $val;
2317 * Reset all options to the site defaults
2319 public function resetOptions() {
2322 $this->mOptions
= self
::getDefaultOptions();
2323 $this->mOptionsLoaded
= true;
2327 * Get the user's preferred date format.
2328 * @return String User's preferred date format
2330 public function getDatePreference() {
2331 // Important migration for old data rows
2332 if ( is_null( $this->mDatePreference
) ) {
2334 $value = $this->getOption( 'date' );
2335 $map = $wgLang->getDatePreferenceMigrationMap();
2336 if ( isset( $map[$value] ) ) {
2337 $value = $map[$value];
2339 $this->mDatePreference
= $value;
2341 return $this->mDatePreference
;
2345 * Get the user preferred stub threshold
2349 public function getStubThreshold() {
2350 global $wgMaxArticleSize; # Maximum article size, in Kb
2351 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2352 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2353 # If they have set an impossible value, disable the preference
2354 # so we can use the parser cache again.
2361 * Get the permissions this user has.
2362 * @return Array of String permission names
2364 public function getRights() {
2365 if ( is_null( $this->mRights
) ) {
2366 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2367 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2368 // Force reindexation of rights when a hook has unset one of them
2369 $this->mRights
= array_values( $this->mRights
);
2371 return $this->mRights
;
2375 * Get the list of explicit group memberships this user has.
2376 * The implicit * and user groups are not included.
2377 * @return Array of String internal group names
2379 public function getGroups() {
2381 $this->loadGroups();
2382 return $this->mGroups
;
2386 * Get the list of implicit group memberships this user has.
2387 * This includes all explicit groups, plus 'user' if logged in,
2388 * '*' for all accounts, and autopromoted groups
2389 * @param $recache Bool Whether to avoid the cache
2390 * @return Array of String internal group names
2392 public function getEffectiveGroups( $recache = false ) {
2393 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2394 wfProfileIn( __METHOD__
);
2395 $this->mEffectiveGroups
= array_unique( array_merge(
2396 $this->getGroups(), // explicit groups
2397 $this->getAutomaticGroups( $recache ) // implicit groups
2399 # Hook for additional groups
2400 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2401 wfProfileOut( __METHOD__
);
2403 return $this->mEffectiveGroups
;
2407 * Get the list of implicit group memberships this user has.
2408 * This includes 'user' if logged in, '*' for all accounts,
2409 * and autopromoted groups
2410 * @param $recache Bool Whether to avoid the cache
2411 * @return Array of String internal group names
2413 public function getAutomaticGroups( $recache = false ) {
2414 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2415 wfProfileIn( __METHOD__
);
2416 $this->mImplicitGroups
= array( '*' );
2417 if ( $this->getId() ) {
2418 $this->mImplicitGroups
[] = 'user';
2420 $this->mImplicitGroups
= array_unique( array_merge(
2421 $this->mImplicitGroups
,
2422 Autopromote
::getAutopromoteGroups( $this )
2426 # Assure data consistency with rights/groups,
2427 # as getEffectiveGroups() depends on this function
2428 $this->mEffectiveGroups
= null;
2430 wfProfileOut( __METHOD__
);
2432 return $this->mImplicitGroups
;
2436 * Returns the groups the user has belonged to.
2438 * The user may still belong to the returned groups. Compare with getGroups().
2440 * The function will not return groups the user had belonged to before MW 1.17
2442 * @return array Names of the groups the user has belonged to.
2444 public function getFormerGroups() {
2445 if( is_null( $this->mFormerGroups
) ) {
2446 $dbr = wfGetDB( DB_MASTER
);
2447 $res = $dbr->select( 'user_former_groups',
2448 array( 'ufg_group' ),
2449 array( 'ufg_user' => $this->mId
),
2451 $this->mFormerGroups
= array();
2452 foreach( $res as $row ) {
2453 $this->mFormerGroups
[] = $row->ufg_group
;
2456 return $this->mFormerGroups
;
2460 * Get the user's edit count.
2463 public function getEditCount() {
2464 if( $this->getId() ) {
2465 if ( !isset( $this->mEditCount
) ) {
2466 /* Populate the count, if it has not been populated yet */
2467 $this->mEditCount
= User
::edits( $this->mId
);
2469 return $this->mEditCount
;
2477 * Add the user to the given group.
2478 * This takes immediate effect.
2479 * @param $group String Name of the group to add
2481 public function addGroup( $group ) {
2482 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2483 $dbw = wfGetDB( DB_MASTER
);
2484 if( $this->getId() ) {
2485 $dbw->insert( 'user_groups',
2487 'ug_user' => $this->getID(),
2488 'ug_group' => $group,
2491 array( 'IGNORE' ) );
2494 $this->loadGroups();
2495 $this->mGroups
[] = $group;
2496 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2498 $this->invalidateCache();
2502 * Remove the user from the given group.
2503 * This takes immediate effect.
2504 * @param $group String Name of the group to remove
2506 public function removeGroup( $group ) {
2508 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2509 $dbw = wfGetDB( DB_MASTER
);
2510 $dbw->delete( 'user_groups',
2512 'ug_user' => $this->getID(),
2513 'ug_group' => $group,
2515 // Remember that the user was in this group
2516 $dbw->insert( 'user_former_groups',
2518 'ufg_user' => $this->getID(),
2519 'ufg_group' => $group,
2522 array( 'IGNORE' ) );
2524 $this->loadGroups();
2525 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2526 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2528 $this->invalidateCache();
2532 * Get whether the user is logged in
2535 public function isLoggedIn() {
2536 return $this->getID() != 0;
2540 * Get whether the user is anonymous
2543 public function isAnon() {
2544 return !$this->isLoggedIn();
2548 * Check if user is allowed to access a feature / make an action
2550 * @internal param \String $varargs permissions to test
2551 * @return Boolean: True if user is allowed to perform *any* of the given actions
2555 public function isAllowedAny( /*...*/ ){
2556 $permissions = func_get_args();
2557 foreach( $permissions as $permission ){
2558 if( $this->isAllowed( $permission ) ){
2567 * @internal param $varargs string
2568 * @return bool True if the user is allowed to perform *all* of the given actions
2570 public function isAllowedAll( /*...*/ ){
2571 $permissions = func_get_args();
2572 foreach( $permissions as $permission ){
2573 if( !$this->isAllowed( $permission ) ){
2581 * Internal mechanics of testing a permission
2582 * @param $action String
2585 public function isAllowed( $action = '' ) {
2586 if ( $action === '' ) {
2587 return true; // In the spirit of DWIM
2589 # Patrolling may not be enabled
2590 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2591 global $wgUseRCPatrol, $wgUseNPPatrol;
2592 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2595 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2596 # by misconfiguration: 0 == 'foo'
2597 return in_array( $action, $this->getRights(), true );
2601 * Check whether to enable recent changes patrol features for this user
2602 * @return Boolean: True or false
2604 public function useRCPatrol() {
2605 global $wgUseRCPatrol;
2606 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2610 * Check whether to enable new pages patrol features for this user
2611 * @return Bool True or false
2613 public function useNPPatrol() {
2614 global $wgUseRCPatrol, $wgUseNPPatrol;
2615 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2619 * Get the WebRequest object to use with this object
2621 * @return WebRequest
2623 public function getRequest() {
2624 if ( $this->mRequest
) {
2625 return $this->mRequest
;
2633 * Get the current skin, loading it if required
2634 * @return Skin The current skin
2635 * @todo FIXME: Need to check the old failback system [AV]
2636 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2638 public function getSkin() {
2639 wfDeprecated( __METHOD__
, '1.18' );
2640 return RequestContext
::getMain()->getSkin();
2644 * Get a WatchedItem for this user and $title.
2646 * @param $title Title
2647 * @return WatchedItem
2649 public function getWatchedItem( $title ) {
2650 $key = $title->getNamespace() . ':' . $title->getDBkey();
2652 if ( isset( $this->mWatchedItems
[$key] ) ) {
2653 return $this->mWatchedItems
[$key];
2656 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2657 $this->mWatchedItems
= array();
2660 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2661 return $this->mWatchedItems
[$key];
2665 * Check the watched status of an article.
2666 * @param $title Title of the article to look at
2669 public function isWatched( $title ) {
2670 return $this->getWatchedItem( $title )->isWatched();
2675 * @param $title Title of the article to look at
2677 public function addWatch( $title ) {
2678 $this->getWatchedItem( $title )->addWatch();
2679 $this->invalidateCache();
2683 * Stop watching an article.
2684 * @param $title Title of the article to look at
2686 public function removeWatch( $title ) {
2687 $this->getWatchedItem( $title )->removeWatch();
2688 $this->invalidateCache();
2692 * Clear the user's notification timestamp for the given title.
2693 * If e-notif e-mails are on, they will receive notification mails on
2694 * the next change of the page if it's watched etc.
2695 * @param $title Title of the article to look at
2697 public function clearNotification( &$title ) {
2698 global $wgUseEnotif, $wgShowUpdatedMarker;
2700 # Do nothing if the database is locked to writes
2701 if( wfReadOnly() ) {
2705 if( $title->getNamespace() == NS_USER_TALK
&&
2706 $title->getText() == $this->getName() ) {
2707 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2709 $this->setNewtalk( false );
2712 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2716 if( $this->isAnon() ) {
2717 // Nothing else to do...
2721 // Only update the timestamp if the page is being watched.
2722 // The query to find out if it is watched is cached both in memcached and per-invocation,
2723 // and when it does have to be executed, it can be on a slave
2724 // If this is the user's newtalk page, we always update the timestamp
2726 if ( $title->getNamespace() == NS_USER_TALK
&&
2727 $title->getText() == $this->getName() )
2732 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2736 * Resets all of the given user's page-change notification timestamps.
2737 * If e-notif e-mails are on, they will receive notification mails on
2738 * the next change of any watched page.
2740 public function clearAllNotifications() {
2741 global $wgUseEnotif, $wgShowUpdatedMarker;
2742 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2743 $this->setNewtalk( false );
2746 $id = $this->getId();
2748 $dbw = wfGetDB( DB_MASTER
);
2749 $dbw->update( 'watchlist',
2751 'wl_notificationtimestamp' => null
2752 ), array( /* WHERE */
2756 # We also need to clear here the "you have new message" notification for the own user_talk page
2757 # This is cleared one page view later in Article::viewUpdates();
2762 * Set this user's options from an encoded string
2763 * @param $str String Encoded options to import
2765 * @deprecated in 1.19 due to removal of user_options from the user table
2767 private function decodeOptions( $str ) {
2768 wfDeprecated( __METHOD__
, '1.19' );
2772 $this->mOptionsLoaded
= true;
2773 $this->mOptionOverrides
= array();
2775 // If an option is not set in $str, use the default value
2776 $this->mOptions
= self
::getDefaultOptions();
2778 $a = explode( "\n", $str );
2779 foreach ( $a as $s ) {
2781 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2782 $this->mOptions
[$m[1]] = $m[2];
2783 $this->mOptionOverrides
[$m[1]] = $m[2];
2789 * Set a cookie on the user's client. Wrapper for
2790 * WebResponse::setCookie
2791 * @param $name String Name of the cookie to set
2792 * @param $value String Value to set
2793 * @param $exp Int Expiration time, as a UNIX time value;
2794 * if 0 or not specified, use the default $wgCookieExpiration
2796 protected function setCookie( $name, $value, $exp = 0 ) {
2797 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2801 * Clear a cookie on the user's client
2802 * @param $name String Name of the cookie to clear
2804 protected function clearCookie( $name ) {
2805 $this->setCookie( $name, '', time() - 86400 );
2809 * Set the default cookies for this session on the user's client.
2811 * @param $request WebRequest object to use; $wgRequest will be used if null
2814 public function setCookies( $request = null ) {
2815 if ( $request === null ) {
2816 $request = $this->getRequest();
2820 if ( 0 == $this->mId
) return;
2821 if ( !$this->mToken
) {
2822 // When token is empty or NULL generate a new one and then save it to the database
2823 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2824 // Simply by setting every cell in the user_token column to NULL and letting them be
2825 // regenerated as users log back into the wiki.
2827 $this->saveSettings();
2830 'wsUserID' => $this->mId
,
2831 'wsToken' => $this->mToken
,
2832 'wsUserName' => $this->getName()
2835 'UserID' => $this->mId
,
2836 'UserName' => $this->getName(),
2838 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2839 $cookies['Token'] = $this->mToken
;
2841 $cookies['Token'] = false;
2844 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2846 foreach ( $session as $name => $value ) {
2847 $request->setSessionData( $name, $value );
2849 foreach ( $cookies as $name => $value ) {
2850 if ( $value === false ) {
2851 $this->clearCookie( $name );
2853 $this->setCookie( $name, $value );
2859 * Log this user out.
2861 public function logout() {
2862 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2868 * Clear the user's cookies and session, and reset the instance cache.
2871 public function doLogout() {
2872 $this->clearInstanceCache( 'defaults' );
2874 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2876 $this->clearCookie( 'UserID' );
2877 $this->clearCookie( 'Token' );
2879 # Remember when user logged out, to prevent seeing cached pages
2880 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2884 * Save this user's settings into the database.
2885 * @todo Only rarely do all these fields need to be set!
2887 public function saveSettings() {
2889 if ( wfReadOnly() ) { return; }
2890 if ( 0 == $this->mId
) { return; }
2892 $this->mTouched
= self
::newTouchedTimestamp();
2894 $dbw = wfGetDB( DB_MASTER
);
2895 $dbw->update( 'user',
2897 'user_name' => $this->mName
,
2898 'user_password' => $this->mPassword
,
2899 'user_newpassword' => $this->mNewpassword
,
2900 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2901 'user_real_name' => $this->mRealName
,
2902 'user_email' => $this->mEmail
,
2903 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2904 'user_touched' => $dbw->timestamp( $this->mTouched
),
2905 'user_token' => strval( $this->mToken
),
2906 'user_email_token' => $this->mEmailToken
,
2907 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2908 ), array( /* WHERE */
2909 'user_id' => $this->mId
2913 $this->saveOptions();
2915 wfRunHooks( 'UserSaveSettings', array( $this ) );
2916 $this->clearSharedCache();
2917 $this->getUserPage()->invalidateCache();
2921 * If only this user's username is known, and it exists, return the user ID.
2924 public function idForName() {
2925 $s = trim( $this->getName() );
2926 if ( $s === '' ) return 0;
2928 $dbr = wfGetDB( DB_SLAVE
);
2929 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2930 if ( $id === false ) {
2937 * Add a user to the database, return the user object
2939 * @param $name String Username to add
2940 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2941 * - password The user's password hash. Password logins will be disabled if this is omitted.
2942 * - newpassword Hash for a temporary password that has been mailed to the user
2943 * - email The user's email address
2944 * - email_authenticated The email authentication timestamp
2945 * - real_name The user's real name
2946 * - options An associative array of non-default options
2947 * - token Random authentication token. Do not set.
2948 * - registration Registration timestamp. Do not set.
2950 * @return User object, or null if the username already exists
2952 public static function createNew( $name, $params = array() ) {
2955 if ( isset( $params['options'] ) ) {
2956 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2957 unset( $params['options'] );
2959 $dbw = wfGetDB( DB_MASTER
);
2960 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2963 'user_id' => $seqVal,
2964 'user_name' => $name,
2965 'user_password' => $user->mPassword
,
2966 'user_newpassword' => $user->mNewpassword
,
2967 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2968 'user_email' => $user->mEmail
,
2969 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2970 'user_real_name' => $user->mRealName
,
2971 'user_token' => strval( $user->mToken
),
2972 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2973 'user_editcount' => 0,
2974 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
2976 foreach ( $params as $name => $value ) {
2977 $fields["user_$name"] = $value;
2979 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2980 if ( $dbw->affectedRows() ) {
2981 $newUser = User
::newFromId( $dbw->insertId() );
2989 * Add this existing user object to the database
2991 public function addToDatabase() {
2994 $this->mTouched
= self
::newTouchedTimestamp();
2996 $dbw = wfGetDB( DB_MASTER
);
2997 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2998 $dbw->insert( 'user',
3000 'user_id' => $seqVal,
3001 'user_name' => $this->mName
,
3002 'user_password' => $this->mPassword
,
3003 'user_newpassword' => $this->mNewpassword
,
3004 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3005 'user_email' => $this->mEmail
,
3006 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3007 'user_real_name' => $this->mRealName
,
3008 'user_token' => strval( $this->mToken
),
3009 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3010 'user_editcount' => 0,
3011 'user_touched' => $dbw->timestamp( $this->mTouched
),
3014 $this->mId
= $dbw->insertId();
3016 // Clear instance cache other than user table data, which is already accurate
3017 $this->clearInstanceCache();
3019 $this->saveOptions();
3023 * If this user is logged-in and blocked,
3024 * block any IP address they've successfully logged in from.
3025 * @return bool A block was spread
3027 public function spreadAnyEditBlock() {
3028 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3029 return $this->spreadBlock();
3035 * If this (non-anonymous) user is blocked,
3036 * block the IP address they've successfully logged in from.
3037 * @return bool A block was spread
3039 protected function spreadBlock() {
3040 wfDebug( __METHOD__
. "()\n" );
3042 if ( $this->mId
== 0 ) {
3046 $userblock = Block
::newFromTarget( $this->getName() );
3047 if ( !$userblock ) {
3051 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3055 * Generate a string which will be different for any combination of
3056 * user options which would produce different parser output.
3057 * This will be used as part of the hash key for the parser cache,
3058 * so users with the same options can share the same cached data
3061 * Extensions which require it should install 'PageRenderingHash' hook,
3062 * which will give them a chance to modify this key based on their own
3065 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3066 * @return String Page rendering hash
3068 public function getPageRenderingHash() {
3069 wfDeprecated( __METHOD__
, '1.17' );
3071 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3073 return $this->mHash
;
3076 // stubthreshold is only included below for completeness,
3077 // since it disables the parser cache, its value will always
3078 // be 0 when this function is called by parsercache.
3080 $confstr = $this->getOption( 'math' );
3081 $confstr .= '!' . $this->getStubThreshold();
3082 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3083 $confstr .= '!' . $this->getDatePreference();
3085 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3086 $confstr .= '!' . $wgLang->getCode();
3087 $confstr .= '!' . $this->getOption( 'thumbsize' );
3088 // add in language specific options, if any
3089 $extra = $wgContLang->getExtraHashOptions();
3092 // Since the skin could be overloading link(), it should be
3093 // included here but in practice, none of our skins do that.
3095 $confstr .= $wgRenderHashAppend;
3097 // Give a chance for extensions to modify the hash, if they have
3098 // extra options or other effects on the parser cache.
3099 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3101 // Make it a valid memcached key fragment
3102 $confstr = str_replace( ' ', '_', $confstr );
3103 $this->mHash
= $confstr;
3108 * Get whether the user is explicitly blocked from account creation.
3109 * @return Bool|Block
3111 public function isBlockedFromCreateAccount() {
3112 $this->getBlockedStatus();
3113 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3114 return $this->mBlock
;
3117 # bug 13611: if the IP address the user is trying to create an account from is
3118 # blocked with createaccount disabled, prevent new account creation there even
3119 # when the user is logged in
3120 if( $this->mBlockedFromCreateAccount
=== false ){
3121 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3123 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3124 ?
$this->mBlockedFromCreateAccount
3129 * Get whether the user is blocked from using Special:Emailuser.
3132 public function isBlockedFromEmailuser() {
3133 $this->getBlockedStatus();
3134 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3138 * Get whether the user is allowed to create an account.
3141 function isAllowedToCreateAccount() {
3142 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3146 * Get this user's personal page title.
3148 * @return Title: User's personal page title
3150 public function getUserPage() {
3151 return Title
::makeTitle( NS_USER
, $this->getName() );
3155 * Get this user's talk page title.
3157 * @return Title: User's talk page title
3159 public function getTalkPage() {
3160 $title = $this->getUserPage();
3161 return $title->getTalkPage();
3165 * Determine whether the user is a newbie. Newbies are either
3166 * anonymous IPs, or the most recently created accounts.
3169 public function isNewbie() {
3170 return !$this->isAllowed( 'autoconfirmed' );
3174 * Check to see if the given clear-text password is one of the accepted passwords
3175 * @param $password String: user password.
3176 * @return Boolean: True if the given password is correct, otherwise False.
3178 public function checkPassword( $password ) {
3179 global $wgAuth, $wgLegacyEncoding;
3182 // Even though we stop people from creating passwords that
3183 // are shorter than this, doesn't mean people wont be able
3184 // to. Certain authentication plugins do NOT want to save
3185 // domain passwords in a mysql database, so we should
3186 // check this (in case $wgAuth->strict() is false).
3187 if( !$this->isValidPassword( $password ) ) {
3191 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3193 } elseif( $wgAuth->strict() ) {
3194 /* Auth plugin doesn't allow local authentication */
3196 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3197 /* Auth plugin doesn't allow local authentication for this user name */
3200 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3202 } elseif ( $wgLegacyEncoding ) {
3203 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3204 # Check for this with iconv
3205 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3206 if ( $cp1252Password != $password &&
3207 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3216 * Check if the given clear-text password matches the temporary password
3217 * sent by e-mail for password reset operations.
3219 * @param $plaintext string
3221 * @return Boolean: True if matches, false otherwise
3223 public function checkTemporaryPassword( $plaintext ) {
3224 global $wgNewPasswordExpiry;
3227 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3228 if ( is_null( $this->mNewpassTime
) ) {
3231 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3232 return ( time() < $expiry );
3239 * Alias for getEditToken.
3240 * @deprecated since 1.19, use getEditToken instead.
3242 * @param $salt String|Array of Strings Optional function-specific data for hashing
3243 * @param $request WebRequest object to use or null to use $wgRequest
3244 * @return String The new edit token
3246 public function editToken( $salt = '', $request = null ) {
3247 wfDeprecated( __METHOD__
, '1.19' );
3248 return $this->getEditToken( $salt, $request );
3252 * Initialize (if necessary) and return a session token value
3253 * which can be used in edit forms to show that the user's
3254 * login credentials aren't being hijacked with a foreign form
3259 * @param $salt String|Array of Strings Optional function-specific data for hashing
3260 * @param $request WebRequest object to use or null to use $wgRequest
3261 * @return String The new edit token
3263 public function getEditToken( $salt = '', $request = null ) {
3264 if ( $request == null ) {
3265 $request = $this->getRequest();
3268 if ( $this->isAnon() ) {
3269 return EDIT_TOKEN_SUFFIX
;
3271 $token = $request->getSessionData( 'wsEditToken' );
3272 if ( $token === null ) {
3273 $token = MWCryptRand
::generateHex( 32 );
3274 $request->setSessionData( 'wsEditToken', $token );
3276 if( is_array( $salt ) ) {
3277 $salt = implode( '|', $salt );
3279 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3284 * Generate a looking random token for various uses.
3286 * @param $salt String Optional salt value
3287 * @return String The new random token
3288 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3290 public static function generateToken( $salt = '' ) {
3291 return MWCryptRand
::generateHex( 32 );
3295 * Check given value against the token value stored in the session.
3296 * A match should confirm that the form was submitted from the
3297 * user's own login session, not a form submission from a third-party
3300 * @param $val String Input value to compare
3301 * @param $salt String Optional function-specific data for hashing
3302 * @param $request WebRequest object to use or null to use $wgRequest
3303 * @return Boolean: Whether the token matches
3305 public function matchEditToken( $val, $salt = '', $request = null ) {
3306 $sessionToken = $this->getEditToken( $salt, $request );
3307 if ( $val != $sessionToken ) {
3308 wfDebug( "User::matchEditToken: broken session data\n" );
3310 return $val == $sessionToken;
3314 * Check given value against the token value stored in the session,
3315 * ignoring the suffix.
3317 * @param $val String Input value to compare
3318 * @param $salt String Optional function-specific data for hashing
3319 * @param $request WebRequest object to use or null to use $wgRequest
3320 * @return Boolean: Whether the token matches
3322 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3323 $sessionToken = $this->getEditToken( $salt, $request );
3324 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3328 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3329 * mail to the user's given address.
3331 * @param $type String: message to send, either "created", "changed" or "set"
3332 * @return Status object
3334 public function sendConfirmationMail( $type = 'created' ) {
3336 $expiration = null; // gets passed-by-ref and defined in next line.
3337 $token = $this->confirmationToken( $expiration );
3338 $url = $this->confirmationTokenUrl( $token );
3339 $invalidateURL = $this->invalidationTokenUrl( $token );
3340 $this->saveSettings();
3342 if ( $type == 'created' ||
$type === false ) {
3343 $message = 'confirmemail_body';
3344 } elseif ( $type === true ) {
3345 $message = 'confirmemail_body_changed';
3347 $message = 'confirmemail_body_' . $type;
3350 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3352 $this->getRequest()->getIP(),
3355 $wgLang->timeanddate( $expiration, false ),
3357 $wgLang->date( $expiration, false ),
3358 $wgLang->time( $expiration, false ) ) );
3362 * Send an e-mail to this user's account. Does not check for
3363 * confirmed status or validity.
3365 * @param $subject String Message subject
3366 * @param $body String Message body
3367 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3368 * @param $replyto String Reply-To address
3371 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3372 if( is_null( $from ) ) {
3373 global $wgPasswordSender, $wgPasswordSenderName;
3374 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3376 $sender = new MailAddress( $from );
3379 $to = new MailAddress( $this );
3380 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3384 * Generate, store, and return a new e-mail confirmation code.
3385 * A hash (unsalted, since it's used as a key) is stored.
3387 * @note Call saveSettings() after calling this function to commit
3388 * this change to the database.
3390 * @param &$expiration \mixed Accepts the expiration time
3391 * @return String New token
3393 private function confirmationToken( &$expiration ) {
3394 global $wgUserEmailConfirmationTokenExpiry;
3396 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3397 $expiration = wfTimestamp( TS_MW
, $expires );
3399 $token = MWCryptRand
::generateHex( 32 );
3400 $hash = md5( $token );
3401 $this->mEmailToken
= $hash;
3402 $this->mEmailTokenExpires
= $expiration;
3407 * Return a URL the user can use to confirm their email address.
3408 * @param $token String Accepts the email confirmation token
3409 * @return String New token URL
3411 private function confirmationTokenUrl( $token ) {
3412 return $this->getTokenUrl( 'ConfirmEmail', $token );
3416 * Return a URL the user can use to invalidate their email address.
3417 * @param $token String Accepts the email confirmation token
3418 * @return String New token URL
3420 private function invalidationTokenUrl( $token ) {
3421 return $this->getTokenUrl( 'InvalidateEmail', $token );
3425 * Internal function to format the e-mail validation/invalidation URLs.
3426 * This uses a quickie hack to use the
3427 * hardcoded English names of the Special: pages, for ASCII safety.
3429 * @note Since these URLs get dropped directly into emails, using the
3430 * short English names avoids insanely long URL-encoded links, which
3431 * also sometimes can get corrupted in some browsers/mailers
3432 * (bug 6957 with Gmail and Internet Explorer).
3434 * @param $page String Special page
3435 * @param $token String Token
3436 * @return String Formatted URL
3438 protected function getTokenUrl( $page, $token ) {
3439 // Hack to bypass localization of 'Special:'
3440 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3441 return $title->getCanonicalUrl();
3445 * Mark the e-mail address confirmed.
3447 * @note Call saveSettings() after calling this function to commit the change.
3451 public function confirmEmail() {
3452 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3453 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3458 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3459 * address if it was already confirmed.
3461 * @note Call saveSettings() after calling this function to commit the change.
3462 * @return bool Returns true
3464 function invalidateEmail() {
3466 $this->mEmailToken
= null;
3467 $this->mEmailTokenExpires
= null;
3468 $this->setEmailAuthenticationTimestamp( null );
3469 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3474 * Set the e-mail authentication timestamp.
3475 * @param $timestamp String TS_MW timestamp
3477 function setEmailAuthenticationTimestamp( $timestamp ) {
3479 $this->mEmailAuthenticated
= $timestamp;
3480 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3484 * Is this user allowed to send e-mails within limits of current
3485 * site configuration?
3488 public function canSendEmail() {
3489 global $wgEnableEmail, $wgEnableUserEmail;
3490 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3493 $canSend = $this->isEmailConfirmed();
3494 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3499 * Is this user allowed to receive e-mails within limits of current
3500 * site configuration?
3503 public function canReceiveEmail() {
3504 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3508 * Is this user's e-mail address valid-looking and confirmed within
3509 * limits of the current site configuration?
3511 * @note If $wgEmailAuthentication is on, this may require the user to have
3512 * confirmed their address by returning a code or using a password
3513 * sent to the address from the wiki.
3517 public function isEmailConfirmed() {
3518 global $wgEmailAuthentication;
3521 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3522 if( $this->isAnon() ) {
3525 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3528 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3538 * Check whether there is an outstanding request for e-mail confirmation.
3541 public function isEmailConfirmationPending() {
3542 global $wgEmailAuthentication;
3543 return $wgEmailAuthentication &&
3544 !$this->isEmailConfirmed() &&
3545 $this->mEmailToken
&&
3546 $this->mEmailTokenExpires
> wfTimestamp();
3550 * Get the timestamp of account creation.
3552 * @return String|Bool Timestamp of account creation, or false for
3553 * non-existent/anonymous user accounts.
3555 public function getRegistration() {
3556 if ( $this->isAnon() ) {
3560 return $this->mRegistration
;
3564 * Get the timestamp of the first edit
3566 * @return String|Bool Timestamp of first edit, or false for
3567 * non-existent/anonymous user accounts.
3569 public function getFirstEditTimestamp() {
3570 if( $this->getId() == 0 ) {
3571 return false; // anons
3573 $dbr = wfGetDB( DB_SLAVE
);
3574 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3575 array( 'rev_user' => $this->getId() ),
3577 array( 'ORDER BY' => 'rev_timestamp ASC' )
3580 return false; // no edits
3582 return wfTimestamp( TS_MW
, $time );
3586 * Get the permissions associated with a given list of groups
3588 * @param $groups Array of Strings List of internal group names
3589 * @return Array of Strings List of permission key names for given groups combined
3591 public static function getGroupPermissions( $groups ) {
3592 global $wgGroupPermissions, $wgRevokePermissions;
3594 // grant every granted permission first
3595 foreach( $groups as $group ) {
3596 if( isset( $wgGroupPermissions[$group] ) ) {
3597 $rights = array_merge( $rights,
3598 // array_filter removes empty items
3599 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3602 // now revoke the revoked permissions
3603 foreach( $groups as $group ) {
3604 if( isset( $wgRevokePermissions[$group] ) ) {
3605 $rights = array_diff( $rights,
3606 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3609 return array_unique( $rights );
3613 * Get all the groups who have a given permission
3615 * @param $role String Role to check
3616 * @return Array of Strings List of internal group names with the given permission
3618 public static function getGroupsWithPermission( $role ) {
3619 global $wgGroupPermissions;
3620 $allowedGroups = array();
3621 foreach ( $wgGroupPermissions as $group => $rights ) {
3622 if ( isset( $rights[$role] ) && $rights[$role] ) {
3623 $allowedGroups[] = $group;
3626 return $allowedGroups;
3630 * Get the localized descriptive name for a group, if it exists
3632 * @param $group String Internal group name
3633 * @return String Localized descriptive group name
3635 public static function getGroupName( $group ) {
3636 $msg = wfMessage( "group-$group" );
3637 return $msg->isBlank() ?
$group : $msg->text();
3641 * Get the localized descriptive name for a member of a group, if it exists
3643 * @param $group String Internal group name
3644 * @param $username String Username for gender (since 1.19)
3645 * @return String Localized name for group member
3647 public static function getGroupMember( $group, $username = '#' ) {
3648 $msg = wfMessage( "group-$group-member", $username );
3649 return $msg->isBlank() ?
$group : $msg->text();
3653 * Return the set of defined explicit groups.
3654 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3655 * are not included, as they are defined automatically, not in the database.
3656 * @return Array of internal group names
3658 public static function getAllGroups() {
3659 global $wgGroupPermissions, $wgRevokePermissions;
3661 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3662 self
::getImplicitGroups()
3667 * Get a list of all available permissions.
3668 * @return Array of permission names
3670 public static function getAllRights() {
3671 if ( self
::$mAllRights === false ) {
3672 global $wgAvailableRights;
3673 if ( count( $wgAvailableRights ) ) {
3674 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3676 self
::$mAllRights = self
::$mCoreRights;
3678 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3680 return self
::$mAllRights;
3684 * Get a list of implicit groups
3685 * @return Array of Strings Array of internal group names
3687 public static function getImplicitGroups() {
3688 global $wgImplicitGroups;
3689 $groups = $wgImplicitGroups;
3690 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3695 * Get the title of a page describing a particular group
3697 * @param $group String Internal group name
3698 * @return Title|Bool Title of the page if it exists, false otherwise
3700 public static function getGroupPage( $group ) {
3701 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3702 if( $msg->exists() ) {
3703 $title = Title
::newFromText( $msg->text() );
3704 if( is_object( $title ) )
3711 * Create a link to the group in HTML, if available;
3712 * else return the group name.
3714 * @param $group String Internal name of the group
3715 * @param $text String The text of the link
3716 * @return String HTML link to the group
3718 public static function makeGroupLinkHTML( $group, $text = '' ) {
3720 $text = self
::getGroupName( $group );
3722 $title = self
::getGroupPage( $group );
3724 return Linker
::link( $title, htmlspecialchars( $text ) );
3731 * Create a link to the group in Wikitext, if available;
3732 * else return the group name.
3734 * @param $group String Internal name of the group
3735 * @param $text String The text of the link
3736 * @return String Wikilink to the group
3738 public static function makeGroupLinkWiki( $group, $text = '' ) {
3740 $text = self
::getGroupName( $group );
3742 $title = self
::getGroupPage( $group );
3744 $page = $title->getPrefixedText();
3745 return "[[$page|$text]]";
3752 * Returns an array of the groups that a particular group can add/remove.
3754 * @param $group String: the group to check for whether it can add/remove
3755 * @return Array array( 'add' => array( addablegroups ),
3756 * 'remove' => array( removablegroups ),
3757 * 'add-self' => array( addablegroups to self),
3758 * 'remove-self' => array( removable groups from self) )
3760 public static function changeableByGroup( $group ) {
3761 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3763 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3764 if( empty( $wgAddGroups[$group] ) ) {
3765 // Don't add anything to $groups
3766 } elseif( $wgAddGroups[$group] === true ) {
3767 // You get everything
3768 $groups['add'] = self
::getAllGroups();
3769 } elseif( is_array( $wgAddGroups[$group] ) ) {
3770 $groups['add'] = $wgAddGroups[$group];
3773 // Same thing for remove
3774 if( empty( $wgRemoveGroups[$group] ) ) {
3775 } elseif( $wgRemoveGroups[$group] === true ) {
3776 $groups['remove'] = self
::getAllGroups();
3777 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3778 $groups['remove'] = $wgRemoveGroups[$group];
3781 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3782 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3783 foreach( $wgGroupsAddToSelf as $key => $value ) {
3784 if( is_int( $key ) ) {
3785 $wgGroupsAddToSelf['user'][] = $value;
3790 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3791 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3792 if( is_int( $key ) ) {
3793 $wgGroupsRemoveFromSelf['user'][] = $value;
3798 // Now figure out what groups the user can add to him/herself
3799 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3800 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3801 // No idea WHY this would be used, but it's there
3802 $groups['add-self'] = User
::getAllGroups();
3803 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3804 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3807 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3808 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3809 $groups['remove-self'] = User
::getAllGroups();
3810 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3811 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3818 * Returns an array of groups that this user can add and remove
3819 * @return Array array( 'add' => array( addablegroups ),
3820 * 'remove' => array( removablegroups ),
3821 * 'add-self' => array( addablegroups to self),
3822 * 'remove-self' => array( removable groups from self) )
3824 public function changeableGroups() {
3825 if( $this->isAllowed( 'userrights' ) ) {
3826 // This group gives the right to modify everything (reverse-
3827 // compatibility with old "userrights lets you change
3829 // Using array_merge to make the groups reindexed
3830 $all = array_merge( User
::getAllGroups() );
3834 'add-self' => array(),
3835 'remove-self' => array()
3839 // Okay, it's not so simple, we will have to go through the arrays
3842 'remove' => array(),
3843 'add-self' => array(),
3844 'remove-self' => array()
3846 $addergroups = $this->getEffectiveGroups();
3848 foreach( $addergroups as $addergroup ) {
3849 $groups = array_merge_recursive(
3850 $groups, $this->changeableByGroup( $addergroup )
3852 $groups['add'] = array_unique( $groups['add'] );
3853 $groups['remove'] = array_unique( $groups['remove'] );
3854 $groups['add-self'] = array_unique( $groups['add-self'] );
3855 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3861 * Increment the user's edit-count field.
3862 * Will have no effect for anonymous users.
3864 public function incEditCount() {
3865 if( !$this->isAnon() ) {
3866 $dbw = wfGetDB( DB_MASTER
);
3867 $dbw->update( 'user',
3868 array( 'user_editcount=user_editcount+1' ),
3869 array( 'user_id' => $this->getId() ),
3872 // Lazy initialization check...
3873 if( $dbw->affectedRows() == 0 ) {
3874 // Pull from a slave to be less cruel to servers
3875 // Accuracy isn't the point anyway here
3876 $dbr = wfGetDB( DB_SLAVE
);
3877 $count = $dbr->selectField( 'revision',
3879 array( 'rev_user' => $this->getId() ),
3882 // Now here's a goddamn hack...
3883 if( $dbr !== $dbw ) {
3884 // If we actually have a slave server, the count is
3885 // at least one behind because the current transaction
3886 // has not been committed and replicated.
3889 // But if DB_SLAVE is selecting the master, then the
3890 // count we just read includes the revision that was
3891 // just added in the working transaction.
3894 $dbw->update( 'user',
3895 array( 'user_editcount' => $count ),
3896 array( 'user_id' => $this->getId() ),
3900 // edit count in user cache too
3901 $this->invalidateCache();
3905 * Get the description of a given right
3907 * @param $right String Right to query
3908 * @return String Localized description of the right
3910 public static function getRightDescription( $right ) {
3911 $key = "right-$right";
3912 $msg = wfMessage( $key );
3913 return $msg->isBlank() ?
$right : $msg->text();
3917 * Make an old-style password hash
3919 * @param $password String Plain-text password
3920 * @param $userId String User ID
3921 * @return String Password hash
3923 public static function oldCrypt( $password, $userId ) {
3924 global $wgPasswordSalt;
3925 if ( $wgPasswordSalt ) {
3926 return md5( $userId . '-' . md5( $password ) );
3928 return md5( $password );
3933 * Make a new-style password hash
3935 * @param $password String Plain-text password
3936 * @param bool|string $salt Optional salt, may be random or the user ID.
3938 * If unspecified or false, will generate one automatically
3939 * @return String Password hash
3941 public static function crypt( $password, $salt = false ) {
3942 global $wgPasswordSalt;
3945 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3949 if( $wgPasswordSalt ) {
3950 if ( $salt === false ) {
3951 $salt = MWCryptRand
::generateHex( 8 );
3953 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3955 return ':A:' . md5( $password );
3960 * Compare a password hash with a plain-text password. Requires the user
3961 * ID if there's a chance that the hash is an old-style hash.
3963 * @param $hash String Password hash
3964 * @param $password String Plain-text password to compare
3965 * @param $userId String|bool User ID for old-style password salt
3969 public static function comparePasswords( $hash, $password, $userId = false ) {
3970 $type = substr( $hash, 0, 3 );
3973 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3977 if ( $type == ':A:' ) {
3979 return md5( $password ) === substr( $hash, 3 );
3980 } elseif ( $type == ':B:' ) {
3982 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3983 return md5( $salt.'-'.md5( $password ) ) === $realHash;
3986 return self
::oldCrypt( $password, $userId ) === $hash;
3991 * Add a newuser log entry for this user. Before 1.19 the return value was always true.
3993 * @param $byEmail Boolean: account made by email?
3994 * @param $reason String: user supplied reason
3996 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
3998 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3999 global $wgUser, $wgContLang, $wgNewUserLog;
4000 if( empty( $wgNewUserLog ) ) {
4001 return true; // disabled
4004 if( $this->getName() == $wgUser->getName() ) {
4007 $action = 'create2';
4009 if ( $reason === '' ) {
4010 $reason = wfMsgForContent( 'newuserlog-byemail' );
4012 $reason = $wgContLang->commaList( array(
4013 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
4017 $log = new LogPage( 'newusers' );
4018 return (int)$log->addEntry(
4020 $this->getUserPage(),
4022 array( $this->getId() )
4027 * Add an autocreate newuser log entry for this user
4028 * Used by things like CentralAuth and perhaps other authplugins.
4032 public function addNewUserLogEntryAutoCreate() {
4033 global $wgNewUserLog;
4034 if( !$wgNewUserLog ) {
4035 return true; // disabled
4037 $log = new LogPage( 'newusers', false );
4038 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ), $this );
4045 protected function loadOptions() {
4047 if ( $this->mOptionsLoaded ||
!$this->getId() )
4050 $this->mOptions
= self
::getDefaultOptions();
4052 // Maybe load from the object
4053 if ( !is_null( $this->mOptionOverrides
) ) {
4054 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4055 foreach( $this->mOptionOverrides
as $key => $value ) {
4056 $this->mOptions
[$key] = $value;
4059 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4060 // Load from database
4061 $dbr = wfGetDB( DB_SLAVE
);
4063 $res = $dbr->select(
4065 array( 'up_property', 'up_value' ),
4066 array( 'up_user' => $this->getId() ),
4070 $this->mOptionOverrides
= array();
4071 foreach ( $res as $row ) {
4072 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4073 $this->mOptions
[$row->up_property
] = $row->up_value
;
4077 $this->mOptionsLoaded
= true;
4079 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4085 protected function saveOptions() {
4086 global $wgAllowPrefChange;
4088 $this->loadOptions();
4090 // Not using getOptions(), to keep hidden preferences in database
4091 $saveOptions = $this->mOptions
;
4093 // Allow hooks to abort, for instance to save to a global profile.
4094 // Reset options to default state before saving.
4095 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4099 $extuser = ExternalUser
::newFromUser( $this );
4100 $userId = $this->getId();
4101 $insert_rows = array();
4102 foreach( $saveOptions as $key => $value ) {
4103 # Don't bother storing default values
4104 $defaultOption = self
::getDefaultOption( $key );
4105 if ( ( is_null( $defaultOption ) &&
4106 !( $value === false ||
is_null( $value ) ) ) ||
4107 $value != $defaultOption ) {
4108 $insert_rows[] = array(
4109 'up_user' => $userId,
4110 'up_property' => $key,
4111 'up_value' => $value,
4114 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4115 switch ( $wgAllowPrefChange[$key] ) {
4121 $extuser->setPref( $key, $value );
4126 $dbw = wfGetDB( DB_MASTER
);
4127 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4128 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4132 * Provide an array of HTML5 attributes to put on an input element
4133 * intended for the user to enter a new password. This may include
4134 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4136 * Do *not* use this when asking the user to enter his current password!
4137 * Regardless of configuration, users may have invalid passwords for whatever
4138 * reason (e.g., they were set before requirements were tightened up).
4139 * Only use it when asking for a new password, like on account creation or
4142 * Obviously, you still need to do server-side checking.
4144 * NOTE: A combination of bugs in various browsers means that this function
4145 * actually just returns array() unconditionally at the moment. May as
4146 * well keep it around for when the browser bugs get fixed, though.
4148 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4150 * @return array Array of HTML attributes suitable for feeding to
4151 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4152 * That will potentially output invalid XHTML 1.0 Transitional, and will
4153 * get confused by the boolean attribute syntax used.)
4155 public static function passwordChangeInputAttribs() {
4156 global $wgMinimalPasswordLength;
4158 if ( $wgMinimalPasswordLength == 0 ) {
4162 # Note that the pattern requirement will always be satisfied if the
4163 # input is empty, so we need required in all cases.
4165 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4166 # if e-mail confirmation is being used. Since HTML5 input validation
4167 # is b0rked anyway in some browsers, just return nothing. When it's
4168 # re-enabled, fix this code to not output required for e-mail
4170 #$ret = array( 'required' );
4173 # We can't actually do this right now, because Opera 9.6 will print out
4174 # the entered password visibly in its error message! When other
4175 # browsers add support for this attribute, or Opera fixes its support,
4176 # we can add support with a version check to avoid doing this on Opera
4177 # versions where it will be a problem. Reported to Opera as
4178 # DSK-262266, but they don't have a public bug tracker for us to follow.
4180 if ( $wgMinimalPasswordLength > 1 ) {
4181 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4182 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4183 $wgMinimalPasswordLength );
4191 * Return the list of user fields that should be selected to create
4192 * a new user object.
4195 public static function selectFields() {
4202 'user_newpass_time',
4206 'user_email_authenticated',
4208 'user_email_token_expires',
4209 'user_registration',