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 * Array of Strings List of member variables which are saved to the
70 * shared cache (memcached). Any operation which changes the
71 * corresponding database fields must call a cache-clearing function.
74 static $mCacheVars = array(
85 'mEmailAuthenticated',
92 // user_properties table
97 * Array of Strings Core rights.
98 * Each of these should have a corresponding message of the form
102 static $mCoreRights = array(
121 'editusercssjs', #deprecated
133 'move-rootuserpages',
137 'override-export-depth',
159 'userrights-interwiki',
163 * String Cached results of getAllRights()
165 static $mAllRights = false;
167 /** @name Cache variables */
169 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
170 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
171 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides,
172 $mCookiePassword, $mEditCount, $mAllowUsertalk;
176 * Bool Whether the cache variables have been loaded.
182 * Array with already loaded items or true if all items have been loaded.
184 private $mLoadedItems = array();
188 * String Initialization data source if mLoadedItems!==true. May be one of:
189 * - 'defaults' anonymous user initialised from class defaults
190 * - 'name' initialise from mName
191 * - 'id' initialise from mId
192 * - 'session' log in from cookies or session if possible
194 * Use the User::newFrom*() family of functions to set this.
199 * Lazy-initialized variables, invalidated with clearInstanceCache
201 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
202 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
203 $mLocked, $mHideName, $mOptions;
218 private $mBlockedFromCreateAccount = false;
220 static $idCacheByName = array();
223 * Lightweight constructor for an anonymous user.
224 * Use the User::newFrom* factory functions for other kinds of users.
228 * @see newFromConfirmationCode()
229 * @see newFromSession()
232 function __construct() {
233 $this->clearInstanceCache( 'defaults' );
239 function __toString(){
240 return $this->getName();
244 * Load the user table data for this object from the source given by mFrom.
246 public function load() {
247 if ( $this->mLoadedItems
=== true ) {
250 wfProfileIn( __METHOD__
);
252 # Set it now to avoid infinite recursion in accessors
253 $this->mLoadedItems
= true;
255 switch ( $this->mFrom
) {
257 $this->loadDefaults();
260 $this->mId
= self
::idFromName( $this->mName
);
262 # Nonexistent user placeholder object
263 $this->loadDefaults( $this->mName
);
272 $this->loadFromSession();
273 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
276 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
278 wfProfileOut( __METHOD__
);
282 * Load user table data, given mId has already been set.
283 * @return Bool false if the ID does not exist, true otherwise
285 public function loadFromId() {
287 if ( $this->mId
== 0 ) {
288 $this->loadDefaults();
293 $key = wfMemcKey( 'user', 'id', $this->mId
);
294 $data = $wgMemc->get( $key );
295 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
296 # Object is expired, load from DB
301 wfDebug( "User: cache miss for user {$this->mId}\n" );
303 if ( !$this->loadFromDatabase() ) {
304 # Can't load from ID, user is anonymous
307 $this->saveToCache();
309 wfDebug( "User: got user {$this->mId} from cache\n" );
311 foreach ( self
::$mCacheVars as $name ) {
312 $this->$name = $data[$name];
319 * Save user data to the shared cache
321 public function saveToCache() {
324 $this->loadOptions();
325 if ( $this->isAnon() ) {
326 // Anonymous users are uncached
330 foreach ( self
::$mCacheVars as $name ) {
331 $data[$name] = $this->$name;
333 $data['mVersion'] = MW_USER_VERSION
;
334 $key = wfMemcKey( 'user', 'id', $this->mId
);
336 $wgMemc->set( $key, $data );
339 /** @name newFrom*() static factory methods */
343 * Static factory method for creation from username.
345 * This is slightly less efficient than newFromId(), so use newFromId() if
346 * you have both an ID and a name handy.
348 * @param $name String Username, validated by Title::newFromText()
349 * @param $validate String|Bool Validate username. Takes the same parameters as
350 * User::getCanonicalName(), except that true is accepted as an alias
351 * for 'valid', for BC.
353 * @return User object, or false if the username is invalid
354 * (e.g. if it contains illegal characters or is an IP address). If the
355 * username is not present in the database, the result will be a user object
356 * with a name, zero user ID and default settings.
358 public static function newFromName( $name, $validate = 'valid' ) {
359 if ( $validate === true ) {
362 $name = self
::getCanonicalName( $name, $validate );
363 if ( $name === false ) {
366 # Create unloaded user object
370 $u->setItemLoaded( 'name' );
376 * Static factory method for creation from a given user ID.
378 * @param $id Int Valid user ID
379 * @return User The corresponding User object
381 public static function newFromId( $id ) {
385 $u->setItemLoaded( 'id' );
390 * Factory method to fetch whichever user has a given email confirmation code.
391 * This code is generated when an account is created or its e-mail address
394 * If the code is invalid or has expired, returns NULL.
396 * @param $code String Confirmation code
399 public static function newFromConfirmationCode( $code ) {
400 $dbr = wfGetDB( DB_SLAVE
);
401 $id = $dbr->selectField( 'user', 'user_id', array(
402 'user_email_token' => md5( $code ),
403 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
405 if( $id !== false ) {
406 return User
::newFromId( $id );
413 * Create a new user object using data from session or cookies. If the
414 * login credentials are invalid, the result is an anonymous user.
416 * @param $request WebRequest object to use; $wgRequest will be used if
420 public static function newFromSession( WebRequest
$request = null ) {
422 $user->mFrom
= 'session';
423 $user->mRequest
= $request;
428 * Create a new user object from a user row.
429 * The row should have the following fields from the user table in it:
430 * - either user_name or user_id to load further data if needed (or both)
432 * - all other fields (email, password, etc.)
433 * It is useless to provide the remaining fields if either user_id,
434 * user_name and user_real_name are not provided because the whole row
435 * will be loaded once more from the database when accessing them.
437 * @param $row Array A row from the user table
440 public static function newFromRow( $row ) {
442 $user->loadFromRow( $row );
449 * Get the username corresponding to a given user ID
450 * @param $id Int User ID
451 * @return String|false The corresponding username
453 public static function whoIs( $id ) {
454 $dbr = wfGetDB( DB_SLAVE
);
455 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
459 * Get the real name of a user given their user ID
461 * @param $id Int User ID
462 * @return String|false The corresponding user's real name
464 public static function whoIsReal( $id ) {
465 $dbr = wfGetDB( DB_SLAVE
);
466 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
470 * Get database id given a user name
471 * @param $name String Username
472 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
474 public static function idFromName( $name ) {
475 $nt = Title
::makeTitleSafe( NS_USER
, $name );
476 if( is_null( $nt ) ) {
481 if ( isset( self
::$idCacheByName[$name] ) ) {
482 return self
::$idCacheByName[$name];
485 $dbr = wfGetDB( DB_SLAVE
);
486 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
488 if ( $s === false ) {
491 $result = $s->user_id
;
494 self
::$idCacheByName[$name] = $result;
496 if ( count( self
::$idCacheByName ) > 1000 ) {
497 self
::$idCacheByName = array();
504 * Reset the cache used in idFromName(). For use in tests.
506 public static function resetIdByNameCache() {
507 self
::$idCacheByName = array();
511 * Does the string match an anonymous IPv4 address?
513 * This function exists for username validation, in order to reject
514 * usernames which are similar in form to IP addresses. Strings such
515 * as 300.300.300.300 will return true because it looks like an IP
516 * address, despite not being strictly valid.
518 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
519 * address because the usemod software would "cloak" anonymous IP
520 * addresses like this, if we allowed accounts like this to be created
521 * new users could get the old edits of these anonymous users.
523 * @param $name String to match
526 public static function isIP( $name ) {
527 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
531 * Is the input a valid username?
533 * Checks if the input is a valid username, we don't want an empty string,
534 * an IP address, anything that containins slashes (would mess up subpages),
535 * is longer than the maximum allowed username size or doesn't begin with
538 * @param $name String to match
541 public static function isValidUserName( $name ) {
542 global $wgContLang, $wgMaxNameChars;
545 || User
::isIP( $name )
546 ||
strpos( $name, '/' ) !== false
547 ||
strlen( $name ) > $wgMaxNameChars
548 ||
$name != $wgContLang->ucfirst( $name ) ) {
549 wfDebugLog( 'username', __METHOD__
.
550 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
554 // Ensure that the name can't be misresolved as a different title,
555 // such as with extra namespace keys at the start.
556 $parsed = Title
::newFromText( $name );
557 if( is_null( $parsed )
558 ||
$parsed->getNamespace()
559 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
560 wfDebugLog( 'username', __METHOD__
.
561 ": '$name' invalid due to ambiguous prefixes" );
565 // Check an additional blacklist of troublemaker characters.
566 // Should these be merged into the title char list?
567 $unicodeBlacklist = '/[' .
568 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
569 '\x{00a0}' . # non-breaking space
570 '\x{2000}-\x{200f}' . # various whitespace
571 '\x{2028}-\x{202f}' . # breaks and control chars
572 '\x{3000}' . # ideographic space
573 '\x{e000}-\x{f8ff}' . # private use
575 if( preg_match( $unicodeBlacklist, $name ) ) {
576 wfDebugLog( 'username', __METHOD__
.
577 ": '$name' invalid due to blacklisted characters" );
585 * Usernames which fail to pass this function will be blocked
586 * from user login and new account registrations, but may be used
587 * internally by batch processes.
589 * If an account already exists in this form, login will be blocked
590 * by a failure to pass this function.
592 * @param $name String to match
595 public static function isUsableName( $name ) {
596 global $wgReservedUsernames;
597 // Must be a valid username, obviously ;)
598 if ( !self
::isValidUserName( $name ) ) {
602 static $reservedUsernames = false;
603 if ( !$reservedUsernames ) {
604 $reservedUsernames = $wgReservedUsernames;
605 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
608 // Certain names may be reserved for batch processes.
609 foreach ( $reservedUsernames as $reserved ) {
610 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
611 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
613 if ( $reserved == $name ) {
621 * Usernames which fail to pass this function will be blocked
622 * from new account registrations, but may be used internally
623 * either by batch processes or by user accounts which have
624 * already been created.
626 * Additional blacklisting may be added here rather than in
627 * isValidUserName() to avoid disrupting existing accounts.
629 * @param $name String to match
632 public static function isCreatableName( $name ) {
633 global $wgInvalidUsernameCharacters;
635 // Ensure that the username isn't longer than 235 bytes, so that
636 // (at least for the builtin skins) user javascript and css files
637 // will work. (bug 23080)
638 if( strlen( $name ) > 235 ) {
639 wfDebugLog( 'username', __METHOD__
.
640 ": '$name' invalid due to length" );
644 // Preg yells if you try to give it an empty string
645 if( $wgInvalidUsernameCharacters !== '' ) {
646 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
647 wfDebugLog( 'username', __METHOD__
.
648 ": '$name' invalid due to wgInvalidUsernameCharacters" );
653 return self
::isUsableName( $name );
657 * Is the input a valid password for this user?
659 * @param $password String Desired password
662 public function isValidPassword( $password ) {
663 //simple boolean wrapper for getPasswordValidity
664 return $this->getPasswordValidity( $password ) === true;
668 * Given unvalidated password input, return error message on failure.
670 * @param $password String Desired password
671 * @return mixed: true on success, string or array of error message on failure
673 public function getPasswordValidity( $password ) {
674 global $wgMinimalPasswordLength, $wgContLang;
676 static $blockedLogins = array(
677 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
678 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
681 $result = false; //init $result to false for the internal checks
683 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
686 if ( $result === false ) {
687 if( strlen( $password ) < $wgMinimalPasswordLength ) {
688 return 'passwordtooshort';
689 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
690 return 'password-name-match';
691 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
692 return 'password-login-forbidden';
694 //it seems weird returning true here, but this is because of the
695 //initialization of $result to false above. If the hook is never run or it
696 //doesn't modify $result, then we will likely get down into this if with
700 } elseif( $result === true ) {
703 return $result; //the isValidPassword hook set a string $result and returned true
708 * Does a string look like an e-mail address?
710 * This validates an email address using an HTML5 specification found at:
711 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
712 * Which as of 2011-01-24 says:
714 * A valid e-mail address is a string that matches the ABNF production
715 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
716 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
719 * This function is an implementation of the specification as requested in
722 * Client-side forms will use the same standard validation rules via JS or
723 * HTML 5 validation; additional restrictions can be enforced server-side
724 * by extensions via the 'isValidEmailAddr' hook.
726 * Note that this validation doesn't 100% match RFC 2822, but is believed
727 * to be liberal enough for wide use. Some invalid addresses will still
728 * pass validation here.
730 * @param $addr String E-mail address
732 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
734 public static function isValidEmailAddr( $addr ) {
735 return Sanitizer
::validateEmail( $addr );
739 * Given unvalidated user input, return a canonical username, or false if
740 * the username is invalid.
741 * @param $name String User input
742 * @param $validate String|Bool type of validation to use:
743 * - false No validation
744 * - 'valid' Valid for batch processes
745 * - 'usable' Valid for batch processes and login
746 * - 'creatable' Valid for batch processes, login and account creation
748 * @return bool|string
750 public static function getCanonicalName( $name, $validate = 'valid' ) {
751 # Force usernames to capital
753 $name = $wgContLang->ucfirst( $name );
755 # Reject names containing '#'; these will be cleaned up
756 # with title normalisation, but then it's too late to
758 if( strpos( $name, '#' ) !== false )
761 # Clean up name according to title rules
762 $t = ( $validate === 'valid' ) ?
763 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
764 # Check for invalid titles
765 if( is_null( $t ) ) {
769 # Reject various classes of invalid names
771 $name = $wgAuth->getCanonicalName( $t->getText() );
773 switch ( $validate ) {
777 if ( !User
::isValidUserName( $name ) ) {
782 if ( !User
::isUsableName( $name ) ) {
787 if ( !User
::isCreatableName( $name ) ) {
792 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
798 * Count the number of edits of a user
799 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
801 * @param $uid Int User ID to check
802 * @return Int the user's edit count
804 public static function edits( $uid ) {
805 wfProfileIn( __METHOD__
);
806 $dbr = wfGetDB( DB_SLAVE
);
807 // check if the user_editcount field has been initialized
808 $field = $dbr->selectField(
809 'user', 'user_editcount',
810 array( 'user_id' => $uid ),
814 if( $field === null ) { // it has not been initialized. do so.
815 $dbw = wfGetDB( DB_MASTER
);
816 $count = $dbr->selectField(
817 'revision', 'count(*)',
818 array( 'rev_user' => $uid ),
823 array( 'user_editcount' => $count ),
824 array( 'user_id' => $uid ),
830 wfProfileOut( __METHOD__
);
835 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
836 * @todo hash random numbers to improve security, like generateToken()
838 * @return String new random password
840 public static function randomPassword() {
841 global $wgMinimalPasswordLength;
842 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
843 $l = strlen( $pwchars ) - 1;
845 $pwlength = max( 7, $wgMinimalPasswordLength );
846 $digit = mt_rand( 0, $pwlength - 1 );
848 for ( $i = 0; $i < $pwlength; $i++
) {
849 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars[ mt_rand( 0, $l ) ];
855 * Set cached properties to default.
857 * @note This no longer clears uncached lazy-initialised properties;
858 * the constructor does that instead.
860 * @param $name string
862 public function loadDefaults( $name = false ) {
863 wfProfileIn( __METHOD__
);
866 $this->mName
= $name;
867 $this->mRealName
= '';
868 $this->mPassword
= $this->mNewpassword
= '';
869 $this->mNewpassTime
= null;
871 $this->mOptionOverrides
= null;
872 $this->mOptionsLoaded
= false;
874 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
875 if( $loggedOut !== null ) {
876 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
878 $this->mTouched
= '0'; # Allow any pages to be cached
881 $this->setToken(); # Random
882 $this->mEmailAuthenticated
= null;
883 $this->mEmailToken
= '';
884 $this->mEmailTokenExpires
= null;
885 $this->mRegistration
= wfTimestamp( TS_MW
);
886 $this->mGroups
= array();
888 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
890 wfProfileOut( __METHOD__
);
894 * Return whether an item has been loaded.
896 * @param $item String: item to check. Current possibilities:
900 * @param $all String: 'all' to check if the whole object has been loaded
901 * or any other string to check if only the item is available (e.g.
905 public function isItemLoaded( $item, $all = 'all' ) {
906 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
907 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
911 * Set that an item has been loaded
913 * @param $item String
915 private function setItemLoaded( $item ) {
916 if ( is_array( $this->mLoadedItems
) ) {
917 $this->mLoadedItems
[$item] = true;
922 * Load user data from the session or login cookie. If there are no valid
923 * credentials, initialises the user as an anonymous user.
924 * @return Bool True if the user is logged in, false otherwise.
926 private function loadFromSession() {
927 global $wgExternalAuthType, $wgAutocreatePolicy;
930 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
931 if ( $result !== null ) {
935 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
936 $extUser = ExternalUser
::newFromCookie();
938 # TODO: Automatically create the user here (or probably a bit
939 # lower down, in fact)
943 $request = $this->getRequest();
945 $cookieId = $request->getCookie( 'UserID' );
946 $sessId = $request->getSessionData( 'wsUserID' );
948 if ( $cookieId !== null ) {
949 $sId = intval( $cookieId );
950 if( $sessId !== null && $cookieId != $sessId ) {
951 $this->loadDefaults(); // Possible collision!
952 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
953 cookie user ID ($sId) don't match!" );
956 $request->setSessionData( 'wsUserID', $sId );
957 } elseif ( $sessId !== null && $sessId != 0 ) {
960 $this->loadDefaults();
964 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
965 $sName = $request->getSessionData( 'wsUserName' );
966 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
967 $sName = $request->getCookie( 'UserName' );
968 $request->setSessionData( 'wsUserName', $sName );
970 $this->loadDefaults();
974 $proposedUser = User
::newFromId( $sId );
975 if ( !$proposedUser->isLoggedIn() ) {
977 $this->loadDefaults();
981 global $wgBlockDisablesLogin;
982 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
983 # User blocked and we've disabled blocked user logins
984 $this->loadDefaults();
988 if ( $request->getSessionData( 'wsToken' ) !== null ) {
989 $passwordCorrect = $proposedUser->getToken() === $request->getSessionData( 'wsToken' );
991 } elseif ( $request->getCookie( 'Token' ) !== null ) {
992 $passwordCorrect = $proposedUser->getToken() === $request->getCookie( 'Token' );
995 # No session or persistent login cookie
996 $this->loadDefaults();
1000 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1001 $this->loadFromUserObject( $proposedUser );
1002 $request->setSessionData( 'wsToken', $this->mToken
);
1003 wfDebug( "User: logged in from $from\n" );
1006 # Invalid credentials
1007 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1008 $this->loadDefaults();
1014 * Load user and user_group data from the database.
1015 * $this->mId must be set, this is how the user is identified.
1017 * @return Bool True if the user exists, false if the user is anonymous
1019 public function loadFromDatabase() {
1021 $this->mId
= intval( $this->mId
);
1023 /** Anonymous user */
1025 $this->loadDefaults();
1029 $dbr = wfGetDB( DB_MASTER
);
1030 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
1032 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1034 if ( $s !== false ) {
1035 # Initialise user table data
1036 $this->loadFromRow( $s );
1037 $this->mGroups
= null; // deferred
1038 $this->getEditCount(); // revalidation for nulls
1043 $this->loadDefaults();
1049 * Initialize this object from a row from the user table.
1051 * @param $row Array Row from the user table to load.
1053 public function loadFromRow( $row ) {
1056 $this->mGroups
= null; // deferred
1058 if ( isset( $row->user_name
) ) {
1059 $this->mName
= $row->user_name
;
1060 $this->mFrom
= 'name';
1061 $this->setItemLoaded( 'name' );
1066 if ( isset( $row->user_real_name
) ) {
1067 $this->mRealName
= $row->user_real_name
;
1068 $this->setItemLoaded( 'realname' );
1073 if ( isset( $row->user_id
) ) {
1074 $this->mId
= intval( $row->user_id
);
1075 $this->mFrom
= 'id';
1076 $this->setItemLoaded( 'id' );
1081 if ( isset( $row->user_editcount
) ) {
1082 $this->mEditCount
= $row->user_editcount
;
1087 if ( isset( $row->user_password
) ) {
1088 $this->mPassword
= $row->user_password
;
1089 $this->mNewpassword
= $row->user_newpassword
;
1090 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1091 $this->mEmail
= $row->user_email
;
1092 if ( isset( $row->user_options
) ) {
1093 $this->decodeOptions( $row->user_options
);
1095 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1096 $this->mToken
= $row->user_token
;
1097 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1098 $this->mEmailToken
= $row->user_email_token
;
1099 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1100 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1106 $this->mLoadedItems
= true;
1111 * Load the data for this user object from another user object.
1115 protected function loadFromUserObject( $user ) {
1117 $user->loadGroups();
1118 $user->loadOptions();
1119 foreach ( self
::$mCacheVars as $var ) {
1120 $this->$var = $user->$var;
1125 * Load the groups from the database if they aren't already loaded.
1127 private function loadGroups() {
1128 if ( is_null( $this->mGroups
) ) {
1129 $dbr = wfGetDB( DB_MASTER
);
1130 $res = $dbr->select( 'user_groups',
1131 array( 'ug_group' ),
1132 array( 'ug_user' => $this->mId
),
1134 $this->mGroups
= array();
1135 foreach ( $res as $row ) {
1136 $this->mGroups
[] = $row->ug_group
;
1142 * Add the user to the group if he/she meets given criteria.
1144 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1145 * possible to remove manually via Special:UserRights. In such case it
1146 * will not be re-added automatically. The user will also not lose the
1147 * group if they no longer meet the criteria.
1149 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1151 * @return array Array of groups the user has been promoted to.
1153 * @see $wgAutopromoteOnce
1155 public function addAutopromoteOnceGroups( $event ) {
1156 global $wgAutopromoteOnceLogInRC;
1158 $toPromote = array();
1159 if ( $this->getId() ) {
1160 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1161 if ( count( $toPromote ) ) {
1162 $oldGroups = $this->getGroups(); // previous groups
1163 foreach ( $toPromote as $group ) {
1164 $this->addGroup( $group );
1166 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1168 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1169 $log->addEntry( 'autopromote',
1170 $this->getUserPage(),
1172 // These group names are "list to texted"-ed in class LogPage.
1173 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1181 * Clear various cached data stored in this object.
1182 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1183 * given source. May be "name", "id", "defaults", "session", or false for
1186 public function clearInstanceCache( $reloadFrom = false ) {
1187 $this->mNewtalk
= -1;
1188 $this->mDatePreference
= null;
1189 $this->mBlockedby
= -1; # Unset
1190 $this->mHash
= false;
1191 $this->mRights
= null;
1192 $this->mEffectiveGroups
= null;
1193 $this->mImplicitGroups
= null;
1194 $this->mOptions
= null;
1196 if ( $reloadFrom ) {
1197 $this->mLoadedItems
= array();
1198 $this->mFrom
= $reloadFrom;
1203 * Combine the language default options with any site-specific options
1204 * and add the default language variants.
1206 * @return Array of String options
1208 public static function getDefaultOptions() {
1209 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1210 static $defOpt = null;
1211 if ( $defOpt !== null ) {
1215 $defOpt = $wgDefaultUserOptions;
1216 # default language setting
1217 $variant = $wgContLang->getDefaultVariant();
1218 $defOpt['variant'] = $variant;
1219 $defOpt['language'] = $variant;
1220 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1221 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1223 $defOpt['skin'] = $wgDefaultSkin;
1225 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1231 * Get a given default option value.
1233 * @param $opt String Name of option to retrieve
1234 * @return String Default option value
1236 public static function getDefaultOption( $opt ) {
1237 $defOpts = self
::getDefaultOptions();
1238 if( isset( $defOpts[$opt] ) ) {
1239 return $defOpts[$opt];
1247 * Get blocking information
1248 * @param $bFromSlave Bool Whether to check the slave database first. To
1249 * improve performance, non-critical checks are done
1250 * against slaves. Check when actually saving should be
1251 * done against master.
1253 private function getBlockedStatus( $bFromSlave = true ) {
1254 global $wgProxyWhitelist, $wgUser;
1256 if ( -1 != $this->mBlockedby
) {
1260 wfProfileIn( __METHOD__
);
1261 wfDebug( __METHOD__
.": checking...\n" );
1263 // Initialize data...
1264 // Otherwise something ends up stomping on $this->mBlockedby when
1265 // things get lazy-loaded later, causing false positive block hits
1266 // due to -1 !== 0. Probably session-related... Nothing should be
1267 // overwriting mBlockedby, surely?
1270 $this->mBlockedby
= 0;
1271 $this->mHideName
= 0;
1272 $this->mAllowUsertalk
= 0;
1274 # We only need to worry about passing the IP address to the Block generator if the
1275 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1276 # know which IP address they're actually coming from
1277 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1278 $ip = $this->getRequest()->getIP();
1284 $this->mBlock
= Block
::newFromTarget( $this->getName(), $ip, !$bFromSlave );
1285 if ( $this->mBlock
instanceof Block
) {
1286 wfDebug( __METHOD__
. ": Found block.\n" );
1287 $this->mBlockedby
= $this->mBlock
->getByName();
1288 $this->mBlockreason
= $this->mBlock
->mReason
;
1289 $this->mHideName
= $this->mBlock
->mHideName
;
1290 $this->mAllowUsertalk
= !$this->mBlock
->prevents( 'editownusertalk' );
1294 if ( $ip !== null && !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1296 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1297 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1298 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1302 if ( !$this->mBlockedby
&& !$this->getID() ) {
1303 if ( $this->isDnsBlacklisted( $ip ) ) {
1304 $this->mBlockedby
= wfMsg( 'sorbs' );
1305 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1311 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1313 wfProfileOut( __METHOD__
);
1317 * Whether the given IP is in a DNS blacklist.
1319 * @param $ip String IP to check
1320 * @param $checkWhitelist Bool: whether to check the whitelist first
1321 * @return Bool True if blacklisted.
1323 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1324 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1325 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1327 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1330 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1333 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1334 return $this->inDnsBlacklist( $ip, $urls );
1338 * Whether the given IP is in a given DNS blacklist.
1340 * @param $ip String IP to check
1341 * @param $bases String|Array of Strings: URL of the DNS blacklist
1342 * @return Bool True if blacklisted.
1344 public function inDnsBlacklist( $ip, $bases ) {
1345 wfProfileIn( __METHOD__
);
1348 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1349 if( IP
::isIPv4( $ip ) ) {
1350 # Reverse IP, bug 21255
1351 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1353 foreach( (array)$bases as $base ) {
1355 # If we have an access key, use that too (ProjectHoneypot, etc.)
1356 if( is_array( $base ) ) {
1357 if( count( $base ) >= 2 ) {
1358 # Access key is 1, base URL is 0
1359 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1361 $host = "$ipReversed.{$base[0]}";
1364 $host = "$ipReversed.$base";
1368 $ipList = gethostbynamel( $host );
1371 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1375 wfDebug( "Requested $host, not found in $base.\n" );
1380 wfProfileOut( __METHOD__
);
1385 * Check if an IP address is in the local proxy list
1391 public static function isLocallyBlockedProxy( $ip ) {
1392 global $wgProxyList;
1394 if ( !$wgProxyList ) {
1397 wfProfileIn( __METHOD__
);
1399 if ( !is_array( $wgProxyList ) ) {
1400 # Load from the specified file
1401 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1404 if ( !is_array( $wgProxyList ) ) {
1406 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1408 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1409 # Old-style flipped proxy list
1414 wfProfileOut( __METHOD__
);
1419 * Is this user subject to rate limiting?
1421 * @return Bool True if rate limited
1423 public function isPingLimitable() {
1424 global $wgRateLimitsExcludedIPs;
1425 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1426 // No other good way currently to disable rate limits
1427 // for specific IPs. :P
1428 // But this is a crappy hack and should die.
1431 return !$this->isAllowed('noratelimit');
1435 * Primitive rate limits: enforce maximum actions per time period
1436 * to put a brake on flooding.
1438 * @note When using a shared cache like memcached, IP-address
1439 * last-hit counters will be shared across wikis.
1441 * @param $action String Action to enforce; 'edit' if unspecified
1442 * @return Bool True if a rate limiter was tripped
1444 public function pingLimiter( $action = 'edit' ) {
1445 # Call the 'PingLimiter' hook
1447 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1451 global $wgRateLimits;
1452 if( !isset( $wgRateLimits[$action] ) ) {
1456 # Some groups shouldn't trigger the ping limiter, ever
1457 if( !$this->isPingLimitable() )
1460 global $wgMemc, $wgRateLimitLog;
1461 wfProfileIn( __METHOD__
);
1463 $limits = $wgRateLimits[$action];
1465 $id = $this->getId();
1466 $ip = $this->getRequest()->getIP();
1469 if( isset( $limits['anon'] ) && $id == 0 ) {
1470 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1473 if( isset( $limits['user'] ) && $id != 0 ) {
1474 $userLimit = $limits['user'];
1476 if( $this->isNewbie() ) {
1477 if( isset( $limits['newbie'] ) && $id != 0 ) {
1478 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1480 if( isset( $limits['ip'] ) ) {
1481 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1484 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1485 $subnet = $matches[1];
1486 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1489 // Check for group-specific permissions
1490 // If more than one group applies, use the group with the highest limit
1491 foreach ( $this->getGroups() as $group ) {
1492 if ( isset( $limits[$group] ) ) {
1493 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1494 $userLimit = $limits[$group];
1498 // Set the user limit key
1499 if ( $userLimit !== false ) {
1500 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1501 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1505 foreach( $keys as $key => $limit ) {
1506 list( $max, $period ) = $limit;
1507 $summary = "(limit $max in {$period}s)";
1508 $count = $wgMemc->get( $key );
1511 if( $count > $max ) {
1512 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1513 if( $wgRateLimitLog ) {
1514 wfSuppressWarnings();
1515 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1516 wfRestoreWarnings();
1520 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1523 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1524 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1526 $wgMemc->incr( $key );
1529 wfProfileOut( __METHOD__
);
1534 * Check if user is blocked
1536 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1537 * @return Bool True if blocked, false otherwise
1539 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1540 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1544 * Get the block affecting the user, or null if the user is not blocked
1546 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1547 * @return Block|null
1549 public function getBlock( $bFromSlave = true ){
1550 $this->getBlockedStatus( $bFromSlave );
1551 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1555 * Check if user is blocked from editing a particular article
1557 * @param $title Title to check
1558 * @param $bFromSlave Bool whether to check the slave database instead of the master
1561 function isBlockedFrom( $title, $bFromSlave = false ) {
1562 global $wgBlockAllowsUTEdit;
1563 wfProfileIn( __METHOD__
);
1565 $blocked = $this->isBlocked( $bFromSlave );
1566 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1567 # If a user's name is suppressed, they cannot make edits anywhere
1568 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1569 $title->getNamespace() == NS_USER_TALK
) {
1571 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1574 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1576 wfProfileOut( __METHOD__
);
1581 * If user is blocked, return the name of the user who placed the block
1582 * @return String name of blocker
1584 public function blockedBy() {
1585 $this->getBlockedStatus();
1586 return $this->mBlockedby
;
1590 * If user is blocked, return the specified reason for the block
1591 * @return String Blocking reason
1593 public function blockedFor() {
1594 $this->getBlockedStatus();
1595 return $this->mBlockreason
;
1599 * If user is blocked, return the ID for the block
1600 * @return Int Block ID
1602 public function getBlockId() {
1603 $this->getBlockedStatus();
1604 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1608 * Check if user is blocked on all wikis.
1609 * Do not use for actual edit permission checks!
1610 * This is intented for quick UI checks.
1612 * @param $ip String IP address, uses current client if none given
1613 * @return Bool True if blocked, false otherwise
1615 public function isBlockedGlobally( $ip = '' ) {
1616 if( $this->mBlockedGlobally
!== null ) {
1617 return $this->mBlockedGlobally
;
1619 // User is already an IP?
1620 if( IP
::isIPAddress( $this->getName() ) ) {
1621 $ip = $this->getName();
1623 $ip = $this->getRequest()->getIP();
1626 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1627 $this->mBlockedGlobally
= (bool)$blocked;
1628 return $this->mBlockedGlobally
;
1632 * Check if user account is locked
1634 * @return Bool True if locked, false otherwise
1636 public function isLocked() {
1637 if( $this->mLocked
!== null ) {
1638 return $this->mLocked
;
1641 $authUser = $wgAuth->getUserInstance( $this );
1642 $this->mLocked
= (bool)$authUser->isLocked();
1643 return $this->mLocked
;
1647 * Check if user account is hidden
1649 * @return Bool True if hidden, false otherwise
1651 public function isHidden() {
1652 if( $this->mHideName
!== null ) {
1653 return $this->mHideName
;
1655 $this->getBlockedStatus();
1656 if( !$this->mHideName
) {
1658 $authUser = $wgAuth->getUserInstance( $this );
1659 $this->mHideName
= (bool)$authUser->isHidden();
1661 return $this->mHideName
;
1665 * Get the user's ID.
1666 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1668 public function getId() {
1669 if( $this->mId
=== null && $this->mName
!== null
1670 && User
::isIP( $this->mName
) ) {
1671 // Special case, we know the user is anonymous
1673 } elseif( !$this->isItemLoaded( 'id' ) ) {
1674 // Don't load if this was initialized from an ID
1681 * Set the user and reload all fields according to a given ID
1682 * @param $v Int User ID to reload
1684 public function setId( $v ) {
1686 $this->clearInstanceCache( 'id' );
1690 * Get the user name, or the IP of an anonymous user
1691 * @return String User's name or IP address
1693 public function getName() {
1694 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1695 # Special case optimisation
1696 return $this->mName
;
1699 if ( $this->mName
=== false ) {
1701 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1703 return $this->mName
;
1708 * Set the user name.
1710 * This does not reload fields from the database according to the given
1711 * name. Rather, it is used to create a temporary "nonexistent user" for
1712 * later addition to the database. It can also be used to set the IP
1713 * address for an anonymous user to something other than the current
1716 * @note User::newFromName() has rougly the same function, when the named user
1718 * @param $str String New user name to set
1720 public function setName( $str ) {
1722 $this->mName
= $str;
1726 * Get the user's name escaped by underscores.
1727 * @return String Username escaped by underscores.
1729 public function getTitleKey() {
1730 return str_replace( ' ', '_', $this->getName() );
1734 * Check if the user has new messages.
1735 * @return Bool True if the user has new messages
1737 public function getNewtalk() {
1740 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1741 if( $this->mNewtalk
=== -1 ) {
1742 $this->mNewtalk
= false; # reset talk page status
1744 # Check memcached separately for anons, who have no
1745 # entire User object stored in there.
1748 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1749 $newtalk = $wgMemc->get( $key );
1750 if( strval( $newtalk ) !== '' ) {
1751 $this->mNewtalk
= (bool)$newtalk;
1753 // Since we are caching this, make sure it is up to date by getting it
1755 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1756 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1759 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1763 return (bool)$this->mNewtalk
;
1767 * Return the talk page(s) this user has new messages on.
1768 * @return Array of String page URLs
1770 public function getNewMessageLinks() {
1772 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1775 if( !$this->getNewtalk() )
1777 $up = $this->getUserPage();
1778 $utp = $up->getTalkPage();
1779 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1783 * Internal uncached check for new messages
1786 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1787 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1788 * @param $fromMaster Bool true to fetch from the master, false for a slave
1789 * @return Bool True if the user has new messages
1791 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1792 if ( $fromMaster ) {
1793 $db = wfGetDB( DB_MASTER
);
1795 $db = wfGetDB( DB_SLAVE
);
1797 $ok = $db->selectField( 'user_newtalk', $field,
1798 array( $field => $id ), __METHOD__
);
1799 return $ok !== false;
1803 * Add or update the new messages flag
1804 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1805 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1806 * @return Bool True if successful, false otherwise
1808 protected function updateNewtalk( $field, $id ) {
1809 $dbw = wfGetDB( DB_MASTER
);
1810 $dbw->insert( 'user_newtalk',
1811 array( $field => $id ),
1814 if ( $dbw->affectedRows() ) {
1815 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1818 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1824 * Clear the new messages flag for the given user
1825 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1826 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1827 * @return Bool True if successful, false otherwise
1829 protected function deleteNewtalk( $field, $id ) {
1830 $dbw = wfGetDB( DB_MASTER
);
1831 $dbw->delete( 'user_newtalk',
1832 array( $field => $id ),
1834 if ( $dbw->affectedRows() ) {
1835 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1838 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1844 * Update the 'You have new messages!' status.
1845 * @param $val Bool Whether the user has new messages
1847 public function setNewtalk( $val ) {
1848 if( wfReadOnly() ) {
1853 $this->mNewtalk
= $val;
1855 if( $this->isAnon() ) {
1857 $id = $this->getName();
1860 $id = $this->getId();
1865 $changed = $this->updateNewtalk( $field, $id );
1867 $changed = $this->deleteNewtalk( $field, $id );
1870 if( $this->isAnon() ) {
1871 // Anons have a separate memcached space, since
1872 // user records aren't kept for them.
1873 $key = wfMemcKey( 'newtalk', 'ip', $id );
1874 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1877 $this->invalidateCache();
1882 * Generate a current or new-future timestamp to be stored in the
1883 * user_touched field when we update things.
1884 * @return String Timestamp in TS_MW format
1886 private static function newTouchedTimestamp() {
1887 global $wgClockSkewFudge;
1888 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1892 * Clear user data from memcached.
1893 * Use after applying fun updates to the database; caller's
1894 * responsibility to update user_touched if appropriate.
1896 * Called implicitly from invalidateCache() and saveSettings().
1898 private function clearSharedCache() {
1902 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1907 * Immediately touch the user data cache for this account.
1908 * Updates user_touched field, and removes account data from memcached
1909 * for reload on the next hit.
1911 public function invalidateCache() {
1912 if( wfReadOnly() ) {
1917 $this->mTouched
= self
::newTouchedTimestamp();
1919 $dbw = wfGetDB( DB_MASTER
);
1920 $dbw->update( 'user',
1921 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1922 array( 'user_id' => $this->mId
),
1925 $this->clearSharedCache();
1930 * Validate the cache for this account.
1931 * @param $timestamp String A timestamp in TS_MW format
1935 public function validateCache( $timestamp ) {
1937 return ( $timestamp >= $this->mTouched
);
1941 * Get the user touched timestamp
1942 * @return String timestamp
1944 public function getTouched() {
1946 return $this->mTouched
;
1950 * Set the password and reset the random token.
1951 * Calls through to authentication plugin if necessary;
1952 * will have no effect if the auth plugin refuses to
1953 * pass the change through or if the legal password
1956 * As a special case, setting the password to null
1957 * wipes it, so the account cannot be logged in until
1958 * a new password is set, for instance via e-mail.
1960 * @param $str String New password to set
1961 * @throws PasswordError on failure
1965 public function setPassword( $str ) {
1968 if( $str !== null ) {
1969 if( !$wgAuth->allowPasswordChange() ) {
1970 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1973 if( !$this->isValidPassword( $str ) ) {
1974 global $wgMinimalPasswordLength;
1975 $valid = $this->getPasswordValidity( $str );
1976 if ( is_array( $valid ) ) {
1977 $message = array_shift( $valid );
1981 $params = array( $wgMinimalPasswordLength );
1983 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
1987 if( !$wgAuth->setPassword( $this, $str ) ) {
1988 throw new PasswordError( wfMsg( 'externaldberror' ) );
1991 $this->setInternalPassword( $str );
1997 * Set the password and reset the random token unconditionally.
1999 * @param $str String New password to set
2001 public function setInternalPassword( $str ) {
2005 if( $str === null ) {
2006 // Save an invalid hash...
2007 $this->mPassword
= '';
2009 $this->mPassword
= self
::crypt( $str );
2011 $this->mNewpassword
= '';
2012 $this->mNewpassTime
= null;
2016 * Get the user's current token.
2017 * @return String Token
2019 public function getToken() {
2021 return $this->mToken
;
2025 * Set the random token (used for persistent authentication)
2026 * Called from loadDefaults() among other places.
2028 * @param $token String|bool If specified, set the token to this value
2030 public function setToken( $token = false ) {
2031 global $wgSecretKey, $wgProxyKey;
2034 if ( $wgSecretKey ) {
2035 $key = $wgSecretKey;
2036 } elseif ( $wgProxyKey ) {
2041 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
2043 $this->mToken
= $token;
2048 * Set the cookie password
2050 * @param $str String New cookie password
2052 private function setCookiePassword( $str ) {
2054 $this->mCookiePassword
= md5( $str );
2058 * Set the password for a password reminder or new account email
2060 * @param $str String New password to set
2061 * @param $throttle Bool If true, reset the throttle timestamp to the present
2063 public function setNewpassword( $str, $throttle = true ) {
2065 $this->mNewpassword
= self
::crypt( $str );
2067 $this->mNewpassTime
= wfTimestampNow();
2072 * Has password reminder email been sent within the last
2073 * $wgPasswordReminderResendTime hours?
2076 public function isPasswordReminderThrottled() {
2077 global $wgPasswordReminderResendTime;
2079 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2082 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2083 return time() < $expiry;
2087 * Get the user's e-mail address
2088 * @return String User's email address
2090 public function getEmail() {
2092 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2093 return $this->mEmail
;
2097 * Get the timestamp of the user's e-mail authentication
2098 * @return String TS_MW timestamp
2100 public function getEmailAuthenticationTimestamp() {
2102 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2103 return $this->mEmailAuthenticated
;
2107 * Set the user's e-mail address
2108 * @param $str String New e-mail address
2110 public function setEmail( $str ) {
2112 $this->mEmail
= $str;
2113 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2117 * Get the user's real name
2118 * @return String User's real name
2120 public function getRealName() {
2121 if ( !$this->isItemLoaded( 'realname' ) ) {
2125 return $this->mRealName
;
2129 * Set the user's real name
2130 * @param $str String New real name
2132 public function setRealName( $str ) {
2134 $this->mRealName
= $str;
2138 * Get the user's current setting for a given option.
2140 * @param $oname String The option to check
2141 * @param $defaultOverride String A default value returned if the option does not exist
2142 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2143 * @return String User's current value for the option
2144 * @see getBoolOption()
2145 * @see getIntOption()
2147 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2148 global $wgHiddenPrefs;
2149 $this->loadOptions();
2151 if ( is_null( $this->mOptions
) ) {
2152 if($defaultOverride != '') {
2153 return $defaultOverride;
2155 $this->mOptions
= User
::getDefaultOptions();
2158 # We want 'disabled' preferences to always behave as the default value for
2159 # users, even if they have set the option explicitly in their settings (ie they
2160 # set it, and then it was disabled removing their ability to change it). But
2161 # we don't want to erase the preferences in the database in case the preference
2162 # is re-enabled again. So don't touch $mOptions, just override the returned value
2163 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2164 return self
::getDefaultOption( $oname );
2167 if ( array_key_exists( $oname, $this->mOptions
) ) {
2168 return $this->mOptions
[$oname];
2170 return $defaultOverride;
2175 * Get all user's options
2179 public function getOptions() {
2180 global $wgHiddenPrefs;
2181 $this->loadOptions();
2182 $options = $this->mOptions
;
2184 # We want 'disabled' preferences to always behave as the default value for
2185 # users, even if they have set the option explicitly in their settings (ie they
2186 # set it, and then it was disabled removing their ability to change it). But
2187 # we don't want to erase the preferences in the database in case the preference
2188 # is re-enabled again. So don't touch $mOptions, just override the returned value
2189 foreach( $wgHiddenPrefs as $pref ){
2190 $default = self
::getDefaultOption( $pref );
2191 if( $default !== null ){
2192 $options[$pref] = $default;
2200 * Get the user's current setting for a given option, as a boolean value.
2202 * @param $oname String The option to check
2203 * @return Bool User's current value for the option
2206 public function getBoolOption( $oname ) {
2207 return (bool)$this->getOption( $oname );
2211 * Get the user's current setting for a given option, as a boolean value.
2213 * @param $oname String The option to check
2214 * @param $defaultOverride Int A default value returned if the option does not exist
2215 * @return Int User's current value for the option
2218 public function getIntOption( $oname, $defaultOverride=0 ) {
2219 $val = $this->getOption( $oname );
2221 $val = $defaultOverride;
2223 return intval( $val );
2227 * Set the given option for a user.
2229 * @param $oname String The option to set
2230 * @param $val mixed New value to set
2232 public function setOption( $oname, $val ) {
2234 $this->loadOptions();
2236 // Explicitly NULL values should refer to defaults
2237 global $wgDefaultUserOptions;
2238 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2239 $val = $wgDefaultUserOptions[$oname];
2242 $this->mOptions
[$oname] = $val;
2246 * Reset all options to the site defaults
2248 public function resetOptions() {
2249 $this->mOptions
= self
::getDefaultOptions();
2253 * Get the user's preferred date format.
2254 * @return String User's preferred date format
2256 public function getDatePreference() {
2257 // Important migration for old data rows
2258 if ( is_null( $this->mDatePreference
) ) {
2260 $value = $this->getOption( 'date' );
2261 $map = $wgLang->getDatePreferenceMigrationMap();
2262 if ( isset( $map[$value] ) ) {
2263 $value = $map[$value];
2265 $this->mDatePreference
= $value;
2267 return $this->mDatePreference
;
2271 * Get the user preferred stub threshold
2275 public function getStubThreshold() {
2276 global $wgMaxArticleSize; # Maximum article size, in Kb
2277 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2278 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2279 # If they have set an impossible value, disable the preference
2280 # so we can use the parser cache again.
2287 * Get the permissions this user has.
2288 * @param $ns int If numeric, get permissions for this namespace
2289 * @return Array of String permission names
2291 public function getRights( $ns = null ) {
2292 $key = is_null( $ns ) ?
'*' : intval( $ns );
2294 if ( is_null( $this->mRights
) ) {
2295 $this->mRights
= array();
2298 if ( !isset( $this->mRights
[$key] ) ) {
2299 $this->mRights
[$key] = self
::getGroupPermissions( $this->getEffectiveGroups(), $ns );
2300 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
[$key], $ns ) );
2301 // Force reindexation of rights when a hook has unset one of them
2302 $this->mRights
[$key] = array_values( $this->mRights
[$key] );
2304 if ( is_null( $ns ) ) {
2305 return $this->mRights
[$key];
2307 // Merge non namespace specific rights
2308 return array_merge( $this->mRights
[$key], $this->getRights() );
2314 * Get the list of explicit group memberships this user has.
2315 * The implicit * and user groups are not included.
2316 * @return Array of String internal group names
2318 public function getGroups() {
2320 $this->loadGroups();
2321 return $this->mGroups
;
2325 * Get the list of implicit group memberships this user has.
2326 * This includes all explicit groups, plus 'user' if logged in,
2327 * '*' for all accounts, and autopromoted groups
2328 * @param $recache Bool Whether to avoid the cache
2329 * @return Array of String internal group names
2331 public function getEffectiveGroups( $recache = false ) {
2332 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2333 wfProfileIn( __METHOD__
);
2334 $this->mEffectiveGroups
= array_unique( array_merge(
2335 $this->getGroups(), // explicit groups
2336 $this->getAutomaticGroups( $recache ) // implicit groups
2338 # Hook for additional groups
2339 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2340 wfProfileOut( __METHOD__
);
2342 return $this->mEffectiveGroups
;
2346 * Get the list of implicit group memberships this user has.
2347 * This includes 'user' if logged in, '*' for all accounts,
2348 * and autopromoted groups
2349 * @param $recache Bool Whether to avoid the cache
2350 * @return Array of String internal group names
2352 public function getAutomaticGroups( $recache = false ) {
2353 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2354 wfProfileIn( __METHOD__
);
2355 $this->mImplicitGroups
= array( '*' );
2356 if ( $this->getId() ) {
2357 $this->mImplicitGroups
[] = 'user';
2359 $this->mImplicitGroups
= array_unique( array_merge(
2360 $this->mImplicitGroups
,
2361 Autopromote
::getAutopromoteGroups( $this )
2365 # Assure data consistency with rights/groups,
2366 # as getEffectiveGroups() depends on this function
2367 $this->mEffectiveGroups
= null;
2369 wfProfileOut( __METHOD__
);
2371 return $this->mImplicitGroups
;
2375 * Returns the groups the user has belonged to.
2377 * The user may still belong to the returned groups. Compare with getGroups().
2379 * The function will not return groups the user had belonged to before MW 1.17
2381 * @return array Names of the groups the user has belonged to.
2383 public function getFormerGroups() {
2384 if( is_null( $this->mFormerGroups
) ) {
2385 $dbr = wfGetDB( DB_MASTER
);
2386 $res = $dbr->select( 'user_former_groups',
2387 array( 'ufg_group' ),
2388 array( 'ufg_user' => $this->mId
),
2390 $this->mFormerGroups
= array();
2391 foreach( $res as $row ) {
2392 $this->mFormerGroups
[] = $row->ufg_group
;
2395 return $this->mFormerGroups
;
2399 * Get the user's edit count.
2402 public function getEditCount() {
2403 if( $this->getId() ) {
2404 if ( !isset( $this->mEditCount
) ) {
2405 /* Populate the count, if it has not been populated yet */
2406 $this->mEditCount
= User
::edits( $this->mId
);
2408 return $this->mEditCount
;
2416 * Add the user to the given group.
2417 * This takes immediate effect.
2418 * @param $group String Name of the group to add
2420 public function addGroup( $group ) {
2421 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2422 $dbw = wfGetDB( DB_MASTER
);
2423 if( $this->getId() ) {
2424 $dbw->insert( 'user_groups',
2426 'ug_user' => $this->getID(),
2427 'ug_group' => $group,
2430 array( 'IGNORE' ) );
2433 $this->loadGroups();
2434 $this->mGroups
[] = $group;
2435 $this->mRights
= null;
2437 $this->invalidateCache();
2441 * Remove the user from the given group.
2442 * This takes immediate effect.
2443 * @param $group String Name of the group to remove
2445 public function removeGroup( $group ) {
2447 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2448 $dbw = wfGetDB( DB_MASTER
);
2449 $dbw->delete( 'user_groups',
2451 'ug_user' => $this->getID(),
2452 'ug_group' => $group,
2454 // Remember that the user was in this group
2455 $dbw->insert( 'user_former_groups',
2457 'ufg_user' => $this->getID(),
2458 'ufg_group' => $group,
2461 array( 'IGNORE' ) );
2463 $this->loadGroups();
2464 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2465 $this->mRights
= null;
2467 $this->invalidateCache();
2471 * Get whether the user is logged in
2474 public function isLoggedIn() {
2475 return $this->getID() != 0;
2479 * Get whether the user is anonymous
2482 public function isAnon() {
2483 return !$this->isLoggedIn();
2487 * Check if user is allowed to access a feature / make an action
2489 * @internal param \String $varargs permissions to test
2490 * @return Boolean: True if user is allowed to perform *any* of the given actions
2494 public function isAllowedAny( /*...*/ ){
2495 $permissions = func_get_args();
2496 foreach( $permissions as $permission ){
2497 if( $this->isAllowed( $permission ) ){
2506 * @internal param $varargs string
2507 * @return bool True if the user is allowed to perform *all* of the given actions
2509 public function isAllowedAll( /*...*/ ){
2510 $permissions = func_get_args();
2511 foreach( $permissions as $permission ){
2512 if( !$this->isAllowed( $permission ) ){
2520 * Internal mechanics of testing a permission
2521 * @param $action String
2522 * @param $ns int|null Namespace optional
2525 public function isAllowed( $action = '', $ns = null ) {
2526 if ( $action === '' ) {
2527 return true; // In the spirit of DWIM
2529 # Patrolling may not be enabled
2530 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2531 global $wgUseRCPatrol, $wgUseNPPatrol;
2532 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2535 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2536 # by misconfiguration: 0 == 'foo'
2537 return in_array( $action, $this->getRights( $ns ), true );
2541 * Check whether to enable recent changes patrol features for this user
2542 * @return Boolean: True or false
2544 public function useRCPatrol() {
2545 global $wgUseRCPatrol;
2546 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2550 * Check whether to enable new pages patrol features for this user
2551 * @return Bool True or false
2553 public function useNPPatrol() {
2554 global $wgUseRCPatrol, $wgUseNPPatrol;
2555 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2559 * Get the WebRequest object to use with this object
2561 * @return WebRequest
2563 public function getRequest() {
2564 if ( $this->mRequest
) {
2565 return $this->mRequest
;
2573 * Get the current skin, loading it if required
2574 * @return Skin The current skin
2575 * @todo FIXME: Need to check the old failback system [AV]
2576 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2578 public function getSkin() {
2579 return RequestContext
::getMain()->getSkin();
2583 * Check the watched status of an article.
2584 * @param $title Title of the article to look at
2587 public function isWatched( $title ) {
2588 $wl = WatchedItem
::fromUserTitle( $this, $title );
2589 return $wl->isWatched();
2594 * @param $title Title of the article to look at
2596 public function addWatch( $title ) {
2597 $wl = WatchedItem
::fromUserTitle( $this, $title );
2599 $this->invalidateCache();
2603 * Stop watching an article.
2604 * @param $title Title of the article to look at
2606 public function removeWatch( $title ) {
2607 $wl = WatchedItem
::fromUserTitle( $this, $title );
2609 $this->invalidateCache();
2613 * Cleans up watchlist by removing invalid entries from it
2615 public function cleanupWatchlist() {
2616 $dbw = wfGetDB( DB_MASTER
);
2617 $dbw->delete( 'watchlist', array( 'wl_namespace < 0', 'wl_user' => $this->getId() ), __METHOD__
);
2621 * Clear the user's notification timestamp for the given title.
2622 * If e-notif e-mails are on, they will receive notification mails on
2623 * the next change of the page if it's watched etc.
2624 * @param $title Title of the article to look at
2626 public function clearNotification( &$title ) {
2627 global $wgUseEnotif, $wgShowUpdatedMarker;
2629 # Do nothing if the database is locked to writes
2630 if( wfReadOnly() ) {
2634 if( $title->getNamespace() == NS_USER_TALK
&&
2635 $title->getText() == $this->getName() ) {
2636 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2638 $this->setNewtalk( false );
2641 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2645 if( $this->isAnon() ) {
2646 // Nothing else to do...
2650 // Only update the timestamp if the page is being watched.
2651 // The query to find out if it is watched is cached both in memcached and per-invocation,
2652 // and when it does have to be executed, it can be on a slave
2653 // If this is the user's newtalk page, we always update the timestamp
2654 if( $title->getNamespace() == NS_USER_TALK
&&
2655 $title->getText() == $this->getName() )
2659 $watched = $this->isWatched( $title );
2662 // If the page is watched by the user (or may be watched), update the timestamp on any
2663 // any matching rows
2665 $dbw = wfGetDB( DB_MASTER
);
2666 $dbw->update( 'watchlist',
2668 'wl_notificationtimestamp' => null
2669 ), array( /* WHERE */
2670 'wl_title' => $title->getDBkey(),
2671 'wl_namespace' => $title->getNamespace(),
2672 'wl_user' => $this->getID()
2679 * Resets all of the given user's page-change notification timestamps.
2680 * If e-notif e-mails are on, they will receive notification mails on
2681 * the next change of any watched page.
2683 public function clearAllNotifications() {
2684 global $wgUseEnotif, $wgShowUpdatedMarker;
2685 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2686 $this->setNewtalk( false );
2689 $id = $this->getId();
2691 $dbw = wfGetDB( DB_MASTER
);
2692 $dbw->update( 'watchlist',
2694 'wl_notificationtimestamp' => null
2695 ), array( /* WHERE */
2699 # We also need to clear here the "you have new message" notification for the own user_talk page
2700 # This is cleared one page view later in Article::viewUpdates();
2705 * Set this user's options from an encoded string
2706 * @param $str String Encoded options to import
2708 * @deprecated in 1.19 due to removal of user_options from the user table
2710 private function decodeOptions( $str ) {
2714 $this->mOptionsLoaded
= true;
2715 $this->mOptionOverrides
= array();
2717 // If an option is not set in $str, use the default value
2718 $this->mOptions
= self
::getDefaultOptions();
2720 $a = explode( "\n", $str );
2721 foreach ( $a as $s ) {
2723 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2724 $this->mOptions
[$m[1]] = $m[2];
2725 $this->mOptionOverrides
[$m[1]] = $m[2];
2731 * Set a cookie on the user's client. Wrapper for
2732 * WebResponse::setCookie
2733 * @param $name String Name of the cookie to set
2734 * @param $value String Value to set
2735 * @param $exp Int Expiration time, as a UNIX time value;
2736 * if 0 or not specified, use the default $wgCookieExpiration
2738 protected function setCookie( $name, $value, $exp = 0 ) {
2739 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2743 * Clear a cookie on the user's client
2744 * @param $name String Name of the cookie to clear
2746 protected function clearCookie( $name ) {
2747 $this->setCookie( $name, '', time() - 86400 );
2751 * Set the default cookies for this session on the user's client.
2753 * @param $request WebRequest object to use; $wgRequest will be used if null
2756 public function setCookies( $request = null ) {
2757 if ( $request === null ) {
2758 $request = $this->getRequest();
2762 if ( 0 == $this->mId
) return;
2764 'wsUserID' => $this->mId
,
2765 'wsToken' => $this->mToken
,
2766 'wsUserName' => $this->getName()
2769 'UserID' => $this->mId
,
2770 'UserName' => $this->getName(),
2772 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2773 $cookies['Token'] = $this->mToken
;
2775 $cookies['Token'] = false;
2778 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2780 foreach ( $session as $name => $value ) {
2781 $request->setSessionData( $name, $value );
2783 foreach ( $cookies as $name => $value ) {
2784 if ( $value === false ) {
2785 $this->clearCookie( $name );
2787 $this->setCookie( $name, $value );
2793 * Log this user out.
2795 public function logout() {
2796 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2802 * Clear the user's cookies and session, and reset the instance cache.
2805 public function doLogout() {
2806 $this->clearInstanceCache( 'defaults' );
2808 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2810 $this->clearCookie( 'UserID' );
2811 $this->clearCookie( 'Token' );
2813 # Remember when user logged out, to prevent seeing cached pages
2814 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2818 * Save this user's settings into the database.
2819 * @todo Only rarely do all these fields need to be set!
2821 public function saveSettings() {
2823 if ( wfReadOnly() ) { return; }
2824 if ( 0 == $this->mId
) { return; }
2826 $this->mTouched
= self
::newTouchedTimestamp();
2828 $dbw = wfGetDB( DB_MASTER
);
2829 $dbw->update( 'user',
2831 'user_name' => $this->mName
,
2832 'user_password' => $this->mPassword
,
2833 'user_newpassword' => $this->mNewpassword
,
2834 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2835 'user_real_name' => $this->mRealName
,
2836 'user_email' => $this->mEmail
,
2837 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2838 'user_touched' => $dbw->timestamp( $this->mTouched
),
2839 'user_token' => $this->mToken
,
2840 'user_email_token' => $this->mEmailToken
,
2841 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2842 ), array( /* WHERE */
2843 'user_id' => $this->mId
2847 $this->saveOptions();
2849 wfRunHooks( 'UserSaveSettings', array( $this ) );
2850 $this->clearSharedCache();
2851 $this->getUserPage()->invalidateCache();
2855 * If only this user's username is known, and it exists, return the user ID.
2858 public function idForName() {
2859 $s = trim( $this->getName() );
2860 if ( $s === '' ) return 0;
2862 $dbr = wfGetDB( DB_SLAVE
);
2863 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2864 if ( $id === false ) {
2871 * Add a user to the database, return the user object
2873 * @param $name String Username to add
2874 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2875 * - password The user's password hash. Password logins will be disabled if this is omitted.
2876 * - newpassword Hash for a temporary password that has been mailed to the user
2877 * - email The user's email address
2878 * - email_authenticated The email authentication timestamp
2879 * - real_name The user's real name
2880 * - options An associative array of non-default options
2881 * - token Random authentication token. Do not set.
2882 * - registration Registration timestamp. Do not set.
2884 * @return User object, or null if the username already exists
2886 public static function createNew( $name, $params = array() ) {
2889 if ( isset( $params['options'] ) ) {
2890 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2891 unset( $params['options'] );
2893 $dbw = wfGetDB( DB_MASTER
);
2894 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2897 'user_id' => $seqVal,
2898 'user_name' => $name,
2899 'user_password' => $user->mPassword
,
2900 'user_newpassword' => $user->mNewpassword
,
2901 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2902 'user_email' => $user->mEmail
,
2903 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2904 'user_real_name' => $user->mRealName
,
2905 'user_token' => $user->mToken
,
2906 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2907 'user_editcount' => 0,
2909 foreach ( $params as $name => $value ) {
2910 $fields["user_$name"] = $value;
2912 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2913 if ( $dbw->affectedRows() ) {
2914 $newUser = User
::newFromId( $dbw->insertId() );
2922 * Add this existing user object to the database
2924 public function addToDatabase() {
2926 $dbw = wfGetDB( DB_MASTER
);
2927 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2928 $dbw->insert( 'user',
2930 'user_id' => $seqVal,
2931 'user_name' => $this->mName
,
2932 'user_password' => $this->mPassword
,
2933 'user_newpassword' => $this->mNewpassword
,
2934 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2935 'user_email' => $this->mEmail
,
2936 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2937 'user_real_name' => $this->mRealName
,
2938 'user_token' => $this->mToken
,
2939 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2940 'user_editcount' => 0,
2943 $this->mId
= $dbw->insertId();
2945 // Clear instance cache other than user table data, which is already accurate
2946 $this->clearInstanceCache();
2948 $this->saveOptions();
2952 * If this user is logged-in and blocked,
2953 * block any IP address they've successfully logged in from.
2954 * @return bool A block was spread
2956 public function spreadAnyEditBlock() {
2957 if ( $this->isLoggedIn() && $this->isBlocked() ) {
2958 return $this->spreadBlock();
2964 * If this (non-anonymous) user is blocked,
2965 * block the IP address they've successfully logged in from.
2966 * @return bool A block was spread
2968 protected function spreadBlock() {
2969 wfDebug( __METHOD__
. "()\n" );
2971 if ( $this->mId
== 0 ) {
2975 $userblock = Block
::newFromTarget( $this->getName() );
2976 if ( !$userblock ) {
2980 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
2984 * Generate a string which will be different for any combination of
2985 * user options which would produce different parser output.
2986 * This will be used as part of the hash key for the parser cache,
2987 * so users with the same options can share the same cached data
2990 * Extensions which require it should install 'PageRenderingHash' hook,
2991 * which will give them a chance to modify this key based on their own
2994 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
2995 * @return String Page rendering hash
2997 public function getPageRenderingHash() {
2998 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3000 return $this->mHash
;
3002 wfDeprecated( __METHOD__
);
3004 // stubthreshold is only included below for completeness,
3005 // since it disables the parser cache, its value will always
3006 // be 0 when this function is called by parsercache.
3008 $confstr = $this->getOption( 'math' );
3009 $confstr .= '!' . $this->getStubThreshold();
3010 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3011 $confstr .= '!' . $this->getDatePreference();
3013 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3014 $confstr .= '!' . $wgLang->getCode();
3015 $confstr .= '!' . $this->getOption( 'thumbsize' );
3016 // add in language specific options, if any
3017 $extra = $wgContLang->getExtraHashOptions();
3020 // Since the skin could be overloading link(), it should be
3021 // included here but in practice, none of our skins do that.
3023 $confstr .= $wgRenderHashAppend;
3025 // Give a chance for extensions to modify the hash, if they have
3026 // extra options or other effects on the parser cache.
3027 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3029 // Make it a valid memcached key fragment
3030 $confstr = str_replace( ' ', '_', $confstr );
3031 $this->mHash
= $confstr;
3036 * Get whether the user is explicitly blocked from account creation.
3037 * @return Bool|Block
3039 public function isBlockedFromCreateAccount() {
3040 $this->getBlockedStatus();
3041 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3042 return $this->mBlock
;
3045 # bug 13611: if the IP address the user is trying to create an account from is
3046 # blocked with createaccount disabled, prevent new account creation there even
3047 # when the user is logged in
3048 if( $this->mBlockedFromCreateAccount
=== false ){
3049 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3051 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3052 ?
$this->mBlockedFromCreateAccount
3057 * Get whether the user is blocked from using Special:Emailuser.
3060 public function isBlockedFromEmailuser() {
3061 $this->getBlockedStatus();
3062 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3066 * Get whether the user is allowed to create an account.
3069 function isAllowedToCreateAccount() {
3070 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3074 * Get this user's personal page title.
3076 * @return Title: User's personal page title
3078 public function getUserPage() {
3079 return Title
::makeTitle( NS_USER
, $this->getName() );
3083 * Get this user's talk page title.
3085 * @return Title: User's talk page title
3087 public function getTalkPage() {
3088 $title = $this->getUserPage();
3089 return $title->getTalkPage();
3093 * Determine whether the user is a newbie. Newbies are either
3094 * anonymous IPs, or the most recently created accounts.
3097 public function isNewbie() {
3098 return !$this->isAllowed( 'autoconfirmed' );
3102 * Check to see if the given clear-text password is one of the accepted passwords
3103 * @param $password String: user password.
3104 * @return Boolean: True if the given password is correct, otherwise False.
3106 public function checkPassword( $password ) {
3107 global $wgAuth, $wgLegacyEncoding;
3110 // Even though we stop people from creating passwords that
3111 // are shorter than this, doesn't mean people wont be able
3112 // to. Certain authentication plugins do NOT want to save
3113 // domain passwords in a mysql database, so we should
3114 // check this (in case $wgAuth->strict() is false).
3115 if( !$this->isValidPassword( $password ) ) {
3119 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3121 } elseif( $wgAuth->strict() ) {
3122 /* Auth plugin doesn't allow local authentication */
3124 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3125 /* Auth plugin doesn't allow local authentication for this user name */
3128 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3130 } elseif ( $wgLegacyEncoding ) {
3131 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3132 # Check for this with iconv
3133 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3134 if ( $cp1252Password != $password &&
3135 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3144 * Check if the given clear-text password matches the temporary password
3145 * sent by e-mail for password reset operations.
3147 * @param $plaintext string
3149 * @return Boolean: True if matches, false otherwise
3151 public function checkTemporaryPassword( $plaintext ) {
3152 global $wgNewPasswordExpiry;
3155 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3156 if ( is_null( $this->mNewpassTime
) ) {
3159 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3160 return ( time() < $expiry );
3167 * Alias for getEditToken.
3168 * @deprecated since 1.19, use getEditToken instead.
3170 * @param $salt String|Array of Strings Optional function-specific data for hashing
3171 * @param $request WebRequest object to use or null to use $wgRequest
3172 * @return String The new edit token
3174 public function editToken( $salt = '', $request = null ) {
3175 return $this->getEditToken( $salt, $request );
3179 * Initialize (if necessary) and return a session token value
3180 * which can be used in edit forms to show that the user's
3181 * login credentials aren't being hijacked with a foreign form
3186 * @param $salt String|Array of Strings Optional function-specific data for hashing
3187 * @param $request WebRequest object to use or null to use $wgRequest
3188 * @return String The new edit token
3190 public function getEditToken( $salt = '', $request = null ) {
3191 if ( $request == null ) {
3192 $request = $this->getRequest();
3195 if ( $this->isAnon() ) {
3196 return EDIT_TOKEN_SUFFIX
;
3198 $token = $request->getSessionData( 'wsEditToken' );
3199 if ( $token === null ) {
3200 $token = self
::generateToken();
3201 $request->setSessionData( 'wsEditToken', $token );
3203 if( is_array( $salt ) ) {
3204 $salt = implode( '|', $salt );
3206 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3211 * Generate a looking random token for various uses.
3213 * @param $salt String Optional salt value
3214 * @return String The new random token
3216 public static function generateToken( $salt = '' ) {
3217 $token = dechex( mt_rand() ) . dechex( mt_rand() );
3218 return md5( $token . $salt );
3222 * Check given value against the token value stored in the session.
3223 * A match should confirm that the form was submitted from the
3224 * user's own login session, not a form submission from a third-party
3227 * @param $val String Input value to compare
3228 * @param $salt String Optional function-specific data for hashing
3229 * @param $request WebRequest object to use or null to use $wgRequest
3230 * @return Boolean: Whether the token matches
3232 public function matchEditToken( $val, $salt = '', $request = null ) {
3233 $sessionToken = $this->editToken( $salt, $request );
3234 if ( $val != $sessionToken ) {
3235 wfDebug( "User::matchEditToken: broken session data\n" );
3237 return $val == $sessionToken;
3241 * Check given value against the token value stored in the session,
3242 * ignoring the suffix.
3244 * @param $val String Input value to compare
3245 * @param $salt String Optional function-specific data for hashing
3246 * @param $request WebRequest object to use or null to use $wgRequest
3247 * @return Boolean: Whether the token matches
3249 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3250 $sessionToken = $this->editToken( $salt, $request );
3251 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3255 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3256 * mail to the user's given address.
3258 * @param $type String: message to send, either "created", "changed" or "set"
3259 * @return Status object
3261 public function sendConfirmationMail( $type = 'created' ) {
3263 $expiration = null; // gets passed-by-ref and defined in next line.
3264 $token = $this->confirmationToken( $expiration );
3265 $url = $this->confirmationTokenUrl( $token );
3266 $invalidateURL = $this->invalidationTokenUrl( $token );
3267 $this->saveSettings();
3269 if ( $type == 'created' ||
$type === false ) {
3270 $message = 'confirmemail_body';
3271 } elseif ( $type === true ) {
3272 $message = 'confirmemail_body_changed';
3274 $message = 'confirmemail_body_' . $type;
3277 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3279 $this->getRequest()->getIP(),
3282 $wgLang->timeanddate( $expiration, false ),
3284 $wgLang->date( $expiration, false ),
3285 $wgLang->time( $expiration, false ) ) );
3289 * Send an e-mail to this user's account. Does not check for
3290 * confirmed status or validity.
3292 * @param $subject String Message subject
3293 * @param $body String Message body
3294 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3295 * @param $replyto String Reply-To address
3298 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3299 if( is_null( $from ) ) {
3300 global $wgPasswordSender, $wgPasswordSenderName;
3301 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3303 $sender = new MailAddress( $from );
3306 $to = new MailAddress( $this );
3307 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3311 * Generate, store, and return a new e-mail confirmation code.
3312 * A hash (unsalted, since it's used as a key) is stored.
3314 * @note Call saveSettings() after calling this function to commit
3315 * this change to the database.
3317 * @param &$expiration \mixed Accepts the expiration time
3318 * @return String New token
3320 private function confirmationToken( &$expiration ) {
3321 global $wgUserEmailConfirmationTokenExpiry;
3323 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3324 $expiration = wfTimestamp( TS_MW
, $expires );
3325 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
3326 $hash = md5( $token );
3328 $this->mEmailToken
= $hash;
3329 $this->mEmailTokenExpires
= $expiration;
3334 * Return a URL the user can use to confirm their email address.
3335 * @param $token String Accepts the email confirmation token
3336 * @return String New token URL
3338 private function confirmationTokenUrl( $token ) {
3339 return $this->getTokenUrl( 'ConfirmEmail', $token );
3343 * Return a URL the user can use to invalidate their email address.
3344 * @param $token String Accepts the email confirmation token
3345 * @return String New token URL
3347 private function invalidationTokenUrl( $token ) {
3348 return $this->getTokenUrl( 'Invalidateemail', $token );
3352 * Internal function to format the e-mail validation/invalidation URLs.
3353 * This uses a quickie hack to use the
3354 * hardcoded English names of the Special: pages, for ASCII safety.
3356 * @note Since these URLs get dropped directly into emails, using the
3357 * short English names avoids insanely long URL-encoded links, which
3358 * also sometimes can get corrupted in some browsers/mailers
3359 * (bug 6957 with Gmail and Internet Explorer).
3361 * @param $page String Special page
3362 * @param $token String Token
3363 * @return String Formatted URL
3365 protected function getTokenUrl( $page, $token ) {
3366 // Hack to bypass localization of 'Special:'
3367 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3368 return $title->getCanonicalUrl();
3372 * Mark the e-mail address confirmed.
3374 * @note Call saveSettings() after calling this function to commit the change.
3378 public function confirmEmail() {
3379 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3380 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3385 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3386 * address if it was already confirmed.
3388 * @note Call saveSettings() after calling this function to commit the change.
3391 function invalidateEmail() {
3393 $this->mEmailToken
= null;
3394 $this->mEmailTokenExpires
= null;
3395 $this->setEmailAuthenticationTimestamp( null );
3396 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3401 * Set the e-mail authentication timestamp.
3402 * @param $timestamp String TS_MW timestamp
3404 function setEmailAuthenticationTimestamp( $timestamp ) {
3406 $this->mEmailAuthenticated
= $timestamp;
3407 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3411 * Is this user allowed to send e-mails within limits of current
3412 * site configuration?
3415 public function canSendEmail() {
3416 global $wgEnableEmail, $wgEnableUserEmail;
3417 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3420 $canSend = $this->isEmailConfirmed();
3421 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3426 * Is this user allowed to receive e-mails within limits of current
3427 * site configuration?
3430 public function canReceiveEmail() {
3431 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3435 * Is this user's e-mail address valid-looking and confirmed within
3436 * limits of the current site configuration?
3438 * @note If $wgEmailAuthentication is on, this may require the user to have
3439 * confirmed their address by returning a code or using a password
3440 * sent to the address from the wiki.
3444 public function isEmailConfirmed() {
3445 global $wgEmailAuthentication;
3448 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3449 if( $this->isAnon() ) {
3452 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3455 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3465 * Check whether there is an outstanding request for e-mail confirmation.
3468 public function isEmailConfirmationPending() {
3469 global $wgEmailAuthentication;
3470 return $wgEmailAuthentication &&
3471 !$this->isEmailConfirmed() &&
3472 $this->mEmailToken
&&
3473 $this->mEmailTokenExpires
> wfTimestamp();
3477 * Get the timestamp of account creation.
3479 * @return String|Bool Timestamp of account creation, or false for
3480 * non-existent/anonymous user accounts.
3482 public function getRegistration() {
3483 if ( $this->isAnon() ) {
3487 return $this->mRegistration
;
3491 * Get the timestamp of the first edit
3493 * @return String|Bool Timestamp of first edit, or false for
3494 * non-existent/anonymous user accounts.
3496 public function getFirstEditTimestamp() {
3497 if( $this->getId() == 0 ) {
3498 return false; // anons
3500 $dbr = wfGetDB( DB_SLAVE
);
3501 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3502 array( 'rev_user' => $this->getId() ),
3504 array( 'ORDER BY' => 'rev_timestamp ASC' )
3507 return false; // no edits
3509 return wfTimestamp( TS_MW
, $time );
3513 * Get the permissions associated with a given list of groups
3515 * @param $groups Array of Strings List of internal group names
3518 * @return Array of Strings List of permission key names for given groups combined
3520 public static function getGroupPermissions( array $groups, $ns = null ) {
3521 global $wgGroupPermissions, $wgRevokePermissions;
3524 // Grant every granted permission first
3525 foreach( $groups as $group ) {
3526 if( isset( $wgGroupPermissions[$group] ) ) {
3527 $rights = array_merge( $rights, self
::extractRights(
3528 $wgGroupPermissions[$group], $ns ) );
3532 // Revoke the revoked permissions
3533 foreach( $groups as $group ) {
3534 if( isset( $wgRevokePermissions[$group] ) ) {
3535 $rights = array_diff( $rights, self
::extractRights(
3536 $wgRevokePermissions[$group], $ns ) );
3539 return array_unique( $rights );
3543 * Helper for User::getGroupPermissions
3544 * @param $list array
3548 private static function extractRights( $list, $ns ) {
3550 foreach( $list as $right => $value ) {
3551 if ( is_array( $value ) ) {
3552 # This is a list of namespaces where the permission applies
3553 if ( !is_null( $ns ) && !empty( $value[$ns] ) ) {
3557 # This is a boolean indicating that the permission applies
3567 * Get all the groups who have a given permission
3569 * @param $role String Role to check
3573 * @return Array of Strings List of internal group names with the given permission
3575 public static function getGroupsWithPermission( $role, $ns = null ) {
3576 global $wgGroupPermissions;
3577 $allowedGroups = array();
3578 foreach ( $wgGroupPermissions as $group => $rights ) {
3579 if ( in_array( $role, self
::getGroupPermissions( array( $group ), $ns ), true ) ) {
3580 $allowedGroups[] = $group;
3583 return $allowedGroups;
3587 * Get the localized descriptive name for a group, if it exists
3589 * @param $group String Internal group name
3590 * @return String Localized descriptive group name
3592 public static function getGroupName( $group ) {
3593 $msg = wfMessage( "group-$group" );
3594 return $msg->isBlank() ?
$group : $msg->text();
3598 * Get the localized descriptive name for a member of a group, if it exists
3600 * @param $group String Internal group name
3601 * @param $username String Username for gender (since 1.19)
3602 * @return String Localized name for group member
3604 public static function getGroupMember( $group, $username = '#' ) {
3605 $msg = wfMessage( "group-$group-member", $username );
3606 return $msg->isBlank() ?
$group : $msg->text();
3610 * Return the set of defined explicit groups.
3611 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3612 * are not included, as they are defined automatically, not in the database.
3613 * @return Array of internal group names
3615 public static function getAllGroups() {
3616 global $wgGroupPermissions, $wgRevokePermissions;
3618 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3619 self
::getImplicitGroups()
3624 * Get a list of all available permissions.
3625 * @return Array of permission names
3627 public static function getAllRights() {
3628 if ( self
::$mAllRights === false ) {
3629 global $wgAvailableRights;
3630 if ( count( $wgAvailableRights ) ) {
3631 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3633 self
::$mAllRights = self
::$mCoreRights;
3635 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3637 return self
::$mAllRights;
3641 * Get a list of implicit groups
3642 * @return Array of Strings Array of internal group names
3644 public static function getImplicitGroups() {
3645 global $wgImplicitGroups;
3646 $groups = $wgImplicitGroups;
3647 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3652 * Get the title of a page describing a particular group
3654 * @param $group String Internal group name
3655 * @return Title|Bool Title of the page if it exists, false otherwise
3657 public static function getGroupPage( $group ) {
3658 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3659 if( $msg->exists() ) {
3660 $title = Title
::newFromText( $msg->text() );
3661 if( is_object( $title ) )
3668 * Create a link to the group in HTML, if available;
3669 * else return the group name.
3671 * @param $group String Internal name of the group
3672 * @param $text String The text of the link
3673 * @return String HTML link to the group
3675 public static function makeGroupLinkHTML( $group, $text = '' ) {
3677 $text = self
::getGroupName( $group );
3679 $title = self
::getGroupPage( $group );
3681 return Linker
::link( $title, htmlspecialchars( $text ) );
3688 * Create a link to the group in Wikitext, if available;
3689 * else return the group name.
3691 * @param $group String Internal name of the group
3692 * @param $text String The text of the link
3693 * @return String Wikilink to the group
3695 public static function makeGroupLinkWiki( $group, $text = '' ) {
3697 $text = self
::getGroupName( $group );
3699 $title = self
::getGroupPage( $group );
3701 $page = $title->getPrefixedText();
3702 return "[[$page|$text]]";
3709 * Returns an array of the groups that a particular group can add/remove.
3711 * @param $group String: the group to check for whether it can add/remove
3712 * @return Array array( 'add' => array( addablegroups ),
3713 * 'remove' => array( removablegroups ),
3714 * 'add-self' => array( addablegroups to self),
3715 * 'remove-self' => array( removable groups from self) )
3717 public static function changeableByGroup( $group ) {
3718 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3720 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3721 if( empty( $wgAddGroups[$group] ) ) {
3722 // Don't add anything to $groups
3723 } elseif( $wgAddGroups[$group] === true ) {
3724 // You get everything
3725 $groups['add'] = self
::getAllGroups();
3726 } elseif( is_array( $wgAddGroups[$group] ) ) {
3727 $groups['add'] = $wgAddGroups[$group];
3730 // Same thing for remove
3731 if( empty( $wgRemoveGroups[$group] ) ) {
3732 } elseif( $wgRemoveGroups[$group] === true ) {
3733 $groups['remove'] = self
::getAllGroups();
3734 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3735 $groups['remove'] = $wgRemoveGroups[$group];
3738 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3739 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3740 foreach( $wgGroupsAddToSelf as $key => $value ) {
3741 if( is_int( $key ) ) {
3742 $wgGroupsAddToSelf['user'][] = $value;
3747 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3748 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3749 if( is_int( $key ) ) {
3750 $wgGroupsRemoveFromSelf['user'][] = $value;
3755 // Now figure out what groups the user can add to him/herself
3756 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3757 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3758 // No idea WHY this would be used, but it's there
3759 $groups['add-self'] = User
::getAllGroups();
3760 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3761 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3764 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3765 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3766 $groups['remove-self'] = User
::getAllGroups();
3767 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3768 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3775 * Returns an array of groups that this user can add and remove
3776 * @return Array array( 'add' => array( addablegroups ),
3777 * 'remove' => array( removablegroups ),
3778 * 'add-self' => array( addablegroups to self),
3779 * 'remove-self' => array( removable groups from self) )
3781 public function changeableGroups() {
3782 if( $this->isAllowed( 'userrights' ) ) {
3783 // This group gives the right to modify everything (reverse-
3784 // compatibility with old "userrights lets you change
3786 // Using array_merge to make the groups reindexed
3787 $all = array_merge( User
::getAllGroups() );
3791 'add-self' => array(),
3792 'remove-self' => array()
3796 // Okay, it's not so simple, we will have to go through the arrays
3799 'remove' => array(),
3800 'add-self' => array(),
3801 'remove-self' => array()
3803 $addergroups = $this->getEffectiveGroups();
3805 foreach( $addergroups as $addergroup ) {
3806 $groups = array_merge_recursive(
3807 $groups, $this->changeableByGroup( $addergroup )
3809 $groups['add'] = array_unique( $groups['add'] );
3810 $groups['remove'] = array_unique( $groups['remove'] );
3811 $groups['add-self'] = array_unique( $groups['add-self'] );
3812 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3818 * Increment the user's edit-count field.
3819 * Will have no effect for anonymous users.
3821 public function incEditCount() {
3822 if( !$this->isAnon() ) {
3823 $dbw = wfGetDB( DB_MASTER
);
3824 $dbw->update( 'user',
3825 array( 'user_editcount=user_editcount+1' ),
3826 array( 'user_id' => $this->getId() ),
3829 // Lazy initialization check...
3830 if( $dbw->affectedRows() == 0 ) {
3831 // Pull from a slave to be less cruel to servers
3832 // Accuracy isn't the point anyway here
3833 $dbr = wfGetDB( DB_SLAVE
);
3834 $count = $dbr->selectField( 'revision',
3836 array( 'rev_user' => $this->getId() ),
3839 // Now here's a goddamn hack...
3840 if( $dbr !== $dbw ) {
3841 // If we actually have a slave server, the count is
3842 // at least one behind because the current transaction
3843 // has not been committed and replicated.
3846 // But if DB_SLAVE is selecting the master, then the
3847 // count we just read includes the revision that was
3848 // just added in the working transaction.
3851 $dbw->update( 'user',
3852 array( 'user_editcount' => $count ),
3853 array( 'user_id' => $this->getId() ),
3857 // edit count in user cache too
3858 $this->invalidateCache();
3862 * Get the description of a given right
3864 * @param $right String Right to query
3865 * @return String Localized description of the right
3867 public static function getRightDescription( $right ) {
3868 $key = "right-$right";
3869 $msg = wfMessage( $key );
3870 return $msg->isBlank() ?
$right : $msg->text();
3874 * Make an old-style password hash
3876 * @param $password String Plain-text password
3877 * @param $userId String User ID
3878 * @return String Password hash
3880 public static function oldCrypt( $password, $userId ) {
3881 global $wgPasswordSalt;
3882 if ( $wgPasswordSalt ) {
3883 return md5( $userId . '-' . md5( $password ) );
3885 return md5( $password );
3890 * Make a new-style password hash
3892 * @param $password String Plain-text password
3893 * @param bool|string $salt Optional salt, may be random or the user ID.
3895 * If unspecified or false, will generate one automatically
3896 * @return String Password hash
3898 public static function crypt( $password, $salt = false ) {
3899 global $wgPasswordSalt;
3902 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3906 if( $wgPasswordSalt ) {
3907 if ( $salt === false ) {
3908 $salt = substr( wfGenerateToken(), 0, 8 );
3910 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3912 return ':A:' . md5( $password );
3917 * Compare a password hash with a plain-text password. Requires the user
3918 * ID if there's a chance that the hash is an old-style hash.
3920 * @param $hash String Password hash
3921 * @param $password String Plain-text password to compare
3922 * @param $userId String|bool User ID for old-style password salt
3926 public static function comparePasswords( $hash, $password, $userId = false ) {
3927 $type = substr( $hash, 0, 3 );
3930 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3934 if ( $type == ':A:' ) {
3936 return md5( $password ) === substr( $hash, 3 );
3937 } elseif ( $type == ':B:' ) {
3939 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3940 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3943 return self
::oldCrypt( $password, $userId ) === $hash;
3948 * Add a newuser log entry for this user
3950 * @param $byEmail Boolean: account made by email?
3951 * @param $reason String: user supplied reason
3953 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
3955 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3956 global $wgUser, $wgContLang, $wgNewUserLog;
3957 if( empty( $wgNewUserLog ) ) {
3958 return true; // disabled
3961 if( $this->getName() == $wgUser->getName() ) {
3964 $action = 'create2';
3966 if ( $reason === '' ) {
3967 $reason = wfMsgForContent( 'newuserlog-byemail' );
3969 $reason = $wgContLang->commaList( array(
3970 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3974 $log = new LogPage( 'newusers' );
3975 return (int)$log->addEntry(
3977 $this->getUserPage(),
3979 array( $this->getId() )
3984 * Add an autocreate newuser log entry for this user
3985 * Used by things like CentralAuth and perhaps other authplugins.
3989 public function addNewUserLogEntryAutoCreate() {
3990 global $wgNewUserLog;
3991 if( !$wgNewUserLog ) {
3992 return true; // disabled
3994 $log = new LogPage( 'newusers', false );
3995 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
4002 protected function loadOptions() {
4004 if ( $this->mOptionsLoaded ||
!$this->getId() )
4007 $this->mOptions
= self
::getDefaultOptions();
4009 // Maybe load from the object
4010 if ( !is_null( $this->mOptionOverrides
) ) {
4011 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4012 foreach( $this->mOptionOverrides
as $key => $value ) {
4013 $this->mOptions
[$key] = $value;
4016 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4017 // Load from database
4018 $dbr = wfGetDB( DB_SLAVE
);
4020 $res = $dbr->select(
4023 array( 'up_user' => $this->getId() ),
4027 foreach ( $res as $row ) {
4028 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4029 $this->mOptions
[$row->up_property
] = $row->up_value
;
4033 $this->mOptionsLoaded
= true;
4035 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4041 protected function saveOptions() {
4042 global $wgAllowPrefChange;
4044 $extuser = ExternalUser
::newFromUser( $this );
4046 $this->loadOptions();
4047 $dbw = wfGetDB( DB_MASTER
);
4049 $insert_rows = array();
4051 $saveOptions = $this->mOptions
;
4053 // Allow hooks to abort, for instance to save to a global profile.
4054 // Reset options to default state before saving.
4055 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4059 foreach( $saveOptions as $key => $value ) {
4060 # Don't bother storing default values
4061 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
4062 !( $value === false ||
is_null($value) ) ) ||
4063 $value != self
::getDefaultOption( $key ) ) {
4064 $insert_rows[] = array(
4065 'up_user' => $this->getId(),
4066 'up_property' => $key,
4067 'up_value' => $value,
4070 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4071 switch ( $wgAllowPrefChange[$key] ) {
4077 $extuser->setPref( $key, $value );
4083 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
4084 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4089 * Provide an array of HTML5 attributes to put on an input element
4090 * intended for the user to enter a new password. This may include
4091 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4093 * Do *not* use this when asking the user to enter his current password!
4094 * Regardless of configuration, users may have invalid passwords for whatever
4095 * reason (e.g., they were set before requirements were tightened up).
4096 * Only use it when asking for a new password, like on account creation or
4099 * Obviously, you still need to do server-side checking.
4101 * NOTE: A combination of bugs in various browsers means that this function
4102 * actually just returns array() unconditionally at the moment. May as
4103 * well keep it around for when the browser bugs get fixed, though.
4105 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4107 * @return array Array of HTML attributes suitable for feeding to
4108 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4109 * That will potentially output invalid XHTML 1.0 Transitional, and will
4110 * get confused by the boolean attribute syntax used.)
4112 public static function passwordChangeInputAttribs() {
4113 global $wgMinimalPasswordLength;
4115 if ( $wgMinimalPasswordLength == 0 ) {
4119 # Note that the pattern requirement will always be satisfied if the
4120 # input is empty, so we need required in all cases.
4122 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4123 # if e-mail confirmation is being used. Since HTML5 input validation
4124 # is b0rked anyway in some browsers, just return nothing. When it's
4125 # re-enabled, fix this code to not output required for e-mail
4127 #$ret = array( 'required' );
4130 # We can't actually do this right now, because Opera 9.6 will print out
4131 # the entered password visibly in its error message! When other
4132 # browsers add support for this attribute, or Opera fixes its support,
4133 # we can add support with a version check to avoid doing this on Opera
4134 # versions where it will be a problem. Reported to Opera as
4135 # DSK-262266, but they don't have a public bug tracker for us to follow.
4137 if ( $wgMinimalPasswordLength > 1 ) {
4138 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4139 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4140 $wgMinimalPasswordLength );