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',
157 'userrights-interwiki',
161 * String Cached results of getAllRights()
163 static $mAllRights = false;
165 /** @name Cache variables */
167 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
168 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
169 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides,
170 $mCookiePassword, $mEditCount, $mAllowUsertalk;
174 * Bool Whether the cache variables have been loaded.
180 * Array with already loaded items or true if all items have been loaded.
182 private $mLoadedItems = array();
186 * String Initialization data source if mLoadedItems!==true. May be one of:
187 * - 'defaults' anonymous user initialised from class defaults
188 * - 'name' initialise from mName
189 * - 'id' initialise from mId
190 * - 'session' log in from cookies or session if possible
192 * Use the User::newFrom*() family of functions to set this.
197 * Lazy-initialized variables, invalidated with clearInstanceCache
199 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
200 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
201 $mLocked, $mHideName, $mOptions, $mDisplayName;
216 private $mBlockedFromCreateAccount = false;
218 static $idCacheByName = array();
221 * Lightweight constructor for an anonymous user.
222 * Use the User::newFrom* factory functions for other kinds of users.
226 * @see newFromConfirmationCode()
227 * @see newFromSession()
230 function __construct() {
231 $this->clearInstanceCache( 'defaults' );
237 function __toString(){
238 return $this->getName();
242 * Load the user table data for this object from the source given by mFrom.
244 public function load() {
245 if ( $this->mLoadedItems
=== true ) {
248 wfProfileIn( __METHOD__
);
250 # Set it now to avoid infinite recursion in accessors
251 $this->mLoadedItems
= true;
253 switch ( $this->mFrom
) {
255 $this->loadDefaults();
258 $this->mId
= self
::idFromName( $this->mName
);
260 # Nonexistent user placeholder object
261 $this->loadDefaults( $this->mName
);
270 $this->loadFromSession();
271 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
274 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
276 wfProfileOut( __METHOD__
);
280 * Load user table data, given mId has already been set.
281 * @return Bool false if the ID does not exist, true otherwise
283 public function loadFromId() {
285 if ( $this->mId
== 0 ) {
286 $this->loadDefaults();
291 $key = wfMemcKey( 'user', 'id', $this->mId
);
292 $data = $wgMemc->get( $key );
293 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
294 # Object is expired, load from DB
299 wfDebug( "User: cache miss for user {$this->mId}\n" );
301 if ( !$this->loadFromDatabase() ) {
302 # Can't load from ID, user is anonymous
305 $this->saveToCache();
307 wfDebug( "User: got user {$this->mId} from cache\n" );
309 foreach ( self
::$mCacheVars as $name ) {
310 $this->$name = $data[$name];
317 * Save user data to the shared cache
319 public function saveToCache() {
322 $this->loadOptions();
323 if ( $this->isAnon() ) {
324 // Anonymous users are uncached
328 foreach ( self
::$mCacheVars as $name ) {
329 $data[$name] = $this->$name;
331 $data['mVersion'] = MW_USER_VERSION
;
332 $key = wfMemcKey( 'user', 'id', $this->mId
);
334 $wgMemc->set( $key, $data );
337 /** @name newFrom*() static factory methods */
341 * Static factory method for creation from username.
343 * This is slightly less efficient than newFromId(), so use newFromId() if
344 * you have both an ID and a name handy.
346 * @param $name String Username, validated by Title::newFromText()
347 * @param $validate String|Bool Validate username. Takes the same parameters as
348 * User::getCanonicalName(), except that true is accepted as an alias
349 * for 'valid', for BC.
351 * @return User object, or false if the username is invalid
352 * (e.g. if it contains illegal characters or is an IP address). If the
353 * username is not present in the database, the result will be a user object
354 * with a name, zero user ID and default settings.
356 public static function newFromName( $name, $validate = 'valid' ) {
357 if ( $validate === true ) {
360 $name = self
::getCanonicalName( $name, $validate );
361 if ( $name === false ) {
364 # Create unloaded user object
368 $u->setItemLoaded( 'name' );
374 * Static factory method for creation from a given user ID.
376 * @param $id Int Valid user ID
377 * @return User The corresponding User object
379 public static function newFromId( $id ) {
383 $u->setItemLoaded( 'id' );
388 * Factory method to fetch whichever user has a given email confirmation code.
389 * This code is generated when an account is created or its e-mail address
392 * If the code is invalid or has expired, returns NULL.
394 * @param $code String Confirmation code
395 * @return User object, or null
397 public static function newFromConfirmationCode( $code ) {
398 $dbr = wfGetDB( DB_SLAVE
);
399 $id = $dbr->selectField( 'user', 'user_id', array(
400 'user_email_token' => md5( $code ),
401 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
403 if( $id !== false ) {
404 return User
::newFromId( $id );
411 * Create a new user object using data from session or cookies. If the
412 * login credentials are invalid, the result is an anonymous user.
414 * @param $request WebRequest object to use; $wgRequest will be used if
416 * @return User object
418 public static function newFromSession( WebRequest
$request = null ) {
420 $user->mFrom
= 'session';
421 $user->mRequest
= $request;
426 * Create a new user object from a user row.
427 * The row should have the following fields from the user table in it:
428 * - either user_name or user_id to load further data if needed (or both)
430 * - all other fields (email, password, etc.)
431 * It is useless to provide the remaining fields if either user_id,
432 * user_name and user_real_name are not provided because the whole row
433 * will be loaded once more from the database when accessing them.
435 * @param $row Array A row from the user table
438 public static function newFromRow( $row ) {
440 $user->loadFromRow( $row );
447 * Get the username corresponding to a given user ID
448 * @param $id Int User ID
449 * @return String|false The corresponding username
451 public static function whoIs( $id ) {
452 $dbr = wfGetDB( DB_SLAVE
);
453 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
457 * Get the real name of a user given their user ID
459 * @param $id Int User ID
460 * @return String|false The corresponding user's real name
462 public static function whoIsReal( $id ) {
463 $dbr = wfGetDB( DB_SLAVE
);
464 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
468 * Get database id given a user name
469 * @param $name String Username
470 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
472 public static function idFromName( $name ) {
473 $nt = Title
::makeTitleSafe( NS_USER
, $name );
474 if( is_null( $nt ) ) {
479 if ( isset( self
::$idCacheByName[$name] ) ) {
480 return self
::$idCacheByName[$name];
483 $dbr = wfGetDB( DB_SLAVE
);
484 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
486 if ( $s === false ) {
489 $result = $s->user_id
;
492 self
::$idCacheByName[$name] = $result;
494 if ( count( self
::$idCacheByName ) > 1000 ) {
495 self
::$idCacheByName = array();
502 * Reset the cache used in idFromName(). For use in tests.
504 public static function resetIdByNameCache() {
505 self
::$idCacheByName = array();
509 * Does the string match an anonymous IPv4 address?
511 * This function exists for username validation, in order to reject
512 * usernames which are similar in form to IP addresses. Strings such
513 * as 300.300.300.300 will return true because it looks like an IP
514 * address, despite not being strictly valid.
516 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
517 * address because the usemod software would "cloak" anonymous IP
518 * addresses like this, if we allowed accounts like this to be created
519 * new users could get the old edits of these anonymous users.
521 * @param $name String to match
524 public static function isIP( $name ) {
525 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
529 * Is the input a valid username?
531 * Checks if the input is a valid username, we don't want an empty string,
532 * an IP address, anything that containins slashes (would mess up subpages),
533 * is longer than the maximum allowed username size or doesn't begin with
536 * @param $name String to match
539 public static function isValidUserName( $name ) {
540 global $wgContLang, $wgMaxNameChars;
543 || User
::isIP( $name )
544 ||
strpos( $name, '/' ) !== false
545 ||
strlen( $name ) > $wgMaxNameChars
546 ||
$name != $wgContLang->ucfirst( $name ) ) {
547 wfDebugLog( 'username', __METHOD__
.
548 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
552 // Ensure that the name can't be misresolved as a different title,
553 // such as with extra namespace keys at the start.
554 $parsed = Title
::newFromText( $name );
555 if( is_null( $parsed )
556 ||
$parsed->getNamespace()
557 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
558 wfDebugLog( 'username', __METHOD__
.
559 ": '$name' invalid due to ambiguous prefixes" );
563 // Check an additional blacklist of troublemaker characters.
564 // Should these be merged into the title char list?
565 $unicodeBlacklist = '/[' .
566 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
567 '\x{00a0}' . # non-breaking space
568 '\x{2000}-\x{200f}' . # various whitespace
569 '\x{2028}-\x{202f}' . # breaks and control chars
570 '\x{3000}' . # ideographic space
571 '\x{e000}-\x{f8ff}' . # private use
573 if( preg_match( $unicodeBlacklist, $name ) ) {
574 wfDebugLog( 'username', __METHOD__
.
575 ": '$name' invalid due to blacklisted characters" );
583 * Usernames which fail to pass this function will be blocked
584 * from user login and new account registrations, but may be used
585 * internally by batch processes.
587 * If an account already exists in this form, login will be blocked
588 * by a failure to pass this function.
590 * @param $name String to match
593 public static function isUsableName( $name ) {
594 global $wgReservedUsernames;
595 // Must be a valid username, obviously ;)
596 if ( !self
::isValidUserName( $name ) ) {
600 static $reservedUsernames = false;
601 if ( !$reservedUsernames ) {
602 $reservedUsernames = $wgReservedUsernames;
603 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
606 // Certain names may be reserved for batch processes.
607 foreach ( $reservedUsernames as $reserved ) {
608 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
609 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
611 if ( $reserved == $name ) {
619 * Usernames which fail to pass this function will be blocked
620 * from new account registrations, but may be used internally
621 * either by batch processes or by user accounts which have
622 * already been created.
624 * Additional blacklisting may be added here rather than in
625 * isValidUserName() to avoid disrupting existing accounts.
627 * @param $name String to match
630 public static function isCreatableName( $name ) {
631 global $wgInvalidUsernameCharacters;
633 // Ensure that the username isn't longer than 235 bytes, so that
634 // (at least for the builtin skins) user javascript and css files
635 // will work. (bug 23080)
636 if( strlen( $name ) > 235 ) {
637 wfDebugLog( 'username', __METHOD__
.
638 ": '$name' invalid due to length" );
642 // Preg yells if you try to give it an empty string
643 if( $wgInvalidUsernameCharacters !== '' ) {
644 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
645 wfDebugLog( 'username', __METHOD__
.
646 ": '$name' invalid due to wgInvalidUsernameCharacters" );
651 return self
::isUsableName( $name );
655 * Is the input a valid password for this user?
657 * @param $password String Desired password
660 public function isValidPassword( $password ) {
661 //simple boolean wrapper for getPasswordValidity
662 return $this->getPasswordValidity( $password ) === true;
666 * Given unvalidated password input, return error message on failure.
668 * @param $password String Desired password
669 * @return mixed: true on success, string or array of error message on failure
671 public function getPasswordValidity( $password ) {
672 global $wgMinimalPasswordLength, $wgContLang;
674 static $blockedLogins = array(
675 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
676 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
679 $result = false; //init $result to false for the internal checks
681 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
684 if ( $result === false ) {
685 if( strlen( $password ) < $wgMinimalPasswordLength ) {
686 return 'passwordtooshort';
687 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
688 return 'password-name-match';
689 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
690 return 'password-login-forbidden';
692 //it seems weird returning true here, but this is because of the
693 //initialization of $result to false above. If the hook is never run or it
694 //doesn't modify $result, then we will likely get down into this if with
698 } elseif( $result === true ) {
701 return $result; //the isValidPassword hook set a string $result and returned true
706 * Does a string look like an e-mail address?
708 * This validates an email address using an HTML5 specification found at:
709 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
710 * Which as of 2011-01-24 says:
712 * A valid e-mail address is a string that matches the ABNF production
713 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
714 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
717 * This function is an implementation of the specification as requested in
720 * Client-side forms will use the same standard validation rules via JS or
721 * HTML 5 validation; additional restrictions can be enforced server-side
722 * by extensions via the 'isValidEmailAddr' hook.
724 * Note that this validation doesn't 100% match RFC 2822, but is believed
725 * to be liberal enough for wide use. Some invalid addresses will still
726 * pass validation here.
728 * @param $addr String E-mail address
730 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
732 public static function isValidEmailAddr( $addr ) {
733 return Sanitizer
::validateEmail( $addr );
737 * Given unvalidated user input, return a canonical username, or false if
738 * the username is invalid.
739 * @param $name String User input
740 * @param $validate String|Bool type of validation to use:
741 * - false No validation
742 * - 'valid' Valid for batch processes
743 * - 'usable' Valid for batch processes and login
744 * - 'creatable' Valid for batch processes, login and account creation
746 * @return bool|string
748 public static function getCanonicalName( $name, $validate = 'valid' ) {
749 # Force usernames to capital
751 $name = $wgContLang->ucfirst( $name );
753 # Reject names containing '#'; these will be cleaned up
754 # with title normalisation, but then it's too late to
756 if( strpos( $name, '#' ) !== false )
759 # Clean up name according to title rules
760 $t = ( $validate === 'valid' ) ?
761 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
762 # Check for invalid titles
763 if( is_null( $t ) ) {
767 # Reject various classes of invalid names
769 $name = $wgAuth->getCanonicalName( $t->getText() );
771 switch ( $validate ) {
775 if ( !User
::isValidUserName( $name ) ) {
780 if ( !User
::isUsableName( $name ) ) {
785 if ( !User
::isCreatableName( $name ) ) {
790 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
796 * Count the number of edits of a user
797 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
799 * @param $uid Int User ID to check
800 * @return Int the user's edit count
802 public static function edits( $uid ) {
803 wfProfileIn( __METHOD__
);
804 $dbr = wfGetDB( DB_SLAVE
);
805 // check if the user_editcount field has been initialized
806 $field = $dbr->selectField(
807 'user', 'user_editcount',
808 array( 'user_id' => $uid ),
812 if( $field === null ) { // it has not been initialized. do so.
813 $dbw = wfGetDB( DB_MASTER
);
814 $count = $dbr->selectField(
815 'revision', 'count(*)',
816 array( 'rev_user' => $uid ),
821 array( 'user_editcount' => $count ),
822 array( 'user_id' => $uid ),
828 wfProfileOut( __METHOD__
);
833 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
834 * @todo hash random numbers to improve security, like generateToken()
836 * @return String new random password
838 public static function randomPassword() {
839 global $wgMinimalPasswordLength;
840 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
841 $l = strlen( $pwchars ) - 1;
843 $pwlength = max( 7, $wgMinimalPasswordLength );
844 $digit = mt_rand( 0, $pwlength - 1 );
846 for ( $i = 0; $i < $pwlength; $i++
) {
847 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars[ mt_rand( 0, $l ) ];
853 * Set cached properties to default.
855 * @note This no longer clears uncached lazy-initialised properties;
856 * the constructor does that instead.
858 * @param $name string
860 public function loadDefaults( $name = false ) {
861 wfProfileIn( __METHOD__
);
864 $this->mName
= $name;
865 $this->mRealName
= '';
866 $this->mPassword
= $this->mNewpassword
= '';
867 $this->mNewpassTime
= null;
869 $this->mOptionOverrides
= null;
870 $this->mOptionsLoaded
= false;
872 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
873 if( $loggedOut !== null ) {
874 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
876 $this->mTouched
= '0'; # Allow any pages to be cached
879 $this->setToken(); # Random
880 $this->mEmailAuthenticated
= null;
881 $this->mEmailToken
= '';
882 $this->mEmailTokenExpires
= null;
883 $this->mRegistration
= wfTimestamp( TS_MW
);
884 $this->mGroups
= array();
886 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
888 wfProfileOut( __METHOD__
);
892 * Return whether an item has been loaded.
894 * @param $item String: item to check. Current possibilities:
898 * @param $all String: 'all' to check if the whole object has been loaded
899 * or any other string to check if only the item is available (e.g.
903 public function isItemLoaded( $item, $all = 'all' ) {
904 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
905 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
909 * Set that an item has been loaded
911 * @param $item String
913 private function setItemLoaded( $item ) {
914 if ( is_array( $this->mLoadedItems
) ) {
915 $this->mLoadedItems
[$item] = true;
920 * Load user data from the session or login cookie. If there are no valid
921 * credentials, initialises the user as an anonymous user.
922 * @return Bool True if the user is logged in, false otherwise.
924 private function loadFromSession() {
925 global $wgExternalAuthType, $wgAutocreatePolicy;
928 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
929 if ( $result !== null ) {
933 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
934 $extUser = ExternalUser
::newFromCookie();
936 # TODO: Automatically create the user here (or probably a bit
937 # lower down, in fact)
941 $request = $this->getRequest();
943 $cookieId = $request->getCookie( 'UserID' );
944 $sessId = $request->getSessionData( 'wsUserID' );
946 if ( $cookieId !== null ) {
947 $sId = intval( $cookieId );
948 if( $sessId !== null && $cookieId != $sessId ) {
949 $this->loadDefaults(); // Possible collision!
950 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
951 cookie user ID ($sId) don't match!" );
954 $request->setSessionData( 'wsUserID', $sId );
955 } elseif ( $sessId !== null && $sessId != 0 ) {
958 $this->loadDefaults();
962 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
963 $sName = $request->getSessionData( 'wsUserName' );
964 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
965 $sName = $request->getCookie( 'UserName' );
966 $request->setSessionData( 'wsUserName', $sName );
968 $this->loadDefaults();
972 $proposedUser = User
::newFromId( $sId );
973 if ( !$proposedUser->isLoggedIn() ) {
975 $this->loadDefaults();
979 global $wgBlockDisablesLogin;
980 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
981 # User blocked and we've disabled blocked user logins
982 $this->loadDefaults();
986 if ( $request->getSessionData( 'wsToken' ) !== null ) {
987 $passwordCorrect = $proposedUser->getToken() === $request->getSessionData( 'wsToken' );
989 } elseif ( $request->getCookie( 'Token' ) !== null ) {
990 $passwordCorrect = $proposedUser->getToken() === $request->getCookie( 'Token' );
993 # No session or persistent login cookie
994 $this->loadDefaults();
998 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
999 $this->loadFromUserObject( $proposedUser );
1000 $request->setSessionData( 'wsToken', $this->mToken
);
1001 wfDebug( "User: logged in from $from\n" );
1004 # Invalid credentials
1005 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1006 $this->loadDefaults();
1012 * Load user and user_group data from the database.
1013 * $this->mId must be set, this is how the user is identified.
1015 * @return Bool True if the user exists, false if the user is anonymous
1017 public function loadFromDatabase() {
1019 $this->mId
= intval( $this->mId
);
1021 /** Anonymous user */
1023 $this->loadDefaults();
1027 $dbr = wfGetDB( DB_MASTER
);
1028 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
1030 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1032 if ( $s !== false ) {
1033 # Initialise user table data
1034 $this->loadFromRow( $s );
1035 $this->mGroups
= null; // deferred
1036 $this->getEditCount(); // revalidation for nulls
1041 $this->loadDefaults();
1047 * Initialize this object from a row from the user table.
1049 * @param $row Array Row from the user table to load.
1051 public function loadFromRow( $row ) {
1054 $this->mGroups
= null; // deferred
1056 if ( isset( $row->user_name
) ) {
1057 $this->mName
= $row->user_name
;
1058 $this->mFrom
= 'name';
1059 $this->setItemLoaded( 'name' );
1064 if ( isset( $row->user_real_name
) ) {
1065 $this->mRealName
= $row->user_real_name
;
1066 $this->setItemLoaded( 'realname' );
1071 if ( isset( $row->user_id
) ) {
1072 $this->mId
= intval( $row->user_id
);
1073 $this->mFrom
= 'id';
1074 $this->setItemLoaded( 'id' );
1079 if ( isset( $row->user_editcount
) ) {
1080 $this->mEditCount
= $row->user_editcount
;
1085 if ( isset( $row->user_password
) ) {
1086 $this->mPassword
= $row->user_password
;
1087 $this->mNewpassword
= $row->user_newpassword
;
1088 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1089 $this->mEmail
= $row->user_email
;
1090 if ( isset( $row->user_options
) ) {
1091 $this->decodeOptions( $row->user_options
);
1093 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1094 $this->mToken
= $row->user_token
;
1095 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1096 $this->mEmailToken
= $row->user_email_token
;
1097 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1098 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1104 $this->mLoadedItems
= true;
1109 * Load the data for this user object from another user object.
1113 protected function loadFromUserObject( $user ) {
1115 $user->loadGroups();
1116 $user->loadOptions();
1117 foreach ( self
::$mCacheVars as $var ) {
1118 $this->$var = $user->$var;
1123 * Load the groups from the database if they aren't already loaded.
1125 private function loadGroups() {
1126 if ( is_null( $this->mGroups
) ) {
1127 $dbr = wfGetDB( DB_MASTER
);
1128 $res = $dbr->select( 'user_groups',
1129 array( 'ug_group' ),
1130 array( 'ug_user' => $this->mId
),
1132 $this->mGroups
= array();
1133 foreach ( $res as $row ) {
1134 $this->mGroups
[] = $row->ug_group
;
1140 * Add the user to the group if he/she meets given criteria.
1142 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1143 * possible to remove manually via Special:UserRights. In such case it
1144 * will not be re-added automatically. The user will also not lose the
1145 * group if they no longer meet the criteria.
1147 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1149 * @return array Array of groups the user has been promoted to.
1151 * @see $wgAutopromoteOnce
1153 public function addAutopromoteOnceGroups( $event ) {
1154 global $wgAutopromoteOnceLogInRC;
1156 $toPromote = array();
1157 if ( $this->getId() ) {
1158 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1159 if ( count( $toPromote ) ) {
1160 $oldGroups = $this->getGroups(); // previous groups
1161 foreach ( $toPromote as $group ) {
1162 $this->addGroup( $group );
1164 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1166 $log = new LogPage( 'rights', $wgAutopromoteOnceLogInRC /* in RC? */ );
1167 $log->addEntry( 'autopromote',
1168 $this->getUserPage(),
1170 // These group names are "list to texted"-ed in class LogPage.
1171 array( implode( ', ', $oldGroups ), implode( ', ', $newGroups ) )
1179 * Clear various cached data stored in this object.
1180 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1181 * given source. May be "name", "id", "defaults", "session", or false for
1184 public function clearInstanceCache( $reloadFrom = false ) {
1185 $this->mNewtalk
= -1;
1186 $this->mDatePreference
= null;
1187 $this->mBlockedby
= -1; # Unset
1188 $this->mHash
= false;
1189 $this->mRights
= null;
1190 $this->mEffectiveGroups
= null;
1191 $this->mImplicitGroups
= null;
1192 $this->mOptions
= null;
1193 $this->mDisplayName
= null;
1195 if ( $reloadFrom ) {
1196 $this->mLoadedItems
= array();
1197 $this->mFrom
= $reloadFrom;
1202 * Combine the language default options with any site-specific options
1203 * and add the default language variants.
1205 * @return Array of String options
1207 public static function getDefaultOptions() {
1208 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1210 $defOpt = $wgDefaultUserOptions;
1211 # default language setting
1212 $variant = $wgContLang->getDefaultVariant();
1213 $defOpt['variant'] = $variant;
1214 $defOpt['language'] = $variant;
1215 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1216 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1218 $defOpt['skin'] = $wgDefaultSkin;
1220 // FIXME: Ideally we'd cache the results of this function so the hook is only run once,
1221 // but that breaks the parser tests because they rely on being able to change $wgContLang
1222 // mid-request and see that change reflected in the return value of this function.
1223 // Which is insane and would never happen during normal MW operation, but is also not
1224 // likely to get fixed unless and until we context-ify everything.
1225 // See also https://www.mediawiki.org/wiki/Special:Code/MediaWiki/101488#c25275
1226 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1232 * Get a given default option value.
1234 * @param $opt String Name of option to retrieve
1235 * @return String Default option value
1237 public static function getDefaultOption( $opt ) {
1238 $defOpts = self
::getDefaultOptions();
1239 if( isset( $defOpts[$opt] ) ) {
1240 return $defOpts[$opt];
1248 * Get blocking information
1249 * @param $bFromSlave Bool Whether to check the slave database first. To
1250 * improve performance, non-critical checks are done
1251 * against slaves. Check when actually saving should be
1252 * done against master.
1254 private function getBlockedStatus( $bFromSlave = true ) {
1255 global $wgProxyWhitelist, $wgUser;
1257 if ( -1 != $this->mBlockedby
) {
1261 wfProfileIn( __METHOD__
);
1262 wfDebug( __METHOD__
.": checking...\n" );
1264 // Initialize data...
1265 // Otherwise something ends up stomping on $this->mBlockedby when
1266 // things get lazy-loaded later, causing false positive block hits
1267 // due to -1 !== 0. Probably session-related... Nothing should be
1268 // overwriting mBlockedby, surely?
1271 $this->mBlockedby
= 0;
1272 $this->mHideName
= 0;
1273 $this->mAllowUsertalk
= 0;
1275 # We only need to worry about passing the IP address to the Block generator if the
1276 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1277 # know which IP address they're actually coming from
1278 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1279 $ip = $this->getRequest()->getIP();
1285 $this->mBlock
= Block
::newFromTarget( $this->getName(), $ip, !$bFromSlave );
1286 if ( $this->mBlock
instanceof Block
) {
1287 wfDebug( __METHOD__
. ": Found block.\n" );
1288 $this->mBlockedby
= $this->mBlock
->getByName();
1289 $this->mBlockreason
= $this->mBlock
->mReason
;
1290 $this->mHideName
= $this->mBlock
->mHideName
;
1291 $this->mAllowUsertalk
= !$this->mBlock
->prevents( 'editownusertalk' );
1295 if ( $ip !== null && !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1297 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1298 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1299 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1303 if ( !$this->mBlockedby
&& !$this->getID() ) {
1304 if ( $this->isDnsBlacklisted( $ip ) ) {
1305 $this->mBlockedby
= wfMsg( 'sorbs' );
1306 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1312 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1314 wfProfileOut( __METHOD__
);
1318 * Whether the given IP is in a DNS blacklist.
1320 * @param $ip String IP to check
1321 * @param $checkWhitelist Bool: whether to check the whitelist first
1322 * @return Bool True if blacklisted.
1324 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1325 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1326 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1328 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1331 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1334 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1335 return $this->inDnsBlacklist( $ip, $urls );
1339 * Whether the given IP is in a given DNS blacklist.
1341 * @param $ip String IP to check
1342 * @param $bases String|Array of Strings: URL of the DNS blacklist
1343 * @return Bool True if blacklisted.
1345 public function inDnsBlacklist( $ip, $bases ) {
1346 wfProfileIn( __METHOD__
);
1349 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1350 if( IP
::isIPv4( $ip ) ) {
1351 # Reverse IP, bug 21255
1352 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1354 foreach( (array)$bases as $base ) {
1356 # If we have an access key, use that too (ProjectHoneypot, etc.)
1357 if( is_array( $base ) ) {
1358 if( count( $base ) >= 2 ) {
1359 # Access key is 1, base URL is 0
1360 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1362 $host = "$ipReversed.{$base[0]}";
1365 $host = "$ipReversed.$base";
1369 $ipList = gethostbynamel( $host );
1372 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1376 wfDebug( "Requested $host, not found in $base.\n" );
1381 wfProfileOut( __METHOD__
);
1386 * Check if an IP address is in the local proxy list
1392 public static function isLocallyBlockedProxy( $ip ) {
1393 global $wgProxyList;
1395 if ( !$wgProxyList ) {
1398 wfProfileIn( __METHOD__
);
1400 if ( !is_array( $wgProxyList ) ) {
1401 # Load from the specified file
1402 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1405 if ( !is_array( $wgProxyList ) ) {
1407 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1409 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1410 # Old-style flipped proxy list
1415 wfProfileOut( __METHOD__
);
1420 * Is this user subject to rate limiting?
1422 * @return Bool True if rate limited
1424 public function isPingLimitable() {
1425 global $wgRateLimitsExcludedIPs;
1426 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1427 // No other good way currently to disable rate limits
1428 // for specific IPs. :P
1429 // But this is a crappy hack and should die.
1432 return !$this->isAllowed('noratelimit');
1436 * Primitive rate limits: enforce maximum actions per time period
1437 * to put a brake on flooding.
1439 * @note When using a shared cache like memcached, IP-address
1440 * last-hit counters will be shared across wikis.
1442 * @param $action String Action to enforce; 'edit' if unspecified
1443 * @return Bool True if a rate limiter was tripped
1445 public function pingLimiter( $action = 'edit' ) {
1446 # Call the 'PingLimiter' hook
1448 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1452 global $wgRateLimits;
1453 if( !isset( $wgRateLimits[$action] ) ) {
1457 # Some groups shouldn't trigger the ping limiter, ever
1458 if( !$this->isPingLimitable() )
1461 global $wgMemc, $wgRateLimitLog;
1462 wfProfileIn( __METHOD__
);
1464 $limits = $wgRateLimits[$action];
1466 $id = $this->getId();
1467 $ip = $this->getRequest()->getIP();
1470 if( isset( $limits['anon'] ) && $id == 0 ) {
1471 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1474 if( isset( $limits['user'] ) && $id != 0 ) {
1475 $userLimit = $limits['user'];
1477 if( $this->isNewbie() ) {
1478 if( isset( $limits['newbie'] ) && $id != 0 ) {
1479 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1481 if( isset( $limits['ip'] ) ) {
1482 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1485 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1486 $subnet = $matches[1];
1487 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1490 // Check for group-specific permissions
1491 // If more than one group applies, use the group with the highest limit
1492 foreach ( $this->getGroups() as $group ) {
1493 if ( isset( $limits[$group] ) ) {
1494 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1495 $userLimit = $limits[$group];
1499 // Set the user limit key
1500 if ( $userLimit !== false ) {
1501 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1502 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1506 foreach( $keys as $key => $limit ) {
1507 list( $max, $period ) = $limit;
1508 $summary = "(limit $max in {$period}s)";
1509 $count = $wgMemc->get( $key );
1512 if( $count > $max ) {
1513 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1514 if( $wgRateLimitLog ) {
1515 wfSuppressWarnings();
1516 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1517 wfRestoreWarnings();
1521 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1524 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1525 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1527 $wgMemc->incr( $key );
1530 wfProfileOut( __METHOD__
);
1535 * Check if user is blocked
1537 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1538 * @return Bool True if blocked, false otherwise
1540 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1541 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1545 * Get the block affecting the user, or null if the user is not blocked
1547 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1548 * @return Block|null
1550 public function getBlock( $bFromSlave = true ){
1551 $this->getBlockedStatus( $bFromSlave );
1552 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1556 * Check if user is blocked from editing a particular article
1558 * @param $title Title to check
1559 * @param $bFromSlave Bool whether to check the slave database instead of the master
1562 function isBlockedFrom( $title, $bFromSlave = false ) {
1563 global $wgBlockAllowsUTEdit;
1564 wfProfileIn( __METHOD__
);
1566 $blocked = $this->isBlocked( $bFromSlave );
1567 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1568 # If a user's name is suppressed, they cannot make edits anywhere
1569 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1570 $title->getNamespace() == NS_USER_TALK
) {
1572 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1575 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1577 wfProfileOut( __METHOD__
);
1582 * If user is blocked, return the name of the user who placed the block
1583 * @return String name of blocker
1585 public function blockedBy() {
1586 $this->getBlockedStatus();
1587 return $this->mBlockedby
;
1591 * If user is blocked, return the specified reason for the block
1592 * @return String Blocking reason
1594 public function blockedFor() {
1595 $this->getBlockedStatus();
1596 return $this->mBlockreason
;
1600 * If user is blocked, return the ID for the block
1601 * @return Int Block ID
1603 public function getBlockId() {
1604 $this->getBlockedStatus();
1605 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1609 * Check if user is blocked on all wikis.
1610 * Do not use for actual edit permission checks!
1611 * This is intented for quick UI checks.
1613 * @param $ip String IP address, uses current client if none given
1614 * @return Bool True if blocked, false otherwise
1616 public function isBlockedGlobally( $ip = '' ) {
1617 if( $this->mBlockedGlobally
!== null ) {
1618 return $this->mBlockedGlobally
;
1620 // User is already an IP?
1621 if( IP
::isIPAddress( $this->getName() ) ) {
1622 $ip = $this->getName();
1624 $ip = $this->getRequest()->getIP();
1627 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1628 $this->mBlockedGlobally
= (bool)$blocked;
1629 return $this->mBlockedGlobally
;
1633 * Check if user account is locked
1635 * @return Bool True if locked, false otherwise
1637 public function isLocked() {
1638 if( $this->mLocked
!== null ) {
1639 return $this->mLocked
;
1642 $authUser = $wgAuth->getUserInstance( $this );
1643 $this->mLocked
= (bool)$authUser->isLocked();
1644 return $this->mLocked
;
1648 * Check if user account is hidden
1650 * @return Bool True if hidden, false otherwise
1652 public function isHidden() {
1653 if( $this->mHideName
!== null ) {
1654 return $this->mHideName
;
1656 $this->getBlockedStatus();
1657 if( !$this->mHideName
) {
1659 $authUser = $wgAuth->getUserInstance( $this );
1660 $this->mHideName
= (bool)$authUser->isHidden();
1662 return $this->mHideName
;
1666 * Get the user's ID.
1667 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1669 public function getId() {
1670 if( $this->mId
=== null && $this->mName
!== null
1671 && User
::isIP( $this->mName
) ) {
1672 // Special case, we know the user is anonymous
1674 } elseif( !$this->isItemLoaded( 'id' ) ) {
1675 // Don't load if this was initialized from an ID
1682 * Set the user and reload all fields according to a given ID
1683 * @param $v Int User ID to reload
1685 public function setId( $v ) {
1687 $this->clearInstanceCache( 'id' );
1691 * Get the user name, or the IP of an anonymous user
1692 * @return String User's name or IP address
1694 public function getName() {
1695 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1696 # Special case optimisation
1697 return $this->mName
;
1700 if ( $this->mName
=== false ) {
1702 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1704 return $this->mName
;
1709 * Set the user name.
1711 * This does not reload fields from the database according to the given
1712 * name. Rather, it is used to create a temporary "nonexistent user" for
1713 * later addition to the database. It can also be used to set the IP
1714 * address for an anonymous user to something other than the current
1717 * @note User::newFromName() has rougly the same function, when the named user
1719 * @param $str String New user name to set
1721 public function setName( $str ) {
1723 $this->mName
= $str;
1727 * Get the user's name escaped by underscores.
1728 * @return String Username escaped by underscores.
1730 public function getTitleKey() {
1731 return str_replace( ' ', '_', $this->getName() );
1735 * Check if the user has new messages.
1736 * @return Bool True if the user has new messages
1738 public function getNewtalk() {
1741 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1742 if( $this->mNewtalk
=== -1 ) {
1743 $this->mNewtalk
= false; # reset talk page status
1745 # Check memcached separately for anons, who have no
1746 # entire User object stored in there.
1749 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1750 $newtalk = $wgMemc->get( $key );
1751 if( strval( $newtalk ) !== '' ) {
1752 $this->mNewtalk
= (bool)$newtalk;
1754 // Since we are caching this, make sure it is up to date by getting it
1756 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1757 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1760 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1764 return (bool)$this->mNewtalk
;
1768 * Return the talk page(s) this user has new messages on.
1769 * @return Array of String page URLs
1771 public function getNewMessageLinks() {
1773 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1776 if( !$this->getNewtalk() )
1778 $up = $this->getUserPage();
1779 $utp = $up->getTalkPage();
1780 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1784 * Internal uncached check for new messages
1787 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1788 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1789 * @param $fromMaster Bool true to fetch from the master, false for a slave
1790 * @return Bool True if the user has new messages
1792 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1793 if ( $fromMaster ) {
1794 $db = wfGetDB( DB_MASTER
);
1796 $db = wfGetDB( DB_SLAVE
);
1798 $ok = $db->selectField( 'user_newtalk', $field,
1799 array( $field => $id ), __METHOD__
);
1800 return $ok !== false;
1804 * Add or update the new messages flag
1805 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1806 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1807 * @return Bool True if successful, false otherwise
1809 protected function updateNewtalk( $field, $id ) {
1810 $dbw = wfGetDB( DB_MASTER
);
1811 $dbw->insert( 'user_newtalk',
1812 array( $field => $id ),
1815 if ( $dbw->affectedRows() ) {
1816 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1819 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1825 * Clear the new messages flag for the given user
1826 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1827 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1828 * @return Bool True if successful, false otherwise
1830 protected function deleteNewtalk( $field, $id ) {
1831 $dbw = wfGetDB( DB_MASTER
);
1832 $dbw->delete( 'user_newtalk',
1833 array( $field => $id ),
1835 if ( $dbw->affectedRows() ) {
1836 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1839 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1845 * Update the 'You have new messages!' status.
1846 * @param $val Bool Whether the user has new messages
1848 public function setNewtalk( $val ) {
1849 if( wfReadOnly() ) {
1854 $this->mNewtalk
= $val;
1856 if( $this->isAnon() ) {
1858 $id = $this->getName();
1861 $id = $this->getId();
1866 $changed = $this->updateNewtalk( $field, $id );
1868 $changed = $this->deleteNewtalk( $field, $id );
1871 if( $this->isAnon() ) {
1872 // Anons have a separate memcached space, since
1873 // user records aren't kept for them.
1874 $key = wfMemcKey( 'newtalk', 'ip', $id );
1875 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1878 $this->invalidateCache();
1883 * Generate a current or new-future timestamp to be stored in the
1884 * user_touched field when we update things.
1885 * @return String Timestamp in TS_MW format
1887 private static function newTouchedTimestamp() {
1888 global $wgClockSkewFudge;
1889 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1893 * Clear user data from memcached.
1894 * Use after applying fun updates to the database; caller's
1895 * responsibility to update user_touched if appropriate.
1897 * Called implicitly from invalidateCache() and saveSettings().
1899 private function clearSharedCache() {
1903 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1908 * Immediately touch the user data cache for this account.
1909 * Updates user_touched field, and removes account data from memcached
1910 * for reload on the next hit.
1912 public function invalidateCache() {
1913 if( wfReadOnly() ) {
1918 $this->mTouched
= self
::newTouchedTimestamp();
1920 $dbw = wfGetDB( DB_MASTER
);
1921 $dbw->update( 'user',
1922 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1923 array( 'user_id' => $this->mId
),
1926 $this->clearSharedCache();
1931 * Validate the cache for this account.
1932 * @param $timestamp String A timestamp in TS_MW format
1936 public function validateCache( $timestamp ) {
1938 return ( $timestamp >= $this->mTouched
);
1942 * Get the user touched timestamp
1943 * @return String timestamp
1945 public function getTouched() {
1947 return $this->mTouched
;
1951 * Set the password and reset the random token.
1952 * Calls through to authentication plugin if necessary;
1953 * will have no effect if the auth plugin refuses to
1954 * pass the change through or if the legal password
1957 * As a special case, setting the password to null
1958 * wipes it, so the account cannot be logged in until
1959 * a new password is set, for instance via e-mail.
1961 * @param $str String New password to set
1962 * @throws PasswordError on failure
1966 public function setPassword( $str ) {
1969 if( $str !== null ) {
1970 if( !$wgAuth->allowPasswordChange() ) {
1971 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1974 if( !$this->isValidPassword( $str ) ) {
1975 global $wgMinimalPasswordLength;
1976 $valid = $this->getPasswordValidity( $str );
1977 if ( is_array( $valid ) ) {
1978 $message = array_shift( $valid );
1982 $params = array( $wgMinimalPasswordLength );
1984 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
1988 if( !$wgAuth->setPassword( $this, $str ) ) {
1989 throw new PasswordError( wfMsg( 'externaldberror' ) );
1992 $this->setInternalPassword( $str );
1998 * Set the password and reset the random token unconditionally.
2000 * @param $str String New password to set
2002 public function setInternalPassword( $str ) {
2006 if( $str === null ) {
2007 // Save an invalid hash...
2008 $this->mPassword
= '';
2010 $this->mPassword
= self
::crypt( $str );
2012 $this->mNewpassword
= '';
2013 $this->mNewpassTime
= null;
2017 * Get the user's current token.
2018 * @return String Token
2020 public function getToken() {
2022 return $this->mToken
;
2026 * Set the random token (used for persistent authentication)
2027 * Called from loadDefaults() among other places.
2029 * @param $token String|bool If specified, set the token to this value
2031 public function setToken( $token = false ) {
2032 global $wgSecretKey, $wgProxyKey;
2035 if ( $wgSecretKey ) {
2036 $key = $wgSecretKey;
2037 } elseif ( $wgProxyKey ) {
2042 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
2044 $this->mToken
= $token;
2049 * Set the cookie password
2051 * @param $str String New cookie password
2053 private function setCookiePassword( $str ) {
2055 $this->mCookiePassword
= md5( $str );
2059 * Set the password for a password reminder or new account email
2061 * @param $str String New password to set
2062 * @param $throttle Bool If true, reset the throttle timestamp to the present
2064 public function setNewpassword( $str, $throttle = true ) {
2066 $this->mNewpassword
= self
::crypt( $str );
2068 $this->mNewpassTime
= wfTimestampNow();
2073 * Has password reminder email been sent within the last
2074 * $wgPasswordReminderResendTime hours?
2077 public function isPasswordReminderThrottled() {
2078 global $wgPasswordReminderResendTime;
2080 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2083 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2084 return time() < $expiry;
2088 * Get the user's e-mail address
2089 * @return String User's email address
2091 public function getEmail() {
2093 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2094 return $this->mEmail
;
2098 * Get the timestamp of the user's e-mail authentication
2099 * @return String TS_MW timestamp
2101 public function getEmailAuthenticationTimestamp() {
2103 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2104 return $this->mEmailAuthenticated
;
2108 * Set the user's e-mail address
2109 * @param $str String New e-mail address
2111 public function setEmail( $str ) {
2113 $this->mEmail
= $str;
2114 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2118 * Get the user's real name
2119 * @return String User's real name
2121 public function getRealName() {
2122 if ( !$this->isItemLoaded( 'realname' ) ) {
2126 return $this->mRealName
;
2130 * Set the user's real name
2131 * @param $str String New real name
2133 public function setRealName( $str ) {
2135 $this->mRealName
= $str;
2139 * Return the name of this user we should used to display in the user interface
2140 * @return String The user's display name
2142 public function getDisplayName() {
2143 global $wgRealNameInInterface;
2144 if ( is_null( $this->mDisplayName
) ) {
2145 $displayName = null;
2147 // Allow hooks to set a display name
2148 wfRunHooks( 'UserDisplayName', array( $this, &$displayName ) );
2150 if ( is_null( $displayName ) && $wgRealNameInInterface && $this->getRealName() ) {
2151 // If $wgRealNameInInterface is true use the real name as the display name if it's set
2152 $displayName = $this->getRealName();
2155 if ( is_null( $displayName ) ) {
2156 $displayName = $this->getName();
2159 $this->mDisplayName
= $displayName;
2161 return $this->mDisplayName
;
2165 * Get the user's current setting for a given option.
2167 * @param $oname String The option to check
2168 * @param $defaultOverride String A default value returned if the option does not exist
2169 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2170 * @return String User's current value for the option
2171 * @see getBoolOption()
2172 * @see getIntOption()
2174 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2175 global $wgHiddenPrefs;
2176 $this->loadOptions();
2178 if ( is_null( $this->mOptions
) ) {
2179 if($defaultOverride != '') {
2180 return $defaultOverride;
2182 $this->mOptions
= User
::getDefaultOptions();
2185 # We want 'disabled' preferences to always behave as the default value for
2186 # users, even if they have set the option explicitly in their settings (ie they
2187 # set it, and then it was disabled removing their ability to change it). But
2188 # we don't want to erase the preferences in the database in case the preference
2189 # is re-enabled again. So don't touch $mOptions, just override the returned value
2190 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2191 return self
::getDefaultOption( $oname );
2194 if ( array_key_exists( $oname, $this->mOptions
) ) {
2195 return $this->mOptions
[$oname];
2197 return $defaultOverride;
2202 * Get all user's options
2206 public function getOptions() {
2207 global $wgHiddenPrefs;
2208 $this->loadOptions();
2209 $options = $this->mOptions
;
2211 # We want 'disabled' preferences to always behave as the default value for
2212 # users, even if they have set the option explicitly in their settings (ie they
2213 # set it, and then it was disabled removing their ability to change it). But
2214 # we don't want to erase the preferences in the database in case the preference
2215 # is re-enabled again. So don't touch $mOptions, just override the returned value
2216 foreach( $wgHiddenPrefs as $pref ){
2217 $default = self
::getDefaultOption( $pref );
2218 if( $default !== null ){
2219 $options[$pref] = $default;
2227 * Get the user's current setting for a given option, as a boolean value.
2229 * @param $oname String The option to check
2230 * @return Bool User's current value for the option
2233 public function getBoolOption( $oname ) {
2234 return (bool)$this->getOption( $oname );
2238 * Get the user's current setting for a given option, as a boolean value.
2240 * @param $oname String The option to check
2241 * @param $defaultOverride Int A default value returned if the option does not exist
2242 * @return Int User's current value for the option
2245 public function getIntOption( $oname, $defaultOverride=0 ) {
2246 $val = $this->getOption( $oname );
2248 $val = $defaultOverride;
2250 return intval( $val );
2254 * Set the given option for a user.
2256 * @param $oname String The option to set
2257 * @param $val mixed New value to set
2259 public function setOption( $oname, $val ) {
2261 $this->loadOptions();
2263 // Explicitly NULL values should refer to defaults
2264 global $wgDefaultUserOptions;
2265 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2266 $val = $wgDefaultUserOptions[$oname];
2269 $this->mOptions
[$oname] = $val;
2273 * Reset all options to the site defaults
2275 public function resetOptions() {
2276 $this->mOptions
= self
::getDefaultOptions();
2280 * Get the user's preferred date format.
2281 * @return String User's preferred date format
2283 public function getDatePreference() {
2284 // Important migration for old data rows
2285 if ( is_null( $this->mDatePreference
) ) {
2287 $value = $this->getOption( 'date' );
2288 $map = $wgLang->getDatePreferenceMigrationMap();
2289 if ( isset( $map[$value] ) ) {
2290 $value = $map[$value];
2292 $this->mDatePreference
= $value;
2294 return $this->mDatePreference
;
2298 * Get the user preferred stub threshold
2302 public function getStubThreshold() {
2303 global $wgMaxArticleSize; # Maximum article size, in Kb
2304 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2305 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2306 # If they have set an impossible value, disable the preference
2307 # so we can use the parser cache again.
2314 * Get the permissions this user has.
2315 * @param $ns int If numeric, get permissions for this namespace
2316 * @return Array of String permission names
2318 public function getRights( $ns = null ) {
2319 $key = is_null( $ns ) ?
'*' : intval( $ns );
2321 if ( is_null( $this->mRights
) ) {
2322 $this->mRights
= array();
2325 if ( !isset( $this->mRights
[$key] ) ) {
2326 $this->mRights
[$key] = self
::getGroupPermissions( $this->getEffectiveGroups(), $ns );
2327 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
[$key], $ns ) );
2328 // Force reindexation of rights when a hook has unset one of them
2329 $this->mRights
[$key] = array_values( $this->mRights
[$key] );
2331 if ( is_null( $ns ) ) {
2332 return $this->mRights
[$key];
2334 // Merge non namespace specific rights
2335 return array_merge( $this->mRights
[$key], $this->getRights() );
2341 * Get the list of explicit group memberships this user has.
2342 * The implicit * and user groups are not included.
2343 * @return Array of String internal group names
2345 public function getGroups() {
2347 $this->loadGroups();
2348 return $this->mGroups
;
2352 * Get the list of implicit group memberships this user has.
2353 * This includes all explicit groups, plus 'user' if logged in,
2354 * '*' for all accounts, and autopromoted groups
2355 * @param $recache Bool Whether to avoid the cache
2356 * @return Array of String internal group names
2358 public function getEffectiveGroups( $recache = false ) {
2359 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2360 wfProfileIn( __METHOD__
);
2361 $this->mEffectiveGroups
= array_unique( array_merge(
2362 $this->getGroups(), // explicit groups
2363 $this->getAutomaticGroups( $recache ) // implicit groups
2365 # Hook for additional groups
2366 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2367 wfProfileOut( __METHOD__
);
2369 return $this->mEffectiveGroups
;
2373 * Get the list of implicit group memberships this user has.
2374 * This includes 'user' if logged in, '*' for all accounts,
2375 * and autopromoted groups
2376 * @param $recache Bool Whether to avoid the cache
2377 * @return Array of String internal group names
2379 public function getAutomaticGroups( $recache = false ) {
2380 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2381 wfProfileIn( __METHOD__
);
2382 $this->mImplicitGroups
= array( '*' );
2383 if ( $this->getId() ) {
2384 $this->mImplicitGroups
[] = 'user';
2386 $this->mImplicitGroups
= array_unique( array_merge(
2387 $this->mImplicitGroups
,
2388 Autopromote
::getAutopromoteGroups( $this )
2392 # Assure data consistency with rights/groups,
2393 # as getEffectiveGroups() depends on this function
2394 $this->mEffectiveGroups
= null;
2396 wfProfileOut( __METHOD__
);
2398 return $this->mImplicitGroups
;
2402 * Returns the groups the user has belonged to.
2404 * The user may still belong to the returned groups. Compare with getGroups().
2406 * The function will not return groups the user had belonged to before MW 1.17
2408 * @return array Names of the groups the user has belonged to.
2410 public function getFormerGroups() {
2411 if( is_null( $this->mFormerGroups
) ) {
2412 $dbr = wfGetDB( DB_MASTER
);
2413 $res = $dbr->select( 'user_former_groups',
2414 array( 'ufg_group' ),
2415 array( 'ufg_user' => $this->mId
),
2417 $this->mFormerGroups
= array();
2418 foreach( $res as $row ) {
2419 $this->mFormerGroups
[] = $row->ufg_group
;
2422 return $this->mFormerGroups
;
2426 * Get the user's edit count.
2429 public function getEditCount() {
2430 if( $this->getId() ) {
2431 if ( !isset( $this->mEditCount
) ) {
2432 /* Populate the count, if it has not been populated yet */
2433 $this->mEditCount
= User
::edits( $this->mId
);
2435 return $this->mEditCount
;
2443 * Add the user to the given group.
2444 * This takes immediate effect.
2445 * @param $group String Name of the group to add
2447 public function addGroup( $group ) {
2448 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2449 $dbw = wfGetDB( DB_MASTER
);
2450 if( $this->getId() ) {
2451 $dbw->insert( 'user_groups',
2453 'ug_user' => $this->getID(),
2454 'ug_group' => $group,
2457 array( 'IGNORE' ) );
2460 $this->loadGroups();
2461 $this->mGroups
[] = $group;
2462 $this->mRights
= null;
2464 $this->invalidateCache();
2468 * Remove the user from the given group.
2469 * This takes immediate effect.
2470 * @param $group String Name of the group to remove
2472 public function removeGroup( $group ) {
2474 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2475 $dbw = wfGetDB( DB_MASTER
);
2476 $dbw->delete( 'user_groups',
2478 'ug_user' => $this->getID(),
2479 'ug_group' => $group,
2481 // Remember that the user was in this group
2482 $dbw->insert( 'user_former_groups',
2484 'ufg_user' => $this->getID(),
2485 'ufg_group' => $group,
2488 array( 'IGNORE' ) );
2490 $this->loadGroups();
2491 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2492 $this->mRights
= null;
2494 $this->invalidateCache();
2498 * Get whether the user is logged in
2501 public function isLoggedIn() {
2502 return $this->getID() != 0;
2506 * Get whether the user is anonymous
2509 public function isAnon() {
2510 return !$this->isLoggedIn();
2514 * Check if user is allowed to access a feature / make an action
2516 * @internal param \String $varargs permissions to test
2517 * @return Boolean: True if user is allowed to perform *any* of the given actions
2521 public function isAllowedAny( /*...*/ ){
2522 $permissions = func_get_args();
2523 foreach( $permissions as $permission ){
2524 if( $this->isAllowed( $permission ) ){
2533 * @internal param $varargs string
2534 * @return bool True if the user is allowed to perform *all* of the given actions
2536 public function isAllowedAll( /*...*/ ){
2537 $permissions = func_get_args();
2538 foreach( $permissions as $permission ){
2539 if( !$this->isAllowed( $permission ) ){
2547 * Internal mechanics of testing a permission
2548 * @param $action String
2549 * @param $ns int|null Namespace optional
2552 public function isAllowed( $action = '', $ns = null ) {
2553 if ( $action === '' ) {
2554 return true; // In the spirit of DWIM
2556 # Patrolling may not be enabled
2557 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2558 global $wgUseRCPatrol, $wgUseNPPatrol;
2559 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2562 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2563 # by misconfiguration: 0 == 'foo'
2564 return in_array( $action, $this->getRights( $ns ), true );
2568 * Check whether to enable recent changes patrol features for this user
2569 * @return Boolean: True or false
2571 public function useRCPatrol() {
2572 global $wgUseRCPatrol;
2573 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2577 * Check whether to enable new pages patrol features for this user
2578 * @return Bool True or false
2580 public function useNPPatrol() {
2581 global $wgUseRCPatrol, $wgUseNPPatrol;
2582 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2586 * Get the WebRequest object to use with this object
2588 * @return WebRequest
2590 public function getRequest() {
2591 if ( $this->mRequest
) {
2592 return $this->mRequest
;
2600 * Get the current skin, loading it if required
2601 * @return Skin The current skin
2602 * @todo FIXME: Need to check the old failback system [AV]
2603 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2605 public function getSkin() {
2606 return RequestContext
::getMain()->getSkin();
2610 * Check the watched status of an article.
2611 * @param $title Title of the article to look at
2614 public function isWatched( $title ) {
2615 $wl = WatchedItem
::fromUserTitle( $this, $title );
2616 return $wl->isWatched();
2621 * @param $title Title of the article to look at
2623 public function addWatch( $title ) {
2624 $wl = WatchedItem
::fromUserTitle( $this, $title );
2626 $this->invalidateCache();
2630 * Stop watching an article.
2631 * @param $title Title of the article to look at
2633 public function removeWatch( $title ) {
2634 $wl = WatchedItem
::fromUserTitle( $this, $title );
2636 $this->invalidateCache();
2640 * Cleans up watchlist by removing invalid entries from it
2642 public function cleanupWatchlist() {
2643 $dbw = wfGetDB( DB_MASTER
);
2644 $dbw->delete( 'watchlist', array( 'wl_namespace < 0', 'wl_user' => $this->getId() ), __METHOD__
);
2648 * Clear the user's notification timestamp for the given title.
2649 * If e-notif e-mails are on, they will receive notification mails on
2650 * the next change of the page if it's watched etc.
2651 * @param $title Title of the article to look at
2653 public function clearNotification( &$title ) {
2654 global $wgUseEnotif, $wgShowUpdatedMarker;
2656 # Do nothing if the database is locked to writes
2657 if( wfReadOnly() ) {
2661 if( $title->getNamespace() == NS_USER_TALK
&&
2662 $title->getText() == $this->getName() ) {
2663 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2665 $this->setNewtalk( false );
2668 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2672 if( $this->isAnon() ) {
2673 // Nothing else to do...
2677 // Only update the timestamp if the page is being watched.
2678 // The query to find out if it is watched is cached both in memcached and per-invocation,
2679 // and when it does have to be executed, it can be on a slave
2680 // If this is the user's newtalk page, we always update the timestamp
2681 if( $title->getNamespace() == NS_USER_TALK
&&
2682 $title->getText() == $this->getName() )
2686 $watched = $this->isWatched( $title );
2689 // If the page is watched by the user (or may be watched), update the timestamp on any
2690 // any matching rows
2692 $dbw = wfGetDB( DB_MASTER
);
2693 $dbw->update( 'watchlist',
2695 'wl_notificationtimestamp' => null
2696 ), array( /* WHERE */
2697 'wl_title' => $title->getDBkey(),
2698 'wl_namespace' => $title->getNamespace(),
2699 'wl_user' => $this->getID()
2706 * Resets all of the given user's page-change notification timestamps.
2707 * If e-notif e-mails are on, they will receive notification mails on
2708 * the next change of any watched page.
2710 public function clearAllNotifications() {
2711 global $wgUseEnotif, $wgShowUpdatedMarker;
2712 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2713 $this->setNewtalk( false );
2716 $id = $this->getId();
2718 $dbw = wfGetDB( DB_MASTER
);
2719 $dbw->update( 'watchlist',
2721 'wl_notificationtimestamp' => null
2722 ), array( /* WHERE */
2726 # We also need to clear here the "you have new message" notification for the own user_talk page
2727 # This is cleared one page view later in Article::viewUpdates();
2732 * Set this user's options from an encoded string
2733 * @param $str String Encoded options to import
2735 * @deprecated in 1.19 due to removal of user_options from the user table
2737 private function decodeOptions( $str ) {
2741 $this->mOptionsLoaded
= true;
2742 $this->mOptionOverrides
= array();
2744 // If an option is not set in $str, use the default value
2745 $this->mOptions
= self
::getDefaultOptions();
2747 $a = explode( "\n", $str );
2748 foreach ( $a as $s ) {
2750 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2751 $this->mOptions
[$m[1]] = $m[2];
2752 $this->mOptionOverrides
[$m[1]] = $m[2];
2758 * Set a cookie on the user's client. Wrapper for
2759 * WebResponse::setCookie
2760 * @param $name String Name of the cookie to set
2761 * @param $value String Value to set
2762 * @param $exp Int Expiration time, as a UNIX time value;
2763 * if 0 or not specified, use the default $wgCookieExpiration
2765 protected function setCookie( $name, $value, $exp = 0 ) {
2766 $this->getRequest()->response()->setcookie( $name, $value, $exp );
2770 * Clear a cookie on the user's client
2771 * @param $name String Name of the cookie to clear
2773 protected function clearCookie( $name ) {
2774 $this->setCookie( $name, '', time() - 86400 );
2778 * Set the default cookies for this session on the user's client.
2780 * @param $request WebRequest object to use; $wgRequest will be used if null
2783 public function setCookies( $request = null ) {
2784 if ( $request === null ) {
2785 $request = $this->getRequest();
2789 if ( 0 == $this->mId
) return;
2791 'wsUserID' => $this->mId
,
2792 'wsToken' => $this->mToken
,
2793 'wsUserName' => $this->getName()
2796 'UserID' => $this->mId
,
2797 'UserName' => $this->getName(),
2799 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2800 $cookies['Token'] = $this->mToken
;
2802 $cookies['Token'] = false;
2805 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2807 foreach ( $session as $name => $value ) {
2808 $request->setSessionData( $name, $value );
2810 foreach ( $cookies as $name => $value ) {
2811 if ( $value === false ) {
2812 $this->clearCookie( $name );
2814 $this->setCookie( $name, $value );
2820 * Log this user out.
2822 public function logout() {
2823 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2829 * Clear the user's cookies and session, and reset the instance cache.
2832 public function doLogout() {
2833 $this->clearInstanceCache( 'defaults' );
2835 $this->getRequest()->setSessionData( 'wsUserID', 0 );
2837 $this->clearCookie( 'UserID' );
2838 $this->clearCookie( 'Token' );
2840 # Remember when user logged out, to prevent seeing cached pages
2841 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2845 * Save this user's settings into the database.
2846 * @todo Only rarely do all these fields need to be set!
2848 public function saveSettings() {
2850 if ( wfReadOnly() ) { return; }
2851 if ( 0 == $this->mId
) { return; }
2853 $this->mTouched
= self
::newTouchedTimestamp();
2855 $dbw = wfGetDB( DB_MASTER
);
2856 $dbw->update( 'user',
2858 'user_name' => $this->mName
,
2859 'user_password' => $this->mPassword
,
2860 'user_newpassword' => $this->mNewpassword
,
2861 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2862 'user_real_name' => $this->mRealName
,
2863 'user_email' => $this->mEmail
,
2864 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2865 'user_touched' => $dbw->timestamp( $this->mTouched
),
2866 'user_token' => $this->mToken
,
2867 'user_email_token' => $this->mEmailToken
,
2868 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2869 ), array( /* WHERE */
2870 'user_id' => $this->mId
2874 $this->saveOptions();
2876 wfRunHooks( 'UserSaveSettings', array( $this ) );
2877 $this->clearSharedCache();
2878 $this->getUserPage()->invalidateCache();
2882 * If only this user's username is known, and it exists, return the user ID.
2885 public function idForName() {
2886 $s = trim( $this->getName() );
2887 if ( $s === '' ) return 0;
2889 $dbr = wfGetDB( DB_SLAVE
);
2890 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2891 if ( $id === false ) {
2898 * Add a user to the database, return the user object
2900 * @param $name String Username to add
2901 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2902 * - password The user's password hash. Password logins will be disabled if this is omitted.
2903 * - newpassword Hash for a temporary password that has been mailed to the user
2904 * - email The user's email address
2905 * - email_authenticated The email authentication timestamp
2906 * - real_name The user's real name
2907 * - options An associative array of non-default options
2908 * - token Random authentication token. Do not set.
2909 * - registration Registration timestamp. Do not set.
2911 * @return User object, or null if the username already exists
2913 public static function createNew( $name, $params = array() ) {
2916 if ( isset( $params['options'] ) ) {
2917 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2918 unset( $params['options'] );
2920 $dbw = wfGetDB( DB_MASTER
);
2921 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2924 'user_id' => $seqVal,
2925 'user_name' => $name,
2926 'user_password' => $user->mPassword
,
2927 'user_newpassword' => $user->mNewpassword
,
2928 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2929 'user_email' => $user->mEmail
,
2930 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2931 'user_real_name' => $user->mRealName
,
2932 'user_token' => $user->mToken
,
2933 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2934 'user_editcount' => 0,
2936 foreach ( $params as $name => $value ) {
2937 $fields["user_$name"] = $value;
2939 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2940 if ( $dbw->affectedRows() ) {
2941 $newUser = User
::newFromId( $dbw->insertId() );
2949 * Add this existing user object to the database
2951 public function addToDatabase() {
2953 $dbw = wfGetDB( DB_MASTER
);
2954 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2955 $dbw->insert( 'user',
2957 'user_id' => $seqVal,
2958 'user_name' => $this->mName
,
2959 'user_password' => $this->mPassword
,
2960 'user_newpassword' => $this->mNewpassword
,
2961 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2962 'user_email' => $this->mEmail
,
2963 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2964 'user_real_name' => $this->mRealName
,
2965 'user_token' => $this->mToken
,
2966 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2967 'user_editcount' => 0,
2970 $this->mId
= $dbw->insertId();
2972 // Clear instance cache other than user table data, which is already accurate
2973 $this->clearInstanceCache();
2975 $this->saveOptions();
2979 * If this user is logged-in and blocked,
2980 * block any IP address they've successfully logged in from.
2981 * @return bool A block was spread
2983 public function spreadAnyEditBlock() {
2984 if ( $this->isLoggedIn() && $this->isBlocked() ) {
2985 return $this->spreadBlock();
2991 * If this (non-anonymous) user is blocked,
2992 * block the IP address they've successfully logged in from.
2993 * @return bool A block was spread
2995 protected function spreadBlock() {
2996 wfDebug( __METHOD__
. "()\n" );
2998 if ( $this->mId
== 0 ) {
3002 $userblock = Block
::newFromTarget( $this->getName() );
3003 if ( !$userblock ) {
3007 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3011 * Generate a string which will be different for any combination of
3012 * user options which would produce different parser output.
3013 * This will be used as part of the hash key for the parser cache,
3014 * so users with the same options can share the same cached data
3017 * Extensions which require it should install 'PageRenderingHash' hook,
3018 * which will give them a chance to modify this key based on their own
3021 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3022 * @return String Page rendering hash
3024 public function getPageRenderingHash() {
3025 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
3027 return $this->mHash
;
3029 wfDeprecated( __METHOD__
);
3031 // stubthreshold is only included below for completeness,
3032 // since it disables the parser cache, its value will always
3033 // be 0 when this function is called by parsercache.
3035 $confstr = $this->getOption( 'math' );
3036 $confstr .= '!' . $this->getStubThreshold();
3037 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
3038 $confstr .= '!' . $this->getDatePreference();
3040 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3041 $confstr .= '!' . $wgLang->getCode();
3042 $confstr .= '!' . $this->getOption( 'thumbsize' );
3043 // add in language specific options, if any
3044 $extra = $wgContLang->getExtraHashOptions();
3047 // Since the skin could be overloading link(), it should be
3048 // included here but in practice, none of our skins do that.
3050 $confstr .= $wgRenderHashAppend;
3052 // Give a chance for extensions to modify the hash, if they have
3053 // extra options or other effects on the parser cache.
3054 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3056 // Make it a valid memcached key fragment
3057 $confstr = str_replace( ' ', '_', $confstr );
3058 $this->mHash
= $confstr;
3063 * Get whether the user is explicitly blocked from account creation.
3064 * @return Bool|Block
3066 public function isBlockedFromCreateAccount() {
3067 $this->getBlockedStatus();
3068 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
3069 return $this->mBlock
;
3072 # bug 13611: if the IP address the user is trying to create an account from is
3073 # blocked with createaccount disabled, prevent new account creation there even
3074 # when the user is logged in
3075 if( $this->mBlockedFromCreateAccount
=== false ){
3076 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3078 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3079 ?
$this->mBlockedFromCreateAccount
3084 * Get whether the user is blocked from using Special:Emailuser.
3087 public function isBlockedFromEmailuser() {
3088 $this->getBlockedStatus();
3089 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3093 * Get whether the user is allowed to create an account.
3096 function isAllowedToCreateAccount() {
3097 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3101 * Get this user's personal page title.
3103 * @return Title: User's personal page title
3105 public function getUserPage() {
3106 return Title
::makeTitle( NS_USER
, $this->getName() );
3110 * Get this user's talk page title.
3112 * @return Title: User's talk page title
3114 public function getTalkPage() {
3115 $title = $this->getUserPage();
3116 return $title->getTalkPage();
3120 * Determine whether the user is a newbie. Newbies are either
3121 * anonymous IPs, or the most recently created accounts.
3124 public function isNewbie() {
3125 return !$this->isAllowed( 'autoconfirmed' );
3129 * Check to see if the given clear-text password is one of the accepted passwords
3130 * @param $password String: user password.
3131 * @return Boolean: True if the given password is correct, otherwise False.
3133 public function checkPassword( $password ) {
3134 global $wgAuth, $wgLegacyEncoding;
3137 // Even though we stop people from creating passwords that
3138 // are shorter than this, doesn't mean people wont be able
3139 // to. Certain authentication plugins do NOT want to save
3140 // domain passwords in a mysql database, so we should
3141 // check this (in case $wgAuth->strict() is false).
3142 if( !$this->isValidPassword( $password ) ) {
3146 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3148 } elseif( $wgAuth->strict() ) {
3149 /* Auth plugin doesn't allow local authentication */
3151 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3152 /* Auth plugin doesn't allow local authentication for this user name */
3155 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3157 } elseif ( $wgLegacyEncoding ) {
3158 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3159 # Check for this with iconv
3160 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3161 if ( $cp1252Password != $password &&
3162 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3171 * Check if the given clear-text password matches the temporary password
3172 * sent by e-mail for password reset operations.
3174 * @param $plaintext string
3176 * @return Boolean: True if matches, false otherwise
3178 public function checkTemporaryPassword( $plaintext ) {
3179 global $wgNewPasswordExpiry;
3182 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3183 if ( is_null( $this->mNewpassTime
) ) {
3186 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3187 return ( time() < $expiry );
3194 * Alias for getEditToken.
3195 * @deprecated since 1.19, use getEditToken instead.
3197 * @param $salt String|Array of Strings Optional function-specific data for hashing
3198 * @param $request WebRequest object to use or null to use $wgRequest
3199 * @return String The new edit token
3201 public function editToken( $salt = '', $request = null ) {
3202 return $this->getEditToken( $salt, $request );
3206 * Initialize (if necessary) and return a session token value
3207 * which can be used in edit forms to show that the user's
3208 * login credentials aren't being hijacked with a foreign form
3213 * @param $salt String|Array of Strings Optional function-specific data for hashing
3214 * @param $request WebRequest object to use or null to use $wgRequest
3215 * @return String The new edit token
3217 public function getEditToken( $salt = '', $request = null ) {
3218 if ( $request == null ) {
3219 $request = $this->getRequest();
3222 if ( $this->isAnon() ) {
3223 return EDIT_TOKEN_SUFFIX
;
3225 $token = $request->getSessionData( 'wsEditToken' );
3226 if ( $token === null ) {
3227 $token = self
::generateToken();
3228 $request->setSessionData( 'wsEditToken', $token );
3230 if( is_array( $salt ) ) {
3231 $salt = implode( '|', $salt );
3233 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3238 * Generate a looking random token for various uses.
3240 * @param $salt String Optional salt value
3241 * @return String The new random token
3243 public static function generateToken( $salt = '' ) {
3244 $token = dechex( mt_rand() ) . dechex( mt_rand() );
3245 return md5( $token . $salt );
3249 * Check given value against the token value stored in the session.
3250 * A match should confirm that the form was submitted from the
3251 * user's own login session, not a form submission from a third-party
3254 * @param $val String Input value to compare
3255 * @param $salt String Optional function-specific data for hashing
3256 * @param $request WebRequest object to use or null to use $wgRequest
3257 * @return Boolean: Whether the token matches
3259 public function matchEditToken( $val, $salt = '', $request = null ) {
3260 $sessionToken = $this->getEditToken( $salt, $request );
3261 if ( $val != $sessionToken ) {
3262 wfDebug( "User::matchEditToken: broken session data\n" );
3264 return $val == $sessionToken;
3268 * Check given value against the token value stored in the session,
3269 * ignoring the suffix.
3271 * @param $val String Input value to compare
3272 * @param $salt String Optional function-specific data for hashing
3273 * @param $request WebRequest object to use or null to use $wgRequest
3274 * @return Boolean: Whether the token matches
3276 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3277 $sessionToken = $this->getEditToken( $salt, $request );
3278 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3282 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3283 * mail to the user's given address.
3285 * @param $type String: message to send, either "created", "changed" or "set"
3286 * @return Status object
3288 public function sendConfirmationMail( $type = 'created' ) {
3290 $expiration = null; // gets passed-by-ref and defined in next line.
3291 $token = $this->confirmationToken( $expiration );
3292 $url = $this->confirmationTokenUrl( $token );
3293 $invalidateURL = $this->invalidationTokenUrl( $token );
3294 $this->saveSettings();
3296 if ( $type == 'created' ||
$type === false ) {
3297 $message = 'confirmemail_body';
3298 } elseif ( $type === true ) {
3299 $message = 'confirmemail_body_changed';
3301 $message = 'confirmemail_body_' . $type;
3304 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3306 $this->getRequest()->getIP(),
3309 $wgLang->timeanddate( $expiration, false ),
3311 $wgLang->date( $expiration, false ),
3312 $wgLang->time( $expiration, false ) ) );
3316 * Send an e-mail to this user's account. Does not check for
3317 * confirmed status or validity.
3319 * @param $subject String Message subject
3320 * @param $body String Message body
3321 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3322 * @param $replyto String Reply-To address
3325 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3326 if( is_null( $from ) ) {
3327 global $wgPasswordSender, $wgPasswordSenderName;
3328 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3330 $sender = new MailAddress( $from );
3333 $to = new MailAddress( $this );
3334 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3338 * Generate, store, and return a new e-mail confirmation code.
3339 * A hash (unsalted, since it's used as a key) is stored.
3341 * @note Call saveSettings() after calling this function to commit
3342 * this change to the database.
3344 * @param &$expiration \mixed Accepts the expiration time
3345 * @return String New token
3347 private function confirmationToken( &$expiration ) {
3348 global $wgUserEmailConfirmationTokenExpiry;
3350 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3351 $expiration = wfTimestamp( TS_MW
, $expires );
3352 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
3353 $hash = md5( $token );
3355 $this->mEmailToken
= $hash;
3356 $this->mEmailTokenExpires
= $expiration;
3361 * Return a URL the user can use to confirm their email address.
3362 * @param $token String Accepts the email confirmation token
3363 * @return String New token URL
3365 private function confirmationTokenUrl( $token ) {
3366 return $this->getTokenUrl( 'ConfirmEmail', $token );
3370 * Return a URL the user can use to invalidate their email address.
3371 * @param $token String Accepts the email confirmation token
3372 * @return String New token URL
3374 private function invalidationTokenUrl( $token ) {
3375 return $this->getTokenUrl( 'Invalidateemail', $token );
3379 * Internal function to format the e-mail validation/invalidation URLs.
3380 * This uses a quickie hack to use the
3381 * hardcoded English names of the Special: pages, for ASCII safety.
3383 * @note Since these URLs get dropped directly into emails, using the
3384 * short English names avoids insanely long URL-encoded links, which
3385 * also sometimes can get corrupted in some browsers/mailers
3386 * (bug 6957 with Gmail and Internet Explorer).
3388 * @param $page String Special page
3389 * @param $token String Token
3390 * @return String Formatted URL
3392 protected function getTokenUrl( $page, $token ) {
3393 // Hack to bypass localization of 'Special:'
3394 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3395 return $title->getCanonicalUrl();
3399 * Mark the e-mail address confirmed.
3401 * @note Call saveSettings() after calling this function to commit the change.
3405 public function confirmEmail() {
3406 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3407 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3412 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3413 * address if it was already confirmed.
3415 * @note Call saveSettings() after calling this function to commit the change.
3418 function invalidateEmail() {
3420 $this->mEmailToken
= null;
3421 $this->mEmailTokenExpires
= null;
3422 $this->setEmailAuthenticationTimestamp( null );
3423 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3428 * Set the e-mail authentication timestamp.
3429 * @param $timestamp String TS_MW timestamp
3431 function setEmailAuthenticationTimestamp( $timestamp ) {
3433 $this->mEmailAuthenticated
= $timestamp;
3434 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3438 * Is this user allowed to send e-mails within limits of current
3439 * site configuration?
3442 public function canSendEmail() {
3443 global $wgEnableEmail, $wgEnableUserEmail;
3444 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3447 $canSend = $this->isEmailConfirmed();
3448 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3453 * Is this user allowed to receive e-mails within limits of current
3454 * site configuration?
3457 public function canReceiveEmail() {
3458 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3462 * Is this user's e-mail address valid-looking and confirmed within
3463 * limits of the current site configuration?
3465 * @note If $wgEmailAuthentication is on, this may require the user to have
3466 * confirmed their address by returning a code or using a password
3467 * sent to the address from the wiki.
3471 public function isEmailConfirmed() {
3472 global $wgEmailAuthentication;
3475 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3476 if( $this->isAnon() ) {
3479 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3482 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3492 * Check whether there is an outstanding request for e-mail confirmation.
3495 public function isEmailConfirmationPending() {
3496 global $wgEmailAuthentication;
3497 return $wgEmailAuthentication &&
3498 !$this->isEmailConfirmed() &&
3499 $this->mEmailToken
&&
3500 $this->mEmailTokenExpires
> wfTimestamp();
3504 * Get the timestamp of account creation.
3506 * @return String|Bool Timestamp of account creation, or false for
3507 * non-existent/anonymous user accounts.
3509 public function getRegistration() {
3510 if ( $this->isAnon() ) {
3514 return $this->mRegistration
;
3518 * Get the timestamp of the first edit
3520 * @return String|Bool Timestamp of first edit, or false for
3521 * non-existent/anonymous user accounts.
3523 public function getFirstEditTimestamp() {
3524 if( $this->getId() == 0 ) {
3525 return false; // anons
3527 $dbr = wfGetDB( DB_SLAVE
);
3528 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3529 array( 'rev_user' => $this->getId() ),
3531 array( 'ORDER BY' => 'rev_timestamp ASC' )
3534 return false; // no edits
3536 return wfTimestamp( TS_MW
, $time );
3540 * Get the permissions associated with a given list of groups
3542 * @param $groups Array of Strings List of internal group names
3545 * @return Array of Strings List of permission key names for given groups combined
3547 public static function getGroupPermissions( array $groups, $ns = null ) {
3548 global $wgGroupPermissions, $wgRevokePermissions;
3551 // Grant every granted permission first
3552 foreach( $groups as $group ) {
3553 if( isset( $wgGroupPermissions[$group] ) ) {
3554 $rights = array_merge( $rights, self
::extractRights(
3555 $wgGroupPermissions[$group], $ns ) );
3559 // Revoke the revoked permissions
3560 foreach( $groups as $group ) {
3561 if( isset( $wgRevokePermissions[$group] ) ) {
3562 $rights = array_diff( $rights, self
::extractRights(
3563 $wgRevokePermissions[$group], $ns ) );
3566 return array_unique( $rights );
3570 * Helper for User::getGroupPermissions
3571 * @param $list array
3575 private static function extractRights( $list, $ns ) {
3577 foreach( $list as $right => $value ) {
3578 if ( is_array( $value ) ) {
3579 # This is a list of namespaces where the permission applies
3580 if ( !is_null( $ns ) && !empty( $value[$ns] ) ) {
3584 # This is a boolean indicating that the permission applies
3594 * Get all the groups who have a given permission
3596 * @param $role String Role to check
3600 * @return Array of Strings List of internal group names with the given permission
3602 public static function getGroupsWithPermission( $role, $ns = null ) {
3603 global $wgGroupPermissions;
3604 $allowedGroups = array();
3605 foreach ( $wgGroupPermissions as $group => $rights ) {
3606 if ( in_array( $role, self
::getGroupPermissions( array( $group ), $ns ), true ) ) {
3607 $allowedGroups[] = $group;
3610 return $allowedGroups;
3614 * Get the localized descriptive name for a group, if it exists
3616 * @param $group String Internal group name
3617 * @return String Localized descriptive group name
3619 public static function getGroupName( $group ) {
3620 $msg = wfMessage( "group-$group" );
3621 return $msg->isBlank() ?
$group : $msg->text();
3625 * Get the localized descriptive name for a member of a group, if it exists
3627 * @param $group String Internal group name
3628 * @param $username String Username for gender (since 1.19)
3629 * @return String Localized name for group member
3631 public static function getGroupMember( $group, $username = '#' ) {
3632 $msg = wfMessage( "group-$group-member", $username );
3633 return $msg->isBlank() ?
$group : $msg->text();
3637 * Return the set of defined explicit groups.
3638 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3639 * are not included, as they are defined automatically, not in the database.
3640 * @return Array of internal group names
3642 public static function getAllGroups() {
3643 global $wgGroupPermissions, $wgRevokePermissions;
3645 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3646 self
::getImplicitGroups()
3651 * Get a list of all available permissions.
3652 * @return Array of permission names
3654 public static function getAllRights() {
3655 if ( self
::$mAllRights === false ) {
3656 global $wgAvailableRights;
3657 if ( count( $wgAvailableRights ) ) {
3658 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3660 self
::$mAllRights = self
::$mCoreRights;
3662 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3664 return self
::$mAllRights;
3668 * Get a list of implicit groups
3669 * @return Array of Strings Array of internal group names
3671 public static function getImplicitGroups() {
3672 global $wgImplicitGroups;
3673 $groups = $wgImplicitGroups;
3674 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3679 * Get the title of a page describing a particular group
3681 * @param $group String Internal group name
3682 * @return Title|Bool Title of the page if it exists, false otherwise
3684 public static function getGroupPage( $group ) {
3685 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3686 if( $msg->exists() ) {
3687 $title = Title
::newFromText( $msg->text() );
3688 if( is_object( $title ) )
3695 * Create a link to the group in HTML, if available;
3696 * else return the group name.
3698 * @param $group String Internal name of the group
3699 * @param $text String The text of the link
3700 * @return String HTML link to the group
3702 public static function makeGroupLinkHTML( $group, $text = '' ) {
3704 $text = self
::getGroupName( $group );
3706 $title = self
::getGroupPage( $group );
3708 return Linker
::link( $title, htmlspecialchars( $text ) );
3715 * Create a link to the group in Wikitext, if available;
3716 * else return the group name.
3718 * @param $group String Internal name of the group
3719 * @param $text String The text of the link
3720 * @return String Wikilink to the group
3722 public static function makeGroupLinkWiki( $group, $text = '' ) {
3724 $text = self
::getGroupName( $group );
3726 $title = self
::getGroupPage( $group );
3728 $page = $title->getPrefixedText();
3729 return "[[$page|$text]]";
3736 * Returns an array of the groups that a particular group can add/remove.
3738 * @param $group String: the group to check for whether it can add/remove
3739 * @return Array array( 'add' => array( addablegroups ),
3740 * 'remove' => array( removablegroups ),
3741 * 'add-self' => array( addablegroups to self),
3742 * 'remove-self' => array( removable groups from self) )
3744 public static function changeableByGroup( $group ) {
3745 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3747 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3748 if( empty( $wgAddGroups[$group] ) ) {
3749 // Don't add anything to $groups
3750 } elseif( $wgAddGroups[$group] === true ) {
3751 // You get everything
3752 $groups['add'] = self
::getAllGroups();
3753 } elseif( is_array( $wgAddGroups[$group] ) ) {
3754 $groups['add'] = $wgAddGroups[$group];
3757 // Same thing for remove
3758 if( empty( $wgRemoveGroups[$group] ) ) {
3759 } elseif( $wgRemoveGroups[$group] === true ) {
3760 $groups['remove'] = self
::getAllGroups();
3761 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3762 $groups['remove'] = $wgRemoveGroups[$group];
3765 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3766 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3767 foreach( $wgGroupsAddToSelf as $key => $value ) {
3768 if( is_int( $key ) ) {
3769 $wgGroupsAddToSelf['user'][] = $value;
3774 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3775 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3776 if( is_int( $key ) ) {
3777 $wgGroupsRemoveFromSelf['user'][] = $value;
3782 // Now figure out what groups the user can add to him/herself
3783 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3784 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3785 // No idea WHY this would be used, but it's there
3786 $groups['add-self'] = User
::getAllGroups();
3787 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3788 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3791 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3792 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3793 $groups['remove-self'] = User
::getAllGroups();
3794 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3795 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3802 * Returns an array of groups that this user can add and remove
3803 * @return Array array( 'add' => array( addablegroups ),
3804 * 'remove' => array( removablegroups ),
3805 * 'add-self' => array( addablegroups to self),
3806 * 'remove-self' => array( removable groups from self) )
3808 public function changeableGroups() {
3809 if( $this->isAllowed( 'userrights' ) ) {
3810 // This group gives the right to modify everything (reverse-
3811 // compatibility with old "userrights lets you change
3813 // Using array_merge to make the groups reindexed
3814 $all = array_merge( User
::getAllGroups() );
3818 'add-self' => array(),
3819 'remove-self' => array()
3823 // Okay, it's not so simple, we will have to go through the arrays
3826 'remove' => array(),
3827 'add-self' => array(),
3828 'remove-self' => array()
3830 $addergroups = $this->getEffectiveGroups();
3832 foreach( $addergroups as $addergroup ) {
3833 $groups = array_merge_recursive(
3834 $groups, $this->changeableByGroup( $addergroup )
3836 $groups['add'] = array_unique( $groups['add'] );
3837 $groups['remove'] = array_unique( $groups['remove'] );
3838 $groups['add-self'] = array_unique( $groups['add-self'] );
3839 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3845 * Increment the user's edit-count field.
3846 * Will have no effect for anonymous users.
3848 public function incEditCount() {
3849 if( !$this->isAnon() ) {
3850 $dbw = wfGetDB( DB_MASTER
);
3851 $dbw->update( 'user',
3852 array( 'user_editcount=user_editcount+1' ),
3853 array( 'user_id' => $this->getId() ),
3856 // Lazy initialization check...
3857 if( $dbw->affectedRows() == 0 ) {
3858 // Pull from a slave to be less cruel to servers
3859 // Accuracy isn't the point anyway here
3860 $dbr = wfGetDB( DB_SLAVE
);
3861 $count = $dbr->selectField( 'revision',
3863 array( 'rev_user' => $this->getId() ),
3866 // Now here's a goddamn hack...
3867 if( $dbr !== $dbw ) {
3868 // If we actually have a slave server, the count is
3869 // at least one behind because the current transaction
3870 // has not been committed and replicated.
3873 // But if DB_SLAVE is selecting the master, then the
3874 // count we just read includes the revision that was
3875 // just added in the working transaction.
3878 $dbw->update( 'user',
3879 array( 'user_editcount' => $count ),
3880 array( 'user_id' => $this->getId() ),
3884 // edit count in user cache too
3885 $this->invalidateCache();
3889 * Get the description of a given right
3891 * @param $right String Right to query
3892 * @return String Localized description of the right
3894 public static function getRightDescription( $right ) {
3895 $key = "right-$right";
3896 $msg = wfMessage( $key );
3897 return $msg->isBlank() ?
$right : $msg->text();
3901 * Make an old-style password hash
3903 * @param $password String Plain-text password
3904 * @param $userId String User ID
3905 * @return String Password hash
3907 public static function oldCrypt( $password, $userId ) {
3908 global $wgPasswordSalt;
3909 if ( $wgPasswordSalt ) {
3910 return md5( $userId . '-' . md5( $password ) );
3912 return md5( $password );
3917 * Make a new-style password hash
3919 * @param $password String Plain-text password
3920 * @param bool|string $salt Optional salt, may be random or the user ID.
3922 * If unspecified or false, will generate one automatically
3923 * @return String Password hash
3925 public static function crypt( $password, $salt = false ) {
3926 global $wgPasswordSalt;
3929 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3933 if( $wgPasswordSalt ) {
3934 if ( $salt === false ) {
3935 $salt = substr( wfGenerateToken(), 0, 8 );
3937 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3939 return ':A:' . md5( $password );
3944 * Compare a password hash with a plain-text password. Requires the user
3945 * ID if there's a chance that the hash is an old-style hash.
3947 * @param $hash String Password hash
3948 * @param $password String Plain-text password to compare
3949 * @param $userId String|bool User ID for old-style password salt
3953 public static function comparePasswords( $hash, $password, $userId = false ) {
3954 $type = substr( $hash, 0, 3 );
3957 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3961 if ( $type == ':A:' ) {
3963 return md5( $password ) === substr( $hash, 3 );
3964 } elseif ( $type == ':B:' ) {
3966 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3967 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3970 return self
::oldCrypt( $password, $userId ) === $hash;
3975 * Add a newuser log entry for this user
3977 * @param $byEmail Boolean: account made by email?
3978 * @param $reason String: user supplied reason
3980 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
3982 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3983 global $wgUser, $wgContLang, $wgNewUserLog;
3984 if( empty( $wgNewUserLog ) ) {
3985 return true; // disabled
3988 if( $this->getName() == $wgUser->getName() ) {
3991 $action = 'create2';
3993 if ( $reason === '' ) {
3994 $reason = wfMsgForContent( 'newuserlog-byemail' );
3996 $reason = $wgContLang->commaList( array(
3997 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
4001 $log = new LogPage( 'newusers' );
4002 return (int)$log->addEntry(
4004 $this->getUserPage(),
4006 array( $this->getId() )
4011 * Add an autocreate newuser log entry for this user
4012 * Used by things like CentralAuth and perhaps other authplugins.
4016 public function addNewUserLogEntryAutoCreate() {
4017 global $wgNewUserLog;
4018 if( !$wgNewUserLog ) {
4019 return true; // disabled
4021 $log = new LogPage( 'newusers', false );
4022 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
4029 protected function loadOptions() {
4031 if ( $this->mOptionsLoaded ||
!$this->getId() )
4034 $this->mOptions
= self
::getDefaultOptions();
4036 // Maybe load from the object
4037 if ( !is_null( $this->mOptionOverrides
) ) {
4038 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4039 foreach( $this->mOptionOverrides
as $key => $value ) {
4040 $this->mOptions
[$key] = $value;
4043 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4044 // Load from database
4045 $dbr = wfGetDB( DB_SLAVE
);
4047 $res = $dbr->select(
4050 array( 'up_user' => $this->getId() ),
4054 foreach ( $res as $row ) {
4055 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
4056 $this->mOptions
[$row->up_property
] = $row->up_value
;
4060 $this->mOptionsLoaded
= true;
4062 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4068 protected function saveOptions() {
4069 global $wgAllowPrefChange;
4071 $extuser = ExternalUser
::newFromUser( $this );
4073 $this->loadOptions();
4074 $dbw = wfGetDB( DB_MASTER
);
4076 $insert_rows = array();
4078 $saveOptions = $this->mOptions
;
4080 // Allow hooks to abort, for instance to save to a global profile.
4081 // Reset options to default state before saving.
4082 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4086 foreach( $saveOptions as $key => $value ) {
4087 # Don't bother storing default values
4088 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
4089 !( $value === false ||
is_null($value) ) ) ||
4090 $value != self
::getDefaultOption( $key ) ) {
4091 $insert_rows[] = array(
4092 'up_user' => $this->getId(),
4093 'up_property' => $key,
4094 'up_value' => $value,
4097 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4098 switch ( $wgAllowPrefChange[$key] ) {
4104 $extuser->setPref( $key, $value );
4109 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
4110 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4114 * Provide an array of HTML5 attributes to put on an input element
4115 * intended for the user to enter a new password. This may include
4116 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4118 * Do *not* use this when asking the user to enter his current password!
4119 * Regardless of configuration, users may have invalid passwords for whatever
4120 * reason (e.g., they were set before requirements were tightened up).
4121 * Only use it when asking for a new password, like on account creation or
4124 * Obviously, you still need to do server-side checking.
4126 * NOTE: A combination of bugs in various browsers means that this function
4127 * actually just returns array() unconditionally at the moment. May as
4128 * well keep it around for when the browser bugs get fixed, though.
4130 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4132 * @return array Array of HTML attributes suitable for feeding to
4133 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4134 * That will potentially output invalid XHTML 1.0 Transitional, and will
4135 * get confused by the boolean attribute syntax used.)
4137 public static function passwordChangeInputAttribs() {
4138 global $wgMinimalPasswordLength;
4140 if ( $wgMinimalPasswordLength == 0 ) {
4144 # Note that the pattern requirement will always be satisfied if the
4145 # input is empty, so we need required in all cases.
4147 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4148 # if e-mail confirmation is being used. Since HTML5 input validation
4149 # is b0rked anyway in some browsers, just return nothing. When it's
4150 # re-enabled, fix this code to not output required for e-mail
4152 #$ret = array( 'required' );
4155 # We can't actually do this right now, because Opera 9.6 will print out
4156 # the entered password visibly in its error message! When other
4157 # browsers add support for this attribute, or Opera fixes its support,
4158 # we can add support with a version check to avoid doing this on Opera
4159 # versions where it will be a problem. Reported to Opera as
4160 # DSK-262266, but they don't have a public bug tracker for us to follow.
4162 if ( $wgMinimalPasswordLength > 1 ) {
4163 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4164 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
4165 $wgMinimalPasswordLength );