3 * Implements the User class for the %MediaWiki software.
8 * Int Number of characters in user_token field.
11 define( 'USER_TOKEN_LENGTH', 32 );
14 * Int Serialized record version.
17 define( 'MW_USER_VERSION', 8 );
20 * String Some punctuation to prevent editing from broken text-mangling proxies.
23 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
26 * Thrown by User::setPassword() on error.
29 class PasswordError
extends MWException
{
34 * The User object encapsulates all of the user-specific settings (user_id,
35 * name, rights, password, email address, options, last login time). Client
36 * classes use the getXXX() functions to access these fields. These functions
37 * do all the work of determining whether the user is logged in,
38 * whether the requested option can be satisfied from cookies or
39 * whether a database query is needed. Most of the settings needed
40 * for rendering normal pages are set in the cookie to minimize use
45 * Global constants made accessible as class constants so that autoloader
48 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
49 const MW_USER_VERSION
= MW_USER_VERSION
;
50 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
53 * Array of Strings List of member variables which are saved to the
54 * shared cache (memcached). Any operation which changes the
55 * corresponding database fields must call a cache-clearing function.
58 static $mCacheVars = array(
69 'mEmailAuthenticated',
76 // user_properties table
81 * Array of Strings Core rights.
82 * Each of these should have a corresponding message of the form
86 static $mCoreRights = array(
105 'editusercssjs', #deprecated
117 'move-rootuserpages',
121 'override-export-depth',
143 'userrights-interwiki',
147 * String Cached results of getAllRights()
149 static $mAllRights = false;
151 /** @name Cache variables */
153 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
154 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
155 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
159 * Bool Whether the cache variables have been loaded.
163 private $mLoadedItems = array();
167 * String Initialization data source if mLoadedItems!==true. May be one of:
168 * - 'defaults' anonymous user initialised from class defaults
169 * - 'name' initialise from mName
170 * - 'id' initialise from mId
171 * - 'session' log in from cookies or session if possible
173 * Use the User::newFrom*() family of functions to set this.
178 * Lazy-initialized variables, invalidated with clearInstanceCache
180 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
181 $mBlockreason, $mEffectiveGroups, $mBlockedGlobally,
182 $mLocked, $mHideName, $mOptions;
194 static $idCacheByName = array();
197 * Lightweight constructor for an anonymous user.
198 * Use the User::newFrom* factory functions for other kinds of users.
202 * @see newFromConfirmationCode()
203 * @see newFromSession()
206 function __construct() {
207 $this->clearInstanceCache( 'defaults' );
210 function __toString(){
211 return $this->getName();
215 * Load the user table data for this object from the source given by mFrom.
218 if ( $this->mLoadedItems
=== true ) {
221 wfProfileIn( __METHOD__
);
223 # Set it now to avoid infinite recursion in accessors
224 $this->mLoadedItems
= true;
226 switch ( $this->mFrom
) {
228 $this->loadDefaults();
231 $this->mId
= self
::idFromName( $this->mName
);
233 # Nonexistent user placeholder object
234 $this->loadDefaults( $this->mName
);
243 $this->loadFromSession();
244 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
247 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
249 wfProfileOut( __METHOD__
);
253 * Load user table data, given mId has already been set.
254 * @return Bool false if the ID does not exist, true otherwise
257 function loadFromId() {
259 if ( $this->mId
== 0 ) {
260 $this->loadDefaults();
265 $key = wfMemcKey( 'user', 'id', $this->mId
);
266 $data = $wgMemc->get( $key );
267 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
268 # Object is expired, load from DB
273 wfDebug( "User: cache miss for user {$this->mId}\n" );
275 if ( !$this->loadFromDatabase() ) {
276 # Can't load from ID, user is anonymous
279 $this->saveToCache();
281 wfDebug( "User: got user {$this->mId} from cache\n" );
283 foreach ( self
::$mCacheVars as $name ) {
284 $this->$name = $data[$name];
291 * Save user data to the shared cache
293 function saveToCache() {
296 $this->loadOptions();
297 if ( $this->isAnon() ) {
298 // Anonymous users are uncached
302 foreach ( self
::$mCacheVars as $name ) {
303 $data[$name] = $this->$name;
305 $data['mVersion'] = MW_USER_VERSION
;
306 $key = wfMemcKey( 'user', 'id', $this->mId
);
308 $wgMemc->set( $key, $data );
312 /** @name newFrom*() static factory methods */
316 * Static factory method for creation from username.
318 * This is slightly less efficient than newFromId(), so use newFromId() if
319 * you have both an ID and a name handy.
321 * @param $name String Username, validated by Title::newFromText()
322 * @param $validate String|Bool Validate username. Takes the same parameters as
323 * User::getCanonicalName(), except that true is accepted as an alias
324 * for 'valid', for BC.
326 * @return User object, or false if the username is invalid
327 * (e.g. if it contains illegal characters or is an IP address). If the
328 * username is not present in the database, the result will be a user object
329 * with a name, zero user ID and default settings.
331 static function newFromName( $name, $validate = 'valid' ) {
332 if ( $validate === true ) {
335 $name = self
::getCanonicalName( $name, $validate );
336 if ( $name === false ) {
339 # Create unloaded user object
343 $u->setItemLoaded( 'name' );
349 * Static factory method for creation from a given user ID.
351 * @param $id Int Valid user ID
352 * @return User The corresponding User object
354 static function newFromId( $id ) {
358 $u->setItemLoaded( 'id' );
363 * Factory method to fetch whichever user has a given email confirmation code.
364 * This code is generated when an account is created or its e-mail address
367 * If the code is invalid or has expired, returns NULL.
369 * @param $code String Confirmation code
372 static function newFromConfirmationCode( $code ) {
373 $dbr = wfGetDB( DB_SLAVE
);
374 $id = $dbr->selectField( 'user', 'user_id', array(
375 'user_email_token' => md5( $code ),
376 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
378 if( $id !== false ) {
379 return User
::newFromId( $id );
386 * Create a new user object using data from session or cookies. If the
387 * login credentials are invalid, the result is an anonymous user.
391 static function newFromSession() {
393 $user->mFrom
= 'session';
398 * Create a new user object from a user row.
399 * The row should have the following fields from the user table in it:
400 * - either user_name or user_id to load further data if needed (or both)
402 * - all other fields (email, password, etc.)
403 * It is useless to provide the remaining fields if either user_id,
404 * user_name and user_real_name are not provided because the whole row
405 * will be loaded once more from the database when accessing them.
407 * @param $row Array A row from the user table
410 static function newFromRow( $row ) {
412 $user->loadFromRow( $row );
420 * Get the username corresponding to a given user ID
421 * @param $id Int User ID
422 * @return String The corresponding username
424 static function whoIs( $id ) {
425 $dbr = wfGetDB( DB_SLAVE
);
426 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
430 * Get the real name of a user given their user ID
432 * @param $id Int User ID
433 * @return String The corresponding user's real name
435 static function whoIsReal( $id ) {
436 $dbr = wfGetDB( DB_SLAVE
);
437 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
441 * Get database id given a user name
442 * @param $name String Username
443 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
445 static function idFromName( $name ) {
446 $nt = Title
::makeTitleSafe( NS_USER
, $name );
447 if( is_null( $nt ) ) {
452 if ( isset( self
::$idCacheByName[$name] ) ) {
453 return self
::$idCacheByName[$name];
456 $dbr = wfGetDB( DB_SLAVE
);
457 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
459 if ( $s === false ) {
462 $result = $s->user_id
;
465 self
::$idCacheByName[$name] = $result;
467 if ( count( self
::$idCacheByName ) > 1000 ) {
468 self
::$idCacheByName = array();
475 * Reset the cache used in idFromName(). For use in tests.
477 public static function resetIdByNameCache() {
478 self
::$idCacheByName = array();
482 * Does the string match an anonymous IPv4 address?
484 * This function exists for username validation, in order to reject
485 * usernames which are similar in form to IP addresses. Strings such
486 * as 300.300.300.300 will return true because it looks like an IP
487 * address, despite not being strictly valid.
489 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
490 * address because the usemod software would "cloak" anonymous IP
491 * addresses like this, if we allowed accounts like this to be created
492 * new users could get the old edits of these anonymous users.
494 * @param $name String to match
497 static function isIP( $name ) {
498 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
502 * Is the input a valid username?
504 * Checks if the input is a valid username, we don't want an empty string,
505 * an IP address, anything that containins slashes (would mess up subpages),
506 * is longer than the maximum allowed username size or doesn't begin with
509 * @param $name String to match
512 static function isValidUserName( $name ) {
513 global $wgContLang, $wgMaxNameChars;
516 || User
::isIP( $name )
517 ||
strpos( $name, '/' ) !== false
518 ||
strlen( $name ) > $wgMaxNameChars
519 ||
$name != $wgContLang->ucfirst( $name ) ) {
520 wfDebugLog( 'username', __METHOD__
.
521 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
525 // Ensure that the name can't be misresolved as a different title,
526 // such as with extra namespace keys at the start.
527 $parsed = Title
::newFromText( $name );
528 if( is_null( $parsed )
529 ||
$parsed->getNamespace()
530 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
531 wfDebugLog( 'username', __METHOD__
.
532 ": '$name' invalid due to ambiguous prefixes" );
536 // Check an additional blacklist of troublemaker characters.
537 // Should these be merged into the title char list?
538 $unicodeBlacklist = '/[' .
539 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
540 '\x{00a0}' . # non-breaking space
541 '\x{2000}-\x{200f}' . # various whitespace
542 '\x{2028}-\x{202f}' . # breaks and control chars
543 '\x{3000}' . # ideographic space
544 '\x{e000}-\x{f8ff}' . # private use
546 if( preg_match( $unicodeBlacklist, $name ) ) {
547 wfDebugLog( 'username', __METHOD__
.
548 ": '$name' invalid due to blacklisted characters" );
556 * Usernames which fail to pass this function will be blocked
557 * from user login and new account registrations, but may be used
558 * internally by batch processes.
560 * If an account already exists in this form, login will be blocked
561 * by a failure to pass this function.
563 * @param $name String to match
566 static function isUsableName( $name ) {
567 global $wgReservedUsernames;
568 // Must be a valid username, obviously ;)
569 if ( !self
::isValidUserName( $name ) ) {
573 static $reservedUsernames = false;
574 if ( !$reservedUsernames ) {
575 $reservedUsernames = $wgReservedUsernames;
576 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
579 // Certain names may be reserved for batch processes.
580 foreach ( $reservedUsernames as $reserved ) {
581 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
582 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
584 if ( $reserved == $name ) {
592 * Usernames which fail to pass this function will be blocked
593 * from new account registrations, but may be used internally
594 * either by batch processes or by user accounts which have
595 * already been created.
597 * Additional blacklisting may be added here rather than in
598 * isValidUserName() to avoid disrupting existing accounts.
600 * @param $name String to match
603 static function isCreatableName( $name ) {
604 global $wgInvalidUsernameCharacters;
606 // Ensure that the username isn't longer than 235 bytes, so that
607 // (at least for the builtin skins) user javascript and css files
608 // will work. (bug 23080)
609 if( strlen( $name ) > 235 ) {
610 wfDebugLog( 'username', __METHOD__
.
611 ": '$name' invalid due to length" );
615 // Preg yells if you try to give it an empty string
616 if( $wgInvalidUsernameCharacters !== '' ) {
617 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
618 wfDebugLog( 'username', __METHOD__
.
619 ": '$name' invalid due to wgInvalidUsernameCharacters" );
624 return self
::isUsableName( $name );
628 * Is the input a valid password for this user?
630 * @param $password String Desired password
633 function isValidPassword( $password ) {
634 //simple boolean wrapper for getPasswordValidity
635 return $this->getPasswordValidity( $password ) === true;
639 * Given unvalidated password input, return error message on failure.
641 * @param $password String Desired password
642 * @return mixed: true on success, string or array of error message on failure
644 function getPasswordValidity( $password ) {
645 global $wgMinimalPasswordLength, $wgContLang;
647 static $blockedLogins = array(
648 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
649 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
652 $result = false; //init $result to false for the internal checks
654 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
657 if ( $result === false ) {
658 if( strlen( $password ) < $wgMinimalPasswordLength ) {
659 return 'passwordtooshort';
660 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
661 return 'password-name-match';
662 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
663 return 'password-login-forbidden';
665 //it seems weird returning true here, but this is because of the
666 //initialization of $result to false above. If the hook is never run or it
667 //doesn't modify $result, then we will likely get down into this if with
671 } elseif( $result === true ) {
674 return $result; //the isValidPassword hook set a string $result and returned true
679 * Does a string look like an e-mail address?
681 * This validates an email address using an HTML5 specification found at:
682 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
683 * Which as of 2011-01-24 says:
685 * A valid e-mail address is a string that matches the ABNF production
686 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
687 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
690 * This function is an implementation of the specification as requested in
693 * Client-side forms will use the same standard validation rules via JS or
694 * HTML 5 validation; additional restrictions can be enforced server-side
695 * by extensions via the 'isValidEmailAddr' hook.
697 * Note that this validation doesn't 100% match RFC 2822, but is believed
698 * to be liberal enough for wide use. Some invalid addresses will still
699 * pass validation here.
701 * @param $addr String E-mail address
703 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
705 public static function isValidEmailAddr( $addr ) {
706 return Sanitizer
::validateEmail( $addr );
710 * Given unvalidated user input, return a canonical username, or false if
711 * the username is invalid.
712 * @param $name String User input
713 * @param $validate String|Bool type of validation to use:
714 * - false No validation
715 * - 'valid' Valid for batch processes
716 * - 'usable' Valid for batch processes and login
717 * - 'creatable' Valid for batch processes, login and account creation
719 static function getCanonicalName( $name, $validate = 'valid' ) {
720 # Force usernames to capital
722 $name = $wgContLang->ucfirst( $name );
724 # Reject names containing '#'; these will be cleaned up
725 # with title normalisation, but then it's too late to
727 if( strpos( $name, '#' ) !== false )
730 # Clean up name according to title rules
731 $t = ( $validate === 'valid' ) ?
732 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
733 # Check for invalid titles
734 if( is_null( $t ) ) {
738 # Reject various classes of invalid names
740 $name = $wgAuth->getCanonicalName( $t->getText() );
742 switch ( $validate ) {
746 if ( !User
::isValidUserName( $name ) ) {
751 if ( !User
::isUsableName( $name ) ) {
756 if ( !User
::isCreatableName( $name ) ) {
761 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
767 * Count the number of edits of a user
768 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
770 * @param $uid Int User ID to check
771 * @return Int the user's edit count
773 static function edits( $uid ) {
774 wfProfileIn( __METHOD__
);
775 $dbr = wfGetDB( DB_SLAVE
);
776 // check if the user_editcount field has been initialized
777 $field = $dbr->selectField(
778 'user', 'user_editcount',
779 array( 'user_id' => $uid ),
783 if( $field === null ) { // it has not been initialized. do so.
784 $dbw = wfGetDB( DB_MASTER
);
785 $count = $dbr->selectField(
786 'revision', 'count(*)',
787 array( 'rev_user' => $uid ),
792 array( 'user_editcount' => $count ),
793 array( 'user_id' => $uid ),
799 wfProfileOut( __METHOD__
);
804 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
805 * @todo hash random numbers to improve security, like generateToken()
807 * @return String new random password
809 static function randomPassword() {
810 global $wgMinimalPasswordLength;
811 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
812 $l = strlen( $pwchars ) - 1;
814 $pwlength = max( 7, $wgMinimalPasswordLength );
815 $digit = mt_rand( 0, $pwlength - 1 );
817 for ( $i = 0; $i < $pwlength; $i++
) {
818 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars[ mt_rand( 0, $l ) ];
824 * Set cached properties to default.
826 * @note This no longer clears uncached lazy-initialised properties;
827 * the constructor does that instead.
830 function loadDefaults( $name = false ) {
831 wfProfileIn( __METHOD__
);
836 $this->mName
= $name;
837 $this->mRealName
= '';
838 $this->mPassword
= $this->mNewpassword
= '';
839 $this->mNewpassTime
= null;
841 $this->mOptionOverrides
= null;
842 $this->mOptionsLoaded
= false;
844 if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) {
845 $this->mTouched
= wfTimestamp( TS_MW
, $wgRequest->getCookie( 'LoggedOut' ) );
847 $this->mTouched
= '0'; # Allow any pages to be cached
850 $this->setToken(); # Random
851 $this->mEmailAuthenticated
= null;
852 $this->mEmailToken
= '';
853 $this->mEmailTokenExpires
= null;
854 $this->mRegistration
= wfTimestamp( TS_MW
);
855 $this->mGroups
= array();
857 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
859 wfProfileOut( __METHOD__
);
863 * Return whether an item has been loaded.
865 * @param $item String: item to check. Current possibilities:
869 * @param $all String: 'all' to check if the whole object has been loaded
870 * or any other string to check if only the item is available (e.g.
874 public function isItemLoaded( $item, $all = 'all' ) {
875 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
876 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
880 * Set that an item has been loaded
882 * @param $item String
884 private function setItemLoaded( $item ) {
885 if ( is_array( $this->mLoadedItems
) ) {
886 $this->mLoadedItems
[$item] = true;
891 * Load user data from the session or login cookie. If there are no valid
892 * credentials, initialises the user as an anonymous user.
893 * @return Bool True if the user is logged in, false otherwise.
895 private function loadFromSession() {
896 global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy;
899 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
900 if ( $result !== null ) {
904 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
905 $extUser = ExternalUser
::newFromCookie();
907 # TODO: Automatically create the user here (or probably a bit
908 # lower down, in fact)
912 $cookieId = $wgRequest->getCookie( 'UserID' );
913 $sessId = $wgRequest->getSessionData( 'wsUserID' );
915 if ( $cookieId !== null ) {
916 $sId = intval( $cookieId );
917 if( $sessId !== null && $cookieId != $sessId ) {
918 $this->loadDefaults(); // Possible collision!
919 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
920 cookie user ID ($sId) don't match!" );
923 $wgRequest->setSessionData( 'wsUserID', $sId );
924 } else if ( $sessId !== null && $sessId != 0 ) {
927 $this->loadDefaults();
931 if ( $wgRequest->getSessionData( 'wsUserName' ) !== null ) {
932 $sName = $wgRequest->getSessionData( 'wsUserName' );
933 } else if ( $wgRequest->getCookie( 'UserName' ) !== null ) {
934 $sName = $wgRequest->getCookie( 'UserName' );
935 $wgRequest->setSessionData( 'wsUserName', $sName );
937 $this->loadDefaults();
941 $proposedUser = User
::newFromId( $sId );
942 if ( !$proposedUser->isLoggedIn() ) {
944 $this->loadDefaults();
948 global $wgBlockDisablesLogin;
949 if( $wgBlockDisablesLogin && $proposedUser->isBlocked() ) {
950 # User blocked and we've disabled blocked user logins
951 $this->loadDefaults();
955 if ( $wgRequest->getSessionData( 'wsToken' ) !== null ) {
956 $passwordCorrect = $proposedUser->getToken() === $wgRequest->getSessionData( 'wsToken' );
958 } else if ( $wgRequest->getCookie( 'Token' ) !== null ) {
959 $passwordCorrect = $proposedUser->getToken() === $wgRequest->getCookie( 'Token' );
962 # No session or persistent login cookie
963 $this->loadDefaults();
967 if ( ( $sName === $proposedUser->getName() ) && $passwordCorrect ) {
968 $this->loadFromUserObject( $proposedUser );
969 $wgRequest->setSessionData( 'wsToken', $this->mToken
);
970 wfDebug( "User: logged in from $from\n" );
973 # Invalid credentials
974 wfDebug( "User: can't log in from $from, invalid credentials\n" );
975 $this->loadDefaults();
981 * Load user and user_group data from the database.
982 * $this->mId must be set, this is how the user is identified.
984 * @return Bool True if the user exists, false if the user is anonymous
987 function loadFromDatabase() {
989 $this->mId
= intval( $this->mId
);
991 /** Anonymous user */
993 $this->loadDefaults();
997 $dbr = wfGetDB( DB_MASTER
);
998 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
1000 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
1002 if ( $s !== false ) {
1003 # Initialise user table data
1004 $this->loadFromRow( $s );
1005 $this->mGroups
= null; // deferred
1006 $this->getEditCount(); // revalidation for nulls
1011 $this->loadDefaults();
1017 * Initialize this object from a row from the user table.
1019 * @param $row Array Row from the user table to load.
1021 function loadFromRow( $row ) {
1024 if ( isset( $row->user_name
) ) {
1025 $this->mName
= $row->user_name
;
1026 $this->mFrom
= 'name';
1027 $this->setItemLoaded( 'name' );
1032 if ( isset( $row->user_name
) ) {
1033 $this->mRealName
= $row->user_real_name
;
1034 $this->setItemLoaded( 'realname' );
1039 if ( isset( $row->user_id
) ) {
1040 $this->mId
= intval( $row->user_id
);
1041 $this->mFrom
= 'id';
1042 $this->setItemLoaded( 'id' );
1047 if ( isset( $row->user_password
) ) {
1048 $this->mPassword
= $row->user_password
;
1049 $this->mNewpassword
= $row->user_newpassword
;
1050 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1051 $this->mEmail
= $row->user_email
;
1052 $this->decodeOptions( $row->user_options
);
1053 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
1054 $this->mToken
= $row->user_token
;
1055 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1056 $this->mEmailToken
= $row->user_email_token
;
1057 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1058 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1059 $this->mEditCount
= $row->user_editcount
;
1065 $this->mLoadedItems
= true;
1070 * Load the data for this user object from another user object.
1074 protected function loadFromUserObject( $user ) {
1076 $user->loadGroups();
1077 $user->loadOptions();
1078 foreach ( self
::$mCacheVars as $var ) {
1079 $this->$var = $user->$var;
1084 * Load the groups from the database if they aren't already loaded.
1087 function loadGroups() {
1088 if ( is_null( $this->mGroups
) ) {
1089 $dbr = wfGetDB( DB_MASTER
);
1090 $res = $dbr->select( 'user_groups',
1091 array( 'ug_group' ),
1092 array( 'ug_user' => $this->mId
),
1094 $this->mGroups
= array();
1095 foreach ( $res as $row ) {
1096 $this->mGroups
[] = $row->ug_group
;
1102 * Clear various cached data stored in this object.
1103 * @param $reloadFrom String Reload user and user_groups table data from a
1104 * given source. May be "name", "id", "defaults", "session", or false for
1107 function clearInstanceCache( $reloadFrom = false ) {
1108 $this->mNewtalk
= -1;
1109 $this->mDatePreference
= null;
1110 $this->mBlockedby
= -1; # Unset
1111 $this->mHash
= false;
1112 $this->mSkin
= null;
1113 $this->mRights
= null;
1114 $this->mEffectiveGroups
= null;
1115 $this->mOptions
= null;
1117 if ( $reloadFrom ) {
1118 $this->mLoadedItems
= array();
1119 $this->mFrom
= $reloadFrom;
1124 * Combine the language default options with any site-specific options
1125 * and add the default language variants.
1127 * @return Array of String options
1129 static function getDefaultOptions() {
1130 global $wgNamespacesToBeSearchedDefault;
1132 * Site defaults will override the global/language defaults
1134 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1135 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1138 * default language setting
1140 $variant = $wgContLang->getDefaultVariant();
1141 $defOpt['variant'] = $variant;
1142 $defOpt['language'] = $variant;
1143 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1144 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1146 $defOpt['skin'] = $wgDefaultSkin;
1152 * Get a given default option value.
1154 * @param $opt String Name of option to retrieve
1155 * @return String Default option value
1157 public static function getDefaultOption( $opt ) {
1158 $defOpts = self
::getDefaultOptions();
1159 if( isset( $defOpts[$opt] ) ) {
1160 return $defOpts[$opt];
1168 * Get blocking information
1170 * @param $bFromSlave Bool Whether to check the slave database first. To
1171 * improve performance, non-critical checks are done
1172 * against slaves. Check when actually saving should be
1173 * done against master.
1175 function getBlockedStatus( $bFromSlave = true ) {
1176 global $wgProxyWhitelist, $wgUser;
1178 if ( -1 != $this->mBlockedby
) {
1182 wfProfileIn( __METHOD__
);
1183 wfDebug( __METHOD__
.": checking...\n" );
1185 // Initialize data...
1186 // Otherwise something ends up stomping on $this->mBlockedby when
1187 // things get lazy-loaded later, causing false positive block hits
1188 // due to -1 !== 0. Probably session-related... Nothing should be
1189 // overwriting mBlockedby, surely?
1192 $this->mBlockedby
= 0;
1193 $this->mHideName
= 0;
1194 $this->mAllowUsertalk
= 0;
1196 # We only need to worry about passing the IP address to the Block generator if the
1197 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1198 # know which IP address they're actually coming from
1199 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1206 $this->mBlock
= Block
::newFromTarget( $this->getName(), $ip, !$bFromSlave );
1207 if ( $this->mBlock
instanceof Block
) {
1208 wfDebug( __METHOD__
. ": Found block.\n" );
1209 $this->mBlockedby
= $this->mBlock
->getBlocker()->getName();
1210 $this->mBlockreason
= $this->mBlock
->mReason
;
1211 $this->mHideName
= $this->mBlock
->mHideName
;
1212 $this->mAllowUsertalk
= !$this->mBlock
->prevents( 'editownusertalk' );
1213 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1214 $this->spreadBlock();
1219 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1221 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1222 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1223 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1227 if ( !$this->mBlockedby
&& !$this->getID() ) {
1228 if ( $this->isDnsBlacklisted( $ip ) ) {
1229 $this->mBlockedby
= wfMsg( 'sorbs' );
1230 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1236 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1238 wfProfileOut( __METHOD__
);
1242 * Whether the given IP is in a DNS blacklist.
1244 * @param $ip String IP to check
1245 * @param $checkWhitelist Bool: whether to check the whitelist first
1246 * @return Bool True if blacklisted.
1248 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1249 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1250 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1252 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1255 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1258 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1259 return $this->inDnsBlacklist( $ip, $urls );
1263 * Whether the given IP is in a given DNS blacklist.
1265 * @param $ip String IP to check
1266 * @param $bases String|Array of Strings: URL of the DNS blacklist
1267 * @return Bool True if blacklisted.
1269 function inDnsBlacklist( $ip, $bases ) {
1270 wfProfileIn( __METHOD__
);
1273 // @todo FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1274 if( IP
::isIPv4( $ip ) ) {
1275 # Reverse IP, bug 21255
1276 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1278 foreach( (array)$bases as $base ) {
1280 $host = "$ipReversed.$base";
1283 $ipList = gethostbynamel( $host );
1286 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1290 wfDebug( "Requested $host, not found in $base.\n" );
1295 wfProfileOut( __METHOD__
);
1300 * Is this user subject to rate limiting?
1302 * @return Bool True if rate limited
1304 public function isPingLimitable() {
1305 global $wgRateLimitsExcludedIPs;
1306 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1307 // No other good way currently to disable rate limits
1308 // for specific IPs. :P
1309 // But this is a crappy hack and should die.
1312 return !$this->isAllowed('noratelimit');
1316 * Primitive rate limits: enforce maximum actions per time period
1317 * to put a brake on flooding.
1319 * @note When using a shared cache like memcached, IP-address
1320 * last-hit counters will be shared across wikis.
1322 * @param $action String Action to enforce; 'edit' if unspecified
1323 * @return Bool True if a rate limiter was tripped
1325 function pingLimiter( $action = 'edit' ) {
1326 # Call the 'PingLimiter' hook
1328 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1332 global $wgRateLimits;
1333 if( !isset( $wgRateLimits[$action] ) ) {
1337 # Some groups shouldn't trigger the ping limiter, ever
1338 if( !$this->isPingLimitable() )
1341 global $wgMemc, $wgRateLimitLog;
1342 wfProfileIn( __METHOD__
);
1344 $limits = $wgRateLimits[$action];
1346 $id = $this->getId();
1350 if( isset( $limits['anon'] ) && $id == 0 ) {
1351 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1354 if( isset( $limits['user'] ) && $id != 0 ) {
1355 $userLimit = $limits['user'];
1357 if( $this->isNewbie() ) {
1358 if( isset( $limits['newbie'] ) && $id != 0 ) {
1359 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1361 if( isset( $limits['ip'] ) ) {
1362 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1365 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1366 $subnet = $matches[1];
1367 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1370 // Check for group-specific permissions
1371 // If more than one group applies, use the group with the highest limit
1372 foreach ( $this->getGroups() as $group ) {
1373 if ( isset( $limits[$group] ) ) {
1374 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1375 $userLimit = $limits[$group];
1379 // Set the user limit key
1380 if ( $userLimit !== false ) {
1381 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1382 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1386 foreach( $keys as $key => $limit ) {
1387 list( $max, $period ) = $limit;
1388 $summary = "(limit $max in {$period}s)";
1389 $count = $wgMemc->get( $key );
1392 if( $count > $max ) {
1393 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1394 if( $wgRateLimitLog ) {
1395 @file_put_contents
( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1399 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1402 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1403 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1405 $wgMemc->incr( $key );
1408 wfProfileOut( __METHOD__
);
1413 * Check if user is blocked
1415 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1416 * @return Bool True if blocked, false otherwise
1418 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1419 $this->getBlockedStatus( $bFromSlave );
1420 return $this->mBlock
instanceof Block
&& $this->mBlock
->prevents( 'edit' );
1424 * Check if user is blocked from editing a particular article
1426 * @param $title Title to check
1427 * @param $bFromSlave Bool whether to check the slave database instead of the master
1430 function isBlockedFrom( $title, $bFromSlave = false ) {
1431 global $wgBlockAllowsUTEdit;
1432 wfProfileIn( __METHOD__
);
1434 $blocked = $this->isBlocked( $bFromSlave );
1435 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1436 # If a user's name is suppressed, they cannot make edits anywhere
1437 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1438 $title->getNamespace() == NS_USER_TALK
) {
1440 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1443 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1445 wfProfileOut( __METHOD__
);
1450 * If user is blocked, return the name of the user who placed the block
1451 * @return String name of blocker
1453 function blockedBy() {
1454 $this->getBlockedStatus();
1455 return $this->mBlockedby
;
1459 * If user is blocked, return the specified reason for the block
1460 * @return String Blocking reason
1462 function blockedFor() {
1463 $this->getBlockedStatus();
1464 return $this->mBlockreason
;
1468 * If user is blocked, return the ID for the block
1469 * @return Int Block ID
1471 function getBlockId() {
1472 $this->getBlockedStatus();
1473 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1477 * Check if user is blocked on all wikis.
1478 * Do not use for actual edit permission checks!
1479 * This is intented for quick UI checks.
1481 * @param $ip String IP address, uses current client if none given
1482 * @return Bool True if blocked, false otherwise
1484 function isBlockedGlobally( $ip = '' ) {
1485 if( $this->mBlockedGlobally
!== null ) {
1486 return $this->mBlockedGlobally
;
1488 // User is already an IP?
1489 if( IP
::isIPAddress( $this->getName() ) ) {
1490 $ip = $this->getName();
1495 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1496 $this->mBlockedGlobally
= (bool)$blocked;
1497 return $this->mBlockedGlobally
;
1501 * Check if user account is locked
1503 * @return Bool True if locked, false otherwise
1505 function isLocked() {
1506 if( $this->mLocked
!== null ) {
1507 return $this->mLocked
;
1510 $authUser = $wgAuth->getUserInstance( $this );
1511 $this->mLocked
= (bool)$authUser->isLocked();
1512 return $this->mLocked
;
1516 * Check if user account is hidden
1518 * @return Bool True if hidden, false otherwise
1520 function isHidden() {
1521 if( $this->mHideName
!== null ) {
1522 return $this->mHideName
;
1524 $this->getBlockedStatus();
1525 if( !$this->mHideName
) {
1527 $authUser = $wgAuth->getUserInstance( $this );
1528 $this->mHideName
= (bool)$authUser->isHidden();
1530 return $this->mHideName
;
1534 * Get the user's ID.
1535 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1538 if( $this->mId
=== null && $this->mName
!== null
1539 && User
::isIP( $this->mName
) ) {
1540 // Special case, we know the user is anonymous
1542 } elseif( !$this->isItemLoaded( 'id' ) ) {
1543 // Don't load if this was initialized from an ID
1550 * Set the user and reload all fields according to a given ID
1551 * @param $v Int User ID to reload
1553 function setId( $v ) {
1555 $this->clearInstanceCache( 'id' );
1559 * Get the user name, or the IP of an anonymous user
1560 * @return String User's name or IP address
1562 function getName() {
1563 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1564 # Special case optimisation
1565 return $this->mName
;
1568 if ( $this->mName
=== false ) {
1570 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1572 return $this->mName
;
1577 * Set the user name.
1579 * This does not reload fields from the database according to the given
1580 * name. Rather, it is used to create a temporary "nonexistent user" for
1581 * later addition to the database. It can also be used to set the IP
1582 * address for an anonymous user to something other than the current
1585 * @note User::newFromName() has rougly the same function, when the named user
1587 * @param $str String New user name to set
1589 function setName( $str ) {
1591 $this->mName
= $str;
1595 * Get the user's name escaped by underscores.
1596 * @return String Username escaped by underscores.
1598 function getTitleKey() {
1599 return str_replace( ' ', '_', $this->getName() );
1603 * Check if the user has new messages.
1604 * @return Bool True if the user has new messages
1606 function getNewtalk() {
1609 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1610 if( $this->mNewtalk
=== -1 ) {
1611 $this->mNewtalk
= false; # reset talk page status
1613 # Check memcached separately for anons, who have no
1614 # entire User object stored in there.
1617 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1618 $newtalk = $wgMemc->get( $key );
1619 if( strval( $newtalk ) !== '' ) {
1620 $this->mNewtalk
= (bool)$newtalk;
1622 // Since we are caching this, make sure it is up to date by getting it
1624 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1625 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1628 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1632 return (bool)$this->mNewtalk
;
1636 * Return the talk page(s) this user has new messages on.
1637 * @return Array of String page URLs
1639 function getNewMessageLinks() {
1641 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1644 if( !$this->getNewtalk() )
1646 $up = $this->getUserPage();
1647 $utp = $up->getTalkPage();
1648 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1652 * Internal uncached check for new messages
1655 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1656 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1657 * @param $fromMaster Bool true to fetch from the master, false for a slave
1658 * @return Bool True if the user has new messages
1660 protected function checkNewtalk( $field, $id, $fromMaster = false ) {
1661 if ( $fromMaster ) {
1662 $db = wfGetDB( DB_MASTER
);
1664 $db = wfGetDB( DB_SLAVE
);
1666 $ok = $db->selectField( 'user_newtalk', $field,
1667 array( $field => $id ), __METHOD__
);
1668 return $ok !== false;
1672 * Add or update the new messages flag
1673 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1674 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1675 * @return Bool True if successful, false otherwise
1677 protected function updateNewtalk( $field, $id ) {
1678 $dbw = wfGetDB( DB_MASTER
);
1679 $dbw->insert( 'user_newtalk',
1680 array( $field => $id ),
1683 if ( $dbw->affectedRows() ) {
1684 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1687 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1693 * Clear the new messages flag for the given user
1694 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1695 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1696 * @return Bool True if successful, false otherwise
1698 protected function deleteNewtalk( $field, $id ) {
1699 $dbw = wfGetDB( DB_MASTER
);
1700 $dbw->delete( 'user_newtalk',
1701 array( $field => $id ),
1703 if ( $dbw->affectedRows() ) {
1704 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1707 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1713 * Update the 'You have new messages!' status.
1714 * @param $val Bool Whether the user has new messages
1716 function setNewtalk( $val ) {
1717 if( wfReadOnly() ) {
1722 $this->mNewtalk
= $val;
1724 if( $this->isAnon() ) {
1726 $id = $this->getName();
1729 $id = $this->getId();
1734 $changed = $this->updateNewtalk( $field, $id );
1736 $changed = $this->deleteNewtalk( $field, $id );
1739 if( $this->isAnon() ) {
1740 // Anons have a separate memcached space, since
1741 // user records aren't kept for them.
1742 $key = wfMemcKey( 'newtalk', 'ip', $id );
1743 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1746 $this->invalidateCache( true );
1751 * Generate a current or new-future timestamp to be stored in the
1752 * user_touched field when we update things.
1753 * @return String Timestamp in TS_MW format
1755 private static function newTouchedTimestamp() {
1756 global $wgClockSkewFudge;
1757 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1761 * Clear user data from memcached.
1762 * Use after applying fun updates to the database; caller's
1763 * responsibility to update user_touched if appropriate.
1765 * Called implicitly from invalidateCache() and saveSettings().
1767 private function clearSharedCache() {
1771 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1776 * Immediately touch the user data cache for this account.
1777 * Updates user_touched field, and removes account data from memcached
1778 * for reload on the next hit.
1780 * @param $doDatabaseUpdate bool Do you really need to update the database? Really?
1782 function invalidateCache( $doDatabaseUpdate = false ) {
1783 if( wfReadOnly() ) {
1787 if( $this->mId
&& $doDatabaseUpdate ) {
1788 $this->mTouched
= self
::newTouchedTimestamp();
1790 $dbw = wfGetDB( DB_MASTER
);
1791 $dbw->update( 'user',
1792 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1793 array( 'user_id' => $this->mId
),
1796 $this->clearSharedCache();
1801 * Validate the cache for this account.
1802 * @param $timestamp String A timestamp in TS_MW format
1804 function validateCache( $timestamp ) {
1806 return ( $timestamp >= $this->mTouched
);
1810 * Get the user touched timestamp
1811 * @return String timestamp
1813 function getTouched() {
1815 return $this->mTouched
;
1819 * Set the password and reset the random token.
1820 * Calls through to authentication plugin if necessary;
1821 * will have no effect if the auth plugin refuses to
1822 * pass the change through or if the legal password
1825 * As a special case, setting the password to null
1826 * wipes it, so the account cannot be logged in until
1827 * a new password is set, for instance via e-mail.
1829 * @param $str String New password to set
1830 * @throws PasswordError on failure
1832 function setPassword( $str ) {
1835 if( $str !== null ) {
1836 if( !$wgAuth->allowPasswordChange() ) {
1837 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1840 if( !$this->isValidPassword( $str ) ) {
1841 global $wgMinimalPasswordLength;
1842 $valid = $this->getPasswordValidity( $str );
1843 if ( is_array( $valid ) ) {
1844 $message = array_shift( $valid );
1848 $params = array( $wgMinimalPasswordLength );
1850 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
1854 if( !$wgAuth->setPassword( $this, $str ) ) {
1855 throw new PasswordError( wfMsg( 'externaldberror' ) );
1858 $this->setInternalPassword( $str );
1864 * Set the password and reset the random token unconditionally.
1866 * @param $str String New password to set
1868 function setInternalPassword( $str ) {
1872 if( $str === null ) {
1873 // Save an invalid hash...
1874 $this->mPassword
= '';
1876 $this->mPassword
= self
::crypt( $str );
1878 $this->mNewpassword
= '';
1879 $this->mNewpassTime
= null;
1883 * Get the user's current token.
1884 * @return String Token
1886 function getToken() {
1888 return $this->mToken
;
1892 * Set the random token (used for persistent authentication)
1893 * Called from loadDefaults() among other places.
1895 * @param $token String If specified, set the token to this value
1898 function setToken( $token = false ) {
1899 global $wgSecretKey, $wgProxyKey;
1902 if ( $wgSecretKey ) {
1903 $key = $wgSecretKey;
1904 } elseif ( $wgProxyKey ) {
1909 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1911 $this->mToken
= $token;
1916 * Set the cookie password
1918 * @param $str String New cookie password
1921 function setCookiePassword( $str ) {
1923 $this->mCookiePassword
= md5( $str );
1927 * Set the password for a password reminder or new account email
1929 * @param $str String New password to set
1930 * @param $throttle Bool If true, reset the throttle timestamp to the present
1932 function setNewpassword( $str, $throttle = true ) {
1934 $this->mNewpassword
= self
::crypt( $str );
1936 $this->mNewpassTime
= wfTimestampNow();
1941 * Has password reminder email been sent within the last
1942 * $wgPasswordReminderResendTime hours?
1945 function isPasswordReminderThrottled() {
1946 global $wgPasswordReminderResendTime;
1948 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1951 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1952 return time() < $expiry;
1956 * Get the user's e-mail address
1957 * @return String User's email address
1959 function getEmail() {
1961 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1962 return $this->mEmail
;
1966 * Get the timestamp of the user's e-mail authentication
1967 * @return String TS_MW timestamp
1969 function getEmailAuthenticationTimestamp() {
1971 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1972 return $this->mEmailAuthenticated
;
1976 * Set the user's e-mail address
1977 * @param $str String New e-mail address
1979 function setEmail( $str ) {
1981 $this->mEmail
= $str;
1982 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1986 * Get the user's real name
1987 * @return String User's real name
1989 function getRealName() {
1990 if ( !$this->isItemLoaded( 'realname' ) ) {
1994 return $this->mRealName
;
1998 * Set the user's real name
1999 * @param $str String New real name
2001 function setRealName( $str ) {
2003 $this->mRealName
= $str;
2007 * Get the user's current setting for a given option.
2009 * @param $oname String The option to check
2010 * @param $defaultOverride String A default value returned if the option does not exist
2011 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2012 * @return String User's current value for the option
2013 * @see getBoolOption()
2014 * @see getIntOption()
2016 function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2017 global $wgHiddenPrefs;
2018 $this->loadOptions();
2020 if ( is_null( $this->mOptions
) ) {
2021 if($defaultOverride != '') {
2022 return $defaultOverride;
2024 $this->mOptions
= User
::getDefaultOptions();
2027 # We want 'disabled' preferences to always behave as the default value for
2028 # users, even if they have set the option explicitly in their settings (ie they
2029 # set it, and then it was disabled removing their ability to change it). But
2030 # we don't want to erase the preferences in the database in case the preference
2031 # is re-enabled again. So don't touch $mOptions, just override the returned value
2032 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2033 return self
::getDefaultOption( $oname );
2036 if ( array_key_exists( $oname, $this->mOptions
) ) {
2037 return $this->mOptions
[$oname];
2039 return $defaultOverride;
2044 * Get all user's options
2048 public function getOptions() {
2049 global $wgHiddenPrefs;
2050 $this->loadOptions();
2051 $options = $this->mOptions
;
2053 # We want 'disabled' preferences to always behave as the default value for
2054 # users, even if they have set the option explicitly in their settings (ie they
2055 # set it, and then it was disabled removing their ability to change it). But
2056 # we don't want to erase the preferences in the database in case the preference
2057 # is re-enabled again. So don't touch $mOptions, just override the returned value
2058 foreach( $wgHiddenPrefs as $pref ){
2059 $default = self
::getDefaultOption( $pref );
2060 if( $default !== null ){
2061 $options[$pref] = $default;
2069 * Get the user's current setting for a given option, as a boolean value.
2071 * @param $oname String The option to check
2072 * @return Bool User's current value for the option
2075 function getBoolOption( $oname ) {
2076 return (bool)$this->getOption( $oname );
2081 * Get the user's current setting for a given option, as a boolean value.
2083 * @param $oname String The option to check
2084 * @param $defaultOverride Int A default value returned if the option does not exist
2085 * @return Int User's current value for the option
2088 function getIntOption( $oname, $defaultOverride=0 ) {
2089 $val = $this->getOption( $oname );
2091 $val = $defaultOverride;
2093 return intval( $val );
2097 * Set the given option for a user.
2099 * @param $oname String The option to set
2100 * @param $val mixed New value to set
2102 function setOption( $oname, $val ) {
2104 $this->loadOptions();
2106 if ( $oname == 'skin' ) {
2107 # Clear cached skin, so the new one displays immediately in Special:Preferences
2108 $this->mSkin
= null;
2111 // Explicitly NULL values should refer to defaults
2112 global $wgDefaultUserOptions;
2113 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2114 $val = $wgDefaultUserOptions[$oname];
2117 $this->mOptions
[$oname] = $val;
2121 * Reset all options to the site defaults
2123 function resetOptions() {
2124 $this->mOptions
= self
::getDefaultOptions();
2128 * Get the user's preferred date format.
2129 * @return String User's preferred date format
2131 function getDatePreference() {
2132 // Important migration for old data rows
2133 if ( is_null( $this->mDatePreference
) ) {
2135 $value = $this->getOption( 'date' );
2136 $map = $wgLang->getDatePreferenceMigrationMap();
2137 if ( isset( $map[$value] ) ) {
2138 $value = $map[$value];
2140 $this->mDatePreference
= $value;
2142 return $this->mDatePreference
;
2146 * Get the user preferred stub threshold
2148 function getStubThreshold() {
2149 global $wgMaxArticleSize; # Maximum article size, in Kb
2150 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2151 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2152 # If they have set an impossible value, disable the preference
2153 # so we can use the parser cache again.
2160 * Get the permissions this user has.
2161 * @return Array of String permission names
2163 function getRights() {
2164 if ( is_null( $this->mRights
) ) {
2165 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2166 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2167 // Force reindexation of rights when a hook has unset one of them
2168 $this->mRights
= array_values( $this->mRights
);
2170 return $this->mRights
;
2174 * Get the list of explicit group memberships this user has.
2175 * The implicit * and user groups are not included.
2176 * @return Array of String internal group names
2178 function getGroups() {
2180 return $this->mGroups
;
2184 * Get the list of implicit group memberships this user has.
2185 * This includes all explicit groups, plus 'user' if logged in,
2186 * '*' for all accounts, and autopromoted groups
2187 * @param $recache Bool Whether to avoid the cache
2188 * @return Array of String internal group names
2190 function getEffectiveGroups( $recache = false ) {
2191 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2192 wfProfileIn( __METHOD__
);
2193 $this->mEffectiveGroups
= $this->getGroups();
2194 $this->mEffectiveGroups
[] = '*';
2195 if( $this->getId() ) {
2196 $this->mEffectiveGroups
[] = 'user';
2198 $this->mEffectiveGroups
= array_unique( array_merge(
2199 $this->mEffectiveGroups
,
2200 Autopromote
::getAutopromoteGroups( $this )
2203 # Hook for additional groups
2204 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2206 wfProfileOut( __METHOD__
);
2208 return $this->mEffectiveGroups
;
2212 * Get the user's edit count.
2215 function getEditCount() {
2216 if( $this->getId() ) {
2217 if ( !isset( $this->mEditCount
) ) {
2218 /* Populate the count, if it has not been populated yet */
2219 $this->mEditCount
= User
::edits( $this->mId
);
2221 return $this->mEditCount
;
2229 * Add the user to the given group.
2230 * This takes immediate effect.
2231 * @param $group String Name of the group to add
2233 function addGroup( $group, $dbw = null ) {
2234 if( wfRunHooks( 'UserAddGroup', array( &$this, &$group ) ) ) {
2235 if( $dbw == null ) $dbw = wfGetDB( DB_MASTER
);
2236 if( $this->getId() ) {
2237 $dbw->insert( 'user_groups',
2239 'ug_user' => $this->getID(),
2240 'ug_group' => $group,
2243 array( 'IGNORE' ) );
2246 $this->loadGroups();
2247 $this->mGroups
[] = $group;
2248 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2250 $this->invalidateCache( true );
2254 * Remove the user from the given group.
2255 * This takes immediate effect.
2256 * @param $group String Name of the group to remove
2258 function removeGroup( $group ) {
2260 if( wfRunHooks( 'UserRemoveGroup', array( &$this, &$group ) ) ) {
2261 $dbw = wfGetDB( DB_MASTER
);
2262 $dbw->delete( 'user_groups',
2264 'ug_user' => $this->getID(),
2265 'ug_group' => $group,
2268 $this->loadGroups();
2269 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2270 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2272 $this->invalidateCache( true );
2276 * Get whether the user is logged in
2279 function isLoggedIn() {
2280 return $this->getID() != 0;
2284 * Get whether the user is anonymous
2288 return !$this->isLoggedIn();
2292 * Check if user is allowed to access a feature / make an action
2293 * @param varargs String permissions to test
2294 * @return Boolean: True if user is allowed to perform *any* of the given actions
2296 public function isAllowedAny( /*...*/ ){
2297 $permissions = func_get_args();
2298 foreach( $permissions as $permission ){
2299 if( $this->isAllowed( $permission ) ){
2307 * @param varargs String
2308 * @return bool True if the user is allowed to perform *all* of the given actions
2310 public function isAllowedAll( /*...*/ ){
2311 $permissions = func_get_args();
2312 foreach( $permissions as $permission ){
2313 if( !$this->isAllowed( $permission ) ){
2321 * Internal mechanics of testing a permission
2322 * @param $action String
2325 public function isAllowed( $action = '' ) {
2326 if ( $action === '' ) {
2327 return true; // In the spirit of DWIM
2329 # Patrolling may not be enabled
2330 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2331 global $wgUseRCPatrol, $wgUseNPPatrol;
2332 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2335 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2336 # by misconfiguration: 0 == 'foo'
2337 return in_array( $action, $this->getRights(), true );
2341 * Check whether to enable recent changes patrol features for this user
2342 * @return Boolean: True or false
2344 public function useRCPatrol() {
2345 global $wgUseRCPatrol;
2346 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2350 * Check whether to enable new pages patrol features for this user
2351 * @return Bool True or false
2353 public function useNPPatrol() {
2354 global $wgUseRCPatrol, $wgUseNPPatrol;
2355 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2359 * Get the current skin, loading it if required
2360 * @return Skin The current skin
2361 * @todo FIXME: Need to check the old failback system [AV]
2362 * @deprecated since 1.18 Use ->getSkin() in the most relevant outputting context you have
2364 function getSkin() {
2365 return RequestContext
::getMain()->getSkin();
2369 * Check the watched status of an article.
2370 * @param $title Title of the article to look at
2373 function isWatched( $title ) {
2374 $wl = WatchedItem
::fromUserTitle( $this, $title );
2375 return $wl->isWatched();
2380 * @param $title Title of the article to look at
2382 function addWatch( $title ) {
2383 $wl = WatchedItem
::fromUserTitle( $this, $title );
2385 $this->invalidateCache();
2389 * Stop watching an article.
2390 * @param $title Title of the article to look at
2392 function removeWatch( $title ) {
2393 $wl = WatchedItem
::fromUserTitle( $this, $title );
2395 $this->invalidateCache();
2399 * Clear the user's notification timestamp for the given title.
2400 * If e-notif e-mails are on, they will receive notification mails on
2401 * the next change of the page if it's watched etc.
2402 * @param $title Title of the article to look at
2404 function clearNotification( &$title ) {
2405 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2407 # Do nothing if the database is locked to writes
2408 if( wfReadOnly() ) {
2412 if( $title->getNamespace() == NS_USER_TALK
&&
2413 $title->getText() == $this->getName() ) {
2414 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2416 $this->setNewtalk( false );
2419 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2423 if( $this->isAnon() ) {
2424 // Nothing else to do...
2428 // Only update the timestamp if the page is being watched.
2429 // The query to find out if it is watched is cached both in memcached and per-invocation,
2430 // and when it does have to be executed, it can be on a slave
2431 // If this is the user's newtalk page, we always update the timestamp
2432 if( $title->getNamespace() == NS_USER_TALK
&&
2433 $title->getText() == $wgUser->getName() )
2436 } elseif ( $this->getId() == $wgUser->getId() ) {
2437 $watched = $title->userIsWatching();
2442 // If the page is watched by the user (or may be watched), update the timestamp on any
2443 // any matching rows
2445 $dbw = wfGetDB( DB_MASTER
);
2446 $dbw->update( 'watchlist',
2448 'wl_notificationtimestamp' => null
2449 ), array( /* WHERE */
2450 'wl_title' => $title->getDBkey(),
2451 'wl_namespace' => $title->getNamespace(),
2452 'wl_user' => $this->getID()
2459 * Resets all of the given user's page-change notification timestamps.
2460 * If e-notif e-mails are on, they will receive notification mails on
2461 * the next change of any watched page.
2463 * @param $currentUser Int User ID
2465 function clearAllNotifications( $currentUser ) {
2466 global $wgUseEnotif, $wgShowUpdatedMarker;
2467 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2468 $this->setNewtalk( false );
2471 if( $currentUser != 0 ) {
2472 $dbw = wfGetDB( DB_MASTER
);
2473 $dbw->update( 'watchlist',
2475 'wl_notificationtimestamp' => null
2476 ), array( /* WHERE */
2477 'wl_user' => $currentUser
2480 # We also need to clear here the "you have new message" notification for the own user_talk page
2481 # This is cleared one page view later in Article::viewUpdates();
2486 * Set this user's options from an encoded string
2487 * @param $str String Encoded options to import
2490 function decodeOptions( $str ) {
2494 $this->mOptionsLoaded
= true;
2495 $this->mOptionOverrides
= array();
2497 // If an option is not set in $str, use the default value
2498 $this->mOptions
= self
::getDefaultOptions();
2500 $a = explode( "\n", $str );
2501 foreach ( $a as $s ) {
2503 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2504 $this->mOptions
[$m[1]] = $m[2];
2505 $this->mOptionOverrides
[$m[1]] = $m[2];
2511 * Set a cookie on the user's client. Wrapper for
2512 * WebResponse::setCookie
2513 * @param $name String Name of the cookie to set
2514 * @param $value String Value to set
2515 * @param $exp Int Expiration time, as a UNIX time value;
2516 * if 0 or not specified, use the default $wgCookieExpiration
2518 protected function setCookie( $name, $value, $exp = 0 ) {
2520 $wgRequest->response()->setcookie( $name, $value, $exp );
2524 * Clear a cookie on the user's client
2525 * @param $name String Name of the cookie to clear
2527 protected function clearCookie( $name ) {
2528 $this->setCookie( $name, '', time() - 86400 );
2532 * Set the default cookies for this session on the user's client.
2534 * @param $request WebRequest object to use; $wgRequest will be used if null
2537 function setCookies( $request = null ) {
2538 if ( $request === null ) {
2540 $request = $wgRequest;
2544 if ( 0 == $this->mId
) return;
2546 'wsUserID' => $this->mId
,
2547 'wsToken' => $this->mToken
,
2548 'wsUserName' => $this->getName()
2551 'UserID' => $this->mId
,
2552 'UserName' => $this->getName(),
2554 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2555 $cookies['Token'] = $this->mToken
;
2557 $cookies['Token'] = false;
2560 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2562 foreach ( $session as $name => $value ) {
2563 $request->setSessionData( $name, $value );
2565 foreach ( $cookies as $name => $value ) {
2566 if ( $value === false ) {
2567 $this->clearCookie( $name );
2569 $this->setCookie( $name, $value );
2575 * Log this user out.
2578 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2584 * Clear the user's cookies and session, and reset the instance cache.
2588 function doLogout() {
2591 $this->clearInstanceCache( 'defaults' );
2593 $wgRequest->setSessionData( 'wsUserID', 0 );
2595 $this->clearCookie( 'UserID' );
2596 $this->clearCookie( 'Token' );
2598 # Remember when user logged out, to prevent seeing cached pages
2599 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2603 * Save this user's settings into the database.
2604 * @todo Only rarely do all these fields need to be set!
2606 function saveSettings( $dbw = null ) {
2608 if ( wfReadOnly() ) { return; }
2609 if ( 0 == $this->mId
) { return; }
2611 $this->mTouched
= self
::newTouchedTimestamp();
2613 if( $dbw === null ) $dbw = wfGetDB( DB_MASTER
);
2614 $dbw->update( 'user',
2616 'user_name' => $this->mName
,
2617 'user_password' => $this->mPassword
,
2618 'user_newpassword' => $this->mNewpassword
,
2619 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2620 'user_real_name' => $this->mRealName
,
2621 'user_email' => $this->mEmail
,
2622 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2623 'user_options' => '',
2624 'user_touched' => $dbw->timestamp( $this->mTouched
),
2625 'user_token' => $this->mToken
,
2626 'user_email_token' => $this->mEmailToken
,
2627 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2628 ), array( /* WHERE */
2629 'user_id' => $this->mId
2633 $this->saveOptions( $dbw );
2635 wfRunHooks( 'UserSaveSettings', array( $this ) );
2636 $this->clearSharedCache();
2637 $this->getUserPage()->invalidateCache();
2641 * If only this user's username is known, and it exists, return the user ID.
2644 function idForName( $dbr = null ) {
2645 $s = trim( $this->getName() );
2646 if ( $s === '' ) return 0;
2648 if( $dbr == null ) $dbr = wfGetDB( DB_SLAVE
);
2649 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2650 if ( $id === false ) {
2657 * Add a user to the database, return the user object
2659 * @param $name String Username to add
2660 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2661 * - password The user's password hash. Password logins will be disabled if this is omitted.
2662 * - newpassword Hash for a temporary password that has been mailed to the user
2663 * - email The user's email address
2664 * - email_authenticated The email authentication timestamp
2665 * - real_name The user's real name
2666 * - options An associative array of non-default options
2667 * - token Random authentication token. Do not set.
2668 * - registration Registration timestamp. Do not set.
2670 * @return User object, or null if the username already exists
2672 static function createNew( $name, $params = array() ) {
2675 if ( isset( $params['options'] ) ) {
2676 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2677 unset( $params['options'] );
2679 $dbw = wfGetDB( DB_MASTER
);
2680 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2683 'user_id' => $seqVal,
2684 'user_name' => $name,
2685 'user_password' => $user->mPassword
,
2686 'user_newpassword' => $user->mNewpassword
,
2687 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2688 'user_email' => $user->mEmail
,
2689 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2690 'user_real_name' => $user->mRealName
,
2691 'user_options' => '',
2692 'user_token' => $user->mToken
,
2693 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2694 'user_editcount' => 0,
2696 foreach ( $params as $name => $value ) {
2697 $fields["user_$name"] = $value;
2699 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2700 if ( $dbw->affectedRows() ) {
2701 $newUser = User
::newFromId( $dbw->insertId() );
2709 * Add this existing user object to the database
2711 function addToDatabase( $dbw = null ) {
2713 if( $dbw === null ) $dbw = wfGetDB( DB_MASTER
);
2714 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2715 $dbw->insert( 'user',
2717 'user_id' => $seqVal,
2718 'user_name' => $this->mName
,
2719 'user_password' => $this->mPassword
,
2720 'user_newpassword' => $this->mNewpassword
,
2721 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2722 'user_email' => $this->mEmail
,
2723 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2724 'user_real_name' => $this->mRealName
,
2725 'user_options' => '',
2726 'user_token' => $this->mToken
,
2727 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2728 'user_editcount' => 0,
2731 $this->mId
= $dbw->insertId();
2733 // Clear instance cache other than user table data, which is already accurate
2734 $this->clearInstanceCache();
2736 $this->saveOptions( $dbw );
2740 * If this (non-anonymous) user is blocked, block any IP address
2741 * they've successfully logged in from.
2743 function spreadBlock() {
2744 wfDebug( __METHOD__
. "()\n" );
2746 if ( $this->mId
== 0 ) {
2750 $userblock = Block
::newFromTarget( $this->getName() );
2751 if ( !$userblock ) {
2755 $userblock->doAutoblock( wfGetIP() );
2759 * Generate a string which will be different for any combination of
2760 * user options which would produce different parser output.
2761 * This will be used as part of the hash key for the parser cache,
2762 * so users with the same options can share the same cached data
2765 * Extensions which require it should install 'PageRenderingHash' hook,
2766 * which will give them a chance to modify this key based on their own
2769 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
2770 * @return String Page rendering hash
2772 function getPageRenderingHash() {
2773 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2775 return $this->mHash
;
2777 wfDeprecated( __METHOD__
);
2779 // stubthreshold is only included below for completeness,
2780 // since it disables the parser cache, its value will always
2781 // be 0 when this function is called by parsercache.
2783 $confstr = $this->getOption( 'math' );
2784 $confstr .= '!' . $this->getStubThreshold();
2785 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2786 $confstr .= '!' . $this->getDatePreference();
2788 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2789 $confstr .= '!' . $wgLang->getCode();
2790 $confstr .= '!' . $this->getOption( 'thumbsize' );
2791 // add in language specific options, if any
2792 $extra = $wgContLang->getExtraHashOptions();
2795 // Since the skin could be overloading link(), it should be
2796 // included here but in practice, none of our skins do that.
2798 $confstr .= $wgRenderHashAppend;
2800 // Give a chance for extensions to modify the hash, if they have
2801 // extra options or other effects on the parser cache.
2802 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2804 // Make it a valid memcached key fragment
2805 $confstr = str_replace( ' ', '_', $confstr );
2806 $this->mHash
= $confstr;
2811 * Get whether the user is explicitly blocked from account creation.
2812 * @return Bool|Block
2814 function isBlockedFromCreateAccount() {
2815 $this->getBlockedStatus();
2816 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
2817 return $this->mBlock
;
2820 # bug 13611: if the IP address the user is trying to create an account from is
2821 # blocked with createaccount disabled, prevent new account creation there even
2822 # when the user is logged in
2823 static $accBlock = false;
2824 if( $accBlock === false ){
2825 $accBlock = Block
::newFromTarget( null, wfGetIP() );
2827 return $accBlock instanceof Block
&& $accBlock->prevents( 'createaccount' )
2833 * Get whether the user is blocked from using Special:Emailuser.
2836 function isBlockedFromEmailuser() {
2837 $this->getBlockedStatus();
2838 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
2842 * Get whether the user is allowed to create an account.
2845 function isAllowedToCreateAccount() {
2846 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2850 * Get this user's personal page title.
2852 * @return Title: User's personal page title
2854 function getUserPage() {
2855 return Title
::makeTitle( NS_USER
, $this->getName() );
2859 * Get this user's talk page title.
2861 * @return Title: User's talk page title
2863 function getTalkPage() {
2864 $title = $this->getUserPage();
2865 return $title->getTalkPage();
2869 * Get the maximum valid user ID.
2870 * @return Integer: User ID
2873 function getMaxID() {
2874 static $res; // cache
2876 if ( isset( $res ) ) {
2879 $dbr = wfGetDB( DB_SLAVE
);
2880 return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__
);
2885 * Determine whether the user is a newbie. Newbies are either
2886 * anonymous IPs, or the most recently created accounts.
2889 function isNewbie() {
2890 return !$this->isAllowed( 'autoconfirmed' );
2894 * Check to see if the given clear-text password is one of the accepted passwords
2895 * @param $password String: user password.
2896 * @return Boolean: True if the given password is correct, otherwise False.
2898 function checkPassword( $password ) {
2899 global $wgAuth, $wgLegacyEncoding;
2902 // Even though we stop people from creating passwords that
2903 // are shorter than this, doesn't mean people wont be able
2904 // to. Certain authentication plugins do NOT want to save
2905 // domain passwords in a mysql database, so we should
2906 // check this (in case $wgAuth->strict() is false).
2907 if( !$this->isValidPassword( $password ) ) {
2911 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2913 } elseif( $wgAuth->strict() ) {
2914 /* Auth plugin doesn't allow local authentication */
2916 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2917 /* Auth plugin doesn't allow local authentication for this user name */
2920 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2922 } elseif ( $wgLegacyEncoding ) {
2923 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2924 # Check for this with iconv
2925 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2926 if ( $cp1252Password != $password &&
2927 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
2936 * Check if the given clear-text password matches the temporary password
2937 * sent by e-mail for password reset operations.
2938 * @return Boolean: True if matches, false otherwise
2940 function checkTemporaryPassword( $plaintext ) {
2941 global $wgNewPasswordExpiry;
2944 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2945 if ( is_null( $this->mNewpassTime
) ) {
2948 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2949 return ( time() < $expiry );
2956 * Initialize (if necessary) and return a session token value
2957 * which can be used in edit forms to show that the user's
2958 * login credentials aren't being hijacked with a foreign form
2961 * @param $salt String|Array of Strings Optional function-specific data for hashing
2962 * @param $request WebRequest object to use or null to use $wgRequest
2963 * @return String The new edit token
2965 function editToken( $salt = '', $request = null ) {
2966 if ( $request == null ) {
2968 $request = $wgRequest;
2971 if ( $this->isAnon() ) {
2972 return EDIT_TOKEN_SUFFIX
;
2974 $token = $request->getSessionData( 'wsEditToken' );
2975 if ( $token === null ) {
2976 $token = self
::generateToken();
2977 $request->setSessionData( 'wsEditToken', $token );
2979 if( is_array( $salt ) ) {
2980 $salt = implode( '|', $salt );
2982 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2987 * Generate a looking random token for various uses.
2989 * @param $salt String Optional salt value
2990 * @return String The new random token
2992 public static function generateToken( $salt = '' ) {
2993 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2994 return md5( $token . $salt );
2998 * Check given value against the token value stored in the session.
2999 * A match should confirm that the form was submitted from the
3000 * user's own login session, not a form submission from a third-party
3003 * @param $val String Input value to compare
3004 * @param $salt String Optional function-specific data for hashing
3005 * @param $request WebRequest object to use or null to use $wgRequest
3006 * @return Boolean: Whether the token matches
3008 function matchEditToken( $val, $salt = '', $request = null ) {
3009 $sessionToken = $this->editToken( $salt, $request );
3010 if ( $val != $sessionToken ) {
3011 wfDebug( "User::matchEditToken: broken session data\n" );
3013 return $val == $sessionToken;
3017 * Check given value against the token value stored in the session,
3018 * ignoring the suffix.
3020 * @param $val String Input value to compare
3021 * @param $salt String Optional function-specific data for hashing
3022 * @param $request WebRequest object to use or null to use $wgRequest
3023 * @return Boolean: Whether the token matches
3025 function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3026 $sessionToken = $this->editToken( $salt, $request );
3027 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3031 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3032 * mail to the user's given address.
3034 * @param $type String: message to send, either "created", "changed" or "set"
3035 * @return Status object
3037 function sendConfirmationMail( $type = 'created' ) {
3039 $expiration = null; // gets passed-by-ref and defined in next line.
3040 $token = $this->confirmationToken( $expiration );
3041 $url = $this->confirmationTokenUrl( $token );
3042 $invalidateURL = $this->invalidationTokenUrl( $token );
3043 $this->saveSettings();
3045 if ( $type == 'created' ||
$type === false ) {
3046 $message = 'confirmemail_body';
3047 } elseif ( $type === true ) {
3048 $message = 'confirmemail_body_changed';
3050 $message = 'confirmemail_body_' . $type;
3053 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3058 $wgLang->timeanddate( $expiration, false ),
3060 $wgLang->date( $expiration, false ),
3061 $wgLang->time( $expiration, false ) ) );
3065 * Send an e-mail to this user's account. Does not check for
3066 * confirmed status or validity.
3068 * @param $subject String Message subject
3069 * @param $body String Message body
3070 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3071 * @param $replyto String Reply-To address
3074 function sendMail( $subject, $body, $from = null, $replyto = null ) {
3075 if( is_null( $from ) ) {
3076 global $wgPasswordSender, $wgPasswordSenderName;
3077 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3079 $sender = new MailAddress( $from );
3082 $to = new MailAddress( $this );
3083 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3087 * Generate, store, and return a new e-mail confirmation code.
3088 * A hash (unsalted, since it's used as a key) is stored.
3090 * @note Call saveSettings() after calling this function to commit
3091 * this change to the database.
3093 * @param[out] &$expiration \mixed Accepts the expiration time
3094 * @return String New token
3097 function confirmationToken( &$expiration ) {
3098 global $wgUserEmailConfirmationTokenExpiry;
3100 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3101 $expiration = wfTimestamp( TS_MW
, $expires );
3102 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
3103 $hash = md5( $token );
3105 $this->mEmailToken
= $hash;
3106 $this->mEmailTokenExpires
= $expiration;
3111 * Return a URL the user can use to confirm their email address.
3112 * @param $token String Accepts the email confirmation token
3113 * @return String New token URL
3116 function confirmationTokenUrl( $token ) {
3117 return $this->getTokenUrl( 'ConfirmEmail', $token );
3121 * Return a URL the user can use to invalidate their email address.
3122 * @param $token String Accepts the email confirmation token
3123 * @return String New token URL
3126 function invalidationTokenUrl( $token ) {
3127 return $this->getTokenUrl( 'Invalidateemail', $token );
3131 * Internal function to format the e-mail validation/invalidation URLs.
3132 * This uses $wgArticlePath directly as a quickie hack to use the
3133 * hardcoded English names of the Special: pages, for ASCII safety.
3135 * @note Since these URLs get dropped directly into emails, using the
3136 * short English names avoids insanely long URL-encoded links, which
3137 * also sometimes can get corrupted in some browsers/mailers
3138 * (bug 6957 with Gmail and Internet Explorer).
3140 * @param $page String Special page
3141 * @param $token String Token
3142 * @return String Formatted URL
3144 protected function getTokenUrl( $page, $token ) {
3145 global $wgArticlePath;
3149 "Special:$page/$token",
3154 * Mark the e-mail address confirmed.
3156 * @note Call saveSettings() after calling this function to commit the change.
3158 function confirmEmail() {
3159 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3160 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3165 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3166 * address if it was already confirmed.
3168 * @note Call saveSettings() after calling this function to commit the change.
3170 function invalidateEmail() {
3172 $this->mEmailToken
= null;
3173 $this->mEmailTokenExpires
= null;
3174 $this->setEmailAuthenticationTimestamp( null );
3175 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3180 * Set the e-mail authentication timestamp.
3181 * @param $timestamp String TS_MW timestamp
3183 function setEmailAuthenticationTimestamp( $timestamp ) {
3185 $this->mEmailAuthenticated
= $timestamp;
3186 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3190 * Is this user allowed to send e-mails within limits of current
3191 * site configuration?
3194 function canSendEmail() {
3195 global $wgEnableEmail, $wgEnableUserEmail;
3196 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3199 $canSend = $this->isEmailConfirmed();
3200 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3205 * Is this user allowed to receive e-mails within limits of current
3206 * site configuration?
3209 function canReceiveEmail() {
3210 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3214 * Is this user's e-mail address valid-looking and confirmed within
3215 * limits of the current site configuration?
3217 * @note If $wgEmailAuthentication is on, this may require the user to have
3218 * confirmed their address by returning a code or using a password
3219 * sent to the address from the wiki.
3223 function isEmailConfirmed() {
3224 global $wgEmailAuthentication;
3227 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3228 if( $this->isAnon() )
3230 if( !self
::isValidEmailAddr( $this->mEmail
) )
3232 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3241 * Check whether there is an outstanding request for e-mail confirmation.
3244 function isEmailConfirmationPending() {
3245 global $wgEmailAuthentication;
3246 return $wgEmailAuthentication &&
3247 !$this->isEmailConfirmed() &&
3248 $this->mEmailToken
&&
3249 $this->mEmailTokenExpires
> wfTimestamp();
3253 * Get the timestamp of account creation.
3255 * @return String|Bool Timestamp of account creation, or false for
3256 * non-existent/anonymous user accounts.
3258 public function getRegistration() {
3259 if ( $this->isAnon() ) {
3263 return $this->mRegistration
;
3267 * Get the timestamp of the first edit
3269 * @return String|Bool Timestamp of first edit, or false for
3270 * non-existent/anonymous user accounts.
3272 public function getFirstEditTimestamp() {
3273 if( $this->getId() == 0 ) {
3274 return false; // anons
3276 $dbr = wfGetDB( DB_SLAVE
);
3277 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3278 array( 'rev_user' => $this->getId() ),
3280 array( 'ORDER BY' => 'rev_timestamp ASC' )
3283 return false; // no edits
3285 return wfTimestamp( TS_MW
, $time );
3289 * Get the permissions associated with a given list of groups
3291 * @param $groups Array of Strings List of internal group names
3292 * @return Array of Strings List of permission key names for given groups combined
3294 static function getGroupPermissions( $groups ) {
3295 global $wgGroupPermissions, $wgRevokePermissions;
3297 // grant every granted permission first
3298 foreach( $groups as $group ) {
3299 if( isset( $wgGroupPermissions[$group] ) ) {
3300 $rights = array_merge( $rights,
3301 // array_filter removes empty items
3302 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3305 // now revoke the revoked permissions
3306 foreach( $groups as $group ) {
3307 if( isset( $wgRevokePermissions[$group] ) ) {
3308 $rights = array_diff( $rights,
3309 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3312 return array_unique( $rights );
3316 * Get all the groups who have a given permission
3318 * @param $role String Role to check
3319 * @return Array of Strings List of internal group names with the given permission
3321 static function getGroupsWithPermission( $role ) {
3322 global $wgGroupPermissions;
3323 $allowedGroups = array();
3324 foreach ( $wgGroupPermissions as $group => $rights ) {
3325 if ( isset( $rights[$role] ) && $rights[$role] ) {
3326 $allowedGroups[] = $group;
3329 return $allowedGroups;
3333 * Get the localized descriptive name for a group, if it exists
3335 * @param $group String Internal group name
3336 * @return String Localized descriptive group name
3338 static function getGroupName( $group ) {
3339 $msg = wfMessage( "group-$group" );
3340 return $msg->isBlank() ?
$group : $msg->text();
3344 * Get the localized descriptive name for a member of a group, if it exists
3346 * @param $group String Internal group name
3347 * @return String Localized name for group member
3349 static function getGroupMember( $group ) {
3350 $msg = wfMessage( "group-$group-member" );
3351 return $msg->isBlank() ?
$group : $msg->text();
3355 * Return the set of defined explicit groups.
3356 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3357 * are not included, as they are defined automatically, not in the database.
3358 * @return Array of internal group names
3360 static function getAllGroups() {
3361 global $wgGroupPermissions, $wgRevokePermissions;
3363 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3364 self
::getImplicitGroups()
3369 * Get a list of all available permissions.
3370 * @return Array of permission names
3372 static function getAllRights() {
3373 if ( self
::$mAllRights === false ) {
3374 global $wgAvailableRights;
3375 if ( count( $wgAvailableRights ) ) {
3376 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3378 self
::$mAllRights = self
::$mCoreRights;
3380 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3382 return self
::$mAllRights;
3386 * Get a list of implicit groups
3387 * @return Array of Strings Array of internal group names
3389 public static function getImplicitGroups() {
3390 global $wgImplicitGroups;
3391 $groups = $wgImplicitGroups;
3392 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3397 * Get the title of a page describing a particular group
3399 * @param $group String Internal group name
3400 * @return Title|Bool Title of the page if it exists, false otherwise
3402 static function getGroupPage( $group ) {
3403 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3404 if( $msg->exists() ) {
3405 $title = Title
::newFromText( $msg->text() );
3406 if( is_object( $title ) )
3413 * Create a link to the group in HTML, if available;
3414 * else return the group name.
3416 * @param $group String Internal name of the group
3417 * @param $text String The text of the link
3418 * @return String HTML link to the group
3420 static function makeGroupLinkHTML( $group, $text = '' ) {
3422 $text = self
::getGroupName( $group );
3424 $title = self
::getGroupPage( $group );
3427 $sk = $wgUser->getSkin();
3428 return $sk->link( $title, htmlspecialchars( $text ) );
3435 * Create a link to the group in Wikitext, if available;
3436 * else return the group name.
3438 * @param $group String Internal name of the group
3439 * @param $text String The text of the link
3440 * @return String Wikilink to the group
3442 static function makeGroupLinkWiki( $group, $text = '' ) {
3444 $text = self
::getGroupName( $group );
3446 $title = self
::getGroupPage( $group );
3448 $page = $title->getPrefixedText();
3449 return "[[$page|$text]]";
3456 * Returns an array of the groups that a particular group can add/remove.
3458 * @param $group String: the group to check for whether it can add/remove
3459 * @return Array array( 'add' => array( addablegroups ),
3460 * 'remove' => array( removablegroups ),
3461 * 'add-self' => array( addablegroups to self),
3462 * 'remove-self' => array( removable groups from self) )
3464 static function changeableByGroup( $group ) {
3465 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3467 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3468 if( empty( $wgAddGroups[$group] ) ) {
3469 // Don't add anything to $groups
3470 } elseif( $wgAddGroups[$group] === true ) {
3471 // You get everything
3472 $groups['add'] = self
::getAllGroups();
3473 } elseif( is_array( $wgAddGroups[$group] ) ) {
3474 $groups['add'] = $wgAddGroups[$group];
3477 // Same thing for remove
3478 if( empty( $wgRemoveGroups[$group] ) ) {
3479 } elseif( $wgRemoveGroups[$group] === true ) {
3480 $groups['remove'] = self
::getAllGroups();
3481 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3482 $groups['remove'] = $wgRemoveGroups[$group];
3485 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3486 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3487 foreach( $wgGroupsAddToSelf as $key => $value ) {
3488 if( is_int( $key ) ) {
3489 $wgGroupsAddToSelf['user'][] = $value;
3494 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3495 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3496 if( is_int( $key ) ) {
3497 $wgGroupsRemoveFromSelf['user'][] = $value;
3502 // Now figure out what groups the user can add to him/herself
3503 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3504 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3505 // No idea WHY this would be used, but it's there
3506 $groups['add-self'] = User
::getAllGroups();
3507 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3508 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3511 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3512 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3513 $groups['remove-self'] = User
::getAllGroups();
3514 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3515 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3522 * Returns an array of groups that this user can add and remove
3523 * @return Array array( 'add' => array( addablegroups ),
3524 * 'remove' => array( removablegroups ),
3525 * 'add-self' => array( addablegroups to self),
3526 * 'remove-self' => array( removable groups from self) )
3528 function changeableGroups() {
3529 if( $this->isAllowed( 'userrights' ) ) {
3530 // This group gives the right to modify everything (reverse-
3531 // compatibility with old "userrights lets you change
3533 // Using array_merge to make the groups reindexed
3534 $all = array_merge( User
::getAllGroups() );
3538 'add-self' => array(),
3539 'remove-self' => array()
3543 // Okay, it's not so simple, we will have to go through the arrays
3546 'remove' => array(),
3547 'add-self' => array(),
3548 'remove-self' => array()
3550 $addergroups = $this->getEffectiveGroups();
3552 foreach( $addergroups as $addergroup ) {
3553 $groups = array_merge_recursive(
3554 $groups, $this->changeableByGroup( $addergroup )
3556 $groups['add'] = array_unique( $groups['add'] );
3557 $groups['remove'] = array_unique( $groups['remove'] );
3558 $groups['add-self'] = array_unique( $groups['add-self'] );
3559 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3565 * Increment the user's edit-count field.
3566 * Will have no effect for anonymous users.
3568 function incEditCount() {
3569 if( !$this->isAnon() ) {
3570 $dbw = wfGetDB( DB_MASTER
);
3571 $dbw->update( 'user',
3572 array( 'user_editcount=user_editcount+1' ),
3573 array( 'user_id' => $this->getId() ),
3576 // Lazy initialization check...
3577 if( $dbw->affectedRows() == 0 ) {
3578 // Pull from a slave to be less cruel to servers
3579 // Accuracy isn't the point anyway here
3580 $dbr = wfGetDB( DB_SLAVE
);
3581 $count = $dbr->selectField( 'revision',
3583 array( 'rev_user' => $this->getId() ),
3586 // Now here's a goddamn hack...
3587 if( $dbr !== $dbw ) {
3588 // If we actually have a slave server, the count is
3589 // at least one behind because the current transaction
3590 // has not been committed and replicated.
3593 // But if DB_SLAVE is selecting the master, then the
3594 // count we just read includes the revision that was
3595 // just added in the working transaction.
3598 $dbw->update( 'user',
3599 array( 'user_editcount' => $count ),
3600 array( 'user_id' => $this->getId() ),
3604 // edit count in user cache too
3605 $this->invalidateCache();
3609 * Get the description of a given right
3611 * @param $right String Right to query
3612 * @return String Localized description of the right
3614 static function getRightDescription( $right ) {
3615 $key = "right-$right";
3616 $msg = wfMessage( $key );
3617 return $msg->isBlank() ?
$right : $msg->text();
3621 * Make an old-style password hash
3623 * @param $password String Plain-text password
3624 * @param $userId String User ID
3625 * @return String Password hash
3627 static function oldCrypt( $password, $userId ) {
3628 global $wgPasswordSalt;
3629 if ( $wgPasswordSalt ) {
3630 return md5( $userId . '-' . md5( $password ) );
3632 return md5( $password );
3637 * Make a new-style password hash
3639 * @param $password String Plain-text password
3640 * @param $salt String Optional salt, may be random or the user ID.
3641 * If unspecified or false, will generate one automatically
3642 * @return String Password hash
3644 static function crypt( $password, $salt = false ) {
3645 global $wgPasswordSalt;
3648 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3652 if( $wgPasswordSalt ) {
3653 if ( $salt === false ) {
3654 $salt = substr( wfGenerateToken(), 0, 8 );
3656 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3658 return ':A:' . md5( $password );
3663 * Compare a password hash with a plain-text password. Requires the user
3664 * ID if there's a chance that the hash is an old-style hash.
3666 * @param $hash String Password hash
3667 * @param $password String Plain-text password to compare
3668 * @param $userId String User ID for old-style password salt
3671 static function comparePasswords( $hash, $password, $userId = false ) {
3672 $type = substr( $hash, 0, 3 );
3675 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3679 if ( $type == ':A:' ) {
3681 return md5( $password ) === substr( $hash, 3 );
3682 } elseif ( $type == ':B:' ) {
3684 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3685 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3688 return self
::oldCrypt( $password, $userId ) === $hash;
3693 * Add a newuser log entry for this user
3695 * @param $byEmail Boolean: account made by email?
3696 * @param $reason String: user supplied reason
3700 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3701 global $wgUser, $wgContLang, $wgNewUserLog;
3702 if( empty( $wgNewUserLog ) ) {
3703 return true; // disabled
3706 if( $this->getName() == $wgUser->getName() ) {
3709 $action = 'create2';
3711 if ( $reason === '' ) {
3712 $reason = wfMsgForContent( 'newuserlog-byemail' );
3714 $reason = $wgContLang->commaList( array(
3715 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3719 $log = new LogPage( 'newusers' );
3722 $this->getUserPage(),
3724 array( $this->getId() )
3730 * Add an autocreate newuser log entry for this user
3731 * Used by things like CentralAuth and perhaps other authplugins.
3735 public function addNewUserLogEntryAutoCreate() {
3736 global $wgNewUserLog;
3737 if( !$wgNewUserLog ) {
3738 return true; // disabled
3740 $log = new LogPage( 'newusers', false );
3741 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3745 protected function loadOptions() {
3747 if ( $this->mOptionsLoaded ||
!$this->getId() )
3750 $this->mOptions
= self
::getDefaultOptions();
3752 // Maybe load from the object
3753 if ( !is_null( $this->mOptionOverrides
) ) {
3754 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3755 foreach( $this->mOptionOverrides
as $key => $value ) {
3756 $this->mOptions
[$key] = $value;
3759 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
3760 // Load from database
3761 $dbr = wfGetDB( DB_SLAVE
);
3763 $res = $dbr->select(
3766 array( 'up_user' => $this->getId() ),
3770 foreach ( $res as $row ) {
3771 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3772 $this->mOptions
[$row->up_property
] = $row->up_value
;
3776 $this->mOptionsLoaded
= true;
3778 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3781 protected function saveOptions( $dbw = null ) {
3782 global $wgAllowPrefChange;
3784 $extuser = ExternalUser
::newFromUser( $this );
3786 $this->loadOptions();
3787 if( $dbw === null ) $dbw = wfGetDB( DB_MASTER
);
3789 $insert_rows = array();
3791 $saveOptions = $this->mOptions
;
3793 // Allow hooks to abort, for instance to save to a global profile.
3794 // Reset options to default state before saving.
3795 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3798 foreach( $saveOptions as $key => $value ) {
3799 # Don't bother storing default values
3800 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3801 !( $value === false ||
is_null($value) ) ) ||
3802 $value != self
::getDefaultOption( $key ) ) {
3803 $insert_rows[] = array(
3804 'up_user' => $this->getId(),
3805 'up_property' => $key,
3806 'up_value' => $value,
3809 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3810 switch ( $wgAllowPrefChange[$key] ) {
3816 $extuser->setPref( $key, $value );
3822 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3823 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3828 * Provide an array of HTML5 attributes to put on an input element
3829 * intended for the user to enter a new password. This may include
3830 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3832 * Do *not* use this when asking the user to enter his current password!
3833 * Regardless of configuration, users may have invalid passwords for whatever
3834 * reason (e.g., they were set before requirements were tightened up).
3835 * Only use it when asking for a new password, like on account creation or
3838 * Obviously, you still need to do server-side checking.
3840 * NOTE: A combination of bugs in various browsers means that this function
3841 * actually just returns array() unconditionally at the moment. May as
3842 * well keep it around for when the browser bugs get fixed, though.
3844 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
3846 * @return array Array of HTML attributes suitable for feeding to
3847 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3848 * That will potentially output invalid XHTML 1.0 Transitional, and will
3849 * get confused by the boolean attribute syntax used.)
3851 public static function passwordChangeInputAttribs() {
3852 global $wgMinimalPasswordLength;
3854 if ( $wgMinimalPasswordLength == 0 ) {
3858 # Note that the pattern requirement will always be satisfied if the
3859 # input is empty, so we need required in all cases.
3861 # @todo FIXME: Bug 23769: This needs to not claim the password is required
3862 # if e-mail confirmation is being used. Since HTML5 input validation
3863 # is b0rked anyway in some browsers, just return nothing. When it's
3864 # re-enabled, fix this code to not output required for e-mail
3866 #$ret = array( 'required' );
3869 # We can't actually do this right now, because Opera 9.6 will print out
3870 # the entered password visibly in its error message! When other
3871 # browsers add support for this attribute, or Opera fixes its support,
3872 # we can add support with a version check to avoid doing this on Opera
3873 # versions where it will be a problem. Reported to Opera as
3874 # DSK-262266, but they don't have a public bug tracker for us to follow.
3876 if ( $wgMinimalPasswordLength > 1 ) {
3877 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3878 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3879 $wgMinimalPasswordLength );