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 $passwordCorrect = $proposedUser->getToken( false ) === $request->getCookie( 'Token' );
989 # No session or persistent login cookie
993 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
994 $this->loadFromUserObject( $proposedUser );
995 $request->setSessionData( 'wsToken', $this->mToken
);
996 wfDebug( "User: logged in from $from\n" );
999 # Invalid credentials
1000 wfDebug( "User: can't log in from $from, invalid credentials\n" );
1006 * Load user and user_group data from the database.
1007 * $this->mId must be set, this is how the user is identified.
1009 * @return Bool True if the user exists, false if the user is anonymous
1011 public function loadFromDatabase() {
1013 $this->mId
= intval( $this->mId
);
1015 /** Anonymous user */
1017 $this->loadDefaults();
1021 $dbr = wfGetDB( DB_MASTER
);
1022 $s = $dbr->selectRow( 'user', self
::selectFields(), array( 'user_id' => $this->mId
), __METHOD__
);
1024 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1026 if ( $s !== false ) {
1027 # Initialise user table data
1028 $this->loadFromRow( $s );
1029 $this->mGroups
= null; // deferred
1030 $this->getEditCount(); // revalidation for nulls
1035 $this->loadDefaults();
1041 * Initialize this object from a row from the user table.
1043 * @param $row Array Row from the user table to load.
1044 * @param $data Array Further user data to load into the object
1046 * user_groups Array with groups out of the user_groups table
1047 * user_properties Array with properties out of the user_properties table
1049 public function loadFromRow( $row, $data = null ) {
1052 $this->mGroups
= null; // deferred
1054 if ( isset( $row->user_name
) ) {
1055 $this->mName
= $row->user_name
;
1056 $this->mFrom
= 'name';
1057 $this->setItemLoaded( 'name' );
1062 if ( isset( $row->user_real_name
) ) {
1063 $this->mRealName
= $row->user_real_name
;
1064 $this->setItemLoaded( 'realname' );
1069 if ( isset( $row->user_id
) ) {
1070 $this->mId
= intval( $row->user_id
);
1071 $this->mFrom
= 'id';
1072 $this->setItemLoaded( 'id' );
1077 if ( isset( $row->user_editcount
) ) {
1078 $this->mEditCount
= $row->user_editcount
;
1083 if ( isset( $row->user_password
) ) {
1084 $this->mPassword
= $row->user_password
;
1085 $this->mNewpassword
= $row->user_newpassword
;
1086 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1087 $this->mEmail
= $row->user_email
;
1088 if ( isset( $row->user_options
) ) {
1089 $this->decodeOptions( $row->user_options
);
1091 $this->mTouched
= wfTimestamp( TS_MW
, $row->user_touched
);
1092 $this->mToken
= $row->user_token
;
1093 if ( $this->mToken
== '' ) {
1094 $this->mToken
= null;
1096 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1097 $this->mEmailToken
= $row->user_email_token
;
1098 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1099 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1105 $this->mLoadedItems
= true;
1108 if ( is_array( $data ) ) {
1109 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1110 $this->mGroups
= $data['user_groups'];
1112 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1113 $this->loadOptions( $data['user_properties'] );
1119 * Load the data for this user object from another user object.
1123 protected function loadFromUserObject( $user ) {
1125 $user->loadGroups();
1126 $user->loadOptions();
1127 foreach ( self
::$mCacheVars as $var ) {
1128 $this->$var = $user->$var;
1133 * Load the groups from the database if they aren't already loaded.
1135 private function loadGroups() {
1136 if ( is_null( $this->mGroups
) ) {
1137 $dbr = wfGetDB( DB_MASTER
);
1138 $res = $dbr->select( 'user_groups',
1139 array( 'ug_group' ),
1140 array( 'ug_user' => $this->mId
),
1142 $this->mGroups
= array();
1143 foreach ( $res as $row ) {
1144 $this->mGroups
[] = $row->ug_group
;
1150 * Add the user to the group if he/she meets given criteria.
1152 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1153 * possible to remove manually via Special:UserRights. In such case it
1154 * will not be re-added automatically. The user will also not lose the
1155 * group if they no longer meet the criteria.
1157 * @param $event String key in $wgAutopromoteOnce (each one has groups/criteria)
1159 * @return array Array of groups the user has been promoted to.
1161 * @see $wgAutopromoteOnce
1163 public function addAutopromoteOnceGroups( $event ) {
1164 global $wgAutopromoteOnceLogInRC;
1166 $toPromote = array();
1167 if ( $this->getId() ) {
1168 $toPromote = Autopromote
::getAutopromoteOnceGroups( $this, $event );
1169 if ( count( $toPromote ) ) {
1170 $oldGroups = $this->getGroups(); // previous groups
1171 foreach ( $toPromote as $group ) {
1172 $this->addGroup( $group );
1174 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1176 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1177 $logEntry->setPerformer( $this );
1178 $logEntry->setTarget( $this->getUserPage() );
1179 $logEntry->setParameters( array(
1180 '4::oldgroups' => $oldGroups,
1181 '5::newgroups' => $newGroups,
1183 $logid = $logEntry->insert();
1184 if ( $wgAutopromoteOnceLogInRC ) {
1185 $logEntry->publish( $logid );
1193 * Clear various cached data stored in this object. The cache of the user table
1194 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1196 * @param $reloadFrom bool|String Reload user and user_groups table data from a
1197 * given source. May be "name", "id", "defaults", "session", or false for
1200 public function clearInstanceCache( $reloadFrom = false ) {
1201 $this->mNewtalk
= -1;
1202 $this->mDatePreference
= null;
1203 $this->mBlockedby
= -1; # Unset
1204 $this->mHash
= false;
1205 $this->mRights
= null;
1206 $this->mEffectiveGroups
= null;
1207 $this->mImplicitGroups
= null;
1208 $this->mGroups
= null;
1209 $this->mOptions
= null;
1210 $this->mOptionsLoaded
= false;
1211 $this->mEditCount
= null;
1213 if ( $reloadFrom ) {
1214 $this->mLoadedItems
= array();
1215 $this->mFrom
= $reloadFrom;
1220 * Combine the language default options with any site-specific options
1221 * and add the default language variants.
1223 * @return Array of String options
1225 public static function getDefaultOptions() {
1226 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1228 static $defOpt = null;
1229 if ( !defined( 'MW_PHPUNIT_TEST' ) && $defOpt !== null ) {
1230 // Disabling this for the unit tests, as they rely on being able to change $wgContLang
1231 // mid-request and see that change reflected in the return value of this function.
1232 // Which is insane and would never happen during normal MW operation
1236 $defOpt = $wgDefaultUserOptions;
1237 # default language setting
1238 $defOpt['variant'] = $wgContLang->getCode();
1239 $defOpt['language'] = $wgContLang->getCode();
1240 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1241 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1243 $defOpt['skin'] = $wgDefaultSkin;
1245 wfRunHooks( 'UserGetDefaultOptions', array( &$defOpt ) );
1251 * Get a given default option value.
1253 * @param $opt String Name of option to retrieve
1254 * @return String Default option value
1256 public static function getDefaultOption( $opt ) {
1257 $defOpts = self
::getDefaultOptions();
1258 if( isset( $defOpts[$opt] ) ) {
1259 return $defOpts[$opt];
1267 * Get blocking information
1268 * @param $bFromSlave Bool Whether to check the slave database first. To
1269 * improve performance, non-critical checks are done
1270 * against slaves. Check when actually saving should be
1271 * done against master.
1273 private function getBlockedStatus( $bFromSlave = true ) {
1274 global $wgProxyWhitelist, $wgUser;
1276 if ( -1 != $this->mBlockedby
) {
1280 wfProfileIn( __METHOD__
);
1281 wfDebug( __METHOD__
.": checking...\n" );
1283 // Initialize data...
1284 // Otherwise something ends up stomping on $this->mBlockedby when
1285 // things get lazy-loaded later, causing false positive block hits
1286 // due to -1 !== 0. Probably session-related... Nothing should be
1287 // overwriting mBlockedby, surely?
1290 # We only need to worry about passing the IP address to the Block generator if the
1291 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1292 # know which IP address they're actually coming from
1293 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1294 $ip = $this->getRequest()->getIP();
1300 $block = Block
::newFromTarget( $this, $ip, !$bFromSlave );
1303 if ( !$block instanceof Block
&& $ip !== null && !$this->isAllowed( 'proxyunbannable' )
1304 && !in_array( $ip, $wgProxyWhitelist ) )
1307 if ( self
::isLocallyBlockedProxy( $ip ) ) {
1309 $block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1310 $block->mReason
= wfMessage( 'proxyblockreason' )->text();
1311 $block->setTarget( $ip );
1312 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1314 $block->setBlocker( wfMessage( 'sorbs' )->text() );
1315 $block->mReason
= wfMessage( 'sorbsreason' )->text();
1316 $block->setTarget( $ip );
1320 if ( $block instanceof Block
) {
1321 wfDebug( __METHOD__
. ": Found block.\n" );
1322 $this->mBlock
= $block;
1323 $this->mBlockedby
= $block->getByName();
1324 $this->mBlockreason
= $block->mReason
;
1325 $this->mHideName
= $block->mHideName
;
1326 $this->mAllowUsertalk
= !$block->prevents( 'editownusertalk' );
1328 $this->mBlockedby
= '';
1329 $this->mHideName
= 0;
1330 $this->mAllowUsertalk
= false;
1334 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1336 wfProfileOut( __METHOD__
);
1340 * Whether the given IP is in a DNS blacklist.
1342 * @param $ip String IP to check
1343 * @param $checkWhitelist Bool: whether to check the whitelist first
1344 * @return Bool True if blacklisted.
1346 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1347 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1348 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1350 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1353 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1356 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1357 return $this->inDnsBlacklist( $ip, $urls );
1361 * Whether the given IP is in a given DNS blacklist.
1363 * @param $ip String IP to check
1364 * @param $bases String|Array of Strings: URL of the DNS blacklist
1365 * @return Bool True if blacklisted.
1367 public function inDnsBlacklist( $ip, $bases ) {
1368 wfProfileIn( __METHOD__
);
1371 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1372 if( IP
::isIPv4( $ip ) ) {
1373 # Reverse IP, bug 21255
1374 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1376 foreach( (array)$bases as $base ) {
1378 # If we have an access key, use that too (ProjectHoneypot, etc.)
1379 if( is_array( $base ) ) {
1380 if( count( $base ) >= 2 ) {
1381 # Access key is 1, base URL is 0
1382 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1384 $host = "$ipReversed.{$base[0]}";
1387 $host = "$ipReversed.$base";
1391 $ipList = gethostbynamel( $host );
1394 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1398 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $base.\n" );
1403 wfProfileOut( __METHOD__
);
1408 * Check if an IP address is in the local proxy list
1414 public static function isLocallyBlockedProxy( $ip ) {
1415 global $wgProxyList;
1417 if ( !$wgProxyList ) {
1420 wfProfileIn( __METHOD__
);
1422 if ( !is_array( $wgProxyList ) ) {
1423 # Load from the specified file
1424 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1427 if ( !is_array( $wgProxyList ) ) {
1429 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1431 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1432 # Old-style flipped proxy list
1437 wfProfileOut( __METHOD__
);
1442 * Is this user subject to rate limiting?
1444 * @return Bool True if rate limited
1446 public function isPingLimitable() {
1447 global $wgRateLimitsExcludedIPs;
1448 if( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1449 // No other good way currently to disable rate limits
1450 // for specific IPs. :P
1451 // But this is a crappy hack and should die.
1454 return !$this->isAllowed( 'noratelimit' );
1458 * Primitive rate limits: enforce maximum actions per time period
1459 * to put a brake on flooding.
1461 * @note When using a shared cache like memcached, IP-address
1462 * last-hit counters will be shared across wikis.
1464 * @param $action String Action to enforce; 'edit' if unspecified
1465 * @return Bool True if a rate limiter was tripped
1467 public function pingLimiter( $action = 'edit' ) {
1468 # Call the 'PingLimiter' hook
1470 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, &$result ) ) ) {
1474 global $wgRateLimits;
1475 if( !isset( $wgRateLimits[$action] ) ) {
1479 # Some groups shouldn't trigger the ping limiter, ever
1480 if( !$this->isPingLimitable() )
1483 global $wgMemc, $wgRateLimitLog;
1484 wfProfileIn( __METHOD__
);
1486 $limits = $wgRateLimits[$action];
1488 $id = $this->getId();
1489 $ip = $this->getRequest()->getIP();
1492 if( isset( $limits['anon'] ) && $id == 0 ) {
1493 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1496 if( isset( $limits['user'] ) && $id != 0 ) {
1497 $userLimit = $limits['user'];
1499 if( $this->isNewbie() ) {
1500 if( isset( $limits['newbie'] ) && $id != 0 ) {
1501 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1503 if( isset( $limits['ip'] ) ) {
1504 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1507 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1508 $subnet = $matches[1];
1509 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1512 // Check for group-specific permissions
1513 // If more than one group applies, use the group with the highest limit
1514 foreach ( $this->getGroups() as $group ) {
1515 if ( isset( $limits[$group] ) ) {
1516 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1517 $userLimit = $limits[$group];
1521 // Set the user limit key
1522 if ( $userLimit !== false ) {
1523 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1524 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1528 foreach( $keys as $key => $limit ) {
1529 list( $max, $period ) = $limit;
1530 $summary = "(limit $max in {$period}s)";
1531 $count = $wgMemc->get( $key );
1534 if( $count >= $max ) {
1535 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1536 if( $wgRateLimitLog ) {
1537 wfSuppressWarnings();
1538 file_put_contents( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1539 wfRestoreWarnings();
1543 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1546 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1547 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1549 $wgMemc->incr( $key );
1552 wfProfileOut( __METHOD__
);
1557 * Check if user is blocked
1559 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1560 * @return Bool True if blocked, false otherwise
1562 public function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1563 return $this->getBlock( $bFromSlave ) instanceof Block
&& $this->getBlock()->prevents( 'edit' );
1567 * Get the block affecting the user, or null if the user is not blocked
1569 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1570 * @return Block|null
1572 public function getBlock( $bFromSlave = true ) {
1573 $this->getBlockedStatus( $bFromSlave );
1574 return $this->mBlock
instanceof Block ?
$this->mBlock
: null;
1578 * Check if user is blocked from editing a particular article
1580 * @param $title Title to check
1581 * @param $bFromSlave Bool whether to check the slave database instead of the master
1584 function isBlockedFrom( $title, $bFromSlave = false ) {
1585 global $wgBlockAllowsUTEdit;
1586 wfProfileIn( __METHOD__
);
1588 $blocked = $this->isBlocked( $bFromSlave );
1589 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1590 # If a user's name is suppressed, they cannot make edits anywhere
1591 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1592 $title->getNamespace() == NS_USER_TALK
) {
1594 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1597 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1599 wfProfileOut( __METHOD__
);
1604 * If user is blocked, return the name of the user who placed the block
1605 * @return String name of blocker
1607 public function blockedBy() {
1608 $this->getBlockedStatus();
1609 return $this->mBlockedby
;
1613 * If user is blocked, return the specified reason for the block
1614 * @return String Blocking reason
1616 public function blockedFor() {
1617 $this->getBlockedStatus();
1618 return $this->mBlockreason
;
1622 * If user is blocked, return the ID for the block
1623 * @return Int Block ID
1625 public function getBlockId() {
1626 $this->getBlockedStatus();
1627 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1631 * Check if user is blocked on all wikis.
1632 * Do not use for actual edit permission checks!
1633 * This is intented for quick UI checks.
1635 * @param $ip String IP address, uses current client if none given
1636 * @return Bool True if blocked, false otherwise
1638 public function isBlockedGlobally( $ip = '' ) {
1639 if( $this->mBlockedGlobally
!== null ) {
1640 return $this->mBlockedGlobally
;
1642 // User is already an IP?
1643 if( IP
::isIPAddress( $this->getName() ) ) {
1644 $ip = $this->getName();
1646 $ip = $this->getRequest()->getIP();
1649 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1650 $this->mBlockedGlobally
= (bool)$blocked;
1651 return $this->mBlockedGlobally
;
1655 * Check if user account is locked
1657 * @return Bool True if locked, false otherwise
1659 public function isLocked() {
1660 if( $this->mLocked
!== null ) {
1661 return $this->mLocked
;
1664 $authUser = $wgAuth->getUserInstance( $this );
1665 $this->mLocked
= (bool)$authUser->isLocked();
1666 return $this->mLocked
;
1670 * Check if user account is hidden
1672 * @return Bool True if hidden, false otherwise
1674 public function isHidden() {
1675 if( $this->mHideName
!== null ) {
1676 return $this->mHideName
;
1678 $this->getBlockedStatus();
1679 if( !$this->mHideName
) {
1681 $authUser = $wgAuth->getUserInstance( $this );
1682 $this->mHideName
= (bool)$authUser->isHidden();
1684 return $this->mHideName
;
1688 * Get the user's ID.
1689 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1691 public function getId() {
1692 if( $this->mId
=== null && $this->mName
!== null
1693 && User
::isIP( $this->mName
) ) {
1694 // Special case, we know the user is anonymous
1696 } elseif( !$this->isItemLoaded( 'id' ) ) {
1697 // Don't load if this was initialized from an ID
1704 * Set the user and reload all fields according to a given ID
1705 * @param $v Int User ID to reload
1707 public function setId( $v ) {
1709 $this->clearInstanceCache( 'id' );
1713 * Get the user name, or the IP of an anonymous user
1714 * @return String User's name or IP address
1716 public function getName() {
1717 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1718 # Special case optimisation
1719 return $this->mName
;
1722 if ( $this->mName
=== false ) {
1724 $this->mName
= IP
::sanitizeIP( $this->getRequest()->getIP() );
1726 return $this->mName
;
1731 * Set the user name.
1733 * This does not reload fields from the database according to the given
1734 * name. Rather, it is used to create a temporary "nonexistent user" for
1735 * later addition to the database. It can also be used to set the IP
1736 * address for an anonymous user to something other than the current
1739 * @note User::newFromName() has rougly the same function, when the named user
1741 * @param $str String New user name to set
1743 public function setName( $str ) {
1745 $this->mName
= $str;
1749 * Get the user's name escaped by underscores.
1750 * @return String Username escaped by underscores.
1752 public function getTitleKey() {
1753 return str_replace( ' ', '_', $this->getName() );
1757 * Check if the user has new messages.
1758 * @return Bool True if the user has new messages
1760 public function getNewtalk() {
1763 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1764 if( $this->mNewtalk
=== -1 ) {
1765 $this->mNewtalk
= false; # reset talk page status
1767 # Check memcached separately for anons, who have no
1768 # entire User object stored in there.
1770 global $wgDisableAnonTalk;
1771 if( $wgDisableAnonTalk ) {
1772 // Anon newtalk disabled by configuration.
1773 $this->mNewtalk
= false;
1776 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1777 $newtalk = $wgMemc->get( $key );
1778 if( strval( $newtalk ) !== '' ) {
1779 $this->mNewtalk
= (bool)$newtalk;
1781 // Since we are caching this, make sure it is up to date by getting it
1783 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1784 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1788 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1792 return (bool)$this->mNewtalk
;
1796 * Return the talk page(s) this user has new messages on.
1797 * @return Array of String page URLs
1799 public function getNewMessageLinks() {
1801 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) ) {
1803 } elseif( !$this->getNewtalk() ) {
1806 $utp = $this->getTalkPage();
1807 $dbr = wfGetDB( DB_SLAVE
);
1808 // Get the "last viewed rev" timestamp from the oldest message notification
1809 $timestamp = $dbr->selectField( 'user_newtalk',
1810 'MIN(user_last_timestamp)',
1811 $this->isAnon() ?
array( 'user_ip' => $this->getName() ) : array( 'user_id' => $this->getID() ),
1813 $rev = $timestamp ? Revision
::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
1814 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ) );
1818 * Internal uncached check for new messages
1821 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1822 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1823 * @param $fromMaster Bool true to fetch from the master, false for a slave
1824 * @return Bool True if the user has new messages
1826 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1827 if ( $fromMaster ) {
1828 $db = wfGetDB( DB_MASTER
);
1830 $db = wfGetDB( DB_SLAVE
);
1832 $ok = $db->selectField( 'user_newtalk', $field,
1833 array( $field => $id ), __METHOD__
);
1834 return $ok !== false;
1838 * Add or update the new messages flag
1839 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1840 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1841 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null.
1842 * @return Bool True if successful, false otherwise
1844 protected function updateNewtalk( $field, $id, $curRev = null ) {
1845 // Get timestamp of the talk page revision prior to the current one
1846 $prevRev = $curRev ?
$curRev->getPrevious() : false;
1847 $ts = $prevRev ?
$prevRev->getTimestamp() : null;
1848 // Mark the user as having new messages since this revision
1849 $dbw = wfGetDB( DB_MASTER
);
1850 $dbw->insert( 'user_newtalk',
1851 array( $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ),
1854 if ( $dbw->affectedRows() ) {
1855 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1858 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1864 * Clear the new messages flag for the given user
1865 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1866 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1867 * @return Bool True if successful, false otherwise
1869 protected function deleteNewtalk( $field, $id ) {
1870 $dbw = wfGetDB( DB_MASTER
);
1871 $dbw->delete( 'user_newtalk',
1872 array( $field => $id ),
1874 if ( $dbw->affectedRows() ) {
1875 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1878 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1884 * Update the 'You have new messages!' status.
1885 * @param $val Bool Whether the user has new messages
1886 * @param $curRev Revision new, as yet unseen revision of the user talk page. Ignored if null or !$val.
1888 public function setNewtalk( $val, $curRev = null ) {
1889 if( wfReadOnly() ) {
1894 $this->mNewtalk
= $val;
1896 if( $this->isAnon() ) {
1898 $id = $this->getName();
1901 $id = $this->getId();
1906 $changed = $this->updateNewtalk( $field, $id, $curRev );
1908 $changed = $this->deleteNewtalk( $field, $id );
1911 if( $this->isAnon() ) {
1912 // Anons have a separate memcached space, since
1913 // user records aren't kept for them.
1914 $key = wfMemcKey( 'newtalk', 'ip', $id );
1915 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1918 $this->invalidateCache();
1923 * Generate a current or new-future timestamp to be stored in the
1924 * user_touched field when we update things.
1925 * @return String Timestamp in TS_MW format
1927 private static function newTouchedTimestamp() {
1928 global $wgClockSkewFudge;
1929 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1933 * Clear user data from memcached.
1934 * Use after applying fun updates to the database; caller's
1935 * responsibility to update user_touched if appropriate.
1937 * Called implicitly from invalidateCache() and saveSettings().
1939 private function clearSharedCache() {
1943 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1948 * Immediately touch the user data cache for this account.
1949 * Updates user_touched field, and removes account data from memcached
1950 * for reload on the next hit.
1952 public function invalidateCache() {
1953 if( wfReadOnly() ) {
1958 $this->mTouched
= self
::newTouchedTimestamp();
1960 $dbw = wfGetDB( DB_MASTER
);
1962 // Prevent contention slams by checking user_touched first
1963 $now = $dbw->timestamp( $this->mTouched
);
1964 $needsPurge = $dbw->selectField( 'user', '1',
1965 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) )
1967 if ( $needsPurge ) {
1968 $dbw->update( 'user',
1969 array( 'user_touched' => $now ),
1970 array( 'user_id' => $this->mId
, 'user_touched < ' . $dbw->addQuotes( $now ) ),
1975 $this->clearSharedCache();
1980 * Validate the cache for this account.
1981 * @param $timestamp String A timestamp in TS_MW format
1985 public function validateCache( $timestamp ) {
1987 return ( $timestamp >= $this->mTouched
);
1991 * Get the user touched timestamp
1992 * @return String timestamp
1994 public function getTouched() {
1996 return $this->mTouched
;
2000 * Set the password and reset the random token.
2001 * Calls through to authentication plugin if necessary;
2002 * will have no effect if the auth plugin refuses to
2003 * pass the change through or if the legal password
2006 * As a special case, setting the password to null
2007 * wipes it, so the account cannot be logged in until
2008 * a new password is set, for instance via e-mail.
2010 * @param $str String New password to set
2011 * @throws PasswordError on failure
2015 public function setPassword( $str ) {
2018 if( $str !== null ) {
2019 if( !$wgAuth->allowPasswordChange() ) {
2020 throw new PasswordError( wfMessage( 'password-change-forbidden' )->text() );
2023 if( !$this->isValidPassword( $str ) ) {
2024 global $wgMinimalPasswordLength;
2025 $valid = $this->getPasswordValidity( $str );
2026 if ( is_array( $valid ) ) {
2027 $message = array_shift( $valid );
2031 $params = array( $wgMinimalPasswordLength );
2033 throw new PasswordError( wfMessage( $message, $params )->text() );
2037 if( !$wgAuth->setPassword( $this, $str ) ) {
2038 throw new PasswordError( wfMessage( 'externaldberror' )->text() );
2041 $this->setInternalPassword( $str );
2047 * Set the password and reset the random token unconditionally.
2049 * @param $str string|null New password to set or null to set an invalid
2050 * password hash meaning that the user will not be able to log in
2051 * through the web interface.
2053 public function setInternalPassword( $str ) {
2057 if( $str === null ) {
2058 // Save an invalid hash...
2059 $this->mPassword
= '';
2061 $this->mPassword
= self
::crypt( $str );
2063 $this->mNewpassword
= '';
2064 $this->mNewpassTime
= null;
2068 * Get the user's current token.
2069 * @param $forceCreation Force the generation of a new token if the user doesn't have one (default=true for backwards compatibility)
2070 * @return String Token
2072 public function getToken( $forceCreation = true ) {
2074 if ( !$this->mToken
&& $forceCreation ) {
2077 return $this->mToken
;
2081 * Set the random token (used for persistent authentication)
2082 * Called from loadDefaults() among other places.
2084 * @param $token String|bool If specified, set the token to this value
2086 public function setToken( $token = false ) {
2089 $this->mToken
= MWCryptRand
::generateHex( USER_TOKEN_LENGTH
);
2091 $this->mToken
= $token;
2096 * Set the password for a password reminder or new account email
2098 * @param $str String New password to set
2099 * @param $throttle Bool If true, reset the throttle timestamp to the present
2101 public function setNewpassword( $str, $throttle = true ) {
2103 $this->mNewpassword
= self
::crypt( $str );
2105 $this->mNewpassTime
= wfTimestampNow();
2110 * Has password reminder email been sent within the last
2111 * $wgPasswordReminderResendTime hours?
2114 public function isPasswordReminderThrottled() {
2115 global $wgPasswordReminderResendTime;
2117 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
2120 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
2121 return time() < $expiry;
2125 * Get the user's e-mail address
2126 * @return String User's email address
2128 public function getEmail() {
2130 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
2131 return $this->mEmail
;
2135 * Get the timestamp of the user's e-mail authentication
2136 * @return String TS_MW timestamp
2138 public function getEmailAuthenticationTimestamp() {
2140 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2141 return $this->mEmailAuthenticated
;
2145 * Set the user's e-mail address
2146 * @param $str String New e-mail address
2148 public function setEmail( $str ) {
2150 if( $str == $this->mEmail
) {
2153 $this->mEmail
= $str;
2154 $this->invalidateEmail();
2155 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
2159 * Set the user's e-mail address and a confirmation mail if needed.
2162 * @param $str String New e-mail address
2165 public function setEmailWithConfirmation( $str ) {
2166 global $wgEnableEmail, $wgEmailAuthentication;
2168 if ( !$wgEnableEmail ) {
2169 return Status
::newFatal( 'emaildisabled' );
2172 $oldaddr = $this->getEmail();
2173 if ( $str === $oldaddr ) {
2174 return Status
::newGood( true );
2177 $this->setEmail( $str );
2179 if ( $str !== '' && $wgEmailAuthentication ) {
2180 # Send a confirmation request to the new address if needed
2181 $type = $oldaddr != '' ?
'changed' : 'set';
2182 $result = $this->sendConfirmationMail( $type );
2183 if ( $result->isGood() ) {
2184 # Say the the caller that a confirmation mail has been sent
2185 $result->value
= 'eauth';
2188 $result = Status
::newGood( true );
2195 * Get the user's real name
2196 * @return String User's real name
2198 public function getRealName() {
2199 if ( !$this->isItemLoaded( 'realname' ) ) {
2203 return $this->mRealName
;
2207 * Set the user's real name
2208 * @param $str String New real name
2210 public function setRealName( $str ) {
2212 $this->mRealName
= $str;
2216 * Get the user's current setting for a given option.
2218 * @param $oname String The option to check
2219 * @param $defaultOverride String A default value returned if the option does not exist
2220 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2221 * @return String User's current value for the option
2222 * @see getBoolOption()
2223 * @see getIntOption()
2225 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2226 global $wgHiddenPrefs;
2227 $this->loadOptions();
2229 # We want 'disabled' preferences to always behave as the default value for
2230 # users, even if they have set the option explicitly in their settings (ie they
2231 # set it, and then it was disabled removing their ability to change it). But
2232 # we don't want to erase the preferences in the database in case the preference
2233 # is re-enabled again. So don't touch $mOptions, just override the returned value
2234 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ) {
2235 return self
::getDefaultOption( $oname );
2238 if ( array_key_exists( $oname, $this->mOptions
) ) {
2239 return $this->mOptions
[$oname];
2241 return $defaultOverride;
2246 * Get all user's options
2250 public function getOptions() {
2251 global $wgHiddenPrefs;
2252 $this->loadOptions();
2253 $options = $this->mOptions
;
2255 # We want 'disabled' preferences to always behave as the default value for
2256 # users, even if they have set the option explicitly in their settings (ie they
2257 # set it, and then it was disabled removing their ability to change it). But
2258 # we don't want to erase the preferences in the database in case the preference
2259 # is re-enabled again. So don't touch $mOptions, just override the returned value
2260 foreach( $wgHiddenPrefs as $pref ) {
2261 $default = self
::getDefaultOption( $pref );
2262 if( $default !== null ) {
2263 $options[$pref] = $default;
2271 * Get the user's current setting for a given option, as a boolean value.
2273 * @param $oname String The option to check
2274 * @return Bool User's current value for the option
2277 public function getBoolOption( $oname ) {
2278 return (bool)$this->getOption( $oname );
2282 * Get the user's current setting for a given option, as a boolean value.
2284 * @param $oname String The option to check
2285 * @param $defaultOverride Int A default value returned if the option does not exist
2286 * @return Int User's current value for the option
2289 public function getIntOption( $oname, $defaultOverride = 0 ) {
2290 $val = $this->getOption( $oname );
2292 $val = $defaultOverride;
2294 return intval( $val );
2298 * Set the given option for a user.
2300 * @param $oname String The option to set
2301 * @param $val mixed New value to set
2303 public function setOption( $oname, $val ) {
2304 $this->loadOptions();
2306 // Explicitly NULL values should refer to defaults
2307 if( is_null( $val ) ) {
2308 $val = self
::getDefaultOption( $oname );
2311 $this->mOptions
[$oname] = $val;
2315 * Return a list of the types of user options currently returned by
2316 * User::getOptionKinds().
2318 * Currently, the option kinds are:
2319 * - 'registered' - preferences which are registered in core MediaWiki or
2320 * by extensions using the UserGetDefaultOptions hook.
2321 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2322 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2323 * be used by user scripts.
2324 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2325 * These are usually legacy options, removed in newer versions.
2327 * The API (and possibly others) use this function to determine the possible
2328 * option types for validation purposes, so make sure to update this when a
2329 * new option kind is added.
2331 * @see User::getOptionKinds
2332 * @return array Option kinds
2334 public static function listOptionKinds() {
2337 'registered-multiselect',
2344 * Return an associative array mapping preferences keys to the kind of a preference they're
2345 * used for. Different kinds are handled differently when setting or reading preferences.
2347 * See User::listOptionKinds for the list of valid option types that can be provided.
2349 * @see User::listOptionKinds
2350 * @param $context IContextSource
2351 * @param $options array assoc. array with options keys to check as keys. Defaults to $this->mOptions.
2352 * @return array the key => kind mapping data
2354 public function getOptionKinds( IContextSource
$context, $options = null ) {
2355 $this->loadOptions();
2356 if ( $options === null ) {
2357 $options = $this->mOptions
;
2360 $prefs = Preferences
::getPreferences( $this, $context );
2363 // Multiselect options are stored in the database with one key per
2364 // option, each having a boolean value. Extract those keys.
2365 $multiselectOptions = array();
2366 foreach ( $prefs as $name => $info ) {
2367 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2368 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2369 $opts = HTMLFormField
::flattenOptions( $info['options'] );
2370 $prefix = isset( $info['prefix'] ) ?
$info['prefix'] : $name;
2372 foreach ( $opts as $value ) {
2373 $multiselectOptions["$prefix$value"] = true;
2376 unset( $prefs[$name] );
2380 // $value is ignored
2381 foreach ( $options as $key => $value ) {
2382 if ( isset( $prefs[$key] ) ) {
2383 $mapping[$key] = 'registered';
2384 } elseif( isset( $multiselectOptions[$key] ) ) {
2385 $mapping[$key] = 'registered-multiselect';
2386 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
2387 $mapping[$key] = 'userjs';
2389 $mapping[$key] = 'unused';
2397 * Reset certain (or all) options to the site defaults
2399 * The optional parameter determines which kinds of preferences will be reset.
2400 * Supported values are everything that can be reported by getOptionKinds()
2401 * and 'all', which forces a reset of *all* preferences and overrides everything else.
2403 * @param $resetKinds array|string which kinds of preferences to reset. Defaults to
2404 * array( 'registered', 'registered-multiselect', 'unused' )
2405 * for backwards-compatibility.
2406 * @param $context IContextSource|null context source used when $resetKinds
2407 * does not contain 'all', passed to getOptionKinds().
2408 * Defaults to RequestContext::getMain() when null.
2410 public function resetOptions(
2411 $resetKinds = array( 'registered', 'registered-multiselect', 'unused' ),
2412 IContextSource
$context = null
2415 $defaultOptions = self
::getDefaultOptions();
2417 if ( !is_array( $resetKinds ) ) {
2418 $resetKinds = array( $resetKinds );
2421 if ( in_array( 'all', $resetKinds ) ) {
2422 $newOptions = $defaultOptions;
2424 if ( $context === null ) {
2425 $context = RequestContext
::getMain();
2428 $optionKinds = $this->getOptionKinds( $context );
2429 $resetKinds = array_intersect( $resetKinds, self
::listOptionKinds() );
2430 $newOptions = array();
2432 // Use default values for the options that should be deleted, and
2433 // copy old values for the ones that shouldn't.
2434 foreach ( $this->mOptions
as $key => $value ) {
2435 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
2436 if ( array_key_exists( $key, $defaultOptions ) ) {
2437 $newOptions[$key] = $defaultOptions[$key];
2440 $newOptions[$key] = $value;
2445 $this->mOptions
= $newOptions;
2446 $this->mOptionsLoaded
= true;
2450 * Get the user's preferred date format.
2451 * @return String User's preferred date format
2453 public function getDatePreference() {
2454 // Important migration for old data rows
2455 if ( is_null( $this->mDatePreference
) ) {
2457 $value = $this->getOption( 'date' );
2458 $map = $wgLang->getDatePreferenceMigrationMap();
2459 if ( isset( $map[$value] ) ) {
2460 $value = $map[$value];
2462 $this->mDatePreference
= $value;
2464 return $this->mDatePreference
;
2468 * Get the user preferred stub threshold
2472 public function getStubThreshold() {
2473 global $wgMaxArticleSize; # Maximum article size, in Kb
2474 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2475 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2476 # If they have set an impossible value, disable the preference
2477 # so we can use the parser cache again.
2484 * Get the permissions this user has.
2485 * @return Array of String permission names
2487 public function getRights() {
2488 if ( is_null( $this->mRights
) ) {
2489 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2490 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2491 // Force reindexation of rights when a hook has unset one of them
2492 $this->mRights
= array_values( array_unique( $this->mRights
) );
2494 return $this->mRights
;
2498 * Get the list of explicit group memberships this user has.
2499 * The implicit * and user groups are not included.
2500 * @return Array of String internal group names
2502 public function getGroups() {
2504 $this->loadGroups();
2505 return $this->mGroups
;
2509 * Get the list of implicit group memberships this user has.
2510 * This includes all explicit groups, plus 'user' if logged in,
2511 * '*' for all accounts, and autopromoted groups
2512 * @param $recache Bool Whether to avoid the cache
2513 * @return Array of String internal group names
2515 public function getEffectiveGroups( $recache = false ) {
2516 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2517 wfProfileIn( __METHOD__
);
2518 $this->mEffectiveGroups
= array_unique( array_merge(
2519 $this->getGroups(), // explicit groups
2520 $this->getAutomaticGroups( $recache ) // implicit groups
2522 # Hook for additional groups
2523 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2524 // Force reindexation of groups when a hook has unset one of them
2525 $this->mEffectiveGroups
= array_values( array_unique( $this->mEffectiveGroups
) );
2526 wfProfileOut( __METHOD__
);
2528 return $this->mEffectiveGroups
;
2532 * Get the list of implicit group memberships this user has.
2533 * This includes 'user' if logged in, '*' for all accounts,
2534 * and autopromoted groups
2535 * @param $recache Bool Whether to avoid the cache
2536 * @return Array of String internal group names
2538 public function getAutomaticGroups( $recache = false ) {
2539 if ( $recache ||
is_null( $this->mImplicitGroups
) ) {
2540 wfProfileIn( __METHOD__
);
2541 $this->mImplicitGroups
= array( '*' );
2542 if ( $this->getId() ) {
2543 $this->mImplicitGroups
[] = 'user';
2545 $this->mImplicitGroups
= array_unique( array_merge(
2546 $this->mImplicitGroups
,
2547 Autopromote
::getAutopromoteGroups( $this )
2551 # Assure data consistency with rights/groups,
2552 # as getEffectiveGroups() depends on this function
2553 $this->mEffectiveGroups
= null;
2555 wfProfileOut( __METHOD__
);
2557 return $this->mImplicitGroups
;
2561 * Returns the groups the user has belonged to.
2563 * The user may still belong to the returned groups. Compare with getGroups().
2565 * The function will not return groups the user had belonged to before MW 1.17
2567 * @return array Names of the groups the user has belonged to.
2569 public function getFormerGroups() {
2570 if( is_null( $this->mFormerGroups
) ) {
2571 $dbr = wfGetDB( DB_MASTER
);
2572 $res = $dbr->select( 'user_former_groups',
2573 array( 'ufg_group' ),
2574 array( 'ufg_user' => $this->mId
),
2576 $this->mFormerGroups
= array();
2577 foreach( $res as $row ) {
2578 $this->mFormerGroups
[] = $row->ufg_group
;
2581 return $this->mFormerGroups
;
2585 * Get the user's edit count.
2588 public function getEditCount() {
2589 if ( !$this->getId() ) {
2593 if ( !isset( $this->mEditCount
) ) {
2594 /* Populate the count, if it has not been populated yet */
2595 wfProfileIn( __METHOD__
);
2596 $dbr = wfGetDB( DB_SLAVE
);
2597 // check if the user_editcount field has been initialized
2598 $count = $dbr->selectField(
2599 'user', 'user_editcount',
2600 array( 'user_id' => $this->mId
),
2604 if( $count === null ) {
2605 // it has not been initialized. do so.
2606 $count = $this->initEditCount();
2608 $this->mEditCount
= intval( $count );
2609 wfProfileOut( __METHOD__
);
2611 return $this->mEditCount
;
2615 * Add the user to the given group.
2616 * This takes immediate effect.
2617 * @param $group String Name of the group to add
2619 public function addGroup( $group ) {
2620 if( wfRunHooks( 'UserAddGroup', array( $this, &$group ) ) ) {
2621 $dbw = wfGetDB( DB_MASTER
);
2622 if( $this->getId() ) {
2623 $dbw->insert( 'user_groups',
2625 'ug_user' => $this->getID(),
2626 'ug_group' => $group,
2629 array( 'IGNORE' ) );
2632 $this->loadGroups();
2633 $this->mGroups
[] = $group;
2634 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2636 $this->invalidateCache();
2640 * Remove the user from the given group.
2641 * This takes immediate effect.
2642 * @param $group String Name of the group to remove
2644 public function removeGroup( $group ) {
2646 if( wfRunHooks( 'UserRemoveGroup', array( $this, &$group ) ) ) {
2647 $dbw = wfGetDB( DB_MASTER
);
2648 $dbw->delete( 'user_groups',
2650 'ug_user' => $this->getID(),
2651 'ug_group' => $group,
2653 // Remember that the user was in this group
2654 $dbw->insert( 'user_former_groups',
2656 'ufg_user' => $this->getID(),
2657 'ufg_group' => $group,
2660 array( 'IGNORE' ) );
2662 $this->loadGroups();
2663 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2664 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2666 $this->invalidateCache();
2670 * Get whether the user is logged in
2673 public function isLoggedIn() {
2674 return $this->getID() != 0;
2678 * Get whether the user is anonymous
2681 public function isAnon() {
2682 return !$this->isLoggedIn();
2686 * Check if user is allowed to access a feature / make an action
2688 * @internal param \String $varargs permissions to test
2689 * @return Boolean: True if user is allowed to perform *any* of the given actions
2693 public function isAllowedAny( /*...*/ ) {
2694 $permissions = func_get_args();
2695 foreach( $permissions as $permission ) {
2696 if( $this->isAllowed( $permission ) ) {
2705 * @internal param $varargs string
2706 * @return bool True if the user is allowed to perform *all* of the given actions
2708 public function isAllowedAll( /*...*/ ) {
2709 $permissions = func_get_args();
2710 foreach( $permissions as $permission ) {
2711 if( !$this->isAllowed( $permission ) ) {
2719 * Internal mechanics of testing a permission
2720 * @param $action String
2723 public function isAllowed( $action = '' ) {
2724 if ( $action === '' ) {
2725 return true; // In the spirit of DWIM
2727 # Patrolling may not be enabled
2728 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2729 global $wgUseRCPatrol, $wgUseNPPatrol;
2730 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2733 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2734 # by misconfiguration: 0 == 'foo'
2735 return in_array( $action, $this->getRights(), true );
2739 * Check whether to enable recent changes patrol features for this user
2740 * @return Boolean: True or false
2742 public function useRCPatrol() {
2743 global $wgUseRCPatrol;
2744 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2748 * Check whether to enable new pages patrol features for this user
2749 * @return Bool True or false
2751 public function useNPPatrol() {
2752 global $wgUseRCPatrol, $wgUseNPPatrol;
2753 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2757 * Get the WebRequest object to use with this object
2759 * @return WebRequest
2761 public function getRequest() {
2762 if ( $this->mRequest
) {
2763 return $this->mRequest
;
2771 * Get the current skin, loading it if required
2772 * @return Skin The current skin
2773 * @todo FIXME: Need to check the old failback system [AV]
2774 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2776 public function getSkin() {
2777 wfDeprecated( __METHOD__
, '1.18' );
2778 return RequestContext
::getMain()->getSkin();
2782 * Get a WatchedItem for this user and $title.
2784 * @param $title Title
2785 * @return WatchedItem
2787 public function getWatchedItem( $title ) {
2788 $key = $title->getNamespace() . ':' . $title->getDBkey();
2790 if ( isset( $this->mWatchedItems
[$key] ) ) {
2791 return $this->mWatchedItems
[$key];
2794 if ( count( $this->mWatchedItems
) >= self
::MAX_WATCHED_ITEMS_CACHE
) {
2795 $this->mWatchedItems
= array();
2798 $this->mWatchedItems
[$key] = WatchedItem
::fromUserTitle( $this, $title );
2799 return $this->mWatchedItems
[$key];
2803 * Check the watched status of an article.
2804 * @param $title Title of the article to look at
2807 public function isWatched( $title ) {
2808 return $this->getWatchedItem( $title )->isWatched();
2813 * @param $title Title of the article to look at
2815 public function addWatch( $title ) {
2816 $this->getWatchedItem( $title )->addWatch();
2817 $this->invalidateCache();
2821 * Stop watching an article.
2822 * @param $title Title of the article to look at
2824 public function removeWatch( $title ) {
2825 $this->getWatchedItem( $title )->removeWatch();
2826 $this->invalidateCache();
2830 * Clear the user's notification timestamp for the given title.
2831 * If e-notif e-mails are on, they will receive notification mails on
2832 * the next change of the page if it's watched etc.
2833 * @param $title Title of the article to look at
2835 public function clearNotification( &$title ) {
2836 global $wgUseEnotif, $wgShowUpdatedMarker;
2838 # Do nothing if the database is locked to writes
2839 if( wfReadOnly() ) {
2843 if( $title->getNamespace() == NS_USER_TALK
&&
2844 $title->getText() == $this->getName() ) {
2845 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2847 $this->setNewtalk( false );
2850 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2854 if( $this->isAnon() ) {
2855 // Nothing else to do...
2859 // Only update the timestamp if the page is being watched.
2860 // The query to find out if it is watched is cached both in memcached and per-invocation,
2861 // and when it does have to be executed, it can be on a slave
2862 // If this is the user's newtalk page, we always update the timestamp
2864 if ( $title->getNamespace() == NS_USER_TALK
&&
2865 $title->getText() == $this->getName() )
2870 $this->getWatchedItem( $title )->resetNotificationTimestamp( $force );
2874 * Resets all of the given user's page-change notification timestamps.
2875 * If e-notif e-mails are on, they will receive notification mails on
2876 * the next change of any watched page.
2878 public function clearAllNotifications() {
2879 if ( wfReadOnly() ) {
2883 global $wgUseEnotif, $wgShowUpdatedMarker;
2884 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2885 $this->setNewtalk( false );
2888 $id = $this->getId();
2890 $dbw = wfGetDB( DB_MASTER
);
2891 $dbw->update( 'watchlist',
2893 'wl_notificationtimestamp' => null
2894 ), array( /* WHERE */
2898 # We also need to clear here the "you have new message" notification for the own user_talk page
2899 # This is cleared one page view later in Article::viewUpdates();
2904 * Set this user's options from an encoded string
2905 * @param $str String Encoded options to import
2907 * @deprecated in 1.19 due to removal of user_options from the user table
2909 private function decodeOptions( $str ) {
2910 wfDeprecated( __METHOD__
, '1.19' );
2914 $this->mOptionsLoaded
= true;
2915 $this->mOptionOverrides
= array();
2917 // If an option is not set in $str, use the default value
2918 $this->mOptions
= self
::getDefaultOptions();
2920 $a = explode( "\n", $str );
2921 foreach ( $a as $s ) {
2923 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2924 $this->mOptions
[$m[1]] = $m[2];
2925 $this->mOptionOverrides
[$m[1]] = $m[2];
2931 * Set a cookie on the user's client. Wrapper for
2932 * WebResponse::setCookie
2933 * @param $name String Name of the cookie to set
2934 * @param $value String Value to set
2935 * @param $exp Int Expiration time, as a UNIX time value;
2936 * if 0 or not specified, use the default $wgCookieExpiration
2937 * @param $secure Bool
2938 * true: Force setting the secure attribute when setting the cookie
2939 * false: Force NOT setting the secure attribute when setting the cookie
2940 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
2942 protected function setCookie( $name, $value, $exp = 0, $secure = null ) {
2943 $this->getRequest()->response()->setcookie( $name, $value, $exp, null, null, $secure );
2947 * Clear a cookie on the user's client
2948 * @param $name String Name of the cookie to clear
2950 protected function clearCookie( $name ) {
2951 $this->setCookie( $name, '', time() - 86400 );
2955 * Set the default cookies for this session on the user's client.
2957 * @param $request WebRequest object to use; $wgRequest will be used if null
2959 * @param $secure Whether to force secure/insecure cookies or use default
2961 public function setCookies( $request = null, $secure = null ) {
2962 if ( $request === null ) {
2963 $request = $this->getRequest();
2967 if ( 0 == $this->mId
) return;
2968 if ( !$this->mToken
) {
2969 // When token is empty or NULL generate a new one and then save it to the database
2970 // This allows a wiki to re-secure itself after a leak of it's user table or $wgSecretKey
2971 // Simply by setting every cell in the user_token column to NULL and letting them be
2972 // regenerated as users log back into the wiki.
2974 $this->saveSettings();
2977 'wsUserID' => $this->mId
,
2978 'wsToken' => $this->mToken
,
2979 'wsUserName' => $this->getName()
2982 'UserID' => $this->mId
,
2983 'UserName' => $this->getName(),
2985 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2986 $cookies['Token'] = $this->mToken
;
2988 $cookies['Token'] = false;
2991 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2993 foreach ( $session as $name => $value ) {
2994 $request->setSessionData( $name, $value );
2996 foreach ( $cookies as $name => $value ) {
2997 if ( $value === false ) {
2998 $this->clearCookie( $name );
3000 $this->setCookie( $name, $value, 0, $secure );
3005 * If wpStickHTTPS was selected, also set an insecure cookie that
3006 * will cause the site to redirect the user to HTTPS, if they access
3007 * it over HTTP. Bug 29898.
3009 if ( $request->getCheck( 'wpStickHTTPS' ) ) {
3010 $this->setCookie( 'forceHTTPS', 'true', time() +
2592000, false ); //30 days
3015 * Log this user out.
3017 public function logout() {
3018 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
3024 * Clear the user's cookies and session, and reset the instance cache.
3027 public function doLogout() {
3028 $this->clearInstanceCache( 'defaults' );
3030 $this->getRequest()->setSessionData( 'wsUserID', 0 );
3032 $this->clearCookie( 'UserID' );
3033 $this->clearCookie( 'Token' );
3034 $this->clearCookie( 'forceHTTPS' );
3036 # Remember when user logged out, to prevent seeing cached pages
3037 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
3041 * Save this user's settings into the database.
3042 * @todo Only rarely do all these fields need to be set!
3044 public function saveSettings() {
3048 if ( wfReadOnly() ) { return; }
3049 if ( 0 == $this->mId
) { return; }
3051 $this->mTouched
= self
::newTouchedTimestamp();
3052 if ( !$wgAuth->allowSetLocalPassword() ) {
3053 $this->mPassword
= '';
3056 $dbw = wfGetDB( DB_MASTER
);
3057 $dbw->update( 'user',
3059 'user_name' => $this->mName
,
3060 'user_password' => $this->mPassword
,
3061 'user_newpassword' => $this->mNewpassword
,
3062 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3063 'user_real_name' => $this->mRealName
,
3064 'user_email' => $this->mEmail
,
3065 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3066 'user_touched' => $dbw->timestamp( $this->mTouched
),
3067 'user_token' => strval( $this->mToken
),
3068 'user_email_token' => $this->mEmailToken
,
3069 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
3070 ), array( /* WHERE */
3071 'user_id' => $this->mId
3075 $this->saveOptions();
3077 wfRunHooks( 'UserSaveSettings', array( $this ) );
3078 $this->clearSharedCache();
3079 $this->getUserPage()->invalidateCache();
3083 * If only this user's username is known, and it exists, return the user ID.
3086 public function idForName() {
3087 $s = trim( $this->getName() );
3088 if ( $s === '' ) return 0;
3090 $dbr = wfGetDB( DB_SLAVE
);
3091 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
3092 if ( $id === false ) {
3099 * Add a user to the database, return the user object
3101 * @param $name String Username to add
3102 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
3103 * - password The user's password hash. Password logins will be disabled if this is omitted.
3104 * - newpassword Hash for a temporary password that has been mailed to the user
3105 * - email The user's email address
3106 * - email_authenticated The email authentication timestamp
3107 * - real_name The user's real name
3108 * - options An associative array of non-default options
3109 * - token Random authentication token. Do not set.
3110 * - registration Registration timestamp. Do not set.
3112 * @return User object, or null if the username already exists
3114 public static function createNew( $name, $params = array() ) {
3117 if ( isset( $params['options'] ) ) {
3118 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
3119 unset( $params['options'] );
3121 $dbw = wfGetDB( DB_MASTER
);
3122 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3125 'user_id' => $seqVal,
3126 'user_name' => $name,
3127 'user_password' => $user->mPassword
,
3128 'user_newpassword' => $user->mNewpassword
,
3129 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
3130 'user_email' => $user->mEmail
,
3131 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
3132 'user_real_name' => $user->mRealName
,
3133 'user_token' => strval( $user->mToken
),
3134 'user_registration' => $dbw->timestamp( $user->mRegistration
),
3135 'user_editcount' => 0,
3136 'user_touched' => $dbw->timestamp( self
::newTouchedTimestamp() ),
3138 foreach ( $params as $name => $value ) {
3139 $fields["user_$name"] = $value;
3141 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
3142 if ( $dbw->affectedRows() ) {
3143 $newUser = User
::newFromId( $dbw->insertId() );
3151 * Add this existing user object to the database. If the user already
3152 * exists, a fatal status object is returned, and the user object is
3153 * initialised with the data from the database.
3155 * Previously, this function generated a DB error due to a key conflict
3156 * if the user already existed. Many extension callers use this function
3157 * in code along the lines of:
3159 * $user = User::newFromName( $name );
3160 * if ( !$user->isLoggedIn() ) {
3161 * $user->addToDatabase();
3163 * // do something with $user...
3165 * However, this was vulnerable to a race condition (bug 16020). By
3166 * initialising the user object if the user exists, we aim to support this
3167 * calling sequence as far as possible.
3169 * Note that if the user exists, this function will acquire a write lock,
3170 * so it is still advisable to make the call conditional on isLoggedIn(),
3171 * and to commit the transaction after calling.
3173 * @throws MWException
3176 public function addToDatabase() {
3179 $this->mTouched
= self
::newTouchedTimestamp();
3181 $dbw = wfGetDB( DB_MASTER
);
3182 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3183 $dbw->insert( 'user',
3185 'user_id' => $seqVal,
3186 'user_name' => $this->mName
,
3187 'user_password' => $this->mPassword
,
3188 'user_newpassword' => $this->mNewpassword
,
3189 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
3190 'user_email' => $this->mEmail
,
3191 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
3192 'user_real_name' => $this->mRealName
,
3193 'user_token' => strval( $this->mToken
),
3194 'user_registration' => $dbw->timestamp( $this->mRegistration
),
3195 'user_editcount' => 0,
3196 'user_touched' => $dbw->timestamp( $this->mTouched
),
3200 if ( !$dbw->affectedRows() ) {
3201 $this->mId
= $dbw->selectField( 'user', 'user_id',
3202 array( 'user_name' => $this->mName
), __METHOD__
);
3205 if ( $this->loadFromDatabase() ) {
3210 throw new MWException( __METHOD__
. ": hit a key conflict attempting " .
3211 "to insert a user row, but then it doesn't exist when we select it!" );
3213 return Status
::newFatal( 'userexists' );
3215 $this->mId
= $dbw->insertId();
3217 // Clear instance cache other than user table data, which is already accurate
3218 $this->clearInstanceCache();
3220 $this->saveOptions();
3221 return Status
::newGood();
3225 * If this user is logged-in and blocked,
3226 * block any IP address they've successfully logged in from.
3227 * @return bool A block was spread
3229 public function spreadAnyEditBlock() {
3230 if ( $this->isLoggedIn() && $this->isBlocked() ) {
3231 return $this->spreadBlock();
3237 * If this (non-anonymous) user is blocked,
3238 * block the IP address they've successfully logged in from.
3239 * @return bool A block was spread
3241 protected function spreadBlock() {
3242 wfDebug( __METHOD__
. "()\n" );
3244 if ( $this->mId
== 0 ) {
3248 $userblock = Block
::newFromTarget( $this->getName() );
3249 if ( !$userblock ) {
3253 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
3257 * Generate a string which will be different for any combination of
3258 * user options which would produce different parser output.
3259 * This will be used as part of the hash key for the parser cache,
3260 * so users with the same options can share the same cached data
3263 * Extensions which require it should install 'PageRenderingHash' hook,
3264 * which will give them a chance to modify this key based on their own
3267 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
3268 * @return String Page rendering hash
3270 public function getPageRenderingHash() {
3271 wfDeprecated( __METHOD__
, '1.17' );
3273 global $wgRenderHashAppend, $wgLang, $wgContLang;
3274 if( $this->mHash
) {
3275 return $this->mHash
;
3278 // stubthreshold is only included below for completeness,
3279 // since it disables the parser cache, its value will always
3280 // be 0 when this function is called by parsercache.
3282 $confstr = $this->getOption( 'math' );
3283 $confstr .= '!' . $this->getStubThreshold();
3284 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
3285 $confstr .= '!' . $wgLang->getCode();
3286 $confstr .= '!' . $this->getOption( 'thumbsize' );
3287 // add in language specific options, if any
3288 $extra = $wgContLang->getExtraHashOptions();
3291 // Since the skin could be overloading link(), it should be
3292 // included here but in practice, none of our skins do that.
3294 $confstr .= $wgRenderHashAppend;
3296 // Give a chance for extensions to modify the hash, if they have
3297 // extra options or other effects on the parser cache.
3298 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
3300 // Make it a valid memcached key fragment
3301 $confstr = str_replace( ' ', '_', $confstr );
3302 $this->mHash
= $confstr;
3307 * Get whether the user is explicitly blocked from account creation.
3308 * @return Bool|Block
3310 public function isBlockedFromCreateAccount() {
3311 $this->getBlockedStatus();
3312 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ) {
3313 return $this->mBlock
;
3316 # bug 13611: if the IP address the user is trying to create an account from is
3317 # blocked with createaccount disabled, prevent new account creation there even
3318 # when the user is logged in
3319 if ( $this->mBlockedFromCreateAccount
=== false && !$this->isAllowed( 'ipblock-exempt' ) ) {
3320 $this->mBlockedFromCreateAccount
= Block
::newFromTarget( null, $this->getRequest()->getIP() );
3322 return $this->mBlockedFromCreateAccount
instanceof Block
&& $this->mBlockedFromCreateAccount
->prevents( 'createaccount' )
3323 ?
$this->mBlockedFromCreateAccount
3328 * Get whether the user is blocked from using Special:Emailuser.
3331 public function isBlockedFromEmailuser() {
3332 $this->getBlockedStatus();
3333 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
3337 * Get whether the user is allowed to create an account.
3340 function isAllowedToCreateAccount() {
3341 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
3345 * Get this user's personal page title.
3347 * @return Title: User's personal page title
3349 public function getUserPage() {
3350 return Title
::makeTitle( NS_USER
, $this->getName() );
3354 * Get this user's talk page title.
3356 * @return Title: User's talk page title
3358 public function getTalkPage() {
3359 $title = $this->getUserPage();
3360 return $title->getTalkPage();
3364 * Determine whether the user is a newbie. Newbies are either
3365 * anonymous IPs, or the most recently created accounts.
3368 public function isNewbie() {
3369 return !$this->isAllowed( 'autoconfirmed' );
3373 * Check to see if the given clear-text password is one of the accepted passwords
3374 * @param $password String: user password.
3375 * @return Boolean: True if the given password is correct, otherwise False.
3377 public function checkPassword( $password ) {
3378 global $wgAuth, $wgLegacyEncoding;
3381 // Even though we stop people from creating passwords that
3382 // are shorter than this, doesn't mean people wont be able
3383 // to. Certain authentication plugins do NOT want to save
3384 // domain passwords in a mysql database, so we should
3385 // check this (in case $wgAuth->strict() is false).
3386 if( !$this->isValidPassword( $password ) ) {
3390 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
3392 } elseif( $wgAuth->strict() ) {
3393 /* Auth plugin doesn't allow local authentication */
3395 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
3396 /* Auth plugin doesn't allow local authentication for this user name */
3399 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
3401 } elseif ( $wgLegacyEncoding ) {
3402 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
3403 # Check for this with iconv
3404 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
3405 if ( $cp1252Password != $password &&
3406 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
3415 * Check if the given clear-text password matches the temporary password
3416 * sent by e-mail for password reset operations.
3418 * @param $plaintext string
3420 * @return Boolean: True if matches, false otherwise
3422 public function checkTemporaryPassword( $plaintext ) {
3423 global $wgNewPasswordExpiry;
3426 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
3427 if ( is_null( $this->mNewpassTime
) ) {
3430 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
3431 return ( time() < $expiry );
3438 * Alias for getEditToken.
3439 * @deprecated since 1.19, use getEditToken instead.
3441 * @param $salt String|Array of Strings Optional function-specific data for hashing
3442 * @param $request WebRequest object to use or null to use $wgRequest
3443 * @return String The new edit token
3445 public function editToken( $salt = '', $request = null ) {
3446 wfDeprecated( __METHOD__
, '1.19' );
3447 return $this->getEditToken( $salt, $request );
3451 * Initialize (if necessary) and return a session token value
3452 * which can be used in edit forms to show that the user's
3453 * login credentials aren't being hijacked with a foreign form
3458 * @param $salt String|Array of Strings Optional function-specific data for hashing
3459 * @param $request WebRequest object to use or null to use $wgRequest
3460 * @return String The new edit token
3462 public function getEditToken( $salt = '', $request = null ) {
3463 if ( $request == null ) {
3464 $request = $this->getRequest();
3467 if ( $this->isAnon() ) {
3468 return EDIT_TOKEN_SUFFIX
;
3470 $token = $request->getSessionData( 'wsEditToken' );
3471 if ( $token === null ) {
3472 $token = MWCryptRand
::generateHex( 32 );
3473 $request->setSessionData( 'wsEditToken', $token );
3475 if( is_array( $salt ) ) {
3476 $salt = implode( '|', $salt );
3478 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
3483 * Generate a looking random token for various uses.
3485 * @param $salt String Optional salt value
3486 * @return String The new random token
3487 * @deprecated since 1.20; Use MWCryptRand for secure purposes or wfRandomString for pesudo-randomness
3489 public static function generateToken( $salt = '' ) {
3490 return MWCryptRand
::generateHex( 32 );
3494 * Check given value against the token value stored in the session.
3495 * A match should confirm that the form was submitted from the
3496 * user's own login session, not a form submission from a third-party
3499 * @param $val String Input value to compare
3500 * @param $salt String Optional function-specific data for hashing
3501 * @param $request WebRequest object to use or null to use $wgRequest
3502 * @return Boolean: Whether the token matches
3504 public function matchEditToken( $val, $salt = '', $request = null ) {
3505 $sessionToken = $this->getEditToken( $salt, $request );
3506 if ( $val != $sessionToken ) {
3507 wfDebug( "User::matchEditToken: broken session data\n" );
3509 return $val == $sessionToken;
3513 * Check given value against the token value stored in the session,
3514 * ignoring the suffix.
3516 * @param $val String Input value to compare
3517 * @param $salt String Optional function-specific data for hashing
3518 * @param $request WebRequest object to use or null to use $wgRequest
3519 * @return Boolean: Whether the token matches
3521 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3522 $sessionToken = $this->getEditToken( $salt, $request );
3523 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3527 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3528 * mail to the user's given address.
3530 * @param $type String: message to send, either "created", "changed" or "set"
3531 * @return Status object
3533 public function sendConfirmationMail( $type = 'created' ) {
3535 $expiration = null; // gets passed-by-ref and defined in next line.
3536 $token = $this->confirmationToken( $expiration );
3537 $url = $this->confirmationTokenUrl( $token );
3538 $invalidateURL = $this->invalidationTokenUrl( $token );
3539 $this->saveSettings();
3541 if ( $type == 'created' ||
$type === false ) {
3542 $message = 'confirmemail_body';
3543 } elseif ( $type === true ) {
3544 $message = 'confirmemail_body_changed';
3546 $message = 'confirmemail_body_' . $type;
3549 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
3550 wfMessage( $message,
3551 $this->getRequest()->getIP(),
3554 $wgLang->timeanddate( $expiration, false ),
3556 $wgLang->date( $expiration, false ),
3557 $wgLang->time( $expiration, false ) )->text() );
3561 * Send an e-mail to this user's account. Does not check for
3562 * confirmed status or validity.
3564 * @param $subject String Message subject
3565 * @param $body String Message body
3566 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3567 * @param $replyto String Reply-To address
3570 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
3571 if( is_null( $from ) ) {
3572 global $wgPasswordSender, $wgPasswordSenderName;
3573 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3575 $sender = new MailAddress( $from );
3578 $to = new MailAddress( $this );
3579 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3583 * Generate, store, and return a new e-mail confirmation code.
3584 * A hash (unsalted, since it's used as a key) is stored.
3586 * @note Call saveSettings() after calling this function to commit
3587 * this change to the database.
3589 * @param &$expiration \mixed Accepts the expiration time
3590 * @return String New token
3592 private function confirmationToken( &$expiration ) {
3593 global $wgUserEmailConfirmationTokenExpiry;
3595 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3596 $expiration = wfTimestamp( TS_MW
, $expires );
3598 $token = MWCryptRand
::generateHex( 32 );
3599 $hash = md5( $token );
3600 $this->mEmailToken
= $hash;
3601 $this->mEmailTokenExpires
= $expiration;
3606 * Return a URL the user can use to confirm their email address.
3607 * @param $token String Accepts the email confirmation token
3608 * @return String New token URL
3610 private function confirmationTokenUrl( $token ) {
3611 return $this->getTokenUrl( 'ConfirmEmail', $token );
3615 * Return a URL the user can use to invalidate their email address.
3616 * @param $token String Accepts the email confirmation token
3617 * @return String New token URL
3619 private function invalidationTokenUrl( $token ) {
3620 return $this->getTokenUrl( 'InvalidateEmail', $token );
3624 * Internal function to format the e-mail validation/invalidation URLs.
3625 * This uses a quickie hack to use the
3626 * hardcoded English names of the Special: pages, for ASCII safety.
3628 * @note Since these URLs get dropped directly into emails, using the
3629 * short English names avoids insanely long URL-encoded links, which
3630 * also sometimes can get corrupted in some browsers/mailers
3631 * (bug 6957 with Gmail and Internet Explorer).
3633 * @param $page String Special page
3634 * @param $token String Token
3635 * @return String Formatted URL
3637 protected function getTokenUrl( $page, $token ) {
3638 // Hack to bypass localization of 'Special:'
3639 $title = Title
::makeTitle( NS_MAIN
, "Special:$page/$token" );
3640 return $title->getCanonicalUrl();
3644 * Mark the e-mail address confirmed.
3646 * @note Call saveSettings() after calling this function to commit the change.
3650 public function confirmEmail() {
3651 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3652 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3657 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3658 * address if it was already confirmed.
3660 * @note Call saveSettings() after calling this function to commit the change.
3661 * @return bool Returns true
3663 function invalidateEmail() {
3665 $this->mEmailToken
= null;
3666 $this->mEmailTokenExpires
= null;
3667 $this->setEmailAuthenticationTimestamp( null );
3668 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3673 * Set the e-mail authentication timestamp.
3674 * @param $timestamp String TS_MW timestamp
3676 function setEmailAuthenticationTimestamp( $timestamp ) {
3678 $this->mEmailAuthenticated
= $timestamp;
3679 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3683 * Is this user allowed to send e-mails within limits of current
3684 * site configuration?
3687 public function canSendEmail() {
3688 global $wgEnableEmail, $wgEnableUserEmail;
3689 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3692 $canSend = $this->isEmailConfirmed();
3693 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3698 * Is this user allowed to receive e-mails within limits of current
3699 * site configuration?
3702 public function canReceiveEmail() {
3703 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3707 * Is this user's e-mail address valid-looking and confirmed within
3708 * limits of the current site configuration?
3710 * @note If $wgEmailAuthentication is on, this may require the user to have
3711 * confirmed their address by returning a code or using a password
3712 * sent to the address from the wiki.
3716 public function isEmailConfirmed() {
3717 global $wgEmailAuthentication;
3720 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3721 if( $this->isAnon() ) {
3724 if( !Sanitizer
::validateEmail( $this->mEmail
) ) {
3727 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
3737 * Check whether there is an outstanding request for e-mail confirmation.
3740 public function isEmailConfirmationPending() {
3741 global $wgEmailAuthentication;
3742 return $wgEmailAuthentication &&
3743 !$this->isEmailConfirmed() &&
3744 $this->mEmailToken
&&
3745 $this->mEmailTokenExpires
> wfTimestamp();
3749 * Get the timestamp of account creation.
3751 * @return String|Bool Timestamp of account creation, or false for
3752 * non-existent/anonymous user accounts.
3754 public function getRegistration() {
3755 if ( $this->isAnon() ) {
3759 return $this->mRegistration
;
3763 * Get the timestamp of the first edit
3765 * @return String|Bool Timestamp of first edit, or false for
3766 * non-existent/anonymous user accounts.
3768 public function getFirstEditTimestamp() {
3769 if( $this->getId() == 0 ) {
3770 return false; // anons
3772 $dbr = wfGetDB( DB_SLAVE
);
3773 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3774 array( 'rev_user' => $this->getId() ),
3776 array( 'ORDER BY' => 'rev_timestamp ASC' )
3779 return false; // no edits
3781 return wfTimestamp( TS_MW
, $time );
3785 * Get the permissions associated with a given list of groups
3787 * @param $groups Array of Strings List of internal group names
3788 * @return Array of Strings List of permission key names for given groups combined
3790 public static function getGroupPermissions( $groups ) {
3791 global $wgGroupPermissions, $wgRevokePermissions;
3793 // grant every granted permission first
3794 foreach( $groups as $group ) {
3795 if( isset( $wgGroupPermissions[$group] ) ) {
3796 $rights = array_merge( $rights,
3797 // array_filter removes empty items
3798 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3801 // now revoke the revoked permissions
3802 foreach( $groups as $group ) {
3803 if( isset( $wgRevokePermissions[$group] ) ) {
3804 $rights = array_diff( $rights,
3805 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3808 return array_unique( $rights );
3812 * Get all the groups who have a given permission
3814 * @param $role String Role to check
3815 * @return Array of Strings List of internal group names with the given permission
3817 public static function getGroupsWithPermission( $role ) {
3818 global $wgGroupPermissions;
3819 $allowedGroups = array();
3820 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
3821 if ( self
::groupHasPermission( $group, $role ) ) {
3822 $allowedGroups[] = $group;
3825 return $allowedGroups;
3829 * Check, if the given group has the given permission
3831 * @param $group String Group to check
3832 * @param $role String Role to check
3835 public static function groupHasPermission( $group, $role ) {
3836 global $wgGroupPermissions, $wgRevokePermissions;
3837 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
3838 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
3842 * Get the localized descriptive name for a group, if it exists
3844 * @param $group String Internal group name
3845 * @return String Localized descriptive group name
3847 public static function getGroupName( $group ) {
3848 $msg = wfMessage( "group-$group" );
3849 return $msg->isBlank() ?
$group : $msg->text();
3853 * Get the localized descriptive name for a member of a group, if it exists
3855 * @param $group String Internal group name
3856 * @param $username String Username for gender (since 1.19)
3857 * @return String Localized name for group member
3859 public static function getGroupMember( $group, $username = '#' ) {
3860 $msg = wfMessage( "group-$group-member", $username );
3861 return $msg->isBlank() ?
$group : $msg->text();
3865 * Return the set of defined explicit groups.
3866 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3867 * are not included, as they are defined automatically, not in the database.
3868 * @return Array of internal group names
3870 public static function getAllGroups() {
3871 global $wgGroupPermissions, $wgRevokePermissions;
3873 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3874 self
::getImplicitGroups()
3879 * Get a list of all available permissions.
3880 * @return Array of permission names
3882 public static function getAllRights() {
3883 if ( self
::$mAllRights === false ) {
3884 global $wgAvailableRights;
3885 if ( count( $wgAvailableRights ) ) {
3886 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3888 self
::$mAllRights = self
::$mCoreRights;
3890 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3892 return self
::$mAllRights;
3896 * Get a list of implicit groups
3897 * @return Array of Strings Array of internal group names
3899 public static function getImplicitGroups() {
3900 global $wgImplicitGroups;
3901 $groups = $wgImplicitGroups;
3902 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3907 * Get the title of a page describing a particular group
3909 * @param $group String Internal group name
3910 * @return Title|Bool Title of the page if it exists, false otherwise
3912 public static function getGroupPage( $group ) {
3913 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3914 if( $msg->exists() ) {
3915 $title = Title
::newFromText( $msg->text() );
3916 if( is_object( $title ) )
3923 * Create a link to the group in HTML, if available;
3924 * else return the group name.
3926 * @param $group String Internal name of the group
3927 * @param $text String The text of the link
3928 * @return String HTML link to the group
3930 public static function makeGroupLinkHTML( $group, $text = '' ) {
3932 $text = self
::getGroupName( $group );
3934 $title = self
::getGroupPage( $group );
3936 return Linker
::link( $title, htmlspecialchars( $text ) );
3943 * Create a link to the group in Wikitext, if available;
3944 * else return the group name.
3946 * @param $group String Internal name of the group
3947 * @param $text String The text of the link
3948 * @return String Wikilink to the group
3950 public static function makeGroupLinkWiki( $group, $text = '' ) {
3952 $text = self
::getGroupName( $group );
3954 $title = self
::getGroupPage( $group );
3956 $page = $title->getPrefixedText();
3957 return "[[$page|$text]]";
3964 * Returns an array of the groups that a particular group can add/remove.
3966 * @param $group String: the group to check for whether it can add/remove
3967 * @return Array array( 'add' => array( addablegroups ),
3968 * 'remove' => array( removablegroups ),
3969 * 'add-self' => array( addablegroups to self),
3970 * 'remove-self' => array( removable groups from self) )
3972 public static function changeableByGroup( $group ) {
3973 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3975 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3976 if( empty( $wgAddGroups[$group] ) ) {
3977 // Don't add anything to $groups
3978 } elseif( $wgAddGroups[$group] === true ) {
3979 // You get everything
3980 $groups['add'] = self
::getAllGroups();
3981 } elseif( is_array( $wgAddGroups[$group] ) ) {
3982 $groups['add'] = $wgAddGroups[$group];
3985 // Same thing for remove
3986 if( empty( $wgRemoveGroups[$group] ) ) {
3987 } elseif( $wgRemoveGroups[$group] === true ) {
3988 $groups['remove'] = self
::getAllGroups();
3989 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3990 $groups['remove'] = $wgRemoveGroups[$group];
3993 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3994 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3995 foreach( $wgGroupsAddToSelf as $key => $value ) {
3996 if( is_int( $key ) ) {
3997 $wgGroupsAddToSelf['user'][] = $value;
4002 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
4003 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
4004 if( is_int( $key ) ) {
4005 $wgGroupsRemoveFromSelf['user'][] = $value;
4010 // Now figure out what groups the user can add to him/herself
4011 if( empty( $wgGroupsAddToSelf[$group] ) ) {
4012 } elseif( $wgGroupsAddToSelf[$group] === true ) {
4013 // No idea WHY this would be used, but it's there
4014 $groups['add-self'] = User
::getAllGroups();
4015 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
4016 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4019 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4020 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
4021 $groups['remove-self'] = User
::getAllGroups();
4022 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4023 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4030 * Returns an array of groups that this user can add and remove
4031 * @return Array array( 'add' => array( addablegroups ),
4032 * 'remove' => array( removablegroups ),
4033 * 'add-self' => array( addablegroups to self),
4034 * 'remove-self' => array( removable groups from self) )
4036 public function changeableGroups() {
4037 if( $this->isAllowed( 'userrights' ) ) {
4038 // This group gives the right to modify everything (reverse-
4039 // compatibility with old "userrights lets you change
4041 // Using array_merge to make the groups reindexed
4042 $all = array_merge( User
::getAllGroups() );
4046 'add-self' => array(),
4047 'remove-self' => array()
4051 // Okay, it's not so simple, we will have to go through the arrays
4054 'remove' => array(),
4055 'add-self' => array(),
4056 'remove-self' => array()
4058 $addergroups = $this->getEffectiveGroups();
4060 foreach( $addergroups as $addergroup ) {
4061 $groups = array_merge_recursive(
4062 $groups, $this->changeableByGroup( $addergroup )
4064 $groups['add'] = array_unique( $groups['add'] );
4065 $groups['remove'] = array_unique( $groups['remove'] );
4066 $groups['add-self'] = array_unique( $groups['add-self'] );
4067 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4073 * Increment the user's edit-count field.
4074 * Will have no effect for anonymous users.
4076 public function incEditCount() {
4077 if( !$this->isAnon() ) {
4078 $dbw = wfGetDB( DB_MASTER
);
4081 array( 'user_editcount=user_editcount+1' ),
4082 array( 'user_id' => $this->getId() ),
4086 // Lazy initialization check...
4087 if( $dbw->affectedRows() == 0 ) {
4088 // Now here's a goddamn hack...
4089 $dbr = wfGetDB( DB_SLAVE
);
4090 if( $dbr !== $dbw ) {
4091 // If we actually have a slave server, the count is
4092 // at least one behind because the current transaction
4093 // has not been committed and replicated.
4094 $this->initEditCount( 1 );
4096 // But if DB_SLAVE is selecting the master, then the
4097 // count we just read includes the revision that was
4098 // just added in the working transaction.
4099 $this->initEditCount();
4103 // edit count in user cache too
4104 $this->invalidateCache();
4108 * Initialize user_editcount from data out of the revision table
4110 * @param $add Integer Edits to add to the count from the revision table
4111 * @return Integer Number of edits
4113 protected function initEditCount( $add = 0 ) {
4114 // Pull from a slave to be less cruel to servers
4115 // Accuracy isn't the point anyway here
4116 $dbr = wfGetDB( DB_SLAVE
);
4117 $count = (int) $dbr->selectField(
4120 array( 'rev_user' => $this->getId() ),
4123 $count = $count +
$add;
4125 $dbw = wfGetDB( DB_MASTER
);
4128 array( 'user_editcount' => $count ),
4129 array( 'user_id' => $this->getId() ),
4137 * Get the description of a given right
4139 * @param $right String Right to query
4140 * @return String Localized description of the right
4142 public static function getRightDescription( $right ) {
4143 $key = "right-$right";
4144 $msg = wfMessage( $key );
4145 return $msg->isBlank() ?
$right : $msg->text();
4149 * Make an old-style password hash
4151 * @param $password String Plain-text password
4152 * @param $userId String User ID
4153 * @return String Password hash
4155 public static function oldCrypt( $password, $userId ) {
4156 global $wgPasswordSalt;
4157 if ( $wgPasswordSalt ) {
4158 return md5( $userId . '-' . md5( $password ) );
4160 return md5( $password );
4165 * Make a new-style password hash
4167 * @param $password String Plain-text password
4168 * @param bool|string $salt Optional salt, may be random or the user ID.
4170 * If unspecified or false, will generate one automatically
4171 * @return String Password hash
4173 public static function crypt( $password, $salt = false ) {
4174 global $wgPasswordSalt;
4177 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
4181 if( $wgPasswordSalt ) {
4182 if ( $salt === false ) {
4183 $salt = MWCryptRand
::generateHex( 8 );
4185 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
4187 return ':A:' . md5( $password );
4192 * Compare a password hash with a plain-text password. Requires the user
4193 * ID if there's a chance that the hash is an old-style hash.
4195 * @param $hash String Password hash
4196 * @param $password String Plain-text password to compare
4197 * @param $userId String|bool User ID for old-style password salt
4201 public static function comparePasswords( $hash, $password, $userId = false ) {
4202 $type = substr( $hash, 0, 3 );
4205 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
4209 if ( $type == ':A:' ) {
4211 return md5( $password ) === substr( $hash, 3 );
4212 } elseif ( $type == ':B:' ) {
4214 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
4215 return md5( $salt.'-'.md5( $password ) ) === $realHash;
4218 return self
::oldCrypt( $password, $userId ) === $hash;
4223 * Add a newuser log entry for this user.
4224 * Before 1.19 the return value was always true.
4226 * @param $action string|bool: account creation type.
4227 * - String, one of the following values:
4228 * - 'create' for an anonymous user creating an account for himself.
4229 * This will force the action's performer to be the created user itself,
4230 * no matter the value of $wgUser
4231 * - 'create2' for a logged in user creating an account for someone else
4232 * - 'byemail' when the created user will receive its password by e-mail
4233 * - Boolean means whether the account was created by e-mail (deprecated):
4234 * - true will be converted to 'byemail'
4235 * - false will be converted to 'create' if this object is the same as
4236 * $wgUser and to 'create2' otherwise
4238 * @param $reason String: user supplied reason
4240 * @return int|bool True if not $wgNewUserLog; otherwise ID of log item or 0 on failure
4242 public function addNewUserLogEntry( $action = false, $reason = '' ) {
4243 global $wgUser, $wgNewUserLog;
4244 if( empty( $wgNewUserLog ) ) {
4245 return true; // disabled
4248 if ( $action === true ) {
4249 $action = 'byemail';
4250 } elseif ( $action === false ) {
4251 if ( $this->getName() == $wgUser->getName() ) {
4254 $action = 'create2';
4258 if ( $action === 'create' ||
$action === 'autocreate' ) {
4261 $performer = $wgUser;
4264 $logEntry = new ManualLogEntry( 'newusers', $action );
4265 $logEntry->setPerformer( $performer );
4266 $logEntry->setTarget( $this->getUserPage() );
4267 $logEntry->setComment( $reason );
4268 $logEntry->setParameters( array(
4269 '4::userid' => $this->getId(),
4271 $logid = $logEntry->insert();
4273 if ( $action !== 'autocreate' ) {
4274 $logEntry->publish( $logid );
4281 * Add an autocreate newuser log entry for this user
4282 * Used by things like CentralAuth and perhaps other authplugins.
4283 * Consider calling addNewUserLogEntry() directly instead.
4287 public function addNewUserLogEntryAutoCreate() {
4288 $this->addNewUserLogEntry( 'autocreate' );
4294 * Load the user options either from cache, the database or an array
4296 * @param $data Rows for the current user out of the user_properties table
4298 protected function loadOptions( $data = null ) {
4303 if ( $this->mOptionsLoaded
) {
4307 $this->mOptions
= self
::getDefaultOptions();
4309 if ( !$this->getId() ) {
4310 // For unlogged-in users, load language/variant options from request.
4311 // There's no need to do it for logged-in users: they can set preferences,
4312 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
4313 // so don't override user's choice (especially when the user chooses site default).
4314 $variant = $wgContLang->getDefaultVariant();
4315 $this->mOptions
['variant'] = $variant;
4316 $this->mOptions
['language'] = $variant;
4317 $this->mOptionsLoaded
= true;
4321 // Maybe load from the object
4322 if ( !is_null( $this->mOptionOverrides
) ) {
4323 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
4324 foreach( $this->mOptionOverrides
as $key => $value ) {
4325 $this->mOptions
[$key] = $value;
4328 if( !is_array( $data ) ) {
4329 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
4330 // Load from database
4331 $dbr = wfGetDB( DB_SLAVE
);
4333 $res = $dbr->select(
4335 array( 'up_property', 'up_value' ),
4336 array( 'up_user' => $this->getId() ),
4340 $this->mOptionOverrides
= array();
4342 foreach ( $res as $row ) {
4343 $data[$row->up_property
] = $row->up_value
;
4346 foreach ( $data as $property => $value ) {
4347 $this->mOptionOverrides
[$property] = $value;
4348 $this->mOptions
[$property] = $value;
4352 $this->mOptionsLoaded
= true;
4354 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
4360 protected function saveOptions() {
4361 global $wgAllowPrefChange;
4363 $this->loadOptions();
4365 // Not using getOptions(), to keep hidden preferences in database
4366 $saveOptions = $this->mOptions
;
4368 // Allow hooks to abort, for instance to save to a global profile.
4369 // Reset options to default state before saving.
4370 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) ) {
4374 $extuser = ExternalUser
::newFromUser( $this );
4375 $userId = $this->getId();
4376 $insert_rows = array();
4377 foreach( $saveOptions as $key => $value ) {
4378 # Don't bother storing default values
4379 $defaultOption = self
::getDefaultOption( $key );
4380 if ( ( is_null( $defaultOption ) &&
4381 !( $value === false ||
is_null( $value ) ) ) ||
4382 $value != $defaultOption ) {
4383 $insert_rows[] = array(
4384 'up_user' => $userId,
4385 'up_property' => $key,
4386 'up_value' => $value,
4389 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
4390 switch ( $wgAllowPrefChange[$key] ) {
4396 $extuser->setPref( $key, $value );
4401 $dbw = wfGetDB( DB_MASTER
);
4402 $dbw->delete( 'user_properties', array( 'up_user' => $userId ), __METHOD__
);
4403 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
4407 * Provide an array of HTML5 attributes to put on an input element
4408 * intended for the user to enter a new password. This may include
4409 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
4411 * Do *not* use this when asking the user to enter his current password!
4412 * Regardless of configuration, users may have invalid passwords for whatever
4413 * reason (e.g., they were set before requirements were tightened up).
4414 * Only use it when asking for a new password, like on account creation or
4417 * Obviously, you still need to do server-side checking.
4419 * NOTE: A combination of bugs in various browsers means that this function
4420 * actually just returns array() unconditionally at the moment. May as
4421 * well keep it around for when the browser bugs get fixed, though.
4423 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
4425 * @return array Array of HTML attributes suitable for feeding to
4426 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
4427 * That will potentially output invalid XHTML 1.0 Transitional, and will
4428 * get confused by the boolean attribute syntax used.)
4430 public static function passwordChangeInputAttribs() {
4431 global $wgMinimalPasswordLength;
4433 if ( $wgMinimalPasswordLength == 0 ) {
4437 # Note that the pattern requirement will always be satisfied if the
4438 # input is empty, so we need required in all cases.
4440 # @todo FIXME: Bug 23769: This needs to not claim the password is required
4441 # if e-mail confirmation is being used. Since HTML5 input validation
4442 # is b0rked anyway in some browsers, just return nothing. When it's
4443 # re-enabled, fix this code to not output required for e-mail
4445 #$ret = array( 'required' );
4448 # We can't actually do this right now, because Opera 9.6 will print out
4449 # the entered password visibly in its error message! When other
4450 # browsers add support for this attribute, or Opera fixes its support,
4451 # we can add support with a version check to avoid doing this on Opera
4452 # versions where it will be a problem. Reported to Opera as
4453 # DSK-262266, but they don't have a public bug tracker for us to follow.
4455 if ( $wgMinimalPasswordLength > 1 ) {
4456 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
4457 $ret['title'] = wfMessage( 'passwordtooshort' )
4458 ->numParams( $wgMinimalPasswordLength )->text();
4466 * Return the list of user fields that should be selected to create
4467 * a new user object.
4470 public static function selectFields() {
4477 'user_newpass_time',
4481 'user_email_authenticated',
4483 'user_email_token_expires',
4484 'user_registration',