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',
158 'userrights-interwiki',
162 * String Cached results of getAllRights()
164 static $mAllRights = false;
166 /** @name Cache variables */
168 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
169 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
170 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides,
171 $mCookiePassword, $mEditCount, $mAllowUsertalk;
175 * Bool Whether the cache variables have been loaded.
181 * Array with already loaded items or true if all items have been loaded.
183 private $mLoadedItems = array();
187 * String Initialization data source if mLoadedItems!==true. May be one of:
188 * - 'defaults' anonymous user initialised from class defaults
189 * - 'name' initialise from mName
190 * - 'id' initialise from mId
191 * - 'session' log in from cookies or session if possible
193 * Use the User::newFrom*() family of functions to set this.
198 * Lazy-initialized variables, invalidated with clearInstanceCache
200 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
201 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
202 $mLocked, $mHideName, $mOptions, $mDisplayName;
217 private $mBlockedFromCreateAccount = false;
219 static $idCacheByName = array();
222 * Lightweight constructor for an anonymous user.
223 * Use the User::newFrom* factory functions for other kinds of users.
227 * @see newFromConfirmationCode()
228 * @see newFromSession()
231 function __construct() {
232 $this->clearInstanceCache( 'defaults' );
238 function __toString(){
239 return $this->getName();
243 * Load the user table data for this object from the source given by mFrom.
245 public function load() {
246 if ( $this->mLoadedItems
=== true ) {
249 wfProfileIn( __METHOD__
);
251 # Set it now to avoid infinite recursion in accessors
252 $this->mLoadedItems
= true;
254 switch ( $this->mFrom
) {
256 $this->loadDefaults();
259 $this->mId
= self
::idFromName( $this->mName
);
261 # Nonexistent user placeholder object
262 $this->loadDefaults( $this->mName
);
271 $this->loadFromSession();
272 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
275 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
277 wfProfileOut( __METHOD__
);
281 * Load user table data, given mId has already been set.
282 * @return Bool false if the ID does not exist, true otherwise
284 public function loadFromId() {
286 if ( $this->mId
== 0 ) {
287 $this->loadDefaults();
292 $key = wfMemcKey( 'user', 'id', $this->mId
);
293 $data = $wgMemc->get( $key );
294 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
295 # Object is expired, load from DB
300 wfDebug( "User: cache miss for user {$this->mId}\n" );
302 if ( !$this->loadFromDatabase() ) {
303 # Can't load from ID, user is anonymous
306 $this->saveToCache();
308 wfDebug( "User: got user {$this->mId} from cache\n" );
310 foreach ( self
::$mCacheVars as $name ) {
311 $this->$name = $data[$name];
318 * Save user data to the shared cache
320 public function saveToCache() {
323 $this->loadOptions();
324 if ( $this->isAnon() ) {
325 // Anonymous users are uncached
329 foreach ( self
::$mCacheVars as $name ) {
330 $data[$name] = $this->$name;
332 $data['mVersion'] = MW_USER_VERSION
;
333 $key = wfMemcKey( 'user', 'id', $this->mId
);
335 $wgMemc->set( $key, $data );
338 /** @name newFrom*() static factory methods */
342 * Static factory method for creation from username.
344 * This is slightly less efficient than newFromId(), so use newFromId() if
345 * you have both an ID and a name handy.
347 * @param $name String Username, validated by Title::newFromText()
348 * @param $validate String|Bool Validate username. Takes the same parameters as
349 * User::getCanonicalName(), except that true is accepted as an alias
350 * for 'valid', for BC.
352 * @return User object, or false if the username is invalid
353 * (e.g. if it contains illegal characters or is an IP address). If the
354 * username is not present in the database, the result will be a user object
355 * with a name, zero user ID and default settings.
357 public static function newFromName( $name, $validate = 'valid' ) {
358 if ( $validate === true ) {
361 $name = self
::getCanonicalName( $name, $validate );
362 if ( $name === false ) {
365 # Create unloaded user object
369 $u->setItemLoaded( 'name' );
375 * Static factory method for creation from a given user ID.
377 * @param $id Int Valid user ID
378 * @return User The corresponding User object
380 public static function newFromId( $id ) {
384 $u->setItemLoaded( 'id' );
389 * Factory method to fetch whichever user has a given email confirmation code.
390 * This code is generated when an account is created or its e-mail address
393 * If the code is invalid or has expired, returns NULL.
395 * @param $code String Confirmation code
398 public static function newFromConfirmationCode( $code ) {
399 $dbr = wfGetDB( DB_SLAVE
);
400 $id = $dbr->selectField( 'user', 'user_id', array(
401 'user_email_token' => md5( $code ),
402 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
404 if( $id !== false ) {
405 return User
::newFromId( $id );
412 * Create a new user object using data from session or cookies. If the
413 * login credentials are invalid, the result is an anonymous user.
415 * @param $request WebRequest object to use; $wgRequest will be used if
419 public static function newFromSession( WebRequest
$request = null ) {
421 $user->mFrom
= 'session';
422 $user->mRequest
= $request;
427 * Create a new user object from a user row.
428 * The row should have the following fields from the user table in it:
429 * - either user_name or user_id to load further data if needed (or both)
431 * - all other fields (email, password, etc.)
432 * It is useless to provide the remaining fields if either user_id,
433 * user_name and user_real_name are not provided because the whole row
434 * will be loaded once more from the database when accessing them.
436 * @param $row Array A row from the user table
439 public static function newFromRow( $row ) {
441 $user->loadFromRow( $row );
448 * Get the username corresponding to a given user ID
449 * @param $id Int User ID
450 * @return String|false The corresponding username
452 public static function whoIs( $id ) {
453 $dbr = wfGetDB( DB_SLAVE
);
454 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
458 * Get the real name of a user given their user ID
460 * @param $id Int User ID
461 * @return String|false The corresponding user's real name
463 public static function whoIsReal( $id ) {
464 $dbr = wfGetDB( DB_SLAVE
);
465 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
469 * Get database id given a user name
470 * @param $name String Username
471 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
473 public static function idFromName( $name ) {
474 $nt = Title
::makeTitleSafe( NS_USER
, $name );
475 if( is_null( $nt ) ) {
480 if ( isset( self
::$idCacheByName[$name] ) ) {
481 return self
::$idCacheByName[$name];
484 $dbr = wfGetDB( DB_SLAVE
);
485 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
487 if ( $s === false ) {
490 $result = $s->user_id
;
493 self
::$idCacheByName[$name] = $result;
495 if ( count( self
::$idCacheByName ) > 1000 ) {
496 self
::$idCacheByName = array();
503 * Reset the cache used in idFromName(). For use in tests.
505 public static function resetIdByNameCache() {
506 self
::$idCacheByName = array();
510 * Does the string match an anonymous IPv4 address?
512 * This function exists for username validation, in order to reject
513 * usernames which are similar in form to IP addresses. Strings such
514 * as 300.300.300.300 will return true because it looks like an IP
515 * address, despite not being strictly valid.
517 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
518 * address because the usemod software would "cloak" anonymous IP
519 * addresses like this, if we allowed accounts like this to be created
520 * new users could get the old edits of these anonymous users.
522 * @param $name String to match
525 public static function isIP( $name ) {
526 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
530 * Is the input a valid username?
532 * Checks if the input is a valid username, we don't want an empty string,
533 * an IP address, anything that containins slashes (would mess up subpages),
534 * is longer than the maximum allowed username size or doesn't begin with
537 * @param $name String to match
540 public static function isValidUserName( $name ) {
541 global $wgContLang, $wgMaxNameChars;
544 || User
::isIP( $name )
545 ||
strpos( $name, '/' ) !== false
546 ||
strlen( $name ) > $wgMaxNameChars
547 ||
$name != $wgContLang->ucfirst( $name ) ) {
548 wfDebugLog( 'username', __METHOD__
.
549 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
553 // Ensure that the name can't be misresolved as a different title,
554 // such as with extra namespace keys at the start.
555 $parsed = Title
::newFromText( $name );
556 if( is_null( $parsed )
557 ||
$parsed->getNamespace()
558 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
559 wfDebugLog( 'username', __METHOD__
.
560 ": '$name' invalid due to ambiguous prefixes" );
564 // Check an additional blacklist of troublemaker characters.
565 // Should these be merged into the title char list?
566 $unicodeBlacklist = '/[' .
567 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
568 '\x{00a0}' . # non-breaking space
569 '\x{2000}-\x{200f}' . # various whitespace
570 '\x{2028}-\x{202f}' . # breaks and control chars
571 '\x{3000}' . # ideographic space
572 '\x{e000}-\x{f8ff}' . # private use
574 if( preg_match( $unicodeBlacklist, $name ) ) {
575 wfDebugLog( 'username', __METHOD__
.
576 ": '$name' invalid due to blacklisted characters" );
584 * Usernames which fail to pass this function will be blocked
585 * from user login and new account registrations, but may be used
586 * internally by batch processes.
588 * If an account already exists in this form, login will be blocked
589 * by a failure to pass this function.
591 * @param $name String to match
594 public static function isUsableName( $name ) {
595 global $wgReservedUsernames;
596 // Must be a valid username, obviously ;)
597 if ( !self
::isValidUserName( $name ) ) {
601 static $reservedUsernames = false;
602 if ( !$reservedUsernames ) {
603 $reservedUsernames = $wgReservedUsernames;
604 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
607 // Certain names may be reserved for batch processes.
608 foreach ( $reservedUsernames as $reserved ) {
609 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
610 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
612 if ( $reserved == $name ) {
620 * Usernames which fail to pass this function will be blocked
621 * from new account registrations, but may be used internally
622 * either by batch processes or by user accounts which have
623 * already been created.
625 * Additional blacklisting may be added here rather than in
626 * isValidUserName() to avoid disrupting existing accounts.
628 * @param $name String to match
631 public static function isCreatableName( $name ) {
632 global $wgInvalidUsernameCharacters;
634 // Ensure that the username isn't longer than 235 bytes, so that
635 // (at least for the builtin skins) user javascript and css files
636 // will work. (bug 23080)
637 if( strlen( $name ) > 235 ) {
638 wfDebugLog( 'username', __METHOD__
.
639 ": '$name' invalid due to length" );
643 // Preg yells if you try to give it an empty string
644 if( $wgInvalidUsernameCharacters !== '' ) {
645 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
646 wfDebugLog( 'username', __METHOD__
.
647 ": '$name' invalid due to wgInvalidUsernameCharacters" );
652 return self
::isUsableName( $name );
656 * Is the input a valid password for this user?
658 * @param $password String Desired password
661 public function isValidPassword( $password ) {
662 //simple boolean wrapper for getPasswordValidity
663 return $this->getPasswordValidity( $password ) === true;
667 * Given unvalidated password input, return error message on failure.
669 * @param $password String Desired password
670 * @return mixed: true on success, string or array of error message on failure
672 public function getPasswordValidity( $password ) {
673 global $wgMinimalPasswordLength, $wgContLang;
675 static $blockedLogins = array(
676 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
677 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
680 $result = false; //init $result to false for the internal checks
682 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
685 if ( $result === false ) {
686 if( strlen( $password ) < $wgMinimalPasswordLength ) {
687 return 'passwordtooshort';
688 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
689 return 'password-name-match';
690 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
691 return 'password-login-forbidden';
693 //it seems weird returning true here, but this is because of the
694 //initialization of $result to false above. If the hook is never run or it
695 //doesn't modify $result, then we will likely get down into this if with
699 } elseif( $result === true ) {
702 return $result; //the isValidPassword hook set a string $result and returned true
707 * Does a string look like an e-mail address?
709 * This validates an email address using an HTML5 specification found at:
710 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
711 * Which as of 2011-01-24 says:
713 * A valid e-mail address is a string that matches the ABNF production
714 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
715 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
718 * This function is an implementation of the specification as requested in
721 * Client-side forms will use the same standard validation rules via JS or
722 * HTML 5 validation; additional restrictions can be enforced server-side
723 * by extensions via the 'isValidEmailAddr' hook.
725 * Note that this validation doesn't 100% match RFC 2822, but is believed
726 * to be liberal enough for wide use. Some invalid addresses will still
727 * pass validation here.
729 * @param $addr String E-mail address
731 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
733 public static function isValidEmailAddr( $addr ) {
734 return Sanitizer
::validateEmail( $addr );
738 * Given unvalidated user input, return a canonical username, or false if
739 * the username is invalid.
740 * @param $name String User input
741 * @param $validate String|Bool type of validation to use:
742 * - false No validation
743 * - 'valid' Valid for batch processes
744 * - 'usable' Valid for batch processes and login
745 * - 'creatable' Valid for batch processes, login and account creation
747 * @return bool|string
749 public static function getCanonicalName( $name, $validate = 'valid' ) {
750 # Force usernames to capital
752 $name = $wgContLang->ucfirst( $name );
754 # Reject names containing '#'; these will be cleaned up
755 # with title normalisation, but then it's too late to
757 if( strpos( $name, '#' ) !== false )
760 # Clean up name according to title rules
761 $t = ( $validate === 'valid' ) ?
762 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
763 # Check for invalid titles
764 if( is_null( $t ) ) {
768 # Reject various classes of invalid names
770 $name = $wgAuth->getCanonicalName( $t->getText() );
772 switch ( $validate ) {
776 if ( !User
::isValidUserName( $name ) ) {
781 if ( !User
::isUsableName( $name ) ) {
786 if ( !User
::isCreatableName( $name ) ) {
791 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
797 * Count the number of edits of a user
798 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
800 * @param $uid Int User ID to check
801 * @return Int the user's edit count
803 public static function edits( $uid ) {
804 wfProfileIn( __METHOD__
);
805 $dbr = wfGetDB( DB_SLAVE
);
806 // check if the user_editcount field has been initialized
807 $field = $dbr->selectField(
808 'user', 'user_editcount',
809 array( 'user_id' => $uid ),
813 if( $field === null ) { // it has not been initialized. do so.
814 $dbw = wfGetDB( DB_MASTER
);
815 $count = $dbr->selectField(
816 'revision', 'count(*)',
817 array( 'rev_user' => $uid ),
822 array( 'user_editcount' => $count ),
823 array( 'user_id' => $uid ),
829 wfProfileOut( __METHOD__
);
834 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
835 * @todo hash random numbers to improve security, like generateToken()
837 * @return String new random password
839 public static function randomPassword() {
840 global $wgMinimalPasswordLength;
841 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
842 $l = strlen( $pwchars ) - 1;
844 $pwlength = max( 7, $wgMinimalPasswordLength );
845 $digit = mt_rand( 0, $pwlength - 1 );
847 for ( $i = 0; $i < $pwlength; $i++
) {
848 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars[ mt_rand( 0, $l ) ];
854 * Set cached properties to default.
856 * @note This no longer clears uncached lazy-initialised properties;
857 * the constructor does that instead.
859 * @param $name string
861 public function loadDefaults( $name = false ) {
862 wfProfileIn( __METHOD__
);
865 $this->mName
= $name;
866 $this->mRealName
= '';
867 $this->mPassword
= $this->mNewpassword
= '';
868 $this->mNewpassTime
= null;
870 $this->mOptionOverrides
= null;
871 $this->mOptionsLoaded
= false;
873 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
874 if( $loggedOut !== null ) {
875 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
877 $this->mTouched
= '0'; # Allow any pages to be cached
880 $this->setToken(); # Random
881 $this->mEmailAuthenticated
= null;
882 $this->mEmailToken
= '';
883 $this->mEmailTokenExpires
= null;
884 $this->mRegistration
= wfTimestamp( TS_MW
);
885 $this->mGroups
= array();
887 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
889 wfProfileOut( __METHOD__
);
893 * Return whether an item has been loaded.
895 * @param $item String: item to check. Current possibilities:
899 * @param $all String: 'all' to check if the whole object has been loaded
900 * or any other string to check if only the item is available (e.g.
904 public function isItemLoaded( $item, $all = 'all' ) {
905 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
906 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
910 * Set that an item has been loaded
912 * @param $item String
914 private function setItemLoaded( $item ) {
915 if ( is_array( $this->mLoadedItems
) ) {
916 $this->mLoadedItems
[$item] = true;
921 * Load user data from the session or login cookie. If there are no valid
922 * credentials, initialises the user as an anonymous user.
923 * @return Bool True if the user is logged in, false otherwise.
925 private function loadFromSession() {
926 global $wgExternalAuthType, $wgAutocreatePolicy;
929 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
930 if ( $result !== null ) {
934 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
935 $extUser = ExternalUser
::newFromCookie();
937 # TODO: Automatically create the user here (or probably a bit
938 # lower down, in fact)
942 $request = $this->getRequest();
944 $cookieId = $request->getCookie( 'UserID' );
945 $sessId = $request->getSessionData( 'wsUserID' );
947 if ( $cookieId !== null ) {
948 $sId = intval( $cookieId );
949 if( $sessId !== null && $cookieId != $sessId ) {
950 $this->loadDefaults(); // Possible collision!
951 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
952 cookie user ID ($sId) don't match!" );
955 $request->setSessionData( 'wsUserID', $sId );
956 } elseif ( $sessId !== null && $sessId != 0 ) {
959 $this->loadDefaults();
963 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
964 $sName = $request->getSessionData( 'wsUserName' );
965 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
966 $sName = $request->getCookie( 'UserName' );
967 $request->setSessionData( 'wsUserName', $sName );
969 $this->loadDefaults();
973 $proposedUser = User
::newFromId( $sId );
974 if ( !$proposedUser->isLoggedIn() ) {
976 $this->loadDefaults();
980 global $wgBlockDisablesLogin;
981 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
982 # User blocked and we've disabled blocked user logins
983 $this->loadDefaults();
987 if ( $request->getSessionData( 'wsToken' ) !== null ) {
988 $passwordCorrect = $proposedUser->getToken() === $request->getSessionData( 'wsToken' );
990 } elseif ( $request->getCookie( 'Token' ) !== null ) {
991 $passwordCorrect = $proposedUser->getToken() === $request->getCookie( 'Token' );
994 # No session or persistent login cookie
995 $this->loadDefaults();
999 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
1000 $this->loadFromUserObject( $proposedUser );
1001 $request->setSessionData( 'wsToken', $this->mToken
);
1002 wfDebug( "User: logged in from $from\n" );
1005 # Invalid credentials
1006 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1007 $this->loadDefaults();
1013 * Load user and user_group data from the database.
1014 * $this->mId must be set, this is how the user is identified.
1016 * @return Bool True if the user exists, false if the user is anonymous
1018 public function loadFromDatabase() {
1020 $this->mId
= intval( $this->mId
);
1022 /** Anonymous user */
1024 $this->loadDefaults();
1028 $dbr = wfGetDB( DB_MASTER
);
1029 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
1031 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1033 if ( $s !== false ) {
1034 # Initialise user table data
1035 $this->loadFromRow( $s );
1036 $this->mGroups
= null; // deferred
1037 $this->getEditCount(); // revalidation for nulls
1042 $this->loadDefaults();
1048 * Initialize this object from a row from the user table.
1050 * @param $row Array Row from the user table to load.
1052 public function loadFromRow( $row ) {
1055 $this->mGroups
= null; // deferred
1057 if ( isset( $row->user_name
) ) {
1058 $this->mName
= $row->user_name
;
1059 $this->mFrom
= 'name';
1060 $this->setItemLoaded( 'name' );
1065 if ( isset( $row->user_real_name
) ) {
1066 $this->mRealName
= $row->user_real_name
;
1067 $this->setItemLoaded( 'realname' );
1072 if ( isset( $row->user_id
) ) {
1073 $this->mId
= intval( $row->user_id
);
1074 $this->mFrom
= 'id';
1075 $this->setItemLoaded( 'id' );
1080 if ( isset( $row->user_editcount
) ) {
1081 $this->mEditCount
= $row->user_editcount
;
1086 if ( isset( $row->user_password
) ) {
1087 $this->mPassword
= $row->user_password
;
1088 $this->mNewpassword
= $row->user_newpassword
;
1089 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1090 $this->mEmail
= $row->user_email
;
1091 if ( isset( $row->user_options
) ) {
1092 $this->decodeOptions( $row->user_options
);
1094 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1095 $this->mToken
= $row->user_token
;
1096 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1097 $this->mEmailToken
= $row->user_email_token
;
1098 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1099 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1105 $this->mLoadedItems
= true;
1110 * Load the data for this user object from another user object.
1114 protected function loadFromUserObject( $user ) {
1116 $user->loadGroups();
1117 $user->loadOptions();
1118 foreach ( self
::$mCacheVars as $var ) {
1119 $this->$var = $user->$var;
1124 * Load the groups from the database if they aren't already loaded.
1126 private function loadGroups() {
1127 if ( is_null( $this->mGroups
) ) {
1128 $dbr = wfGetDB( DB_MASTER
);
1129 $res = $dbr->select( 'user_groups',
1130 array( 'ug_group' ),
1131 array( 'ug_user' => $this->mId
),
1133 $this->mGroups
= array();
1134 foreach ( $res as $row ) {
1135 $this->mGroups
[] = $row->ug_group
;
1141 * Add the user to the group if he/she meets given criteria.
1143 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1144 * possible to remove manually via Special:UserRights. In such case it
1145 * will not be re-added automatically. The user will also not lose the
1146 * group if they no longer meet the criteria.
1148 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1150 * @return array Array of groups the user has been promoted to.
1152 * @see $wgAutopromoteOnce
1154 public function addAutopromoteOnceGroups( $event ) {
1155 global $wgAutopromoteOnceLogInRC;
1157 $toPromote = array();
1158 if ( $this->getId() ) {
1159 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1160 if ( count( $toPromote ) ) {
1161 $oldGroups = $this->getGroups(); // previous groups
1162 foreach ( $toPromote as $group ) {
1163 $this->addGroup( $group );
1165 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1167 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1168 $log->addEntry( 'autopromote',
1169 $this->getUserPage(),
1171 // These group names are "list to texted"-ed in class LogPage.
1172 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1180 * Clear various cached data stored in this object.
1181 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1182 * given source. May be "name", "id", "defaults", "session", or false for
1185 public function clearInstanceCache( $reloadFrom = false ) {
1186 $this->mNewtalk
= -1;
1187 $this->mDatePreference
= null;
1188 $this->mBlockedby
= -1; # Unset
1189 $this->mHash
= false;
1190 $this->mRights
= null;
1191 $this->mEffectiveGroups
= null;
1192 $this->mImplicitGroups
= null;
1193 $this->mOptions
= null;
1194 $this->mDisplayName
= 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;
1211 $defOpt = $wgDefaultUserOptions;
1212 # default language setting
1213 $variant = $wgContLang->getDefaultVariant();
1214 $defOpt['variant'] = $variant;
1215 $defOpt['language'] = $variant;
1216 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1217 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1219 $defOpt['skin'] = $wgDefaultSkin;
1221 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1222 // but that breaks the parser tests because they rely on being able to change $wgContLang
1223 // mid-request and see that change reflected in the return value of this function.
1224 // Which is insane and would never happen during normal MW operation, but is also not
1225 // likely to get fixed unless and until we context-ify everything.
1226 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1227 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1233 * Get a given default option value.
1235 * @param $opt String Name of option to retrieve
1236 * @return String Default option value
1238 public static function getDefaultOption( $opt ) {
1239 $defOpts = self
::getDefaultOptions();
1240 if( isset( $defOpts[$opt] ) ) {
1241 return $defOpts[$opt];
1249 * Get blocking information
1250 * @param $bFromSlave Bool Whether to check the slave database first. To
1251 * improve performance, non-critical checks are done
1252 * against slaves. Check when actually saving should be
1253 * done against master.
1255 private function getBlockedStatus( $bFromSlave = true ) {
1256 global $wgProxyWhitelist, $wgUser;
1258 if ( -1 != $this->mBlockedby
) {
1262 wfProfileIn( __METHOD__
);
1263 wfDebug( __METHOD__
.": checking...\n" );
1265 // Initialize data...
1266 // Otherwise something ends up stomping on $this->mBlockedby when
1267 // things get lazy-loaded later, causing false positive block hits
1268 // due to -1 !== 0. Probably session-related... Nothing should be
1269 // overwriting mBlockedby, surely?
1272 $this->mBlockedby
= 0;
1273 $this->mHideName
= 0;
1274 $this->mAllowUsertalk
= 0;
1276 # We only need to worry about passing the IP address to the Block generator if the
1277 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1278 # know which IP address they're actually coming from
1279 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1280 $ip = $this->getRequest()->getIP();
1286 $this->mBlock
= Block
::newFromTarget( $this->getName(), $ip, !$bFromSlave );
1287 if ( $this->mBlock
instanceof Block
) {
1288 wfDebug( __METHOD__
. ": Found block.\n" );
1289 $this->mBlockedby
= $this->mBlock
->getByName();
1290 $this->mBlockreason
= $this->mBlock
->mReason
;
1291 $this->mHideName
= $this->mBlock
->mHideName
;
1292 $this->mAllowUsertalk
= !$this->mBlock
->prevents( 'editownusertalk' );
1296 if ( $ip !== null && !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1298 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1299 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1300 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1304 if ( !$this->mBlockedby
&& !$this->getID() ) {
1305 if ( $this->isDnsBlacklisted( $ip ) ) {
1306 $this->mBlockedby
= wfMsg( 'sorbs' );
1307 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1313 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1315 wfProfileOut( __METHOD__
);
1319 * Whether the given IP is in a DNS blacklist.
1321 * @param $ip String IP to check
1322 * @param $checkWhitelist Bool: whether to check the whitelist first
1323 * @return Bool True if blacklisted.
1325 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1326 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1327 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1329 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1332 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1335 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1336 return $this->inDnsBlacklist( $ip, $urls );
1340 * Whether the given IP is in a given DNS blacklist.
1342 * @param $ip String IP to check
1343 * @param $bases String|Array of Strings: URL of the DNS blacklist
1344 * @return Bool True if blacklisted.
1346 public function inDnsBlacklist( $ip, $bases ) {
1347 wfProfileIn( __METHOD__
);
1350 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1351 if( IP
::isIPv4( $ip ) ) {
1352 # Reverse IP, bug 21255
1353 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1355 foreach( (array)$bases as $base ) {
1357 # If we have an access key, use that too (ProjectHoneypot, etc.)
1358 if( is_array( $base ) ) {
1359 if( count( $base ) >= 2 ) {
1360 # Access key is 1, base URL is 0
1361 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1363 $host = "$ipReversed.{$base[0]}";
1366 $host = "$ipReversed.$base";
1370 $ipList = gethostbynamel( $host );
1373 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1377 wfDebug( "Requested $host, not found in $base.\n" );
1382 wfProfileOut( __METHOD__
);
1387 * Check if an IP address is in the local proxy list
1393 public static function isLocallyBlockedProxy( $ip ) {
1394 global $wgProxyList;
1396 if ( !$wgProxyList ) {
1399 wfProfileIn( __METHOD__
);
1401 if ( !is_array( $wgProxyList ) ) {
1402 # Load from the specified file
1403 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1406 if ( !is_array( $wgProxyList ) ) {
1408 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1410 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1411 # Old-style flipped proxy list
1416 wfProfileOut( __METHOD__
);
1421 * Is this user subject to rate limiting?
1423 * @return Bool True if rate limited
1425 public function isPingLimitable() {
1426 global $wgRateLimitsExcludedIPs;
1427 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1428 // No other good way currently to disable rate limits
1429 // for specific IPs. :P
1430 // But this is a crappy hack and should die.
1433 return !$this->isAllowed('noratelimit');
1437 * Primitive rate limits: enforce maximum actions per time period
1438 * to put a brake on flooding.
1440 * @note When using a shared cache like memcached, IP-address
1441 * last-hit counters will be shared across wikis.
1443 * @param $action String Action to enforce; 'edit' if unspecified
1444 * @return Bool True if a rate limiter was tripped
1446 public function pingLimiter( $action = 'edit' ) {
1447 # Call the 'PingLimiter' hook
1449 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1453 global $wgRateLimits;
1454 if( !isset( $wgRateLimits[$action] ) ) {
1458 # Some groups shouldn't trigger the ping limiter, ever
1459 if( !$this->isPingLimitable() )
1462 global $wgMemc, $wgRateLimitLog;
1463 wfProfileIn( __METHOD__
);
1465 $limits = $wgRateLimits[$action];
1467 $id = $this->getId();
1468 $ip = $this->getRequest()->getIP();
1471 if( isset( $limits['anon'] ) && $id == 0 ) {
1472 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1475 if( isset( $limits['user'] ) && $id != 0 ) {
1476 $userLimit = $limits['user'];
1478 if( $this->isNewbie() ) {
1479 if( isset( $limits['newbie'] ) && $id != 0 ) {
1480 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1482 if( isset( $limits['ip'] ) ) {
1483 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1486 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1487 $subnet = $matches[1];
1488 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1491 // Check for group-specific permissions
1492 // If more than one group applies, use the group with the highest limit
1493 foreach ( $this->getGroups() as $group ) {
1494 if ( isset( $limits[$group] ) ) {
1495 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1496 $userLimit = $limits[$group];
1500 // Set the user limit key
1501 if ( $userLimit !== false ) {
1502 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1503 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1507 foreach( $keys as $key => $limit ) {
1508 list( $max, $period ) = $limit;
1509 $summary = "(limit $max in {$period}s)";
1510 $count = $wgMemc->get( $key );
1513 if( $count > $max ) {
1514 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1515 if( $wgRateLimitLog ) {
1516 wfSuppressWarnings();
1517 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1518 wfRestoreWarnings();
1522 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1525 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1526 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1528 $wgMemc->incr( $key );
1531 wfProfileOut( __METHOD__
);
1536 * Check if user is blocked
1538 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1539 * @return Bool True if blocked, false otherwise
1541 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1542 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1546 * Get the block affecting the user, or null if the user is not blocked
1548 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1549 * @return Block|null
1551 public function getBlock( $bFromSlave = true ){
1552 $this->getBlockedStatus( $bFromSlave );
1553 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1557 * Check if user is blocked from editing a particular article
1559 * @param $title Title to check
1560 * @param $bFromSlave Bool whether to check the slave database instead of the master
1563 function isBlockedFrom( $title, $bFromSlave = false ) {
1564 global $wgBlockAllowsUTEdit;
1565 wfProfileIn( __METHOD__
);
1567 $blocked = $this->isBlocked( $bFromSlave );
1568 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1569 # If a user's name is suppressed, they cannot make edits anywhere
1570 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1571 $title->getNamespace() == NS_USER_TALK
) {
1573 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1576 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1578 wfProfileOut( __METHOD__
);
1583 * If user is blocked, return the name of the user who placed the block
1584 * @return String name of blocker
1586 public function blockedBy() {
1587 $this->getBlockedStatus();
1588 return $this->mBlockedby
;
1592 * If user is blocked, return the specified reason for the block
1593 * @return String Blocking reason
1595 public function blockedFor() {
1596 $this->getBlockedStatus();
1597 return $this->mBlockreason
;
1601 * If user is blocked, return the ID for the block
1602 * @return Int Block ID
1604 public function getBlockId() {
1605 $this->getBlockedStatus();
1606 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1610 * Check if user is blocked on all wikis.
1611 * Do not use for actual edit permission checks!
1612 * This is intented for quick UI checks.
1614 * @param $ip String IP address, uses current client if none given
1615 * @return Bool True if blocked, false otherwise
1617 public function isBlockedGlobally( $ip = '' ) {
1618 if( $this->mBlockedGlobally
!== null ) {
1619 return $this->mBlockedGlobally
;
1621 // User is already an IP?
1622 if( IP
::isIPAddress( $this->getName() ) ) {
1623 $ip = $this->getName();
1625 $ip = $this->getRequest()->getIP();
1628 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1629 $this->mBlockedGlobally
= (bool)$blocked;
1630 return $this->mBlockedGlobally
;
1634 * Check if user account is locked
1636 * @return Bool True if locked, false otherwise
1638 public function isLocked() {
1639 if( $this->mLocked
!== null ) {
1640 return $this->mLocked
;
1643 $authUser = $wgAuth->getUserInstance( $this );
1644 $this->mLocked
= (bool)$authUser->isLocked();
1645 return $this->mLocked
;
1649 * Check if user account is hidden
1651 * @return Bool True if hidden, false otherwise
1653 public function isHidden() {
1654 if( $this->mHideName
!== null ) {
1655 return $this->mHideName
;
1657 $this->getBlockedStatus();
1658 if( !$this->mHideName
) {
1660 $authUser = $wgAuth->getUserInstance( $this );
1661 $this->mHideName
= (bool)$authUser->isHidden();
1663 return $this->mHideName
;
1667 * Get the user's ID.
1668 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1670 public function getId() {
1671 if( $this->mId
=== null && $this->mName
!== null
1672 && User
::isIP( $this->mName
) ) {
1673 // Special case, we know the user is anonymous
1675 } elseif( !$this->isItemLoaded( 'id' ) ) {
1676 // Don't load if this was initialized from an ID
1683 * Set the user and reload all fields according to a given ID
1684 * @param $v Int User ID to reload
1686 public function setId( $v ) {
1688 $this->clearInstanceCache( 'id' );
1692 * Get the user name, or the IP of an anonymous user
1693 * @return String User's name or IP address
1695 public function getName() {
1696 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1697 # Special case optimisation
1698 return $this->mName
;
1701 if ( $this->mName
=== false ) {
1703 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1705 return $this->mName
;
1710 * Set the user name.
1712 * This does not reload fields from the database according to the given
1713 * name. Rather, it is used to create a temporary "nonexistent user" for
1714 * later addition to the database. It can also be used to set the IP
1715 * address for an anonymous user to something other than the current
1718 * @note User::newFromName() has rougly the same function, when the named user
1720 * @param $str String New user name to set
1722 public function setName( $str ) {
1724 $this->mName
= $str;
1728 * Get the user's name escaped by underscores.
1729 * @return String Username escaped by underscores.
1731 public function getTitleKey() {
1732 return str_replace( ' ', '_', $this->getName() );
1736 * Check if the user has new messages.
1737 * @return Bool True if the user has new messages
1739 public function getNewtalk() {
1742 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1743 if( $this->mNewtalk
=== -1 ) {
1744 $this->mNewtalk
= false; # reset talk page status
1746 # Check memcached separately for anons, who have no
1747 # entire User object stored in there.
1750 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1751 $newtalk = $wgMemc->get( $key );
1752 if( strval( $newtalk ) !== '' ) {
1753 $this->mNewtalk
= (bool)$newtalk;
1755 // Since we are caching this, make sure it is up to date by getting it
1757 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1758 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1761 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1765 return (bool)$this->mNewtalk
;
1769 * Return the talk page(s) this user has new messages on.
1770 * @return Array of String page URLs
1772 public function getNewMessageLinks() {
1774 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1777 if( !$this->getNewtalk() )
1779 $up = $this->getUserPage();
1780 $utp = $up->getTalkPage();
1781 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1785 * Internal uncached check for new messages
1788 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1789 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1790 * @param $fromMaster Bool true to fetch from the master, false for a slave
1791 * @return Bool True if the user has new messages
1793 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1794 if ( $fromMaster ) {
1795 $db = wfGetDB( DB_MASTER
);
1797 $db = wfGetDB( DB_SLAVE
);
1799 $ok = $db->selectField( 'user_newtalk', $field,
1800 array( $field => $id ), __METHOD__
);
1801 return $ok !== false;
1805 * Add or update the new messages flag
1806 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1807 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1808 * @return Bool True if successful, false otherwise
1810 protected function updateNewtalk( $field, $id ) {
1811 $dbw = wfGetDB( DB_MASTER
);
1812 $dbw->insert( 'user_newtalk',
1813 array( $field => $id ),
1816 if ( $dbw->affectedRows() ) {
1817 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1820 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1826 * Clear the new messages flag for the given user
1827 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1828 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1829 * @return Bool True if successful, false otherwise
1831 protected function deleteNewtalk( $field, $id ) {
1832 $dbw = wfGetDB( DB_MASTER
);
1833 $dbw->delete( 'user_newtalk',
1834 array( $field => $id ),
1836 if ( $dbw->affectedRows() ) {
1837 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1840 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1846 * Update the 'You have new messages!' status.
1847 * @param $val Bool Whether the user has new messages
1849 public function setNewtalk( $val ) {
1850 if( wfReadOnly() ) {
1855 $this->mNewtalk
= $val;
1857 if( $this->isAnon() ) {
1859 $id = $this->getName();
1862 $id = $this->getId();
1867 $changed = $this->updateNewtalk( $field, $id );
1869 $changed = $this->deleteNewtalk( $field, $id );
1872 if( $this->isAnon() ) {
1873 // Anons have a separate memcached space, since
1874 // user records aren't kept for them.
1875 $key = wfMemcKey( 'newtalk', 'ip', $id );
1876 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1879 $this->invalidateCache();
1884 * Generate a current or new-future timestamp to be stored in the
1885 * user_touched field when we update things.
1886 * @return String Timestamp in TS_MW format
1888 private static function newTouchedTimestamp() {
1889 global $wgClockSkewFudge;
1890 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1894 * Clear user data from memcached.
1895 * Use after applying fun updates to the database; caller's
1896 * responsibility to update user_touched if appropriate.
1898 * Called implicitly from invalidateCache() and saveSettings().
1900 private function clearSharedCache() {
1904 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1909 * Immediately touch the user data cache for this account.
1910 * Updates user_touched field, and removes account data from memcached
1911 * for reload on the next hit.
1913 public function invalidateCache() {
1914 if( wfReadOnly() ) {
1919 $this->mTouched
= self
::newTouchedTimestamp();
1921 $dbw = wfGetDB( DB_MASTER
);
1922 $dbw->update( 'user',
1923 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1924 array( 'user_id' => $this->mId
),
1927 $this->clearSharedCache();
1932 * Validate the cache for this account.
1933 * @param $timestamp String A timestamp in TS_MW format
1937 public function validateCache( $timestamp ) {
1939 return ( $timestamp >= $this->mTouched
);
1943 * Get the user touched timestamp
1944 * @return String timestamp
1946 public function getTouched() {
1948 return $this->mTouched
;
1952 * Set the password and reset the random token.
1953 * Calls through to authentication plugin if necessary;
1954 * will have no effect if the auth plugin refuses to
1955 * pass the change through or if the legal password
1958 * As a special case, setting the password to null
1959 * wipes it, so the account cannot be logged in until
1960 * a new password is set, for instance via e-mail.
1962 * @param $str String New password to set
1963 * @throws PasswordError on failure
1967 public function setPassword( $str ) {
1970 if( $str !== null ) {
1971 if( !$wgAuth->allowPasswordChange() ) {
1972 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1975 if( !$this->isValidPassword( $str ) ) {
1976 global $wgMinimalPasswordLength;
1977 $valid = $this->getPasswordValidity( $str );
1978 if ( is_array( $valid ) ) {
1979 $message = array_shift( $valid );
1983 $params = array( $wgMinimalPasswordLength );
1985 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
1989 if( !$wgAuth->setPassword( $this, $str ) ) {
1990 throw new PasswordError( wfMsg( 'externaldberror' ) );
1993 $this->setInternalPassword( $str );
1999 * Set the password and reset the random token unconditionally.
2001 * @param $str String New password to set
2003 public function setInternalPassword( $str ) {
2007 if( $str === null ) {
2008 // Save an invalid hash...
2009 $this->mPassword
= '';
2011 $this->mPassword
= self
::crypt( $str );
2013 $this->mNewpassword
= '';
2014 $this->mNewpassTime
= null;
2018 * Get the user's current token.
2019 * @return String Token
2021 public function getToken() {
2023 return $this->mToken
;
2027 * Set the random token (used for persistent authentication)
2028 * Called from loadDefaults() among other places.
2030 * @param $token String|bool If specified, set the token to this value
2032 public function setToken( $token = false ) {
2033 global $wgSecretKey, $wgProxyKey;
2036 if ( $wgSecretKey ) {
2037 $key = $wgSecretKey;
2038 } elseif ( $wgProxyKey ) {
2043 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
2045 $this->mToken
= $token;
2050 * Set the cookie password
2052 * @param $str String New cookie password
2054 private function setCookiePassword( $str ) {
2056 $this->mCookiePassword
= md5( $str );
2060 * Set the password for a password reminder or new account email
2062 * @param $str String New password to set
2063 * @param $throttle Bool If true, reset the throttle timestamp to the present
2065 public function setNewpassword( $str, $throttle = true ) {
2067 $this->mNewpassword
= self
::crypt( $str );
2069 $this->mNewpassTime
= wfTimestampNow();
2074 * Has password reminder email been sent within the last
2075 * $wgPasswordReminderResendTime hours?
2078 public function isPasswordReminderThrottled() {
2079 global $wgPasswordReminderResendTime;
2081 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2084 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2085 return time() < $expiry;
2089 * Get the user's e-mail address
2090 * @return String User's email address
2092 public function getEmail() {
2094 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2095 return $this->mEmail
;
2099 * Get the timestamp of the user's e-mail authentication
2100 * @return String TS_MW timestamp
2102 public function getEmailAuthenticationTimestamp() {
2104 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2105 return $this->mEmailAuthenticated
;
2109 * Set the user's e-mail address
2110 * @param $str String New e-mail address
2112 public function setEmail( $str ) {
2114 $this->mEmail
= $str;
2115 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2119 * Get the user's real name
2120 * @return String User's real name
2122 public function getRealName() {
2123 if ( !$this->isItemLoaded( 'realname' ) ) {
2127 return $this->mRealName
;
2131 * Set the user's real name
2132 * @param $str String New real name
2134 public function setRealName( $str ) {
2136 $this->mRealName
= $str;
2140 * Return the name of this user we should used to display in the user interface
2141 * @return String The user's display name
2143 public function getDisplayName() {
2144 global $wgRealNameInInterface;
2145 if ( is_null( $this->mDisplayName
) ) {
2146 $displayName = null;
2148 // Allow hooks to set a display name
2149 wfRunHooks( 'UserDisplayName', array( $this, &$displayName ) );
2151 if ( is_null( $displayName ) && $wgRealNameInInterface && $this->getRealName() ) {
2152 // If $wgRealNameInInterface is true use the real name as the display name if it's set
2153 $displayName = $this->getRealName();
2156 if ( is_null( $displayName ) ) {
2157 $displayName = $this->getName();
2160 $this->mDisplayName
= $displayName;
2162 return $this->mDisplayName
;
2166 * Get the user's current setting for a given option.
2168 * @param $oname String The option to check
2169 * @param $defaultOverride String A default value returned if the option does not exist
2170 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2171 * @return String User's current value for the option
2172 * @see getBoolOption()
2173 * @see getIntOption()
2175 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2176 global $wgHiddenPrefs;
2177 $this->loadOptions();
2179 if ( is_null( $this->mOptions
) ) {
2180 if($defaultOverride != '') {
2181 return $defaultOverride;
2183 $this->mOptions
= User
::getDefaultOptions();
2186 # We want 'disabled' preferences to always behave as the default value for
2187 # users, even if they have set the option explicitly in their settings (ie they
2188 # set it, and then it was disabled removing their ability to change it). But
2189 # we don't want to erase the preferences in the database in case the preference
2190 # is re-enabled again. So don't touch $mOptions, just override the returned value
2191 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2192 return self
::getDefaultOption( $oname );
2195 if ( array_key_exists( $oname, $this->mOptions
) ) {
2196 return $this->mOptions
[$oname];
2198 return $defaultOverride;
2203 * Get all user's options
2207 public function getOptions() {
2208 global $wgHiddenPrefs;
2209 $this->loadOptions();
2210 $options = $this->mOptions
;
2212 # We want 'disabled' preferences to always behave as the default value for
2213 # users, even if they have set the option explicitly in their settings (ie they
2214 # set it, and then it was disabled removing their ability to change it). But
2215 # we don't want to erase the preferences in the database in case the preference
2216 # is re-enabled again. So don't touch $mOptions, just override the returned value
2217 foreach( $wgHiddenPrefs as $pref ){
2218 $default = self
::getDefaultOption( $pref );
2219 if( $default !== null ){
2220 $options[$pref] = $default;
2228 * Get the user's current setting for a given option, as a boolean value.
2230 * @param $oname String The option to check
2231 * @return Bool User's current value for the option
2234 public function getBoolOption( $oname ) {
2235 return (bool)$this->getOption( $oname );
2239 * Get the user's current setting for a given option, as a boolean value.
2241 * @param $oname String The option to check
2242 * @param $defaultOverride Int A default value returned if the option does not exist
2243 * @return Int User's current value for the option
2246 public function getIntOption( $oname, $defaultOverride=0 ) {
2247 $val = $this->getOption( $oname );
2249 $val = $defaultOverride;
2251 return intval( $val );
2255 * Set the given option for a user.
2257 * @param $oname String The option to set
2258 * @param $val mixed New value to set
2260 public function setOption( $oname, $val ) {
2262 $this->loadOptions();
2264 // Explicitly NULL values should refer to defaults
2265 global $wgDefaultUserOptions;
2266 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2267 $val = $wgDefaultUserOptions[$oname];
2270 $this->mOptions
[$oname] = $val;
2274 * Reset all options to the site defaults
2276 public function resetOptions() {
2277 $this->mOptions
= self
::getDefaultOptions();
2281 * Get the user's preferred date format.
2282 * @return String User's preferred date format
2284 public function getDatePreference() {
2285 // Important migration for old data rows
2286 if ( is_null( $this->mDatePreference
) ) {
2288 $value = $this->getOption( 'date' );
2289 $map = $wgLang->getDatePreferenceMigrationMap();
2290 if ( isset( $map[$value] ) ) {
2291 $value = $map[$value];
2293 $this->mDatePreference
= $value;
2295 return $this->mDatePreference
;
2299 * Get the user preferred stub threshold
2303 public function getStubThreshold() {
2304 global $wgMaxArticleSize; # Maximum article size, in Kb
2305 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2306 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2307 # If they have set an impossible value, disable the preference
2308 # so we can use the parser cache again.
2315 * Get the permissions this user has.
2316 * @param $ns int If numeric, get permissions for this namespace
2317 * @return Array of String permission names
2319 public function getRights( $ns = null ) {
2320 $key = is_null( $ns ) ?
'*' : intval( $ns );
2322 if ( is_null( $this->mRights
) ) {
2323 $this->mRights
= array();
2326 if ( !isset( $this->mRights
[$key] ) ) {
2327 $this->mRights
[$key] = self
::getGroupPermissions( $this->getEffectiveGroups(), $ns );
2328 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
[$key], $ns ) );
2329 // Force reindexation of rights when a hook has unset one of them
2330 $this->mRights
[$key] = array_values( $this->mRights
[$key] );
2332 if ( is_null( $ns ) ) {
2333 return $this->mRights
[$key];
2335 // Merge non namespace specific rights
2336 return array_merge( $this->mRights
[$key], $this->getRights() );
2342 * Get the list of explicit group memberships this user has.
2343 * The implicit * and user groups are not included.
2344 * @return Array of String internal group names
2346 public function getGroups() {
2348 $this->loadGroups();
2349 return $this->mGroups
;
2353 * Get the list of implicit group memberships this user has.
2354 * This includes all explicit groups, plus 'user' if logged in,
2355 * '*' for all accounts, and autopromoted groups
2356 * @param $recache Bool Whether to avoid the cache
2357 * @return Array of String internal group names
2359 public function getEffectiveGroups( $recache = false ) {
2360 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2361 wfProfileIn( __METHOD__
);
2362 $this->mEffectiveGroups
= array_unique( array_merge(
2363 $this->getGroups(), // explicit groups
2364 $this->getAutomaticGroups( $recache ) // implicit groups
2366 # Hook for additional groups
2367 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2368 wfProfileOut( __METHOD__
);
2370 return $this->mEffectiveGroups
;
2374 * Get the list of implicit group memberships this user has.
2375 * This includes 'user' if logged in, '*' for all accounts,
2376 * and autopromoted groups
2377 * @param $recache Bool Whether to avoid the cache
2378 * @return Array of String internal group names
2380 public function getAutomaticGroups( $recache = false ) {
2381 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2382 wfProfileIn( __METHOD__
);
2383 $this->mImplicitGroups
= array( '*' );
2384 if ( $this->getId() ) {
2385 $this->mImplicitGroups
[] = 'user';
2387 $this->mImplicitGroups
= array_unique( array_merge(
2388 $this->mImplicitGroups
,
2389 Autopromote
::getAutopromoteGroups( $this )
2393 # Assure data consistency with rights/groups,
2394 # as getEffectiveGroups() depends on this function
2395 $this->mEffectiveGroups
= null;
2397 wfProfileOut( __METHOD__
);
2399 return $this->mImplicitGroups
;
2403 * Returns the groups the user has belonged to.
2405 * The user may still belong to the returned groups. Compare with getGroups().
2407 * The function will not return groups the user had belonged to before MW 1.17
2409 * @return array Names of the groups the user has belonged to.
2411 public function getFormerGroups() {
2412 if( is_null( $this->mFormerGroups
) ) {
2413 $dbr = wfGetDB( DB_MASTER
);
2414 $res = $dbr->select( 'user_former_groups',
2415 array( 'ufg_group' ),
2416 array( 'ufg_user' => $this->mId
),
2418 $this->mFormerGroups
= array();
2419 foreach( $res as $row ) {
2420 $this->mFormerGroups
[] = $row->ufg_group
;
2423 return $this->mFormerGroups
;
2427 * Get the user's edit count.
2430 public function getEditCount() {
2431 if( $this->getId() ) {
2432 if ( !isset( $this->mEditCount
) ) {
2433 /* Populate the count, if it has not been populated yet */
2434 $this->mEditCount
= User
::edits( $this->mId
);
2436 return $this->mEditCount
;
2444 * Add the user to the given group.
2445 * This takes immediate effect.
2446 * @param $group String Name of the group to add
2448 public function addGroup( $group ) {
2449 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2450 $dbw = wfGetDB( DB_MASTER
);
2451 if( $this->getId() ) {
2452 $dbw->insert( 'user_groups',
2454 'ug_user' => $this->getID(),
2455 'ug_group' => $group,
2458 array( 'IGNORE' ) );
2461 $this->loadGroups();
2462 $this->mGroups
[] = $group;
2463 $this->mRights
= null;
2465 $this->invalidateCache();
2469 * Remove the user from the given group.
2470 * This takes immediate effect.
2471 * @param $group String Name of the group to remove
2473 public function removeGroup( $group ) {
2475 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2476 $dbw = wfGetDB( DB_MASTER
);
2477 $dbw->delete( 'user_groups',
2479 'ug_user' => $this->getID(),
2480 'ug_group' => $group,
2482 // Remember that the user was in this group
2483 $dbw->insert( 'user_former_groups',
2485 'ufg_user' => $this->getID(),
2486 'ufg_group' => $group,
2489 array( 'IGNORE' ) );
2491 $this->loadGroups();
2492 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2493 $this->mRights
= null;
2495 $this->invalidateCache();
2499 * Get whether the user is logged in
2502 public function isLoggedIn() {
2503 return $this->getID() != 0;
2507 * Get whether the user is anonymous
2510 public function isAnon() {
2511 return !$this->isLoggedIn();
2515 * Check if user is allowed to access a feature / make an action
2517 * @internal param \String $varargs permissions to test
2518 * @return Boolean: True if user is allowed to perform *any* of the given actions
2522 public function isAllowedAny( /*...*/ ){
2523 $permissions = func_get_args();
2524 foreach( $permissions as $permission ){
2525 if( $this->isAllowed( $permission ) ){
2534 * @internal param $varargs string
2535 * @return bool True if the user is allowed to perform *all* of the given actions
2537 public function isAllowedAll( /*...*/ ){
2538 $permissions = func_get_args();
2539 foreach( $permissions as $permission ){
2540 if( !$this->isAllowed( $permission ) ){
2548 * Internal mechanics of testing a permission
2549 * @param $action String
2550 * @param $ns int|null Namespace optional
2553 public function isAllowed( $action = '', $ns = null ) {
2554 if ( $action === '' ) {
2555 return true; // In the spirit of DWIM
2557 # Patrolling may not be enabled
2558 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2559 global $wgUseRCPatrol, $wgUseNPPatrol;
2560 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2563 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2564 # by misconfiguration: 0 == 'foo'
2565 return in_array( $action, $this->getRights( $ns ), true );
2569 * Check whether to enable recent changes patrol features for this user
2570 * @return Boolean: True or false
2572 public function useRCPatrol() {
2573 global $wgUseRCPatrol;
2574 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2578 * Check whether to enable new pages patrol features for this user
2579 * @return Bool True or false
2581 public function useNPPatrol() {
2582 global $wgUseRCPatrol, $wgUseNPPatrol;
2583 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2587 * Get the WebRequest object to use with this object
2589 * @return WebRequest
2591 public function getRequest() {
2592 if ( $this->mRequest
) {
2593 return $this->mRequest
;
2601 * Get the current skin, loading it if required
2602 * @return Skin The current skin
2603 * @todo FIXME: Need to check the old failback system [AV]
2604 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2606 public function getSkin() {
2607 return RequestContext
::getMain()->getSkin();
2611 * Check the watched status of an article.
2612 * @param $title Title of the article to look at
2615 public function isWatched( $title ) {
2616 $wl = WatchedItem
::fromUserTitle( $this, $title );
2617 return $wl->isWatched();
2622 * @param $title Title of the article to look at
2624 public function addWatch( $title ) {
2625 $wl = WatchedItem
::fromUserTitle( $this, $title );
2627 $this->invalidateCache();
2631 * Stop watching an article.
2632 * @param $title Title of the article to look at
2634 public function removeWatch( $title ) {
2635 $wl = WatchedItem
::fromUserTitle( $this, $title );
2637 $this->invalidateCache();
2641 * Cleans up watchlist by removing invalid entries from it
2643 public function cleanupWatchlist() {
2644 $dbw = wfGetDB( DB_MASTER
);
2645 $dbw->delete( 'watchlist', array( 'wl_namespace < 0', 'wl_user' => $this->getId() ), __METHOD__
);
2649 * Clear the user's notification timestamp for the given title.
2650 * If e-notif e-mails are on, they will receive notification mails on
2651 * the next change of the page if it's watched etc.
2652 * @param $title Title of the article to look at
2654 public function clearNotification( &$title ) {
2655 global $wgUseEnotif, $wgShowUpdatedMarker;
2657 # Do nothing if the database is locked to writes
2658 if( wfReadOnly() ) {
2662 if( $title->getNamespace() == NS_USER_TALK
&&
2663 $title->getText() == $this->getName() ) {
2664 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2666 $this->setNewtalk( false );
2669 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2673 if( $this->isAnon() ) {
2674 // Nothing else to do...
2678 // Only update the timestamp if the page is being watched.
2679 // The query to find out if it is watched is cached both in memcached and per-invocation,
2680 // and when it does have to be executed, it can be on a slave
2681 // If this is the user's newtalk page, we always update the timestamp
2682 if( $title->getNamespace() == NS_USER_TALK
&&
2683 $title->getText() == $this->getName() )
2687 $watched = $this->isWatched( $title );
2690 // If the page is watched by the user (or may be watched), update the timestamp on any
2691 // any matching rows
2693 $dbw = wfGetDB( DB_MASTER
);
2694 $dbw->update( 'watchlist',
2696 'wl_notificationtimestamp' => null
2697 ), array( /* WHERE */
2698 'wl_title' => $title->getDBkey(),
2699 'wl_namespace' => $title->getNamespace(),
2700 'wl_user' => $this->getID()
2707 * Resets all of the given user's page-change notification timestamps.
2708 * If e-notif e-mails are on, they will receive notification mails on
2709 * the next change of any watched page.
2711 public function clearAllNotifications() {
2712 global $wgUseEnotif, $wgShowUpdatedMarker;
2713 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2714 $this->setNewtalk( false );
2717 $id = $this->getId();
2719 $dbw = wfGetDB( DB_MASTER
);
2720 $dbw->update( 'watchlist',
2722 'wl_notificationtimestamp' => null
2723 ), array( /* WHERE */
2727 # We also need to clear here the "you have new message" notification for the own user_talk page
2728 # This is cleared one page view later in Article::viewUpdates();
2733 * Set this user's options from an encoded string
2734 * @param $str String Encoded options to import
2736 * @deprecated in 1.19 due to removal of user_options from the user table
2738 private function decodeOptions( $str ) {
2742 $this->mOptionsLoaded
= true;
2743 $this->mOptionOverrides
= array();
2745 // If an option is not set in $str, use the default value
2746 $this->mOptions
= self
::getDefaultOptions();
2748 $a = explode( "\n", $str );
2749 foreach ( $a as $s ) {
2751 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2752 $this->mOptions
[$m[1]] = $m[2];
2753 $this->mOptionOverrides
[$m[1]] = $m[2];
2759 * Set a cookie on the user's client. Wrapper for
2760 * WebResponse::setCookie
2761 * @param $name String Name of the cookie to set
2762 * @param $value String Value to set
2763 * @param $exp Int Expiration time, as a UNIX time value;
2764 * if 0 or not specified, use the default $wgCookieExpiration
2766 protected function setCookie( $name, $value, $exp = 0 ) {
2767 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2771 * Clear a cookie on the user's client
2772 * @param $name String Name of the cookie to clear
2774 protected function clearCookie( $name ) {
2775 $this->setCookie( $name, '', time() - 86400 );
2779 * Set the default cookies for this session on the user's client.
2781 * @param $request WebRequest object to use; $wgRequest will be used if null
2784 public function setCookies( $request = null ) {
2785 if ( $request === null ) {
2786 $request = $this->getRequest();
2790 if ( 0 == $this->mId
) return;
2792 'wsUserID' => $this->mId
,
2793 'wsToken' => $this->mToken
,
2794 'wsUserName' => $this->getName()
2797 'UserID' => $this->mId
,
2798 'UserName' => $this->getName(),
2800 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2801 $cookies['Token'] = $this->mToken
;
2803 $cookies['Token'] = false;
2806 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2808 foreach ( $session as $name => $value ) {
2809 $request->setSessionData( $name, $value );
2811 foreach ( $cookies as $name => $value ) {
2812 if ( $value === false ) {
2813 $this->clearCookie( $name );
2815 $this->setCookie( $name, $value );
2821 * Log this user out.
2823 public function logout() {
2824 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2830 * Clear the user's cookies and session, and reset the instance cache.
2833 public function doLogout() {
2834 $this->clearInstanceCache( 'defaults' );
2836 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2838 $this->clearCookie( 'UserID' );
2839 $this->clearCookie( 'Token' );
2841 # Remember when user logged out, to prevent seeing cached pages
2842 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2846 * Save this user's settings into the database.
2847 * @todo Only rarely do all these fields need to be set!
2849 public function saveSettings() {
2851 if ( wfReadOnly() ) { return; }
2852 if ( 0 == $this->mId
) { return; }
2854 $this->mTouched
= self
::newTouchedTimestamp();
2856 $dbw = wfGetDB( DB_MASTER
);
2857 $dbw->update( 'user',
2859 'user_name' => $this->mName
,
2860 'user_password' => $this->mPassword
,
2861 'user_newpassword' => $this->mNewpassword
,
2862 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2863 'user_real_name' => $this->mRealName
,
2864 'user_email' => $this->mEmail
,
2865 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2866 'user_touched' => $dbw->timestamp( $this->mTouched
),
2867 'user_token' => $this->mToken
,
2868 'user_email_token' => $this->mEmailToken
,
2869 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2870 ), array( /* WHERE */
2871 'user_id' => $this->mId
2875 $this->saveOptions();
2877 wfRunHooks( 'UserSaveSettings', array( $this ) );
2878 $this->clearSharedCache();
2879 $this->getUserPage()->invalidateCache();
2883 * If only this user's username is known, and it exists, return the user ID.
2886 public function idForName() {
2887 $s = trim( $this->getName() );
2888 if ( $s === '' ) return 0;
2890 $dbr = wfGetDB( DB_SLAVE
);
2891 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2892 if ( $id === false ) {
2899 * Add a user to the database, return the user object
2901 * @param $name String Username to add
2902 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2903 * - password The user's password hash. Password logins will be disabled if this is omitted.
2904 * - newpassword Hash for a temporary password that has been mailed to the user
2905 * - email The user's email address
2906 * - email_authenticated The email authentication timestamp
2907 * - real_name The user's real name
2908 * - options An associative array of non-default options
2909 * - token Random authentication token. Do not set.
2910 * - registration Registration timestamp. Do not set.
2912 * @return User object, or null if the username already exists
2914 public static function createNew( $name, $params = array() ) {
2917 if ( isset( $params['options'] ) ) {
2918 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2919 unset( $params['options'] );
2921 $dbw = wfGetDB( DB_MASTER
);
2922 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2925 'user_id' => $seqVal,
2926 'user_name' => $name,
2927 'user_password' => $user->mPassword
,
2928 'user_newpassword' => $user->mNewpassword
,
2929 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2930 'user_email' => $user->mEmail
,
2931 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2932 'user_real_name' => $user->mRealName
,
2933 'user_token' => $user->mToken
,
2934 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2935 'user_editcount' => 0,
2937 foreach ( $params as $name => $value ) {
2938 $fields["user_$name"] = $value;
2940 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2941 if ( $dbw->affectedRows() ) {
2942 $newUser = User
::newFromId( $dbw->insertId() );
2950 * Add this existing user object to the database
2952 public function addToDatabase() {
2954 $dbw = wfGetDB( DB_MASTER
);
2955 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2956 $dbw->insert( 'user',
2958 'user_id' => $seqVal,
2959 'user_name' => $this->mName
,
2960 'user_password' => $this->mPassword
,
2961 'user_newpassword' => $this->mNewpassword
,
2962 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2963 'user_email' => $this->mEmail
,
2964 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2965 'user_real_name' => $this->mRealName
,
2966 'user_token' => $this->mToken
,
2967 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2968 'user_editcount' => 0,
2971 $this->mId
= $dbw->insertId();
2973 // Clear instance cache other than user table data, which is already accurate
2974 $this->clearInstanceCache();
2976 $this->saveOptions();
2980 * If this user is logged-in and blocked,
2981 * block any IP address they've successfully logged in from.
2982 * @return bool A block was spread
2984 public function spreadAnyEditBlock() {
2985 if ( $this->isLoggedIn() && $this->isBlocked() ) {
2986 return $this->spreadBlock();
2992 * If this (non-anonymous) user is blocked,
2993 * block the IP address they've successfully logged in from.
2994 * @return bool A block was spread
2996 protected function spreadBlock() {
2997 wfDebug( __METHOD__
. "()\n" );
2999 if ( $this->mId
== 0 ) {
3003 $userblock = Block
::newFromTarget( $this->getName() );
3004 if ( !$userblock ) {
3008 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3012 * Generate a string which will be different for any combination of
3013 * user options which would produce different parser output.
3014 * This will be used as part of the hash key for the parser cache,
3015 * so users with the same options can share the same cached data
3018 * Extensions which require it should install 'PageRenderingHash' hook,
3019 * which will give them a chance to modify this key based on their own
3022 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3023 * @return String Page rendering hash
3025 public function getPageRenderingHash() {
3026 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3028 return $this->mHash
;
3030 wfDeprecated( __METHOD__
);
3032 // stubthreshold is only included below for completeness,
3033 // since it disables the parser cache, its value will always
3034 // be 0 when this function is called by parsercache.
3036 $confstr = $this->getOption( 'math' );
3037 $confstr .= '!' . $this->getStubThreshold();
3038 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3039 $confstr .= '!' . $this->getDatePreference();
3041 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3042 $confstr .= '!' . $wgLang->getCode();
3043 $confstr .= '!' . $this->getOption( 'thumbsize' );
3044 // add in language specific options, if any
3045 $extra = $wgContLang->getExtraHashOptions();
3048 // Since the skin could be overloading link(), it should be
3049 // included here but in practice, none of our skins do that.
3051 $confstr .= $wgRenderHashAppend;
3053 // Give a chance for extensions to modify the hash, if they have
3054 // extra options or other effects on the parser cache.
3055 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3057 // Make it a valid memcached key fragment
3058 $confstr = str_replace( ' ', '_', $confstr );
3059 $this->mHash
= $confstr;
3064 * Get whether the user is explicitly blocked from account creation.
3065 * @return Bool|Block
3067 public function isBlockedFromCreateAccount() {
3068 $this->getBlockedStatus();
3069 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3070 return $this->mBlock
;
3073 # bug 13611: if the IP address the user is trying to create an account from is
3074 # blocked with createaccount disabled, prevent new account creation there even
3075 # when the user is logged in
3076 if( $this->mBlockedFromCreateAccount
=== false ){
3077 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3079 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3080 ?
$this->mBlockedFromCreateAccount
3085 * Get whether the user is blocked from using Special:Emailuser.
3088 public function isBlockedFromEmailuser() {
3089 $this->getBlockedStatus();
3090 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3094 * Get whether the user is allowed to create an account.
3097 function isAllowedToCreateAccount() {
3098 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3102 * Get this user's personal page title.
3104 * @return Title: User's personal page title
3106 public function getUserPage() {
3107 return Title
::makeTitle( NS_USER
, $this->getName() );
3111 * Get this user's talk page title.
3113 * @return Title: User's talk page title
3115 public function getTalkPage() {
3116 $title = $this->getUserPage();
3117 return $title->getTalkPage();
3121 * Determine whether the user is a newbie. Newbies are either
3122 * anonymous IPs, or the most recently created accounts.
3125 public function isNewbie() {
3126 return !$this->isAllowed( 'autoconfirmed' );
3130 * Check to see if the given clear-text password is one of the accepted passwords
3131 * @param $password String: user password.
3132 * @return Boolean: True if the given password is correct, otherwise False.
3134 public function checkPassword( $password ) {
3135 global $wgAuth, $wgLegacyEncoding;
3138 // Even though we stop people from creating passwords that
3139 // are shorter than this, doesn't mean people wont be able
3140 // to. Certain authentication plugins do NOT want to save
3141 // domain passwords in a mysql database, so we should
3142 // check this (in case $wgAuth->strict() is false).
3143 if( !$this->isValidPassword( $password ) ) {
3147 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3149 } elseif( $wgAuth->strict() ) {
3150 /* Auth plugin doesn't allow local authentication */
3152 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3153 /* Auth plugin doesn't allow local authentication for this user name */
3156 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3158 } elseif ( $wgLegacyEncoding ) {
3159 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3160 # Check for this with iconv
3161 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3162 if ( $cp1252Password != $password &&
3163 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3172 * Check if the given clear-text password matches the temporary password
3173 * sent by e-mail for password reset operations.
3175 * @param $plaintext string
3177 * @return Boolean: True if matches, false otherwise
3179 public function checkTemporaryPassword( $plaintext ) {
3180 global $wgNewPasswordExpiry;
3183 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3184 if ( is_null( $this->mNewpassTime
) ) {
3187 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3188 return ( time() < $expiry );
3195 * Alias for getEditToken.
3196 * @deprecated since 1.19, use getEditToken instead.
3198 * @param $salt String|Array of Strings Optional function-specific data for hashing
3199 * @param $request WebRequest object to use or null to use $wgRequest
3200 * @return String The new edit token
3202 public function editToken( $salt = '', $request = null ) {
3203 return $this->getEditToken( $salt, $request );
3207 * Initialize (if necessary) and return a session token value
3208 * which can be used in edit forms to show that the user's
3209 * login credentials aren't being hijacked with a foreign form
3214 * @param $salt String|Array of Strings Optional function-specific data for hashing
3215 * @param $request WebRequest object to use or null to use $wgRequest
3216 * @return String The new edit token
3218 public function getEditToken( $salt = '', $request = null ) {
3219 if ( $request == null ) {
3220 $request = $this->getRequest();
3223 if ( $this->isAnon() ) {
3224 return EDIT_TOKEN_SUFFIX
;
3226 $token = $request->getSessionData( 'wsEditToken' );
3227 if ( $token === null ) {
3228 $token = self
::generateToken();
3229 $request->setSessionData( 'wsEditToken', $token );
3231 if( is_array( $salt ) ) {
3232 $salt = implode( '|', $salt );
3234 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3239 * Generate a looking random token for various uses.
3241 * @param $salt String Optional salt value
3242 * @return String The new random token
3244 public static function generateToken( $salt = '' ) {
3245 $token = dechex( mt_rand() ) . dechex( mt_rand() );
3246 return md5( $token . $salt );
3250 * Check given value against the token value stored in the session.
3251 * A match should confirm that the form was submitted from the
3252 * user's own login session, not a form submission from a third-party
3255 * @param $val String Input value to compare
3256 * @param $salt String Optional function-specific data for hashing
3257 * @param $request WebRequest object to use or null to use $wgRequest
3258 * @return Boolean: Whether the token matches
3260 public function matchEditToken( $val, $salt = '', $request = null ) {
3261 $sessionToken = $this->editToken( $salt, $request );
3262 if ( $val != $sessionToken ) {
3263 wfDebug( "User::matchEditToken: broken session data\n" );
3265 return $val == $sessionToken;
3269 * Check given value against the token value stored in the session,
3270 * ignoring the suffix.
3272 * @param $val String Input value to compare
3273 * @param $salt String Optional function-specific data for hashing
3274 * @param $request WebRequest object to use or null to use $wgRequest
3275 * @return Boolean: Whether the token matches
3277 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3278 $sessionToken = $this->editToken( $salt, $request );
3279 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3283 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3284 * mail to the user's given address.
3286 * @param $type String: message to send, either "created", "changed" or "set"
3287 * @return Status object
3289 public function sendConfirmationMail( $type = 'created' ) {
3291 $expiration = null; // gets passed-by-ref and defined in next line.
3292 $token = $this->confirmationToken( $expiration );
3293 $url = $this->confirmationTokenUrl( $token );
3294 $invalidateURL = $this->invalidationTokenUrl( $token );
3295 $this->saveSettings();
3297 if ( $type == 'created' ||
$type === false ) {
3298 $message = 'confirmemail_body';
3299 } elseif ( $type === true ) {
3300 $message = 'confirmemail_body_changed';
3302 $message = 'confirmemail_body_' . $type;
3305 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3307 $this->getRequest()->getIP(),
3310 $wgLang->timeanddate( $expiration, false ),
3312 $wgLang->date( $expiration, false ),
3313 $wgLang->time( $expiration, false ) ) );
3317 * Send an e-mail to this user's account. Does not check for
3318 * confirmed status or validity.
3320 * @param $subject String Message subject
3321 * @param $body String Message body
3322 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3323 * @param $replyto String Reply-To address
3326 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3327 if( is_null( $from ) ) {
3328 global $wgPasswordSender, $wgPasswordSenderName;
3329 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3331 $sender = new MailAddress( $from );
3334 $to = new MailAddress( $this );
3335 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3339 * Generate, store, and return a new e-mail confirmation code.
3340 * A hash (unsalted, since it's used as a key) is stored.
3342 * @note Call saveSettings() after calling this function to commit
3343 * this change to the database.
3345 * @param &$expiration \mixed Accepts the expiration time
3346 * @return String New token
3348 private function confirmationToken( &$expiration ) {
3349 global $wgUserEmailConfirmationTokenExpiry;
3351 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3352 $expiration = wfTimestamp( TS_MW
, $expires );
3353 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
3354 $hash = md5( $token );
3356 $this->mEmailToken
= $hash;
3357 $this->mEmailTokenExpires
= $expiration;
3362 * Return a URL the user can use to confirm their email address.
3363 * @param $token String Accepts the email confirmation token
3364 * @return String New token URL
3366 private function confirmationTokenUrl( $token ) {
3367 return $this->getTokenUrl( 'ConfirmEmail', $token );
3371 * Return a URL the user can use to invalidate their email address.
3372 * @param $token String Accepts the email confirmation token
3373 * @return String New token URL
3375 private function invalidationTokenUrl( $token ) {
3376 return $this->getTokenUrl( 'Invalidateemail', $token );
3380 * Internal function to format the e-mail validation/invalidation URLs.
3381 * This uses a quickie hack to use the
3382 * hardcoded English names of the Special: pages, for ASCII safety.
3384 * @note Since these URLs get dropped directly into emails, using the
3385 * short English names avoids insanely long URL-encoded links, which
3386 * also sometimes can get corrupted in some browsers/mailers
3387 * (bug 6957 with Gmail and Internet Explorer).
3389 * @param $page String Special page
3390 * @param $token String Token
3391 * @return String Formatted URL
3393 protected function getTokenUrl( $page, $token ) {
3394 // Hack to bypass localization of 'Special:'
3395 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3396 return $title->getCanonicalUrl();
3400 * Mark the e-mail address confirmed.
3402 * @note Call saveSettings() after calling this function to commit the change.
3406 public function confirmEmail() {
3407 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3408 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3413 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3414 * address if it was already confirmed.
3416 * @note Call saveSettings() after calling this function to commit the change.
3419 function invalidateEmail() {
3421 $this->mEmailToken
= null;
3422 $this->mEmailTokenExpires
= null;
3423 $this->setEmailAuthenticationTimestamp( null );
3424 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3429 * Set the e-mail authentication timestamp.
3430 * @param $timestamp String TS_MW timestamp
3432 function setEmailAuthenticationTimestamp( $timestamp ) {
3434 $this->mEmailAuthenticated
= $timestamp;
3435 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3439 * Is this user allowed to send e-mails within limits of current
3440 * site configuration?
3443 public function canSendEmail() {
3444 global $wgEnableEmail, $wgEnableUserEmail;
3445 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3448 $canSend = $this->isEmailConfirmed();
3449 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3454 * Is this user allowed to receive e-mails within limits of current
3455 * site configuration?
3458 public function canReceiveEmail() {
3459 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3463 * Is this user's e-mail address valid-looking and confirmed within
3464 * limits of the current site configuration?
3466 * @note If $wgEmailAuthentication is on, this may require the user to have
3467 * confirmed their address by returning a code or using a password
3468 * sent to the address from the wiki.
3472 public function isEmailConfirmed() {
3473 global $wgEmailAuthentication;
3476 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3477 if( $this->isAnon() ) {
3480 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3483 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3493 * Check whether there is an outstanding request for e-mail confirmation.
3496 public function isEmailConfirmationPending() {
3497 global $wgEmailAuthentication;
3498 return $wgEmailAuthentication &&
3499 !$this->isEmailConfirmed() &&
3500 $this->mEmailToken
&&
3501 $this->mEmailTokenExpires
> wfTimestamp();
3505 * Get the timestamp of account creation.
3507 * @return String|Bool Timestamp of account creation, or false for
3508 * non-existent/anonymous user accounts.
3510 public function getRegistration() {
3511 if ( $this->isAnon() ) {
3515 return $this->mRegistration
;
3519 * Get the timestamp of the first edit
3521 * @return String|Bool Timestamp of first edit, or false for
3522 * non-existent/anonymous user accounts.
3524 public function getFirstEditTimestamp() {
3525 if( $this->getId() == 0 ) {
3526 return false; // anons
3528 $dbr = wfGetDB( DB_SLAVE
);
3529 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3530 array( 'rev_user' => $this->getId() ),
3532 array( 'ORDER BY' => 'rev_timestamp ASC' )
3535 return false; // no edits
3537 return wfTimestamp( TS_MW
, $time );
3541 * Get the permissions associated with a given list of groups
3543 * @param $groups Array of Strings List of internal group names
3546 * @return Array of Strings List of permission key names for given groups combined
3548 public static function getGroupPermissions( array $groups, $ns = null ) {
3549 global $wgGroupPermissions, $wgRevokePermissions;
3552 // Grant every granted permission first
3553 foreach( $groups as $group ) {
3554 if( isset( $wgGroupPermissions[$group] ) ) {
3555 $rights = array_merge( $rights, self
::extractRights(
3556 $wgGroupPermissions[$group], $ns ) );
3560 // Revoke the revoked permissions
3561 foreach( $groups as $group ) {
3562 if( isset( $wgRevokePermissions[$group] ) ) {
3563 $rights = array_diff( $rights, self
::extractRights(
3564 $wgRevokePermissions[$group], $ns ) );
3567 return array_unique( $rights );
3571 * Helper for User::getGroupPermissions
3572 * @param $list array
3576 private static function extractRights( $list, $ns ) {
3578 foreach( $list as $right => $value ) {
3579 if ( is_array( $value ) ) {
3580 # This is a list of namespaces where the permission applies
3581 if ( !is_null( $ns ) && !empty( $value[$ns] ) ) {
3585 # This is a boolean indicating that the permission applies
3595 * Get all the groups who have a given permission
3597 * @param $role String Role to check
3601 * @return Array of Strings List of internal group names with the given permission
3603 public static function getGroupsWithPermission( $role, $ns = null ) {
3604 global $wgGroupPermissions;
3605 $allowedGroups = array();
3606 foreach ( $wgGroupPermissions as $group => $rights ) {
3607 if ( in_array( $role, self
::getGroupPermissions( array( $group ), $ns ), true ) ) {
3608 $allowedGroups[] = $group;
3611 return $allowedGroups;
3615 * Get the localized descriptive name for a group, if it exists
3617 * @param $group String Internal group name
3618 * @return String Localized descriptive group name
3620 public static function getGroupName( $group ) {
3621 $msg = wfMessage( "group-$group" );
3622 return $msg->isBlank() ?
$group : $msg->text();
3626 * Get the localized descriptive name for a member of a group, if it exists
3628 * @param $group String Internal group name
3629 * @param $username String Username for gender (since 1.19)
3630 * @return String Localized name for group member
3632 public static function getGroupMember( $group, $username = '#' ) {
3633 $msg = wfMessage( "group-$group-member", $username );
3634 return $msg->isBlank() ?
$group : $msg->text();
3638 * Return the set of defined explicit groups.
3639 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3640 * are not included, as they are defined automatically, not in the database.
3641 * @return Array of internal group names
3643 public static function getAllGroups() {
3644 global $wgGroupPermissions, $wgRevokePermissions;
3646 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3647 self
::getImplicitGroups()
3652 * Get a list of all available permissions.
3653 * @return Array of permission names
3655 public static function getAllRights() {
3656 if ( self
::$mAllRights === false ) {
3657 global $wgAvailableRights;
3658 if ( count( $wgAvailableRights ) ) {
3659 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3661 self
::$mAllRights = self
::$mCoreRights;
3663 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3665 return self
::$mAllRights;
3669 * Get a list of implicit groups
3670 * @return Array of Strings Array of internal group names
3672 public static function getImplicitGroups() {
3673 global $wgImplicitGroups;
3674 $groups = $wgImplicitGroups;
3675 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3680 * Get the title of a page describing a particular group
3682 * @param $group String Internal group name
3683 * @return Title|Bool Title of the page if it exists, false otherwise
3685 public static function getGroupPage( $group ) {
3686 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3687 if( $msg->exists() ) {
3688 $title = Title
::newFromText( $msg->text() );
3689 if( is_object( $title ) )
3696 * Create a link to the group in HTML, if available;
3697 * else return the group name.
3699 * @param $group String Internal name of the group
3700 * @param $text String The text of the link
3701 * @return String HTML link to the group
3703 public static function makeGroupLinkHTML( $group, $text = '' ) {
3705 $text = self
::getGroupName( $group );
3707 $title = self
::getGroupPage( $group );
3709 return Linker
::link( $title, htmlspecialchars( $text ) );
3716 * Create a link to the group in Wikitext, if available;
3717 * else return the group name.
3719 * @param $group String Internal name of the group
3720 * @param $text String The text of the link
3721 * @return String Wikilink to the group
3723 public static function makeGroupLinkWiki( $group, $text = '' ) {
3725 $text = self
::getGroupName( $group );
3727 $title = self
::getGroupPage( $group );
3729 $page = $title->getPrefixedText();
3730 return "[[$page|$text]]";
3737 * Returns an array of the groups that a particular group can add/remove.
3739 * @param $group String: the group to check for whether it can add/remove
3740 * @return Array array( 'add' => array( addablegroups ),
3741 * 'remove' => array( removablegroups ),
3742 * 'add-self' => array( addablegroups to self),
3743 * 'remove-self' => array( removable groups from self) )
3745 public static function changeableByGroup( $group ) {
3746 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3748 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3749 if( empty( $wgAddGroups[$group] ) ) {
3750 // Don't add anything to $groups
3751 } elseif( $wgAddGroups[$group] === true ) {
3752 // You get everything
3753 $groups['add'] = self
::getAllGroups();
3754 } elseif( is_array( $wgAddGroups[$group] ) ) {
3755 $groups['add'] = $wgAddGroups[$group];
3758 // Same thing for remove
3759 if( empty( $wgRemoveGroups[$group] ) ) {
3760 } elseif( $wgRemoveGroups[$group] === true ) {
3761 $groups['remove'] = self
::getAllGroups();
3762 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3763 $groups['remove'] = $wgRemoveGroups[$group];
3766 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3767 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3768 foreach( $wgGroupsAddToSelf as $key => $value ) {
3769 if( is_int( $key ) ) {
3770 $wgGroupsAddToSelf['user'][] = $value;
3775 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3776 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3777 if( is_int( $key ) ) {
3778 $wgGroupsRemoveFromSelf['user'][] = $value;
3783 // Now figure out what groups the user can add to him/herself
3784 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3785 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3786 // No idea WHY this would be used, but it's there
3787 $groups['add-self'] = User
::getAllGroups();
3788 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3789 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3792 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3793 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3794 $groups['remove-self'] = User
::getAllGroups();
3795 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3796 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3803 * Returns an array of groups that this user can add and remove
3804 * @return Array array( 'add' => array( addablegroups ),
3805 * 'remove' => array( removablegroups ),
3806 * 'add-self' => array( addablegroups to self),
3807 * 'remove-self' => array( removable groups from self) )
3809 public function changeableGroups() {
3810 if( $this->isAllowed( 'userrights' ) ) {
3811 // This group gives the right to modify everything (reverse-
3812 // compatibility with old "userrights lets you change
3814 // Using array_merge to make the groups reindexed
3815 $all = array_merge( User
::getAllGroups() );
3819 'add-self' => array(),
3820 'remove-self' => array()
3824 // Okay, it's not so simple, we will have to go through the arrays
3827 'remove' => array(),
3828 'add-self' => array(),
3829 'remove-self' => array()
3831 $addergroups = $this->getEffectiveGroups();
3833 foreach( $addergroups as $addergroup ) {
3834 $groups = array_merge_recursive(
3835 $groups, $this->changeableByGroup( $addergroup )
3837 $groups['add'] = array_unique( $groups['add'] );
3838 $groups['remove'] = array_unique( $groups['remove'] );
3839 $groups['add-self'] = array_unique( $groups['add-self'] );
3840 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3846 * Increment the user's edit-count field.
3847 * Will have no effect for anonymous users.
3849 public function incEditCount() {
3850 if( !$this->isAnon() ) {
3851 $dbw = wfGetDB( DB_MASTER
);
3852 $dbw->update( 'user',
3853 array( 'user_editcount=user_editcount+1' ),
3854 array( 'user_id' => $this->getId() ),
3857 // Lazy initialization check...
3858 if( $dbw->affectedRows() == 0 ) {
3859 // Pull from a slave to be less cruel to servers
3860 // Accuracy isn't the point anyway here
3861 $dbr = wfGetDB( DB_SLAVE
);
3862 $count = $dbr->selectField( 'revision',
3864 array( 'rev_user' => $this->getId() ),
3867 // Now here's a goddamn hack...
3868 if( $dbr !== $dbw ) {
3869 // If we actually have a slave server, the count is
3870 // at least one behind because the current transaction
3871 // has not been committed and replicated.
3874 // But if DB_SLAVE is selecting the master, then the
3875 // count we just read includes the revision that was
3876 // just added in the working transaction.
3879 $dbw->update( 'user',
3880 array( 'user_editcount' => $count ),
3881 array( 'user_id' => $this->getId() ),
3885 // edit count in user cache too
3886 $this->invalidateCache();
3890 * Get the description of a given right
3892 * @param $right String Right to query
3893 * @return String Localized description of the right
3895 public static function getRightDescription( $right ) {
3896 $key = "right-$right";
3897 $msg = wfMessage( $key );
3898 return $msg->isBlank() ?
$right : $msg->text();
3902 * Make an old-style password hash
3904 * @param $password String Plain-text password
3905 * @param $userId String User ID
3906 * @return String Password hash
3908 public static function oldCrypt( $password, $userId ) {
3909 global $wgPasswordSalt;
3910 if ( $wgPasswordSalt ) {
3911 return md5( $userId . '-' . md5( $password ) );
3913 return md5( $password );
3918 * Make a new-style password hash
3920 * @param $password String Plain-text password
3921 * @param bool|string $salt Optional salt, may be random or the user ID.
3923 * If unspecified or false, will generate one automatically
3924 * @return String Password hash
3926 public static function crypt( $password, $salt = false ) {
3927 global $wgPasswordSalt;
3930 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3934 if( $wgPasswordSalt ) {
3935 if ( $salt === false ) {
3936 $salt = substr( wfGenerateToken(), 0, 8 );
3938 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3940 return ':A:' . md5( $password );
3945 * Compare a password hash with a plain-text password. Requires the user
3946 * ID if there's a chance that the hash is an old-style hash.
3948 * @param $hash String Password hash
3949 * @param $password String Plain-text password to compare
3950 * @param $userId String|bool User ID for old-style password salt
3954 public static function comparePasswords( $hash, $password, $userId = false ) {
3955 $type = substr( $hash, 0, 3 );
3958 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3962 if ( $type == ':A:' ) {
3964 return md5( $password ) === substr( $hash, 3 );
3965 } elseif ( $type == ':B:' ) {
3967 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3968 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3971 return self
::oldCrypt( $password, $userId ) === $hash;
3976 * Add a newuser log entry for this user
3978 * @param $byEmail Boolean: account made by email?
3979 * @param $reason String: user supplied reason
3981 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
3983 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3984 global $wgUser, $wgContLang, $wgNewUserLog;
3985 if( empty( $wgNewUserLog ) ) {
3986 return true; // disabled
3989 if( $this->getName() == $wgUser->getName() ) {
3992 $action = 'create2';
3994 if ( $reason === '' ) {
3995 $reason = wfMsgForContent( 'newuserlog-byemail' );
3997 $reason = $wgContLang->commaList( array(
3998 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
4002 $log = new LogPage( 'newusers' );
4003 return (int)$log->addEntry(
4005 $this->getUserPage(),
4007 array( $this->getId() )
4012 * Add an autocreate newuser log entry for this user
4013 * Used by things like CentralAuth and perhaps other authplugins.
4017 public function addNewUserLogEntryAutoCreate() {
4018 global $wgNewUserLog;
4019 if( !$wgNewUserLog ) {
4020 return true; // disabled
4022 $log = new LogPage( 'newusers', false );
4023 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
4030 protected function loadOptions() {
4032 if ( $this->mOptionsLoaded ||
!$this->getId() )
4035 $this->mOptions
= self
::getDefaultOptions();
4037 // Maybe load from the object
4038 if ( !is_null( $this->mOptionOverrides
) ) {
4039 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4040 foreach( $this->mOptionOverrides
as $key => $value ) {
4041 $this->mOptions
[$key] = $value;
4044 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4045 // Load from database
4046 $dbr = wfGetDB( DB_SLAVE
);
4048 $res = $dbr->select(
4051 array( 'up_user' => $this->getId() ),
4055 foreach ( $res as $row ) {
4056 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4057 $this->mOptions
[$row->up_property
] = $row->up_value
;
4061 $this->mOptionsLoaded
= true;
4063 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4069 protected function saveOptions() {
4070 global $wgAllowPrefChange;
4072 $extuser = ExternalUser
::newFromUser( $this );
4074 $this->loadOptions();
4075 $dbw = wfGetDB( DB_MASTER
);
4077 $insert_rows = array();
4079 $saveOptions = $this->mOptions
;
4081 // Allow hooks to abort, for instance to save to a global profile.
4082 // Reset options to default state before saving.
4083 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4087 foreach( $saveOptions as $key => $value ) {
4088 # Don't bother storing default values
4089 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
4090 !( $value === false ||
is_null($value) ) ) ||
4091 $value != self
::getDefaultOption( $key ) ) {
4092 $insert_rows[] = array(
4093 'up_user' => $this->getId(),
4094 'up_property' => $key,
4095 'up_value' => $value,
4098 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4099 switch ( $wgAllowPrefChange[$key] ) {
4105 $extuser->setPref( $key, $value );
4110 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
4111 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4115 * Provide an array of HTML5 attributes to put on an input element
4116 * intended for the user to enter a new password. This may include
4117 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4119 * Do *not* use this when asking the user to enter his current password!
4120 * Regardless of configuration, users may have invalid passwords for whatever
4121 * reason (e.g., they were set before requirements were tightened up).
4122 * Only use it when asking for a new password, like on account creation or
4125 * Obviously, you still need to do server-side checking.
4127 * NOTE: A combination of bugs in various browsers means that this function
4128 * actually just returns array() unconditionally at the moment. May as
4129 * well keep it around for when the browser bugs get fixed, though.
4131 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4133 * @return array Array of HTML attributes suitable for feeding to
4134 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4135 * That will potentially output invalid XHTML 1.0 Transitional, and will
4136 * get confused by the boolean attribute syntax used.)
4138 public static function passwordChangeInputAttribs() {
4139 global $wgMinimalPasswordLength;
4141 if ( $wgMinimalPasswordLength == 0 ) {
4145 # Note that the pattern requirement will always be satisfied if the
4146 # input is empty, so we need required in all cases.
4148 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4149 # if e-mail confirmation is being used. Since HTML5 input validation
4150 # is b0rked anyway in some browsers, just return nothing. When it's
4151 # re-enabled, fix this code to not output required for e-mail
4153 #$ret = array( 'required' );
4156 # We can't actually do this right now, because Opera 9.6 will print out
4157 # the entered password visibly in its error message! When other
4158 # browsers add support for this attribute, or Opera fixes its support,
4159 # we can add support with a version check to avoid doing this on Opera
4160 # versions where it will be a problem. Reported to Opera as
4161 # DSK-262266, but they don't have a public bug tracker for us to follow.
4163 if ( $wgMinimalPasswordLength > 1 ) {
4164 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4165 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4166 $wgMinimalPasswordLength );