3 * Implements the User class for the %MediaWiki software.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
24 * Int Number of characters in user_token field.
27 define( 'USER_TOKEN_LENGTH', 32 );
30 * Int Serialized record version.
33 define( 'MW_USER_VERSION', 8 );
36 * String Some punctuation to prevent editing from broken text-mangling proxies.
39 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
42 * Thrown by User::setPassword() on error.
45 class PasswordError
extends MWException
{
50 * The User object encapsulates all of the user-specific settings (user_id,
51 * name, rights, password, email address, options, last login time). Client
52 * classes use the getXXX() functions to access these fields. These functions
53 * do all the work of determining whether the user is logged in,
54 * whether the requested option can be satisfied from cookies or
55 * whether a database query is needed. Most of the settings needed
56 * for rendering normal pages are set in the cookie to minimize use
61 * Global constants made accessible as class constants so that autoloader
64 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
65 const MW_USER_VERSION
= MW_USER_VERSION
;
66 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
69 * Maximum items in $mWatchedItems
71 const MAX_WATCHED_ITEMS_CACHE
= 100;
74 * Array of Strings List of member variables which are saved to the
75 * shared cache (memcached). Any operation which changes the
76 * corresponding database fields must call a cache-clearing function.
79 static $mCacheVars = array(
90 'mEmailAuthenticated',
97 // user_properties table
102 * Array of Strings Core rights.
103 * Each of these should have a corresponding message of the form
107 static $mCoreRights = array(
127 'editusercssjs', #deprecated
139 'move-rootuserpages',
143 'override-export-depth',
166 'userrights-interwiki',
170 * String Cached results of getAllRights()
172 static $mAllRights = false;
174 /** @name Cache variables */
176 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
177 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
178 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mEditCount,
179 $mGroups, $mOptionOverrides;
183 * Bool Whether the cache variables have been loaded.
189 * Array with already loaded items or true if all items have been loaded.
191 private $mLoadedItems = array();
195 * String Initialization data source if mLoadedItems!==true. May be one of:
196 * - 'defaults' anonymous user initialised from class defaults
197 * - 'name' initialise from mName
198 * - 'id' initialise from mId
199 * - 'session' log in from cookies or session if possible
201 * Use the User::newFrom*() family of functions to set this.
206 * Lazy-initialized variables, invalidated with clearInstanceCache
208 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
209 $mBlockreason, $mEffectiveGroups, $mImplicitGroups, $mFormerGroups, $mBlockedGlobally,
210 $mLocked, $mHideName, $mOptions;
230 private $mBlockedFromCreateAccount = false;
235 private $mWatchedItems = array();
237 static $idCacheByName = array();
240 * Lightweight constructor for an anonymous user.
241 * Use the User::newFrom* factory functions for other kinds of users.
245 * @see newFromConfirmationCode()
246 * @see newFromSession()
249 function __construct() {
250 $this->clearInstanceCache( 'defaults' );
256 function __toString() {
257 return $this->getName();
261 * Load the user table data for this object from the source given by mFrom.
263 public function load() {
264 if ( $this->mLoadedItems
=== true ) {
267 wfProfileIn( __METHOD__
);
269 # Set it now to avoid infinite recursion in accessors
270 $this->mLoadedItems
= true;
272 switch ( $this->mFrom
) {
274 $this->loadDefaults();
277 $this->mId
= self
::idFromName( $this->mName
);
279 # Nonexistent user placeholder object
280 $this->loadDefaults( $this->mName
);
289 if( !$this->loadFromSession() ) {
290 // Loading from session failed. Load defaults.
291 $this->loadDefaults();
293 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
296 wfProfileOut( __METHOD__
);
297 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
299 wfProfileOut( __METHOD__
);
303 * Load user table data, given mId has already been set.
304 * @return Bool false if the ID does not exist, true otherwise
306 public function loadFromId() {
308 if ( $this->mId
== 0 ) {
309 $this->loadDefaults();
314 $key = wfMemcKey( 'user', 'id', $this->mId
);
315 $data = $wgMemc->get( $key );
316 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
317 # Object is expired, load from DB
322 wfDebug( "User: cache miss for user {$this->mId}\n" );
324 if ( !$this->loadFromDatabase() ) {
325 # Can't load from ID, user is anonymous
328 $this->saveToCache();
330 wfDebug( "User: got user {$this->mId} from cache\n" );
332 foreach ( self
::$mCacheVars as $name ) {
333 $this->$name = $data[$name];
337 $this->mLoadedItems
= true;
343 * Save user data to the shared cache
345 public function saveToCache() {
348 $this->loadOptions();
349 if ( $this->isAnon() ) {
350 // Anonymous users are uncached
354 foreach ( self
::$mCacheVars as $name ) {
355 $data[$name] = $this->$name;
357 $data['mVersion'] = MW_USER_VERSION
;
358 $key = wfMemcKey( 'user', 'id', $this->mId
);
360 $wgMemc->set( $key, $data );
363 /** @name newFrom*() static factory methods */
367 * Static factory method for creation from username.
369 * This is slightly less efficient than newFromId(), so use newFromId() if
370 * you have both an ID and a name handy.
372 * @param $name String Username, validated by Title::newFromText()
373 * @param $validate String|Bool Validate username. Takes the same parameters as
374 * User::getCanonicalName(), except that true is accepted as an alias
375 * for 'valid', for BC.
377 * @return User|bool User object, or false if the username is invalid
378 * (e.g. if it contains illegal characters or is an IP address). If the
379 * username is not present in the database, the result will be a user object
380 * with a name, zero user ID and default settings.
382 public static function newFromName( $name, $validate = 'valid' ) {
383 if ( $validate === true ) {
386 $name = self
::getCanonicalName( $name, $validate );
387 if ( $name === false ) {
390 # Create unloaded user object
394 $u->setItemLoaded( 'name' );
400 * Static factory method for creation from a given user ID.
402 * @param $id Int Valid user ID
403 * @return User The corresponding User object
405 public static function newFromId( $id ) {
409 $u->setItemLoaded( 'id' );
414 * Factory method to fetch whichever user has a given email confirmation code.
415 * This code is generated when an account is created or its e-mail address
418 * If the code is invalid or has expired, returns NULL.
420 * @param $code String Confirmation code
421 * @return User object, or null
423 public static function newFromConfirmationCode( $code ) {
424 $dbr = wfGetDB( DB_SLAVE
);
425 $id = $dbr->selectField( 'user', 'user_id', array(
426 'user_email_token' => md5( $code ),
427 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
429 if( $id !== false ) {
430 return User
::newFromId( $id );
437 * Create a new user object using data from session or cookies. If the
438 * login credentials are invalid, the result is an anonymous user.
440 * @param $request WebRequest object to use; $wgRequest will be used if
442 * @return User object
444 public static function newFromSession( WebRequest
$request = null ) {
446 $user->mFrom
= 'session';
447 $user->mRequest
= $request;
452 * Create a new user object from a user row.
453 * The row should have the following fields from the user table in it:
454 * - either user_name or user_id to load further data if needed (or both)
456 * - all other fields (email, password, etc.)
457 * It is useless to provide the remaining fields if either user_id,
458 * user_name and user_real_name are not provided because the whole row
459 * will be loaded once more from the database when accessing them.
461 * @param $row Array A row from the user table
462 * @param $data Array Further data to load into the object (see User::loadFromRow for valid keys)
465 public static function newFromRow( $row, $data = null ) {
467 $user->loadFromRow( $row, $data );
474 * Get the username corresponding to a given user ID
475 * @param $id Int User ID
476 * @return String|bool The corresponding username
478 public static function whoIs( $id ) {
479 return UserCache
::singleton()->getProp( $id, 'name' );
483 * Get the real name of a user given their user ID
485 * @param $id Int User ID
486 * @return String|bool The corresponding user's real name
488 public static function whoIsReal( $id ) {
489 return UserCache
::singleton()->getProp( $id, 'real_name' );
493 * Get database id given a user name
494 * @param $name String Username
495 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
497 public static function idFromName( $name ) {
498 $nt = Title
::makeTitleSafe( NS_USER
, $name );
499 if( is_null( $nt ) ) {
504 if ( isset( self
::$idCacheByName[$name] ) ) {
505 return self
::$idCacheByName[$name];
508 $dbr = wfGetDB( DB_SLAVE
);
509 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
511 if ( $s === false ) {
514 $result = $s->user_id
;
517 self
::$idCacheByName[$name] = $result;
519 if ( count( self
::$idCacheByName ) > 1000 ) {
520 self
::$idCacheByName = array();
527 * Reset the cache used in idFromName(). For use in tests.
529 public static function resetIdByNameCache() {
530 self
::$idCacheByName = array();
534 * Does the string match an anonymous IPv4 address?
536 * This function exists for username validation, in order to reject
537 * usernames which are similar in form to IP addresses. Strings such
538 * as 300.300.300.300 will return true because it looks like an IP
539 * address, despite not being strictly valid.
541 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
542 * address because the usemod software would "cloak" anonymous IP
543 * addresses like this, if we allowed accounts like this to be created
544 * new users could get the old edits of these anonymous users.
546 * @param $name String to match
549 public static function isIP( $name ) {
550 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name ) || IP
::isIPv6( $name );
554 * Is the input a valid username?
556 * Checks if the input is a valid username, we don't want an empty string,
557 * an IP address, anything that containins slashes (would mess up subpages),
558 * is longer than the maximum allowed username size or doesn't begin with
561 * @param $name String to match
564 public static function isValidUserName( $name ) {
565 global $wgContLang, $wgMaxNameChars;
568 || User
::isIP( $name )
569 ||
strpos( $name, '/' ) !== false
570 ||
strlen( $name ) > $wgMaxNameChars
571 ||
$name != $wgContLang->ucfirst( $name ) ) {
572 wfDebugLog( 'username', __METHOD__
.
573 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
578 // Ensure that the name can't be misresolved as a different title,
579 // such as with extra namespace keys at the start.
580 $parsed = Title
::newFromText( $name );
581 if( is_null( $parsed )
582 ||
$parsed->getNamespace()
583 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
584 wfDebugLog( 'username', __METHOD__
.
585 ": '$name' invalid due to ambiguous prefixes" );
589 // Check an additional blacklist of troublemaker characters.
590 // Should these be merged into the title char list?
591 $unicodeBlacklist = '/[' .
592 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
593 '\x{00a0}' . # non-breaking space
594 '\x{2000}-\x{200f}' . # various whitespace
595 '\x{2028}-\x{202f}' . # breaks and control chars
596 '\x{3000}' . # ideographic space
597 '\x{e000}-\x{f8ff}' . # private use
599 if( preg_match( $unicodeBlacklist, $name ) ) {
600 wfDebugLog( 'username', __METHOD__
.
601 ": '$name' invalid due to blacklisted characters" );
609 * Usernames which fail to pass this function will be blocked
610 * from user login and new account registrations, but may be used
611 * internally by batch processes.
613 * If an account already exists in this form, login will be blocked
614 * by a failure to pass this function.
616 * @param $name String to match
619 public static function isUsableName( $name ) {
620 global $wgReservedUsernames;
621 // Must be a valid username, obviously ;)
622 if ( !self
::isValidUserName( $name ) ) {
626 static $reservedUsernames = false;
627 if ( !$reservedUsernames ) {
628 $reservedUsernames = $wgReservedUsernames;
629 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
632 // Certain names may be reserved for batch processes.
633 foreach ( $reservedUsernames as $reserved ) {
634 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
635 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
637 if ( $reserved == $name ) {
645 * Usernames which fail to pass this function will be blocked
646 * from new account registrations, but may be used internally
647 * either by batch processes or by user accounts which have
648 * already been created.
650 * Additional blacklisting may be added here rather than in
651 * isValidUserName() to avoid disrupting existing accounts.
653 * @param $name String to match
656 public static function isCreatableName( $name ) {
657 global $wgInvalidUsernameCharacters;
659 // Ensure that the username isn't longer than 235 bytes, so that
660 // (at least for the builtin skins) user javascript and css files
661 // will work. (bug 23080)
662 if( strlen( $name ) > 235 ) {
663 wfDebugLog( 'username', __METHOD__
.
664 ": '$name' invalid due to length" );
668 // Preg yells if you try to give it an empty string
669 if( $wgInvalidUsernameCharacters !== '' ) {
670 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
671 wfDebugLog( 'username', __METHOD__
.
672 ": '$name' invalid due to wgInvalidUsernameCharacters" );
677 return self
::isUsableName( $name );
681 * Is the input a valid password for this user?
683 * @param $password String Desired password
686 public function isValidPassword( $password ) {
687 //simple boolean wrapper for getPasswordValidity
688 return $this->getPasswordValidity( $password ) === true;
692 * Given unvalidated password input, return error message on failure.
694 * @param $password String Desired password
695 * @return mixed: true on success, string or array of error message on failure
697 public function getPasswordValidity( $password ) {
698 global $wgMinimalPasswordLength, $wgContLang;
700 static $blockedLogins = array(
701 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
702 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
705 $result = false; //init $result to false for the internal checks
707 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
710 if ( $result === false ) {
711 if( strlen( $password ) < $wgMinimalPasswordLength ) {
712 return 'passwordtooshort';
713 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
714 return 'password-name-match';
715 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
716 return 'password-login-forbidden';
718 //it seems weird returning true here, but this is because of the
719 //initialization of $result to false above. If the hook is never run or it
720 //doesn't modify $result, then we will likely get down into this if with
724 } elseif( $result === true ) {
727 return $result; //the isValidPassword hook set a string $result and returned true
732 * Does a string look like an e-mail address?
734 * This validates an email address using an HTML5 specification found at:
735 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
736 * Which as of 2011-01-24 says:
738 * A valid e-mail address is a string that matches the ABNF production
739 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
740 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
743 * This function is an implementation of the specification as requested in
746 * Client-side forms will use the same standard validation rules via JS or
747 * HTML 5 validation; additional restrictions can be enforced server-side
748 * by extensions via the 'isValidEmailAddr' hook.
750 * Note that this validation doesn't 100% match RFC 2822, but is believed
751 * to be liberal enough for wide use. Some invalid addresses will still
752 * pass validation here.
754 * @param $addr String E-mail address
756 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
758 public static function isValidEmailAddr( $addr ) {
759 wfDeprecated( __METHOD__
, '1.18' );
760 return Sanitizer
::validateEmail( $addr );
764 * Given unvalidated user input, return a canonical username, or false if
765 * the username is invalid.
766 * @param $name String User input
767 * @param $validate String|Bool type of validation to use:
768 * - false No validation
769 * - 'valid' Valid for batch processes
770 * - 'usable' Valid for batch processes and login
771 * - 'creatable' Valid for batch processes, login and account creation
773 * @throws MWException
774 * @return bool|string
776 public static function getCanonicalName( $name, $validate = 'valid' ) {
777 # Force usernames to capital
779 $name = $wgContLang->ucfirst( $name );
781 # Reject names containing '#'; these will be cleaned up
782 # with title normalisation, but then it's too late to
784 if( strpos( $name, '#' ) !== false )
787 # Clean up name according to title rules
788 $t = ( $validate === 'valid' ) ?
789 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
790 # Check for invalid titles
791 if( is_null( $t ) ) {
795 # Reject various classes of invalid names
797 $name = $wgAuth->getCanonicalName( $t->getText() );
799 switch ( $validate ) {
803 if ( !User
::isValidUserName( $name ) ) {
808 if ( !User
::isUsableName( $name ) ) {
813 if ( !User
::isCreatableName( $name ) ) {
818 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
824 * Count the number of edits of a user
826 * @param $uid Int User ID to check
827 * @return Int the user's edit count
829 * @deprecated since 1.21 in favour of User::getEditCount
831 public static function edits( $uid ) {
832 wfDeprecated( __METHOD__
, '1.21' );
833 $user = self
::newFromId( $uid );
834 return $user->getEditCount();
838 * Return a random password.
840 * @return String new random password
842 public static function randomPassword() {
843 global $wgMinimalPasswordLength;
844 // Decide the final password length based on our min password length, stopping at a minimum of 10 chars
845 $length = max( 10, $wgMinimalPasswordLength );
846 // Multiply by 1.25 to get the number of hex characters we need
847 $length = $length * 1.25;
848 // Generate random hex chars
849 $hex = MWCryptRand
::generateHex( $length );
850 // Convert from base 16 to base 32 to get a proper password like string
851 return wfBaseConvert( $hex, 16, 32 );
855 * Set cached properties to default.
857 * @note This no longer clears uncached lazy-initialised properties;
858 * the constructor does that instead.
860 * @param $name string
862 public function loadDefaults( $name = false ) {
863 wfProfileIn( __METHOD__
);
866 $this->mName
= $name;
867 $this->mRealName
= '';
868 $this->mPassword
= $this->mNewpassword
= '';
869 $this->mNewpassTime
= null;
871 $this->mOptionOverrides
= null;
872 $this->mOptionsLoaded
= false;
874 $loggedOut = $this->getRequest()->getCookie( 'LoggedOut' );
875 if( $loggedOut !== null ) {
876 $this->mTouched
= wfTimestamp( TS_MW
, $loggedOut );
878 $this->mTouched
= '1'; # Allow any pages to be cached
881 $this->mToken
= null; // Don't run cryptographic functions till we need a token
882 $this->mEmailAuthenticated
= null;
883 $this->mEmailToken
= '';
884 $this->mEmailTokenExpires
= null;
885 $this->mRegistration
= wfTimestamp( TS_MW
);
886 $this->mGroups
= array();
888 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
890 wfProfileOut( __METHOD__
);
894 * Return whether an item has been loaded.
896 * @param $item String: item to check. Current possibilities:
900 * @param $all String: 'all' to check if the whole object has been loaded
901 * or any other string to check if only the item is available (e.g.
905 public function isItemLoaded( $item, $all = 'all' ) {
906 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
907 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
911 * Set that an item has been loaded
913 * @param $item String
915 private function setItemLoaded( $item ) {
916 if ( is_array( $this->mLoadedItems
) ) {
917 $this->mLoadedItems
[$item] = true;
922 * Load user data from the session or login cookie.
923 * @return Bool True if the user is logged in, false otherwise.
925 private function loadFromSession() {
926 global $wgExternalAuthType, $wgAutocreatePolicy;
929 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
930 if ( $result !== null ) {
934 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
935 $extUser = ExternalUser
::newFromCookie();
937 # TODO: Automatically create the user here (or probably a bit
938 # lower down, in fact)
942 $request = $this->getRequest();
944 $cookieId = $request->getCookie( 'UserID' );
945 $sessId = $request->getSessionData( 'wsUserID' );
947 if ( $cookieId !== null ) {
948 $sId = intval( $cookieId );
949 if( $sessId !== null && $cookieId != $sessId ) {
950 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 ) {
961 if ( $request->getSessionData( 'wsUserName' ) !== null ) {
962 $sName = $request->getSessionData( 'wsUserName' );
963 } elseif ( $request->getCookie( 'UserName' ) !== null ) {
964 $sName = $request->getCookie( 'UserName' );
965 $request->setSessionData( 'wsUserName', $sName );
970 $proposedUser = User
::newFromId( $sId );
971 if ( !$proposedUser->isLoggedIn() ) {
976 global $wgBlockDisablesLogin;
977 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
978 # User blocked and we've disabled blocked user logins
982 if ( $request->getSessionData( 'wsToken' ) ) {
983 $passwordCorrect = ( $proposedUser->getToken( false ) === $request->getSessionData( 'wsToken' ) );
985 } elseif ( $request->getCookie( 'Token' ) ) {
986 # Get the token from DB/cache and clean it up to remove garbage padding.
987 # This deals with historical problems with bugs and the default column value.
988 $token = rtrim( $proposedUser->getToken( false ) ); // correct token
989 $passwordCorrect = ( strlen( $token ) && $token === $request->getCookie( 'Token' ) );
992 # No session or persistent login cookie
996 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
997 $this->loadFromUserObject( $proposedUser );
998 $request->setSessionData( 'wsToken', $this->mToken
);
999 wfDebug( "User: logged in from $from\n" );
1002 # Invalid credentials
1003 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1009 * Load user and user_group data from the database.
1010 * $this->mId must be set, this is how the user is identified.
1012 * @return Bool True if the user exists, false if the user is anonymous
1014 public function loadFromDatabase() {
1016 $this->mId
= intval( $this->mId
);
1018 /** Anonymous user */
1020 $this->loadDefaults();
1024 $dbr = wfGetDB( DB_MASTER
);
1025 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1027 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1029 if ( $s !== false ) {
1030 # Initialise user table data
1031 $this->loadFromRow( $s );
1032 $this->mGroups
= null; // deferred
1033 $this->getEditCount(); // revalidation for nulls
1038 $this->loadDefaults();
1044 * Initialize this object from a row from the user table.
1046 * @param $row Array Row from the user table to load.
1047 * @param $data Array Further user data to load into the object
1049 * user_groups Array with groups out of the user_groups table
1050 * user_properties Array with properties out of the user_properties table
1052 public function loadFromRow( $row, $data = null ) {
1055 $this->mGroups
= null; // deferred
1057 if ( isset( $row->user_name
) ) {
1058 $this->mName
= $row->user_name
;
1059 $this->mFrom
= 'name';
1060 $this->setItemLoaded( 'name' );
1065 if ( isset( $row->user_real_name
) ) {
1066 $this->mRealName
= $row->user_real_name
;
1067 $this->setItemLoaded( 'realname' );
1072 if ( isset( $row->user_id
) ) {
1073 $this->mId
= intval( $row->user_id
);
1074 $this->mFrom
= 'id';
1075 $this->setItemLoaded( 'id' );
1080 if ( isset( $row->user_editcount
) ) {
1081 $this->mEditCount
= $row->user_editcount
;
1086 if ( isset( $row->user_password
) ) {
1087 $this->mPassword
= $row->user_password
;
1088 $this->mNewpassword
= $row->user_newpassword
;
1089 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1090 $this->mEmail
= $row->user_email
;
1091 if ( isset( $row->user_options
) ) {
1092 $this->decodeOptions( $row->user_options
);
1094 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1095 $this->mToken
= $row->user_token
;
1096 if ( $this->mToken
== '' ) {
1097 $this->mToken
= null;
1099 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1100 $this->mEmailToken
= $row->user_email_token
;
1101 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1102 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1108 $this->mLoadedItems
= true;
1111 if ( is_array( $data ) ) {
1112 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1113 $this->mGroups
= $data['user_groups'];
1115 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1116 $this->loadOptions( $data['user_properties'] );
1122 * Load the data for this user object from another user object.
1126 protected function loadFromUserObject( $user ) {
1128 $user->loadGroups();
1129 $user->loadOptions();
1130 foreach ( self
::$mCacheVars as $var ) {
1131 $this->$var = $user->$var;
1136 * Load the groups from the database if they aren't already loaded.
1138 private function loadGroups() {
1139 if ( is_null( $this->mGroups
) ) {
1140 $dbr = wfGetDB( DB_MASTER
);
1141 $res = $dbr->select( 'user_groups',
1142 array( 'ug_group' ),
1143 array( 'ug_user' => $this->mId
),
1145 $this->mGroups
= array();
1146 foreach ( $res as $row ) {
1147 $this->mGroups
[] = $row->ug_group
;
1153 * Add the user to the group if he/she meets given criteria.
1155 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1156 * possible to remove manually via Special:UserRights. In such case it
1157 * will not be re-added automatically. The user will also not lose the
1158 * group if they no longer meet the criteria.
1160 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1162 * @return array Array of groups the user has been promoted to.
1164 * @see $wgAutopromoteOnce
1166 public function addAutopromoteOnceGroups( $event ) {
1167 global $wgAutopromoteOnceLogInRC;
1169 $toPromote = array();
1170 if ( $this->getId() ) {
1171 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1172 if ( count( $toPromote ) ) {
1173 $oldGroups = $this->getGroups(); // previous groups
1174 foreach ( $toPromote as $group ) {
1175 $this->addGroup( $group );
1177 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1179 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1180 $logEntry->setPerformer( $this );
1181 $logEntry->setTarget( $this->getUserPage() );
1182 $logEntry->setParameters( array(
1183 '4::oldgroups' => $oldGroups,
1184 '5::newgroups' => $newGroups,
1186 $logid = $logEntry->insert();
1187 if ( $wgAutopromoteOnceLogInRC ) {
1188 $logEntry->publish( $logid );
1196 * Clear various cached data stored in this object. The cache of the user table
1197 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1199 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1200 * given source. May be "name", "id", "defaults", "session", or false for
1203 public function clearInstanceCache( $reloadFrom = false ) {
1204 $this->mNewtalk
= -1;
1205 $this->mDatePreference
= null;
1206 $this->mBlockedby
= -1; # Unset
1207 $this->mHash
= false;
1208 $this->mRights
= null;
1209 $this->mEffectiveGroups
= null;
1210 $this->mImplicitGroups
= null;
1211 $this->mGroups
= null;
1212 $this->mOptions
= null;
1213 $this->mOptionsLoaded
= false;
1214 $this->mEditCount
= null;
1216 if ( $reloadFrom ) {
1217 $this->mLoadedItems
= array();
1218 $this->mFrom
= $reloadFrom;
1223 * Combine the language default options with any site-specific options
1224 * and add the default language variants.
1226 * @return Array of String options
1228 public static function getDefaultOptions() {
1229 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1231 static $defOpt = null;
1232 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1233 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1234 // mid-request and see that change reflected in the return value of this function.
1235 // Which is insane and would never happen during normal MW operation
1239 $defOpt = $wgDefaultUserOptions;
1240 # default language setting
1241 $defOpt['variant'] = $wgContLang->getCode();
1242 $defOpt['language'] = $wgContLang->getCode();
1243 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1244 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1246 $defOpt['skin'] = $wgDefaultSkin;
1248 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1254 * Get a given default option value.
1256 * @param $opt String Name of option to retrieve
1257 * @return String Default option value
1259 public static function getDefaultOption( $opt ) {
1260 $defOpts = self
::getDefaultOptions();
1261 if( isset( $defOpts[$opt] ) ) {
1262 return $defOpts[$opt];
1270 * Get blocking information
1271 * @param $bFromSlave Bool Whether to check the slave database first. To
1272 * improve performance, non-critical checks are done
1273 * against slaves. Check when actually saving should be
1274 * done against master.
1276 private function getBlockedStatus( $bFromSlave = true ) {
1277 global $wgProxyWhitelist, $wgUser;
1279 if ( -1 != $this->mBlockedby
) {
1283 wfProfileIn( __METHOD__
);
1284 wfDebug( __METHOD__
.": checking...\n" );
1286 // Initialize data...
1287 // Otherwise something ends up stomping on $this->mBlockedby when
1288 // things get lazy-loaded later, causing false positive block hits
1289 // due to -1 !== 0. Probably session-related... Nothing should be
1290 // overwriting mBlockedby, surely?
1293 # We only need to worry about passing the IP address to the Block generator if the
1294 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1295 # know which IP address they're actually coming from
1296 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1297 $ip = $this->getRequest()->getIP();
1303 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1306 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1307 && !in_array( $ip, $wgProxyWhitelist ) )
1310 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1312 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1313 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1314 $block->setTarget( $ip );
1315 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1317 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1318 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1319 $block->setTarget( $ip );
1323 if ( $block instanceof Block
) {
1324 wfDebug( __METHOD__
. ": Found block.\n" );
1325 $this->mBlock
= $block;
1326 $this->mBlockedby
= $block->getByName();
1327 $this->mBlockreason
= $block->mReason
;
1328 $this->mHideName
= $block->mHideName
;
1329 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1331 $this->mBlockedby
= '';
1332 $this->mHideName
= 0;
1333 $this->mAllowUsertalk
= false;
1337 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1339 wfProfileOut( __METHOD__
);
1343 * Whether the given IP is in a DNS blacklist.
1345 * @param $ip String IP to check
1346 * @param $checkWhitelist Bool: whether to check the whitelist first
1347 * @return Bool True if blacklisted.
1349 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1350 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1351 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1353 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1356 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1359 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1360 return $this->inDnsBlacklist( $ip, $urls );
1364 * Whether the given IP is in a given DNS blacklist.
1366 * @param $ip String IP to check
1367 * @param $bases String|Array of Strings: URL of the DNS blacklist
1368 * @return Bool True if blacklisted.
1370 public function inDnsBlacklist( $ip, $bases ) {
1371 wfProfileIn( __METHOD__
);
1374 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1375 if( IP
::isIPv4( $ip ) ) {
1376 # Reverse IP, bug 21255
1377 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1379 foreach( (array)$bases as $base ) {
1381 # If we have an access key, use that too (ProjectHoneypot, etc.)
1382 if( is_array( $base ) ) {
1383 if( count( $base ) >= 2 ) {
1384 # Access key is 1, base URL is 0
1385 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1387 $host = "$ipReversed.{$base[0]}";
1390 $host = "$ipReversed.$base";
1394 $ipList = gethostbynamel( $host );
1397 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1401 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1406 wfProfileOut( __METHOD__
);
1411 * Check if an IP address is in the local proxy list
1417 public static function isLocallyBlockedProxy( $ip ) {
1418 global $wgProxyList;
1420 if ( !$wgProxyList ) {
1423 wfProfileIn( __METHOD__
);
1425 if ( !is_array( $wgProxyList ) ) {
1426 # Load from the specified file
1427 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1430 if ( !is_array( $wgProxyList ) ) {
1432 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1434 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1435 # Old-style flipped proxy list
1440 wfProfileOut( __METHOD__
);
1445 * Is this user subject to rate limiting?
1447 * @return Bool True if rate limited
1449 public function isPingLimitable() {
1450 global $wgRateLimitsExcludedIPs;
1451 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1452 // No other good way currently to disable rate limits
1453 // for specific IPs. :P
1454 // But this is a crappy hack and should die.
1457 return !$this->isAllowed( 'noratelimit' );
1461 * Primitive rate limits: enforce maximum actions per time period
1462 * to put a brake on flooding.
1464 * @note When using a shared cache like memcached, IP-address
1465 * last-hit counters will be shared across wikis.
1467 * @param $action String Action to enforce; 'edit' if unspecified
1468 * @return Bool True if a rate limiter was tripped
1470 public function pingLimiter( $action = 'edit' ) {
1471 # Call the 'PingLimiter' hook
1473 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, &$result ) ) ) {
1477 global $wgRateLimits;
1478 if( !isset( $wgRateLimits[$action] ) ) {
1482 # Some groups shouldn't trigger the ping limiter, ever
1483 if( !$this->isPingLimitable() )
1486 global $wgMemc, $wgRateLimitLog;
1487 wfProfileIn( __METHOD__
);
1489 $limits = $wgRateLimits[$action];
1491 $id = $this->getId();
1492 $ip = $this->getRequest()->getIP();
1495 if( isset( $limits['anon'] ) && $id == 0 ) {
1496 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1499 if( isset( $limits['user'] ) && $id != 0 ) {
1500 $userLimit = $limits['user'];
1502 if( $this->isNewbie() ) {
1503 if( isset( $limits['newbie'] ) && $id != 0 ) {
1504 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1506 if( isset( $limits['ip'] ) ) {
1507 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1510 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1511 $subnet = $matches[1];
1512 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1515 // Check for group-specific permissions
1516 // If more than one group applies, use the group with the highest limit
1517 foreach ( $this->getGroups() as $group ) {
1518 if ( isset( $limits[$group] ) ) {
1519 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1520 $userLimit = $limits[$group];
1524 // Set the user limit key
1525 if ( $userLimit !== false ) {
1526 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1527 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1531 foreach( $keys as $key => $limit ) {
1532 list( $max, $period ) = $limit;
1533 $summary = "(limit $max in {$period}s)";
1534 $count = $wgMemc->get( $key );
1537 if( $count >= $max ) {
1538 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1539 if( $wgRateLimitLog ) {
1540 wfSuppressWarnings();
1541 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1542 wfRestoreWarnings();
1546 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1549 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1550 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1552 $wgMemc->incr( $key );
1555 wfProfileOut( __METHOD__
);
1560 * Check if user is blocked
1562 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1563 * @return Bool True if blocked, false otherwise
1565 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1566 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1570 * Get the block affecting the user, or null if the user is not blocked
1572 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1573 * @return Block|null
1575 public function getBlock( $bFromSlave = true ) {
1576 $this->getBlockedStatus( $bFromSlave );
1577 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1581 * Check if user is blocked from editing a particular article
1583 * @param $title Title to check
1584 * @param $bFromSlave Bool whether to check the slave database instead of the master
1587 function isBlockedFrom( $title, $bFromSlave = false ) {
1588 global $wgBlockAllowsUTEdit;
1589 wfProfileIn( __METHOD__
);
1591 $blocked = $this->isBlocked( $bFromSlave );
1592 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1593 # If a user's name is suppressed, they cannot make edits anywhere
1594 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1595 $title->getNamespace() == NS_USER_TALK
) {
1597 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1600 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1602 wfProfileOut( __METHOD__
);
1607 * If user is blocked, return the name of the user who placed the block
1608 * @return String name of blocker
1610 public function blockedBy() {
1611 $this->getBlockedStatus();
1612 return $this->mBlockedby
;
1616 * If user is blocked, return the specified reason for the block
1617 * @return String Blocking reason
1619 public function blockedFor() {
1620 $this->getBlockedStatus();
1621 return $this->mBlockreason
;
1625 * If user is blocked, return the ID for the block
1626 * @return Int Block ID
1628 public function getBlockId() {
1629 $this->getBlockedStatus();
1630 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1634 * Check if user is blocked on all wikis.
1635 * Do not use for actual edit permission checks!
1636 * This is intented for quick UI checks.
1638 * @param $ip String IP address, uses current client if none given
1639 * @return Bool True if blocked, false otherwise
1641 public function isBlockedGlobally( $ip = '' ) {
1642 if( $this->mBlockedGlobally
!== null ) {
1643 return $this->mBlockedGlobally
;
1645 // User is already an IP?
1646 if( IP
::isIPAddress( $this->getName() ) ) {
1647 $ip = $this->getName();
1649 $ip = $this->getRequest()->getIP();
1652 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1653 $this->mBlockedGlobally
= (bool)$blocked;
1654 return $this->mBlockedGlobally
;
1658 * Check if user account is locked
1660 * @return Bool True if locked, false otherwise
1662 public function isLocked() {
1663 if( $this->mLocked
!== null ) {
1664 return $this->mLocked
;
1667 $authUser = $wgAuth->getUserInstance( $this );
1668 $this->mLocked
= (bool)$authUser->isLocked();
1669 return $this->mLocked
;
1673 * Check if user account is hidden
1675 * @return Bool True if hidden, false otherwise
1677 public function isHidden() {
1678 if( $this->mHideName
!== null ) {
1679 return $this->mHideName
;
1681 $this->getBlockedStatus();
1682 if( !$this->mHideName
) {
1684 $authUser = $wgAuth->getUserInstance( $this );
1685 $this->mHideName
= (bool)$authUser->isHidden();
1687 return $this->mHideName
;
1691 * Get the user's ID.
1692 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1694 public function getId() {
1695 if( $this->mId
=== null && $this->mName
!== null
1696 && User
::isIP( $this->mName
) ) {
1697 // Special case, we know the user is anonymous
1699 } elseif( !$this->isItemLoaded( 'id' ) ) {
1700 // Don't load if this was initialized from an ID
1707 * Set the user and reload all fields according to a given ID
1708 * @param $v Int User ID to reload
1710 public function setId( $v ) {
1712 $this->clearInstanceCache( 'id' );
1716 * Get the user name, or the IP of an anonymous user
1717 * @return String User's name or IP address
1719 public function getName() {
1720 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1721 # Special case optimisation
1722 return $this->mName
;
1725 if ( $this->mName
=== false ) {
1727 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1729 return $this->mName
;
1734 * Set the user name.
1736 * This does not reload fields from the database according to the given
1737 * name. Rather, it is used to create a temporary "nonexistent user" for
1738 * later addition to the database. It can also be used to set the IP
1739 * address for an anonymous user to something other than the current
1742 * @note User::newFromName() has rougly the same function, when the named user
1744 * @param $str String New user name to set
1746 public function setName( $str ) {
1748 $this->mName
= $str;
1752 * Get the user's name escaped by underscores.
1753 * @return String Username escaped by underscores.
1755 public function getTitleKey() {
1756 return str_replace( ' ', '_', $this->getName() );
1760 * Check if the user has new messages.
1761 * @return Bool True if the user has new messages
1763 public function getNewtalk() {
1766 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1767 if( $this->mNewtalk
=== -1 ) {
1768 $this->mNewtalk
= false; # reset talk page status
1770 # Check memcached separately for anons, who have no
1771 # entire User object stored in there.
1773 global $wgDisableAnonTalk;
1774 if( $wgDisableAnonTalk ) {
1775 // Anon newtalk disabled by configuration.
1776 $this->mNewtalk
= false;
1779 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1780 $newtalk = $wgMemc->get( $key );
1781 if( strval( $newtalk ) !== '' ) {
1782 $this->mNewtalk
= (bool)$newtalk;
1784 // Since we are caching this, make sure it is up to date by getting it
1786 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1787 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1791 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1795 return (bool)$this->mNewtalk
;
1799 * Return the talk page(s) this user has new messages on.
1800 * @return Array of String page URLs
1802 public function getNewMessageLinks() {
1804 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1806 } elseif( !$this->getNewtalk() ) {
1809 $utp = $this->getTalkPage();
1810 $dbr = wfGetDB( DB_SLAVE
);
1811 // Get the "last viewed rev" timestamp from the oldest message notification
1812 $timestamp = $dbr->selectField( 'user_newtalk',
1813 'MIN(user_last_timestamp)',
1814 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1816 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1817 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1821 * Internal uncached check for new messages
1824 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1825 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1826 * @param $fromMaster Bool true to fetch from the master, false for a slave
1827 * @return Bool True if the user has new messages
1829 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1830 if ( $fromMaster ) {
1831 $db = wfGetDB( DB_MASTER
);
1833 $db = wfGetDB( DB_SLAVE
);
1835 $ok = $db->selectField( 'user_newtalk', $field,
1836 array( $field => $id ), __METHOD__
);
1837 return $ok !== false;
1841 * Add or update the new messages flag
1842 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1843 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1844 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1845 * @return Bool True if successful, false otherwise
1847 protected function updateNewtalk( $field, $id, $curRev = null ) {
1848 // Get timestamp of the talk page revision prior to the current one
1849 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1850 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1851 // Mark the user as having new messages since this revision
1852 $dbw = wfGetDB( DB_MASTER
);
1853 $dbw->insert( 'user_newtalk',
1854 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1857 if ( $dbw->affectedRows() ) {
1858 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1861 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1867 * Clear the new messages flag for the given user
1868 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1869 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1870 * @return Bool True if successful, false otherwise
1872 protected function deleteNewtalk( $field, $id ) {
1873 $dbw = wfGetDB( DB_MASTER
);
1874 $dbw->delete( 'user_newtalk',
1875 array( $field => $id ),
1877 if ( $dbw->affectedRows() ) {
1878 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1881 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1887 * Update the 'You have new messages!' status.
1888 * @param $val Bool Whether the user has new messages
1889 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1891 public function setNewtalk( $val, $curRev = null ) {
1892 if( wfReadOnly() ) {
1897 $this->mNewtalk
= $val;
1899 if( $this->isAnon() ) {
1901 $id = $this->getName();
1904 $id = $this->getId();
1909 $changed = $this->updateNewtalk( $field, $id, $curRev );
1911 $changed = $this->deleteNewtalk( $field, $id );
1914 if( $this->isAnon() ) {
1915 // Anons have a separate memcached space, since
1916 // user records aren't kept for them.
1917 $key = wfMemcKey( 'newtalk', 'ip', $id );
1918 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1921 $this->invalidateCache();
1926 * Generate a current or new-future timestamp to be stored in the
1927 * user_touched field when we update things.
1928 * @return String Timestamp in TS_MW format
1930 private static function newTouchedTimestamp() {
1931 global $wgClockSkewFudge;
1932 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1936 * Clear user data from memcached.
1937 * Use after applying fun updates to the database; caller's
1938 * responsibility to update user_touched if appropriate.
1940 * Called implicitly from invalidateCache() and saveSettings().
1942 private function clearSharedCache() {
1946 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1951 * Immediately touch the user data cache for this account.
1952 * Updates user_touched field, and removes account data from memcached
1953 * for reload on the next hit.
1955 public function invalidateCache() {
1956 if( wfReadOnly() ) {
1961 $this->mTouched
= self
::newTouchedTimestamp();
1963 $dbw = wfGetDB( DB_MASTER
);
1965 // Prevent contention slams by checking user_touched first
1966 $now = $dbw->timestamp( $this->mTouched
);
1967 $needsPurge = $dbw->selectField( 'user', '1',
1968 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1970 if ( $needsPurge ) {
1971 $dbw->update( 'user',
1972 array( 'user_touched' => $now ),
1973 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1978 $this->clearSharedCache();
1983 * Validate the cache for this account.
1984 * @param $timestamp String A timestamp in TS_MW format
1988 public function validateCache( $timestamp ) {
1990 return ( $timestamp >= $this->mTouched
);
1994 * Get the user touched timestamp
1995 * @return String timestamp
1997 public function getTouched() {
1999 return $this->mTouched
;
2003 * Set the password and reset the random token.
2004 * Calls through to authentication plugin if necessary;
2005 * will have no effect if the auth plugin refuses to
2006 * pass the change through or if the legal password
2009 * As a special case, setting the password to null
2010 * wipes it, so the account cannot be logged in until
2011 * a new password is set, for instance via e-mail.
2013 * @param $str String New password to set
2014 * @throws PasswordError on failure
2018 public function setPassword( $str ) {
2021 if( $str !== null ) {
2022 if( !$wgAuth->allowPasswordChange() ) {
2023 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2026 if( !$this->isValidPassword( $str ) ) {
2027 global $wgMinimalPasswordLength;
2028 $valid = $this->getPasswordValidity( $str );
2029 if ( is_array( $valid ) ) {
2030 $message = array_shift( $valid );
2034 $params = array( $wgMinimalPasswordLength );
2036 throw new PasswordError( wfMessage( $message, $params )->text() );
2040 if( !$wgAuth->setPassword( $this, $str ) ) {
2041 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2044 $this->setInternalPassword( $str );
2050 * Set the password and reset the random token unconditionally.
2052 * @param $str string|null New password to set or null to set an invalid
2053 * password hash meaning that the user will not be able to log in
2054 * through the web interface.
2056 public function setInternalPassword( $str ) {
2060 if( $str === null ) {
2061 // Save an invalid hash...
2062 $this->mPassword
= '';
2064 $this->mPassword
= self
::crypt( $str );
2066 $this->mNewpassword
= '';
2067 $this->mNewpassTime
= null;
2071 * Get the user's current token.
2072 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2073 * @return String Token
2075 public function getToken( $forceCreation = true ) {
2077 if ( !$this->mToken
&& $forceCreation ) {
2080 return $this->mToken
;
2084 * Set the random token (used for persistent authentication)
2085 * Called from loadDefaults() among other places.
2087 * @param $token String|bool If specified, set the token to this value
2089 public function setToken( $token = false ) {
2092 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2094 $this->mToken
= $token;
2099 * Set the password for a password reminder or new account email
2101 * @param $str String New password to set
2102 * @param $throttle Bool If true, reset the throttle timestamp to the present
2104 public function setNewpassword( $str, $throttle = true ) {
2106 $this->mNewpassword
= self
::crypt( $str );
2108 $this->mNewpassTime
= wfTimestampNow();
2113 * Has password reminder email been sent within the last
2114 * $wgPasswordReminderResendTime hours?
2117 public function isPasswordReminderThrottled() {
2118 global $wgPasswordReminderResendTime;
2120 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2123 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2124 return time() < $expiry;
2128 * Get the user's e-mail address
2129 * @return String User's email address
2131 public function getEmail() {
2133 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2134 return $this->mEmail
;
2138 * Get the timestamp of the user's e-mail authentication
2139 * @return String TS_MW timestamp
2141 public function getEmailAuthenticationTimestamp() {
2143 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2144 return $this->mEmailAuthenticated
;
2148 * Set the user's e-mail address
2149 * @param $str String New e-mail address
2151 public function setEmail( $str ) {
2153 if( $str == $this->mEmail
) {
2156 $this->mEmail
= $str;
2157 $this->invalidateEmail();
2158 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2162 * Set the user's e-mail address and a confirmation mail if needed.
2165 * @param $str String New e-mail address
2168 public function setEmailWithConfirmation( $str ) {
2169 global $wgEnableEmail, $wgEmailAuthentication;
2171 if ( !$wgEnableEmail ) {
2172 return Status
::newFatal( 'emaildisabled' );
2175 $oldaddr = $this->getEmail();
2176 if ( $str === $oldaddr ) {
2177 return Status
::newGood( true );
2180 $this->setEmail( $str );
2182 if ( $str !== '' && $wgEmailAuthentication ) {
2183 # Send a confirmation request to the new address if needed
2184 $type = $oldaddr != '' ?
'changed' : 'set';
2185 $result = $this->sendConfirmationMail( $type );
2186 if ( $result->isGood() ) {
2187 # Say the the caller that a confirmation mail has been sent
2188 $result->value
= 'eauth';
2191 $result = Status
::newGood( true );
2198 * Get the user's real name
2199 * @return String User's real name
2201 public function getRealName() {
2202 if ( !$this->isItemLoaded( 'realname' ) ) {
2206 return $this->mRealName
;
2210 * Set the user's real name
2211 * @param $str String New real name
2213 public function setRealName( $str ) {
2215 $this->mRealName
= $str;
2219 * Get the user's current setting for a given option.
2221 * @param $oname String The option to check
2222 * @param $defaultOverride String A default value returned if the option does not exist
2223 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2224 * @return String User's current value for the option
2225 * @see getBoolOption()
2226 * @see getIntOption()
2228 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2229 global $wgHiddenPrefs;
2230 $this->loadOptions();
2232 # We want 'disabled' preferences to always behave as the default value for
2233 # users, even if they have set the option explicitly in their settings (ie they
2234 # set it, and then it was disabled removing their ability to change it). But
2235 # we don't want to erase the preferences in the database in case the preference
2236 # is re-enabled again. So don't touch $mOptions, just override the returned value
2237 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ) {
2238 return self
::getDefaultOption( $oname );
2241 if ( array_key_exists( $oname, $this->mOptions
) ) {
2242 return $this->mOptions
[$oname];
2244 return $defaultOverride;
2249 * Get all user's options
2253 public function getOptions() {
2254 global $wgHiddenPrefs;
2255 $this->loadOptions();
2256 $options = $this->mOptions
;
2258 # We want 'disabled' preferences to always behave as the default value for
2259 # users, even if they have set the option explicitly in their settings (ie they
2260 # set it, and then it was disabled removing their ability to change it). But
2261 # we don't want to erase the preferences in the database in case the preference
2262 # is re-enabled again. So don't touch $mOptions, just override the returned value
2263 foreach( $wgHiddenPrefs as $pref ) {
2264 $default = self
::getDefaultOption( $pref );
2265 if( $default !== null ) {
2266 $options[$pref] = $default;
2274 * Get the user's current setting for a given option, as a boolean value.
2276 * @param $oname String The option to check
2277 * @return Bool User's current value for the option
2280 public function getBoolOption( $oname ) {
2281 return (bool)$this->getOption( $oname );
2285 * Get the user's current setting for a given option, as a boolean value.
2287 * @param $oname String The option to check
2288 * @param $defaultOverride Int A default value returned if the option does not exist
2289 * @return Int User's current value for the option
2292 public function getIntOption( $oname, $defaultOverride = 0 ) {
2293 $val = $this->getOption( $oname );
2295 $val = $defaultOverride;
2297 return intval( $val );
2301 * Set the given option for a user.
2303 * @param $oname String The option to set
2304 * @param $val mixed New value to set
2306 public function setOption( $oname, $val ) {
2307 $this->loadOptions();
2309 // Explicitly NULL values should refer to defaults
2310 if( is_null( $val ) ) {
2311 $val = self
::getDefaultOption( $oname );
2314 $this->mOptions
[$oname] = $val;
2318 * Return a list of the types of user options currently returned by
2319 * User::getOptionKinds().
2321 * Currently, the option kinds are:
2322 * - 'registered' - preferences which are registered in core MediaWiki or
2323 * by extensions using the UserGetDefaultOptions hook.
2324 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2325 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2326 * be used by user scripts.
2327 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2328 * These are usually legacy options, removed in newer versions.
2330 * The API (and possibly others) use this function to determine the possible
2331 * option types for validation purposes, so make sure to update this when a
2332 * new option kind is added.
2334 * @see User::getOptionKinds
2335 * @return array Option kinds
2337 public static function listOptionKinds() {
2340 'registered-multiselect',
2347 * Return an associative array mapping preferences keys to the kind of a preference they're
2348 * used for. Different kinds are handled differently when setting or reading preferences.
2350 * See User::listOptionKinds for the list of valid option types that can be provided.
2352 * @see User::listOptionKinds
2353 * @param $context IContextSource
2354 * @param $options array assoc. array with options keys to check as keys. Defaults to $this->mOptions.
2355 * @return array the key => kind mapping data
2357 public function getOptionKinds( IContextSource
$context, $options = null ) {
2358 $this->loadOptions();
2359 if ( $options === null ) {
2360 $options = $this->mOptions
;
2363 $prefs = Preferences
::getPreferences( $this, $context );
2366 // Multiselect options are stored in the database with one key per
2367 // option, each having a boolean value. Extract those keys.
2368 $multiselectOptions = array();
2369 foreach ( $prefs as $name => $info ) {
2370 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2371 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2372 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2373 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2375 foreach ( $opts as $value ) {
2376 $multiselectOptions["$prefix$value"] = true;
2379 unset( $prefs[$name] );
2383 // $value is ignored
2384 foreach ( $options as $key => $value ) {
2385 if ( isset( $prefs[$key] ) ) {
2386 $mapping[$key] = 'registered';
2387 } elseif( isset( $multiselectOptions[$key] ) ) {
2388 $mapping[$key] = 'registered-multiselect';
2389 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2390 $mapping[$key] = 'userjs';
2392 $mapping[$key] = 'unused';
2400 * Reset certain (or all) options to the site defaults
2402 * The optional parameter determines which kinds of preferences will be reset.
2403 * Supported values are everything that can be reported by getOptionKinds()
2404 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2406 * @param $resetKinds array|string which kinds of preferences to reset. Defaults to
2407 * array( 'registered', 'registered-multiselect', 'unused' )
2408 * for backwards-compatibility.
2409 * @param $context IContextSource|null context source used when $resetKinds
2410 * does not contain 'all', passed to getOptionKinds().
2411 * Defaults to RequestContext::getMain() when null.
2413 public function resetOptions(
2414 $resetKinds = array( 'registered', 'registered-multiselect', 'unused' ),
2415 IContextSource
$context = null
2418 $defaultOptions = self
::getDefaultOptions();
2420 if ( !is_array( $resetKinds ) ) {
2421 $resetKinds = array( $resetKinds );
2424 if ( in_array( 'all', $resetKinds ) ) {
2425 $newOptions = $defaultOptions;
2427 if ( $context === null ) {
2428 $context = RequestContext
::getMain();
2431 $optionKinds = $this->getOptionKinds( $context );
2432 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
2433 $newOptions = array();
2435 // Use default values for the options that should be deleted, and
2436 // copy old values for the ones that shouldn't.
2437 foreach ( $this->mOptions
as $key => $value ) {
2438 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2439 if ( array_key_exists( $key, $defaultOptions ) ) {
2440 $newOptions[$key] = $defaultOptions[$key];
2443 $newOptions[$key] = $value;
2448 $this->mOptions
= $newOptions;
2449 $this->mOptionsLoaded
= true;
2453 * Get the user's preferred date format.
2454 * @return String User's preferred date format
2456 public function getDatePreference() {
2457 // Important migration for old data rows
2458 if ( is_null( $this->mDatePreference
) ) {
2460 $value = $this->getOption( 'date' );
2461 $map = $wgLang->getDatePreferenceMigrationMap();
2462 if ( isset( $map[$value] ) ) {
2463 $value = $map[$value];
2465 $this->mDatePreference
= $value;
2467 return $this->mDatePreference
;
2471 * Get the user preferred stub threshold
2475 public function getStubThreshold() {
2476 global $wgMaxArticleSize; # Maximum article size, in Kb
2477 $threshold = $this->getIntOption( 'stubthreshold' );
2478 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2479 # If they have set an impossible value, disable the preference
2480 # so we can use the parser cache again.
2487 * Get the permissions this user has.
2488 * @return Array of String permission names
2490 public function getRights() {
2491 if ( is_null( $this->mRights
) ) {
2492 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2493 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2494 // Force reindexation of rights when a hook has unset one of them
2495 $this->mRights
= array_values( array_unique( $this->mRights
) );
2497 return $this->mRights
;
2501 * Get the list of explicit group memberships this user has.
2502 * The implicit * and user groups are not included.
2503 * @return Array of String internal group names
2505 public function getGroups() {
2507 $this->loadGroups();
2508 return $this->mGroups
;
2512 * Get the list of implicit group memberships this user has.
2513 * This includes all explicit groups, plus 'user' if logged in,
2514 * '*' for all accounts, and autopromoted groups
2515 * @param $recache Bool Whether to avoid the cache
2516 * @return Array of String internal group names
2518 public function getEffectiveGroups( $recache = false ) {
2519 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2520 wfProfileIn( __METHOD__
);
2521 $this->mEffectiveGroups
= array_unique( array_merge(
2522 $this->getGroups(), // explicit groups
2523 $this->getAutomaticGroups( $recache ) // implicit groups
2525 # Hook for additional groups
2526 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2527 // Force reindexation of groups when a hook has unset one of them
2528 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
2529 wfProfileOut( __METHOD__
);
2531 return $this->mEffectiveGroups
;
2535 * Get the list of implicit group memberships this user has.
2536 * This includes 'user' if logged in, '*' for all accounts,
2537 * and autopromoted groups
2538 * @param $recache Bool Whether to avoid the cache
2539 * @return Array of String internal group names
2541 public function getAutomaticGroups( $recache = false ) {
2542 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2543 wfProfileIn( __METHOD__
);
2544 $this->mImplicitGroups
= array( '*' );
2545 if ( $this->getId() ) {
2546 $this->mImplicitGroups
[] = 'user';
2548 $this->mImplicitGroups
= array_unique( array_merge(
2549 $this->mImplicitGroups
,
2550 Autopromote
::getAutopromoteGroups( $this )
2554 # Assure data consistency with rights/groups,
2555 # as getEffectiveGroups() depends on this function
2556 $this->mEffectiveGroups
= null;
2558 wfProfileOut( __METHOD__
);
2560 return $this->mImplicitGroups
;
2564 * Returns the groups the user has belonged to.
2566 * The user may still belong to the returned groups. Compare with getGroups().
2568 * The function will not return groups the user had belonged to before MW 1.17
2570 * @return array Names of the groups the user has belonged to.
2572 public function getFormerGroups() {
2573 if( is_null( $this->mFormerGroups
) ) {
2574 $dbr = wfGetDB( DB_MASTER
);
2575 $res = $dbr->select( 'user_former_groups',
2576 array( 'ufg_group' ),
2577 array( 'ufg_user' => $this->mId
),
2579 $this->mFormerGroups
= array();
2580 foreach( $res as $row ) {
2581 $this->mFormerGroups
[] = $row->ufg_group
;
2584 return $this->mFormerGroups
;
2588 * Get the user's edit count.
2591 public function getEditCount() {
2592 if ( !$this->getId() ) {
2596 if ( !isset( $this->mEditCount
) ) {
2597 /* Populate the count, if it has not been populated yet */
2598 wfProfileIn( __METHOD__
);
2599 $dbr = wfGetDB( DB_SLAVE
);
2600 // check if the user_editcount field has been initialized
2601 $count = $dbr->selectField(
2602 'user', 'user_editcount',
2603 array( 'user_id' => $this->mId
),
2607 if( $count === null ) {
2608 // it has not been initialized. do so.
2609 $count = $this->initEditCount();
2611 $this->mEditCount
= intval( $count );
2612 wfProfileOut( __METHOD__
);
2614 return $this->mEditCount
;
2618 * Add the user to the given group.
2619 * This takes immediate effect.
2620 * @param $group String Name of the group to add
2622 public function addGroup( $group ) {
2623 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2624 $dbw = wfGetDB( DB_MASTER
);
2625 if( $this->getId() ) {
2626 $dbw->insert( 'user_groups',
2628 'ug_user' => $this->getID(),
2629 'ug_group' => $group,
2632 array( 'IGNORE' ) );
2635 $this->loadGroups();
2636 $this->mGroups
[] = $group;
2637 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2639 $this->invalidateCache();
2643 * Remove the user from the given group.
2644 * This takes immediate effect.
2645 * @param $group String Name of the group to remove
2647 public function removeGroup( $group ) {
2649 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2650 $dbw = wfGetDB( DB_MASTER
);
2651 $dbw->delete( 'user_groups',
2653 'ug_user' => $this->getID(),
2654 'ug_group' => $group,
2656 // Remember that the user was in this group
2657 $dbw->insert( 'user_former_groups',
2659 'ufg_user' => $this->getID(),
2660 'ufg_group' => $group,
2663 array( 'IGNORE' ) );
2665 $this->loadGroups();
2666 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2667 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2669 $this->invalidateCache();
2673 * Get whether the user is logged in
2676 public function isLoggedIn() {
2677 return $this->getID() != 0;
2681 * Get whether the user is anonymous
2684 public function isAnon() {
2685 return !$this->isLoggedIn();
2689 * Check if user is allowed to access a feature / make an action
2691 * @internal param \String $varargs permissions to test
2692 * @return Boolean: True if user is allowed to perform *any* of the given actions
2696 public function isAllowedAny( /*...*/ ) {
2697 $permissions = func_get_args();
2698 foreach( $permissions as $permission ) {
2699 if( $this->isAllowed( $permission ) ) {
2708 * @internal param $varargs string
2709 * @return bool True if the user is allowed to perform *all* of the given actions
2711 public function isAllowedAll( /*...*/ ) {
2712 $permissions = func_get_args();
2713 foreach( $permissions as $permission ) {
2714 if( !$this->isAllowed( $permission ) ) {
2722 * Internal mechanics of testing a permission
2723 * @param $action String
2726 public function isAllowed( $action = '' ) {
2727 if ( $action === '' ) {
2728 return true; // In the spirit of DWIM
2730 # Patrolling may not be enabled
2731 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2732 global $wgUseRCPatrol, $wgUseNPPatrol;
2733 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2736 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2737 # by misconfiguration: 0 == 'foo'
2738 return in_array( $action, $this->getRights(), true );
2742 * Check whether to enable recent changes patrol features for this user
2743 * @return Boolean: True or false
2745 public function useRCPatrol() {
2746 global $wgUseRCPatrol;
2747 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2751 * Check whether to enable new pages patrol features for this user
2752 * @return Bool True or false
2754 public function useNPPatrol() {
2755 global $wgUseRCPatrol, $wgUseNPPatrol;
2756 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2760 * Get the WebRequest object to use with this object
2762 * @return WebRequest
2764 public function getRequest() {
2765 if ( $this->mRequest
) {
2766 return $this->mRequest
;
2774 * Get the current skin, loading it if required
2775 * @return Skin The current skin
2776 * @todo FIXME: Need to check the old failback system [AV]
2777 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2779 public function getSkin() {
2780 wfDeprecated( __METHOD__
, '1.18' );
2781 return RequestContext
::getMain()->getSkin();
2785 * Get a WatchedItem for this user and $title.
2787 * @param $title Title
2788 * @return WatchedItem
2790 public function getWatchedItem( $title ) {
2791 $key = $title->getNamespace() . ':' . $title->getDBkey();
2793 if ( isset( $this->mWatchedItems
[$key] ) ) {
2794 return $this->mWatchedItems
[$key];
2797 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2798 $this->mWatchedItems
= array();
2801 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2802 return $this->mWatchedItems
[$key];
2806 * Check the watched status of an article.
2807 * @param $title Title of the article to look at
2810 public function isWatched( $title ) {
2811 return $this->getWatchedItem( $title )->isWatched();
2816 * @param $title Title of the article to look at
2818 public function addWatch( $title ) {
2819 $this->getWatchedItem( $title )->addWatch();
2820 $this->invalidateCache();
2824 * Stop watching an article.
2825 * @param $title Title of the article to look at
2827 public function removeWatch( $title ) {
2828 $this->getWatchedItem( $title )->removeWatch();
2829 $this->invalidateCache();
2833 * Clear the user's notification timestamp for the given title.
2834 * If e-notif e-mails are on, they will receive notification mails on
2835 * the next change of the page if it's watched etc.
2836 * @param $title Title of the article to look at
2838 public function clearNotification( &$title ) {
2839 global $wgUseEnotif, $wgShowUpdatedMarker;
2841 # Do nothing if the database is locked to writes
2842 if( wfReadOnly() ) {
2846 if( $title->getNamespace() == NS_USER_TALK
&&
2847 $title->getText() == $this->getName() ) {
2848 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2850 $this->setNewtalk( false );
2853 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2857 if( $this->isAnon() ) {
2858 // Nothing else to do...
2862 // Only update the timestamp if the page is being watched.
2863 // The query to find out if it is watched is cached both in memcached and per-invocation,
2864 // and when it does have to be executed, it can be on a slave
2865 // If this is the user's newtalk page, we always update the timestamp
2867 if ( $title->getNamespace() == NS_USER_TALK
&&
2868 $title->getText() == $this->getName() )
2873 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2877 * Resets all of the given user's page-change notification timestamps.
2878 * If e-notif e-mails are on, they will receive notification mails on
2879 * the next change of any watched page.
2881 public function clearAllNotifications() {
2882 if ( wfReadOnly() ) {
2886 global $wgUseEnotif, $wgShowUpdatedMarker;
2887 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2888 $this->setNewtalk( false );
2891 $id = $this->getId();
2893 $dbw = wfGetDB( DB_MASTER
);
2894 $dbw->update( 'watchlist',
2896 'wl_notificationtimestamp' => null
2897 ), array( /* WHERE */
2901 # We also need to clear here the "you have new message" notification for the own user_talk page
2902 # This is cleared one page view later in Article::viewUpdates();
2907 * Set this user's options from an encoded string
2908 * @param $str String Encoded options to import
2910 * @deprecated in 1.19 due to removal of user_options from the user table
2912 private function decodeOptions( $str ) {
2913 wfDeprecated( __METHOD__
, '1.19' );
2917 $this->mOptionsLoaded
= true;
2918 $this->mOptionOverrides
= array();
2920 // If an option is not set in $str, use the default value
2921 $this->mOptions
= self
::getDefaultOptions();
2923 $a = explode( "\n", $str );
2924 foreach ( $a as $s ) {
2926 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2927 $this->mOptions
[$m[1]] = $m[2];
2928 $this->mOptionOverrides
[$m[1]] = $m[2];
2934 * Set a cookie on the user's client. Wrapper for
2935 * WebResponse::setCookie
2936 * @param $name String Name of the cookie to set
2937 * @param $value String Value to set
2938 * @param $exp Int Expiration time, as a UNIX time value;
2939 * if 0 or not specified, use the default $wgCookieExpiration
2940 * @param $secure Bool
2941 * true: Force setting the secure attribute when setting the cookie
2942 * false: Force NOT setting the secure attribute when setting the cookie
2943 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
2945 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
2946 $this->getRequest()->response()->setcookie( $name, $value, $exp, null, null, $secure );
2950 * Clear a cookie on the user's client
2951 * @param $name String Name of the cookie to clear
2953 protected function clearCookie( $name ) {
2954 $this->setCookie( $name, '', time() - 86400 );
2958 * Set the default cookies for this session on the user's client.
2960 * @param $request WebRequest object to use; $wgRequest will be used if null
2962 * @param $secure Whether to force secure/insecure cookies or use default
2964 public function setCookies( $request = null, $secure = null ) {
2965 if ( $request === null ) {
2966 $request = $this->getRequest();
2970 if ( 0 == $this->mId
) return;
2971 if ( !$this->mToken
) {
2972 // When token is empty or NULL generate a new one and then save it to the database
2973 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2974 // Simply by setting every cell in the user_token column to NULL and letting them be
2975 // regenerated as users log back into the wiki.
2977 $this->saveSettings();
2980 'wsUserID' => $this->mId
,
2981 'wsToken' => $this->mToken
,
2982 'wsUserName' => $this->getName()
2985 'UserID' => $this->mId
,
2986 'UserName' => $this->getName(),
2988 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2989 $cookies['Token'] = $this->mToken
;
2991 $cookies['Token'] = false;
2994 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2996 foreach ( $session as $name => $value ) {
2997 $request->setSessionData( $name, $value );
2999 foreach ( $cookies as $name => $value ) {
3000 if ( $value === false ) {
3001 $this->clearCookie( $name );
3003 $this->setCookie( $name, $value, 0, $secure );
3008 * If wpStickHTTPS was selected, also set an insecure cookie that
3009 * will cause the site to redirect the user to HTTPS, if they access
3010 * it over HTTP. Bug 29898.
3012 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
3013 $this->setCookie( 'forceHTTPS', 'true', time() +
2592000, false ); //30 days
3018 * Log this user out.
3020 public function logout() {
3021 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
3027 * Clear the user's cookies and session, and reset the instance cache.
3030 public function doLogout() {
3031 $this->clearInstanceCache( 'defaults' );
3033 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3035 $this->clearCookie( 'UserID' );
3036 $this->clearCookie( 'Token' );
3037 $this->clearCookie( 'forceHTTPS' );
3039 # Remember when user logged out, to prevent seeing cached pages
3040 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
3044 * Save this user's settings into the database.
3045 * @todo Only rarely do all these fields need to be set!
3047 public function saveSettings() {
3051 if ( wfReadOnly() ) { return; }
3052 if ( 0 == $this->mId
) { return; }
3054 $this->mTouched
= self
::newTouchedTimestamp();
3055 if ( !$wgAuth->allowSetLocalPassword() ) {
3056 $this->mPassword
= '';
3059 $dbw = wfGetDB( DB_MASTER
);
3060 $dbw->update( 'user',
3062 'user_name' => $this->mName
,
3063 'user_password' => $this->mPassword
,
3064 'user_newpassword' => $this->mNewpassword
,
3065 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3066 'user_real_name' => $this->mRealName
,
3067 'user_email' => $this->mEmail
,
3068 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3069 'user_touched' => $dbw->timestamp( $this->mTouched
),
3070 'user_token' => strval( $this->mToken
),
3071 'user_email_token' => $this->mEmailToken
,
3072 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3073 ), array( /* WHERE */
3074 'user_id' => $this->mId
3078 $this->saveOptions();
3080 wfRunHooks( 'UserSaveSettings', array( $this ) );
3081 $this->clearSharedCache();
3082 $this->getUserPage()->invalidateCache();
3086 * If only this user's username is known, and it exists, return the user ID.
3089 public function idForName() {
3090 $s = trim( $this->getName() );
3091 if ( $s === '' ) return 0;
3093 $dbr = wfGetDB( DB_SLAVE
);
3094 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
3095 if ( $id === false ) {
3102 * Add a user to the database, return the user object
3104 * @param $name String Username to add
3105 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
3106 * - password The user's password hash. Password logins will be disabled if this is omitted.
3107 * - newpassword Hash for a temporary password that has been mailed to the user
3108 * - email The user's email address
3109 * - email_authenticated The email authentication timestamp
3110 * - real_name The user's real name
3111 * - options An associative array of non-default options
3112 * - token Random authentication token. Do not set.
3113 * - registration Registration timestamp. Do not set.
3115 * @return User object, or null if the username already exists
3117 public static function createNew( $name, $params = array() ) {
3120 $user->setToken(); // init token
3121 if ( isset( $params['options'] ) ) {
3122 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3123 unset( $params['options'] );
3125 $dbw = wfGetDB( DB_MASTER
);
3126 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3129 'user_id' => $seqVal,
3130 'user_name' => $name,
3131 'user_password' => $user->mPassword
,
3132 'user_newpassword' => $user->mNewpassword
,
3133 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
3134 'user_email' => $user->mEmail
,
3135 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3136 'user_real_name' => $user->mRealName
,
3137 'user_token' => strval( $user->mToken
),
3138 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3139 'user_editcount' => 0,
3140 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3142 foreach ( $params as $name => $value ) {
3143 $fields["user_$name"] = $value;
3145 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3146 if ( $dbw->affectedRows() ) {
3147 $newUser = User
::newFromId( $dbw->insertId() );
3155 * Add this existing user object to the database. If the user already
3156 * exists, a fatal status object is returned, and the user object is
3157 * initialised with the data from the database.
3159 * Previously, this function generated a DB error due to a key conflict
3160 * if the user already existed. Many extension callers use this function
3161 * in code along the lines of:
3163 * $user = User::newFromName( $name );
3164 * if ( !$user->isLoggedIn() ) {
3165 * $user->addToDatabase();
3167 * // do something with $user...
3169 * However, this was vulnerable to a race condition (bug 16020). By
3170 * initialising the user object if the user exists, we aim to support this
3171 * calling sequence as far as possible.
3173 * Note that if the user exists, this function will acquire a write lock,
3174 * so it is still advisable to make the call conditional on isLoggedIn(),
3175 * and to commit the transaction after calling.
3177 * @throws MWException
3180 public function addToDatabase() {
3182 if ( !$this->mToken
) {
3183 $this->setToken(); // init token
3186 $this->mTouched
= self
::newTouchedTimestamp();
3188 $dbw = wfGetDB( DB_MASTER
);
3189 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3190 $dbw->insert( 'user',
3192 'user_id' => $seqVal,
3193 'user_name' => $this->mName
,
3194 'user_password' => $this->mPassword
,
3195 'user_newpassword' => $this->mNewpassword
,
3196 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3197 'user_email' => $this->mEmail
,
3198 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3199 'user_real_name' => $this->mRealName
,
3200 'user_token' => strval( $this->mToken
),
3201 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3202 'user_editcount' => 0,
3203 'user_touched' => $dbw->timestamp( $this->mTouched
),
3207 if ( !$dbw->affectedRows() ) {
3208 $this->mId
= $dbw->selectField( 'user', 'user_id',
3209 array( 'user_name' => $this->mName
), __METHOD__
);
3212 if ( $this->loadFromDatabase() ) {
3217 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3218 "to insert a user row, but then it doesn't exist when we select it!" );
3220 return Status
::newFatal( 'userexists' );
3222 $this->mId
= $dbw->insertId();
3224 // Clear instance cache other than user table data, which is already accurate
3225 $this->clearInstanceCache();
3227 $this->saveOptions();
3228 return Status
::newGood();
3232 * If this user is logged-in and blocked,
3233 * block any IP address they've successfully logged in from.
3234 * @return bool A block was spread
3236 public function spreadAnyEditBlock() {
3237 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3238 return $this->spreadBlock();
3244 * If this (non-anonymous) user is blocked,
3245 * block the IP address they've successfully logged in from.
3246 * @return bool A block was spread
3248 protected function spreadBlock() {
3249 wfDebug( __METHOD__
. "()\n" );
3251 if ( $this->mId
== 0 ) {
3255 $userblock = Block
::newFromTarget( $this->getName() );
3256 if ( !$userblock ) {
3260 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3264 * Generate a string which will be different for any combination of
3265 * user options which would produce different parser output.
3266 * This will be used as part of the hash key for the parser cache,
3267 * so users with the same options can share the same cached data
3270 * Extensions which require it should install 'PageRenderingHash' hook,
3271 * which will give them a chance to modify this key based on their own
3274 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3275 * @return String Page rendering hash
3277 public function getPageRenderingHash() {
3278 wfDeprecated( __METHOD__
, '1.17' );
3280 global $wgRenderHashAppend, $wgLang, $wgContLang;
3281 if( $this->mHash
) {
3282 return $this->mHash
;
3285 // stubthreshold is only included below for completeness,
3286 // since it disables the parser cache, its value will always
3287 // be 0 when this function is called by parsercache.
3289 $confstr = $this->getOption( 'math' );
3290 $confstr .= '!' . $this->getStubThreshold();
3291 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3292 $confstr .= '!' . $wgLang->getCode();
3293 $confstr .= '!' . $this->getOption( 'thumbsize' );
3294 // add in language specific options, if any
3295 $extra = $wgContLang->getExtraHashOptions();
3298 // Since the skin could be overloading link(), it should be
3299 // included here but in practice, none of our skins do that.
3301 $confstr .= $wgRenderHashAppend;
3303 // Give a chance for extensions to modify the hash, if they have
3304 // extra options or other effects on the parser cache.
3305 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3307 // Make it a valid memcached key fragment
3308 $confstr = str_replace( ' ', '_', $confstr );
3309 $this->mHash
= $confstr;
3314 * Get whether the user is explicitly blocked from account creation.
3315 * @return Bool|Block
3317 public function isBlockedFromCreateAccount() {
3318 $this->getBlockedStatus();
3319 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
3320 return $this->mBlock
;
3323 # bug 13611: if the IP address the user is trying to create an account from is
3324 # blocked with createaccount disabled, prevent new account creation there even
3325 # when the user is logged in
3326 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3327 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3329 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3330 ?
$this->mBlockedFromCreateAccount
3335 * Get whether the user is blocked from using Special:Emailuser.
3338 public function isBlockedFromEmailuser() {
3339 $this->getBlockedStatus();
3340 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3344 * Get whether the user is allowed to create an account.
3347 function isAllowedToCreateAccount() {
3348 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3352 * Get this user's personal page title.
3354 * @return Title: User's personal page title
3356 public function getUserPage() {
3357 return Title
::makeTitle( NS_USER
, $this->getName() );
3361 * Get this user's talk page title.
3363 * @return Title: User's talk page title
3365 public function getTalkPage() {
3366 $title = $this->getUserPage();
3367 return $title->getTalkPage();
3371 * Determine whether the user is a newbie. Newbies are either
3372 * anonymous IPs, or the most recently created accounts.
3375 public function isNewbie() {
3376 return !$this->isAllowed( 'autoconfirmed' );
3380 * Check to see if the given clear-text password is one of the accepted passwords
3381 * @param $password String: user password.
3382 * @return Boolean: True if the given password is correct, otherwise False.
3384 public function checkPassword( $password ) {
3385 global $wgAuth, $wgLegacyEncoding;
3388 // Even though we stop people from creating passwords that
3389 // are shorter than this, doesn't mean people wont be able
3390 // to. Certain authentication plugins do NOT want to save
3391 // domain passwords in a mysql database, so we should
3392 // check this (in case $wgAuth->strict() is false).
3393 if( !$this->isValidPassword( $password ) ) {
3397 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3399 } elseif( $wgAuth->strict() ) {
3400 /* Auth plugin doesn't allow local authentication */
3402 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3403 /* Auth plugin doesn't allow local authentication for this user name */
3406 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3408 } elseif ( $wgLegacyEncoding ) {
3409 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3410 # Check for this with iconv
3411 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3412 if ( $cp1252Password != $password &&
3413 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3422 * Check if the given clear-text password matches the temporary password
3423 * sent by e-mail for password reset operations.
3425 * @param $plaintext string
3427 * @return Boolean: True if matches, false otherwise
3429 public function checkTemporaryPassword( $plaintext ) {
3430 global $wgNewPasswordExpiry;
3433 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3434 if ( is_null( $this->mNewpassTime
) ) {
3437 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3438 return ( time() < $expiry );
3445 * Alias for getEditToken.
3446 * @deprecated since 1.19, use getEditToken instead.
3448 * @param $salt String|Array of Strings Optional function-specific data for hashing
3449 * @param $request WebRequest object to use or null to use $wgRequest
3450 * @return String The new edit token
3452 public function editToken( $salt = '', $request = null ) {
3453 wfDeprecated( __METHOD__
, '1.19' );
3454 return $this->getEditToken( $salt, $request );
3458 * Initialize (if necessary) and return a session token value
3459 * which can be used in edit forms to show that the user's
3460 * login credentials aren't being hijacked with a foreign form
3465 * @param $salt String|Array of Strings Optional function-specific data for hashing
3466 * @param $request WebRequest object to use or null to use $wgRequest
3467 * @return String The new edit token
3469 public function getEditToken( $salt = '', $request = null ) {
3470 if ( $request == null ) {
3471 $request = $this->getRequest();
3474 if ( $this->isAnon() ) {
3475 return EDIT_TOKEN_SUFFIX
;
3477 $token = $request->getSessionData( 'wsEditToken' );
3478 if ( $token === null ) {
3479 $token = MWCryptRand
::generateHex( 32 );
3480 $request->setSessionData( 'wsEditToken', $token );
3482 if( is_array( $salt ) ) {
3483 $salt = implode( '|', $salt );
3485 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3490 * Generate a looking random token for various uses.
3492 * @param $salt String Optional salt value
3493 * @return String The new random token
3494 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3496 public static function generateToken( $salt = '' ) {
3497 return MWCryptRand
::generateHex( 32 );
3501 * Check given value against the token value stored in the session.
3502 * A match should confirm that the form was submitted from the
3503 * user's own login session, not a form submission from a third-party
3506 * @param $val String Input value to compare
3507 * @param $salt String Optional function-specific data for hashing
3508 * @param $request WebRequest object to use or null to use $wgRequest
3509 * @return Boolean: Whether the token matches
3511 public function matchEditToken( $val, $salt = '', $request = null ) {
3512 $sessionToken = $this->getEditToken( $salt, $request );
3513 if ( $val != $sessionToken ) {
3514 wfDebug( "User::matchEditToken: broken session data\n" );
3516 return $val == $sessionToken;
3520 * Check given value against the token value stored in the session,
3521 * ignoring the suffix.
3523 * @param $val String Input value to compare
3524 * @param $salt String Optional function-specific data for hashing
3525 * @param $request WebRequest object to use or null to use $wgRequest
3526 * @return Boolean: Whether the token matches
3528 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3529 $sessionToken = $this->getEditToken( $salt, $request );
3530 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3534 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3535 * mail to the user's given address.
3537 * @param $type String: message to send, either "created", "changed" or "set"
3538 * @return Status object
3540 public function sendConfirmationMail( $type = 'created' ) {
3542 $expiration = null; // gets passed-by-ref and defined in next line.
3543 $token = $this->confirmationToken( $expiration );
3544 $url = $this->confirmationTokenUrl( $token );
3545 $invalidateURL = $this->invalidationTokenUrl( $token );
3546 $this->saveSettings();
3548 if ( $type == 'created' ||
$type === false ) {
3549 $message = 'confirmemail_body';
3550 } elseif ( $type === true ) {
3551 $message = 'confirmemail_body_changed';
3553 $message = 'confirmemail_body_' . $type;
3556 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3557 wfMessage( $message,
3558 $this->getRequest()->getIP(),
3561 $wgLang->timeanddate( $expiration, false ),
3563 $wgLang->date( $expiration, false ),
3564 $wgLang->time( $expiration, false ) )->text() );
3568 * Send an e-mail to this user's account. Does not check for
3569 * confirmed status or validity.
3571 * @param $subject String Message subject
3572 * @param $body String Message body
3573 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3574 * @param $replyto String Reply-To address
3577 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3578 if( is_null( $from ) ) {
3579 global $wgPasswordSender, $wgPasswordSenderName;
3580 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3582 $sender = new MailAddress( $from );
3585 $to = new MailAddress( $this );
3586 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3590 * Generate, store, and return a new e-mail confirmation code.
3591 * A hash (unsalted, since it's used as a key) is stored.
3593 * @note Call saveSettings() after calling this function to commit
3594 * this change to the database.
3596 * @param &$expiration \mixed Accepts the expiration time
3597 * @return String New token
3599 private function confirmationToken( &$expiration ) {
3600 global $wgUserEmailConfirmationTokenExpiry;
3602 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3603 $expiration = wfTimestamp( TS_MW
, $expires );
3605 $token = MWCryptRand
::generateHex( 32 );
3606 $hash = md5( $token );
3607 $this->mEmailToken
= $hash;
3608 $this->mEmailTokenExpires
= $expiration;
3613 * Return a URL the user can use to confirm their email address.
3614 * @param $token String Accepts the email confirmation token
3615 * @return String New token URL
3617 private function confirmationTokenUrl( $token ) {
3618 return $this->getTokenUrl( 'ConfirmEmail', $token );
3622 * Return a URL the user can use to invalidate their email address.
3623 * @param $token String Accepts the email confirmation token
3624 * @return String New token URL
3626 private function invalidationTokenUrl( $token ) {
3627 return $this->getTokenUrl( 'InvalidateEmail', $token );
3631 * Internal function to format the e-mail validation/invalidation URLs.
3632 * This uses a quickie hack to use the
3633 * hardcoded English names of the Special: pages, for ASCII safety.
3635 * @note Since these URLs get dropped directly into emails, using the
3636 * short English names avoids insanely long URL-encoded links, which
3637 * also sometimes can get corrupted in some browsers/mailers
3638 * (bug 6957 with Gmail and Internet Explorer).
3640 * @param $page String Special page
3641 * @param $token String Token
3642 * @return String Formatted URL
3644 protected function getTokenUrl( $page, $token ) {
3645 // Hack to bypass localization of 'Special:'
3646 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3647 return $title->getCanonicalUrl();
3651 * Mark the e-mail address confirmed.
3653 * @note Call saveSettings() after calling this function to commit the change.
3657 public function confirmEmail() {
3658 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3659 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3664 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3665 * address if it was already confirmed.
3667 * @note Call saveSettings() after calling this function to commit the change.
3668 * @return bool Returns true
3670 function invalidateEmail() {
3672 $this->mEmailToken
= null;
3673 $this->mEmailTokenExpires
= null;
3674 $this->setEmailAuthenticationTimestamp( null );
3675 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3680 * Set the e-mail authentication timestamp.
3681 * @param $timestamp String TS_MW timestamp
3683 function setEmailAuthenticationTimestamp( $timestamp ) {
3685 $this->mEmailAuthenticated
= $timestamp;
3686 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3690 * Is this user allowed to send e-mails within limits of current
3691 * site configuration?
3694 public function canSendEmail() {
3695 global $wgEnableEmail, $wgEnableUserEmail;
3696 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3699 $canSend = $this->isEmailConfirmed();
3700 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3705 * Is this user allowed to receive e-mails within limits of current
3706 * site configuration?
3709 public function canReceiveEmail() {
3710 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3714 * Is this user's e-mail address valid-looking and confirmed within
3715 * limits of the current site configuration?
3717 * @note If $wgEmailAuthentication is on, this may require the user to have
3718 * confirmed their address by returning a code or using a password
3719 * sent to the address from the wiki.
3723 public function isEmailConfirmed() {
3724 global $wgEmailAuthentication;
3727 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3728 if( $this->isAnon() ) {
3731 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3734 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3744 * Check whether there is an outstanding request for e-mail confirmation.
3747 public function isEmailConfirmationPending() {
3748 global $wgEmailAuthentication;
3749 return $wgEmailAuthentication &&
3750 !$this->isEmailConfirmed() &&
3751 $this->mEmailToken
&&
3752 $this->mEmailTokenExpires
> wfTimestamp();
3756 * Get the timestamp of account creation.
3758 * @return String|Bool|Null Timestamp of account creation, false for
3759 * non-existent/anonymous user accounts, or null if existing account
3760 * but information is not in database.
3762 public function getRegistration() {
3763 if ( $this->isAnon() ) {
3767 return $this->mRegistration
;
3771 * Get the timestamp of the first edit
3773 * @return String|Bool Timestamp of first edit, or false for
3774 * non-existent/anonymous user accounts.
3776 public function getFirstEditTimestamp() {
3777 if( $this->getId() == 0 ) {
3778 return false; // anons
3780 $dbr = wfGetDB( DB_SLAVE
);
3781 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3782 array( 'rev_user' => $this->getId() ),
3784 array( 'ORDER BY' => 'rev_timestamp ASC' )
3787 return false; // no edits
3789 return wfTimestamp( TS_MW
, $time );
3793 * Get the permissions associated with a given list of groups
3795 * @param $groups Array of Strings List of internal group names
3796 * @return Array of Strings List of permission key names for given groups combined
3798 public static function getGroupPermissions( $groups ) {
3799 global $wgGroupPermissions, $wgRevokePermissions;
3801 // grant every granted permission first
3802 foreach( $groups as $group ) {
3803 if( isset( $wgGroupPermissions[$group] ) ) {
3804 $rights = array_merge( $rights,
3805 // array_filter removes empty items
3806 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3809 // now revoke the revoked permissions
3810 foreach( $groups as $group ) {
3811 if( isset( $wgRevokePermissions[$group] ) ) {
3812 $rights = array_diff( $rights,
3813 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3816 return array_unique( $rights );
3820 * Get all the groups who have a given permission
3822 * @param $role String Role to check
3823 * @return Array of Strings List of internal group names with the given permission
3825 public static function getGroupsWithPermission( $role ) {
3826 global $wgGroupPermissions;
3827 $allowedGroups = array();
3828 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
3829 if ( self
::groupHasPermission( $group, $role ) ) {
3830 $allowedGroups[] = $group;
3833 return $allowedGroups;
3837 * Check, if the given group has the given permission
3839 * @param $group String Group to check
3840 * @param $role String Role to check
3843 public static function groupHasPermission( $group, $role ) {
3844 global $wgGroupPermissions, $wgRevokePermissions;
3845 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
3846 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
3850 * Get the localized descriptive name for a group, if it exists
3852 * @param $group String Internal group name
3853 * @return String Localized descriptive group name
3855 public static function getGroupName( $group ) {
3856 $msg = wfMessage( "group-$group" );
3857 return $msg->isBlank() ?
$group : $msg->text();
3861 * Get the localized descriptive name for a member of a group, if it exists
3863 * @param $group String Internal group name
3864 * @param $username String Username for gender (since 1.19)
3865 * @return String Localized name for group member
3867 public static function getGroupMember( $group, $username = '#' ) {
3868 $msg = wfMessage( "group-$group-member", $username );
3869 return $msg->isBlank() ?
$group : $msg->text();
3873 * Return the set of defined explicit groups.
3874 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3875 * are not included, as they are defined automatically, not in the database.
3876 * @return Array of internal group names
3878 public static function getAllGroups() {
3879 global $wgGroupPermissions, $wgRevokePermissions;
3881 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3882 self
::getImplicitGroups()
3887 * Get a list of all available permissions.
3888 * @return Array of permission names
3890 public static function getAllRights() {
3891 if ( self
::$mAllRights === false ) {
3892 global $wgAvailableRights;
3893 if ( count( $wgAvailableRights ) ) {
3894 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3896 self
::$mAllRights = self
::$mCoreRights;
3898 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3900 return self
::$mAllRights;
3904 * Get a list of implicit groups
3905 * @return Array of Strings Array of internal group names
3907 public static function getImplicitGroups() {
3908 global $wgImplicitGroups;
3909 $groups = $wgImplicitGroups;
3910 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3915 * Get the title of a page describing a particular group
3917 * @param $group String Internal group name
3918 * @return Title|Bool Title of the page if it exists, false otherwise
3920 public static function getGroupPage( $group ) {
3921 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3922 if( $msg->exists() ) {
3923 $title = Title
::newFromText( $msg->text() );
3924 if( is_object( $title ) )
3931 * Create a link to the group in HTML, if available;
3932 * else return the group name.
3934 * @param $group String Internal name of the group
3935 * @param $text String The text of the link
3936 * @return String HTML link to the group
3938 public static function makeGroupLinkHTML( $group, $text = '' ) {
3940 $text = self
::getGroupName( $group );
3942 $title = self
::getGroupPage( $group );
3944 return Linker
::link( $title, htmlspecialchars( $text ) );
3951 * Create a link to the group in Wikitext, if available;
3952 * else return the group name.
3954 * @param $group String Internal name of the group
3955 * @param $text String The text of the link
3956 * @return String Wikilink to the group
3958 public static function makeGroupLinkWiki( $group, $text = '' ) {
3960 $text = self
::getGroupName( $group );
3962 $title = self
::getGroupPage( $group );
3964 $page = $title->getPrefixedText();
3965 return "[[$page|$text]]";
3972 * Returns an array of the groups that a particular group can add/remove.
3974 * @param $group String: the group to check for whether it can add/remove
3975 * @return Array array( 'add' => array( addablegroups ),
3976 * 'remove' => array( removablegroups ),
3977 * 'add-self' => array( addablegroups to self),
3978 * 'remove-self' => array( removable groups from self) )
3980 public static function changeableByGroup( $group ) {
3981 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3983 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3984 if( empty( $wgAddGroups[$group] ) ) {
3985 // Don't add anything to $groups
3986 } elseif( $wgAddGroups[$group] === true ) {
3987 // You get everything
3988 $groups['add'] = self
::getAllGroups();
3989 } elseif( is_array( $wgAddGroups[$group] ) ) {
3990 $groups['add'] = $wgAddGroups[$group];
3993 // Same thing for remove
3994 if( empty( $wgRemoveGroups[$group] ) ) {
3995 } elseif( $wgRemoveGroups[$group] === true ) {
3996 $groups['remove'] = self
::getAllGroups();
3997 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3998 $groups['remove'] = $wgRemoveGroups[$group];
4001 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4002 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
4003 foreach( $wgGroupsAddToSelf as $key => $value ) {
4004 if( is_int( $key ) ) {
4005 $wgGroupsAddToSelf['user'][] = $value;
4010 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4011 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
4012 if( is_int( $key ) ) {
4013 $wgGroupsRemoveFromSelf['user'][] = $value;
4018 // Now figure out what groups the user can add to him/herself
4019 if( empty( $wgGroupsAddToSelf[$group] ) ) {
4020 } elseif( $wgGroupsAddToSelf[$group] === true ) {
4021 // No idea WHY this would be used, but it's there
4022 $groups['add-self'] = User
::getAllGroups();
4023 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
4024 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4027 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4028 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
4029 $groups['remove-self'] = User
::getAllGroups();
4030 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4031 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4038 * Returns an array of groups that this user can add and remove
4039 * @return Array array( 'add' => array( addablegroups ),
4040 * 'remove' => array( removablegroups ),
4041 * 'add-self' => array( addablegroups to self),
4042 * 'remove-self' => array( removable groups from self) )
4044 public function changeableGroups() {
4045 if( $this->isAllowed( 'userrights' ) ) {
4046 // This group gives the right to modify everything (reverse-
4047 // compatibility with old "userrights lets you change
4049 // Using array_merge to make the groups reindexed
4050 $all = array_merge( User
::getAllGroups() );
4054 'add-self' => array(),
4055 'remove-self' => array()
4059 // Okay, it's not so simple, we will have to go through the arrays
4062 'remove' => array(),
4063 'add-self' => array(),
4064 'remove-self' => array()
4066 $addergroups = $this->getEffectiveGroups();
4068 foreach( $addergroups as $addergroup ) {
4069 $groups = array_merge_recursive(
4070 $groups, $this->changeableByGroup( $addergroup )
4072 $groups['add'] = array_unique( $groups['add'] );
4073 $groups['remove'] = array_unique( $groups['remove'] );
4074 $groups['add-self'] = array_unique( $groups['add-self'] );
4075 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4081 * Increment the user's edit-count field.
4082 * Will have no effect for anonymous users.
4084 public function incEditCount() {
4085 if( !$this->isAnon() ) {
4086 $dbw = wfGetDB( DB_MASTER
);
4089 array( 'user_editcount=user_editcount+1' ),
4090 array( 'user_id' => $this->getId() ),
4094 // Lazy initialization check...
4095 if( $dbw->affectedRows() == 0 ) {
4096 // Now here's a goddamn hack...
4097 $dbr = wfGetDB( DB_SLAVE
);
4098 if( $dbr !== $dbw ) {
4099 // If we actually have a slave server, the count is
4100 // at least one behind because the current transaction
4101 // has not been committed and replicated.
4102 $this->initEditCount( 1 );
4104 // But if DB_SLAVE is selecting the master, then the
4105 // count we just read includes the revision that was
4106 // just added in the working transaction.
4107 $this->initEditCount();
4111 // edit count in user cache too
4112 $this->invalidateCache();
4116 * Initialize user_editcount from data out of the revision table
4118 * @param $add Integer Edits to add to the count from the revision table
4119 * @return Integer Number of edits
4121 protected function initEditCount( $add = 0 ) {
4122 // Pull from a slave to be less cruel to servers
4123 // Accuracy isn't the point anyway here
4124 $dbr = wfGetDB( DB_SLAVE
);
4125 $count = (int) $dbr->selectField(
4128 array( 'rev_user' => $this->getId() ),
4131 $count = $count +
$add;
4133 $dbw = wfGetDB( DB_MASTER
);
4136 array( 'user_editcount' => $count ),
4137 array( 'user_id' => $this->getId() ),
4145 * Get the description of a given right
4147 * @param $right String Right to query
4148 * @return String Localized description of the right
4150 public static function getRightDescription( $right ) {
4151 $key = "right-$right";
4152 $msg = wfMessage( $key );
4153 return $msg->isBlank() ?
$right : $msg->text();
4157 * Make an old-style password hash
4159 * @param $password String Plain-text password
4160 * @param $userId String User ID
4161 * @return String Password hash
4163 public static function oldCrypt( $password, $userId ) {
4164 global $wgPasswordSalt;
4165 if ( $wgPasswordSalt ) {
4166 return md5( $userId . '-' . md5( $password ) );
4168 return md5( $password );
4173 * Make a new-style password hash
4175 * @param $password String Plain-text password
4176 * @param bool|string $salt Optional salt, may be random or the user ID.
4178 * If unspecified or false, will generate one automatically
4179 * @return String Password hash
4181 public static function crypt( $password, $salt = false ) {
4182 global $wgPasswordSalt;
4185 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
4189 if( $wgPasswordSalt ) {
4190 if ( $salt === false ) {
4191 $salt = MWCryptRand
::generateHex( 8 );
4193 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
4195 return ':A:' . md5( $password );
4200 * Compare a password hash with a plain-text password. Requires the user
4201 * ID if there's a chance that the hash is an old-style hash.
4203 * @param $hash String Password hash
4204 * @param $password String Plain-text password to compare
4205 * @param $userId String|bool User ID for old-style password salt
4209 public static function comparePasswords( $hash, $password, $userId = false ) {
4210 $type = substr( $hash, 0, 3 );
4213 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4217 if ( $type == ':A:' ) {
4219 return md5( $password ) === substr( $hash, 3 );
4220 } elseif ( $type == ':B:' ) {
4222 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4223 return md5( $salt.'-'.md5( $password ) ) === $realHash;
4226 return self
::oldCrypt( $password, $userId ) === $hash;
4231 * Add a newuser log entry for this user.
4232 * Before 1.19 the return value was always true.
4234 * @param $action string|bool: account creation type.
4235 * - String, one of the following values:
4236 * - 'create' for an anonymous user creating an account for himself.
4237 * This will force the action's performer to be the created user itself,
4238 * no matter the value of $wgUser
4239 * - 'create2' for a logged in user creating an account for someone else
4240 * - 'byemail' when the created user will receive its password by e-mail
4241 * - Boolean means whether the account was created by e-mail (deprecated):
4242 * - true will be converted to 'byemail'
4243 * - false will be converted to 'create' if this object is the same as
4244 * $wgUser and to 'create2' otherwise
4246 * @param $reason String: user supplied reason
4248 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4250 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4251 global $wgUser, $wgNewUserLog;
4252 if( empty( $wgNewUserLog ) ) {
4253 return true; // disabled
4256 if ( $action === true ) {
4257 $action = 'byemail';
4258 } elseif ( $action === false ) {
4259 if ( $this->getName() == $wgUser->getName() ) {
4262 $action = 'create2';
4266 if ( $action === 'create' ||
$action === 'autocreate' ) {
4269 $performer = $wgUser;
4272 $logEntry = new ManualLogEntry( 'newusers', $action );
4273 $logEntry->setPerformer( $performer );
4274 $logEntry->setTarget( $this->getUserPage() );
4275 $logEntry->setComment( $reason );
4276 $logEntry->setParameters( array(
4277 '4::userid' => $this->getId(),
4279 $logid = $logEntry->insert();
4281 if ( $action !== 'autocreate' ) {
4282 $logEntry->publish( $logid );
4289 * Add an autocreate newuser log entry for this user
4290 * Used by things like CentralAuth and perhaps other authplugins.
4291 * Consider calling addNewUserLogEntry() directly instead.
4295 public function addNewUserLogEntryAutoCreate() {
4296 $this->addNewUserLogEntry( 'autocreate' );
4302 * Load the user options either from cache, the database or an array
4304 * @param $data Rows for the current user out of the user_properties table
4306 protected function loadOptions( $data = null ) {
4311 if ( $this->mOptionsLoaded
) {
4315 $this->mOptions
= self
::getDefaultOptions();
4317 if ( !$this->getId() ) {
4318 // For unlogged-in users, load language/variant options from request.
4319 // There's no need to do it for logged-in users: they can set preferences,
4320 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4321 // so don't override user's choice (especially when the user chooses site default).
4322 $variant = $wgContLang->getDefaultVariant();
4323 $this->mOptions
['variant'] = $variant;
4324 $this->mOptions
['language'] = $variant;
4325 $this->mOptionsLoaded
= true;
4329 // Maybe load from the object
4330 if ( !is_null( $this->mOptionOverrides
) ) {
4331 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4332 foreach( $this->mOptionOverrides
as $key => $value ) {
4333 $this->mOptions
[$key] = $value;
4336 if( !is_array( $data ) ) {
4337 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4338 // Load from database
4339 $dbr = wfGetDB( DB_SLAVE
);
4341 $res = $dbr->select(
4343 array( 'up_property', 'up_value' ),
4344 array( 'up_user' => $this->getId() ),
4348 $this->mOptionOverrides
= array();
4350 foreach ( $res as $row ) {
4351 $data[$row->up_property
] = $row->up_value
;
4354 foreach ( $data as $property => $value ) {
4355 $this->mOptionOverrides
[$property] = $value;
4356 $this->mOptions
[$property] = $value;
4360 $this->mOptionsLoaded
= true;
4362 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4368 protected function saveOptions() {
4369 global $wgAllowPrefChange;
4371 $this->loadOptions();
4373 // Not using getOptions(), to keep hidden preferences in database
4374 $saveOptions = $this->mOptions
;
4376 // Allow hooks to abort, for instance to save to a global profile.
4377 // Reset options to default state before saving.
4378 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4382 $extuser = ExternalUser
::newFromUser( $this );
4383 $userId = $this->getId();
4384 $insert_rows = array();
4385 foreach( $saveOptions as $key => $value ) {
4386 # Don't bother storing default values
4387 $defaultOption = self
::getDefaultOption( $key );
4388 if ( ( is_null( $defaultOption ) &&
4389 !( $value === false ||
is_null( $value ) ) ) ||
4390 $value != $defaultOption ) {
4391 $insert_rows[] = array(
4392 'up_user' => $userId,
4393 'up_property' => $key,
4394 'up_value' => $value,
4397 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4398 switch ( $wgAllowPrefChange[$key] ) {
4404 $extuser->setPref( $key, $value );
4409 $dbw = wfGetDB( DB_MASTER
);
4410 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4411 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4415 * Provide an array of HTML5 attributes to put on an input element
4416 * intended for the user to enter a new password. This may include
4417 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4419 * Do *not* use this when asking the user to enter his current password!
4420 * Regardless of configuration, users may have invalid passwords for whatever
4421 * reason (e.g., they were set before requirements were tightened up).
4422 * Only use it when asking for a new password, like on account creation or
4425 * Obviously, you still need to do server-side checking.
4427 * NOTE: A combination of bugs in various browsers means that this function
4428 * actually just returns array() unconditionally at the moment. May as
4429 * well keep it around for when the browser bugs get fixed, though.
4431 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4433 * @return array Array of HTML attributes suitable for feeding to
4434 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4435 * That will potentially output invalid XHTML 1.0 Transitional, and will
4436 * get confused by the boolean attribute syntax used.)
4438 public static function passwordChangeInputAttribs() {
4439 global $wgMinimalPasswordLength;
4441 if ( $wgMinimalPasswordLength == 0 ) {
4445 # Note that the pattern requirement will always be satisfied if the
4446 # input is empty, so we need required in all cases.
4448 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4449 # if e-mail confirmation is being used. Since HTML5 input validation
4450 # is b0rked anyway in some browsers, just return nothing. When it's
4451 # re-enabled, fix this code to not output required for e-mail
4453 #$ret = array( 'required' );
4456 # We can't actually do this right now, because Opera 9.6 will print out
4457 # the entered password visibly in its error message! When other
4458 # browsers add support for this attribute, or Opera fixes its support,
4459 # we can add support with a version check to avoid doing this on Opera
4460 # versions where it will be a problem. Reported to Opera as
4461 # DSK-262266, but they don't have a public bug tracker for us to follow.
4463 if ( $wgMinimalPasswordLength > 1 ) {
4464 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4465 $ret['title'] = wfMessage( 'passwordtooshort' )
4466 ->numParams( $wgMinimalPasswordLength )->text();
4474 * Return the list of user fields that should be selected to create
4475 * a new user object.
4478 public static function selectFields() {
4485 'user_newpass_time',
4489 'user_email_authenticated',
4491 'user_email_token_expires',
4492 'user_registration',