308b6e3b39fd9015856ad9fb3243d7f9eb631d5f
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',
142 'userrights-interwiki',
146 * String Cached results of getAllRights()
148 static $mAllRights = false;
150 /** @name Cache variables */
152 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
153 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
154 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
158 * Bool Whether the cache variables have been loaded.
162 private $mLoadedItems = array();
166 * String Initialization data source if mLoadedItems!==true. May be one of:
167 * - 'defaults' anonymous user initialised from class defaults
168 * - 'name' initialise from mName
169 * - 'id' initialise from mId
170 * - 'session' log in from cookies or session if possible
172 * Use the User::newFrom*() family of functions to set this.
177 * Lazy-initialized variables, invalidated with clearInstanceCache
179 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mRights,
180 $mBlockreason, $mEffectiveGroups, $mBlockedGlobally,
181 $mLocked, $mHideName, $mOptions;
193 static $idCacheByName = array();
196 * Lightweight constructor for an anonymous user.
197 * Use the User::newFrom* factory functions for other kinds of users.
201 * @see newFromConfirmationCode()
202 * @see newFromSession()
205 function __construct() {
206 $this->clearInstanceCache( 'defaults' );
209 function __toString(){
210 return $this->getName();
214 * Load the user table data for this object from the source given by mFrom.
217 if ( $this->mLoadedItems
=== true ) {
220 wfProfileIn( __METHOD__
);
222 # Set it now to avoid infinite recursion in accessors
223 $this->mLoadedItems
= true;
225 switch ( $this->mFrom
) {
227 $this->loadDefaults();
230 $this->mId
= self
::idFromName( $this->mName
);
232 # Nonexistent user placeholder object
233 $this->loadDefaults( $this->mName
);
242 $this->loadFromSession();
243 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
246 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
248 wfProfileOut( __METHOD__
);
252 * Load user table data, given mId has already been set.
253 * @return Bool false if the ID does not exist, true otherwise
256 function loadFromId() {
258 if ( $this->mId
== 0 ) {
259 $this->loadDefaults();
264 $key = wfMemcKey( 'user', 'id', $this->mId
);
265 $data = $wgMemc->get( $key );
266 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
267 # Object is expired, load from DB
272 wfDebug( "User: cache miss for user {$this->mId}\n" );
274 if ( !$this->loadFromDatabase() ) {
275 # Can't load from ID, user is anonymous
278 $this->saveToCache();
280 wfDebug( "User: got user {$this->mId} from cache\n" );
282 foreach ( self
::$mCacheVars as $name ) {
283 $this->$name = $data[$name];
290 * Save user data to the shared cache
292 function saveToCache() {
295 $this->loadOptions();
296 if ( $this->isAnon() ) {
297 // Anonymous users are uncached
301 foreach ( self
::$mCacheVars as $name ) {
302 $data[$name] = $this->$name;
304 $data['mVersion'] = MW_USER_VERSION
;
305 $key = wfMemcKey( 'user', 'id', $this->mId
);
307 $wgMemc->set( $key, $data );
311 /** @name newFrom*() static factory methods */
315 * Static factory method for creation from username.
317 * This is slightly less efficient than newFromId(), so use newFromId() if
318 * you have both an ID and a name handy.
320 * @param $name String Username, validated by Title::newFromText()
321 * @param $validate String|Bool Validate username. Takes the same parameters as
322 * User::getCanonicalName(), except that true is accepted as an alias
323 * for 'valid', for BC.
325 * @return User object, or false if the username is invalid
326 * (e.g. if it contains illegal characters or is an IP address). If the
327 * username is not present in the database, the result will be a user object
328 * with a name, zero user ID and default settings.
330 static function newFromName( $name, $validate = 'valid' ) {
331 if ( $validate === true ) {
334 $name = self
::getCanonicalName( $name, $validate );
335 if ( $name === false ) {
338 # Create unloaded user object
342 $u->setItemLoaded( 'name' );
348 * Static factory method for creation from a given user ID.
350 * @param $id Int Valid user ID
351 * @return User The corresponding User object
353 static function newFromId( $id ) {
357 $u->setItemLoaded( 'id' );
362 * Factory method to fetch whichever user has a given email confirmation code.
363 * This code is generated when an account is created or its e-mail address
366 * If the code is invalid or has expired, returns NULL.
368 * @param $code String Confirmation code
371 static function newFromConfirmationCode( $code ) {
372 $dbr = wfGetDB( DB_SLAVE
);
373 $id = $dbr->selectField( 'user', 'user_id', array(
374 'user_email_token' => md5( $code ),
375 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
377 if( $id !== false ) {
378 return User
::newFromId( $id );
385 * Create a new user object using data from session or cookies. If the
386 * login credentials are invalid, the result is an anonymous user.
390 static function newFromSession() {
392 $user->mFrom
= 'session';
397 * Create a new user object from a user row.
398 * The row should have the following fields from the user table in it:
399 * - either user_name or user_id to load further data if needed (or both)
401 * - all other fields (email, password, etc.)
402 * It is useless to provide the remaining fields if either user_id,
403 * user_name and user_real_name are not provided because the whole row
404 * will be loaded once more from the database when accessing them.
406 * @param $row Array A row from the user table
409 static function newFromRow( $row ) {
411 $user->loadFromRow( $row );
419 * Get the username corresponding to a given user ID
420 * @param $id Int User ID
421 * @return String The corresponding username
423 static function whoIs( $id ) {
424 $dbr = wfGetDB( DB_SLAVE
);
425 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
429 * Get the real name of a user given their user ID
431 * @param $id Int User ID
432 * @return String The corresponding user's real name
434 static function whoIsReal( $id ) {
435 $dbr = wfGetDB( DB_SLAVE
);
436 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
440 * Get database id given a user name
441 * @param $name String Username
442 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
444 static function idFromName( $name ) {
445 $nt = Title
::makeTitleSafe( NS_USER
, $name );
446 if( is_null( $nt ) ) {
451 if ( isset( self
::$idCacheByName[$name] ) ) {
452 return self
::$idCacheByName[$name];
455 $dbr = wfGetDB( DB_SLAVE
);
456 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
458 if ( $s === false ) {
461 $result = $s->user_id
;
464 self
::$idCacheByName[$name] = $result;
466 if ( count( self
::$idCacheByName ) > 1000 ) {
467 self
::$idCacheByName = array();
474 * Reset the cache used in idFromName(). For use in tests.
476 public static function resetIdByNameCache() {
477 self
::$idCacheByName = array();
481 * Does the string match an anonymous IPv4 address?
483 * This function exists for username validation, in order to reject
484 * usernames which are similar in form to IP addresses. Strings such
485 * as 300.300.300.300 will return true because it looks like an IP
486 * address, despite not being strictly valid.
488 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
489 * address because the usemod software would "cloak" anonymous IP
490 * addresses like this, if we allowed accounts like this to be created
491 * new users could get the old edits of these anonymous users.
493 * @param $name String to match
496 static function isIP( $name ) {
497 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
501 * Is the input a valid username?
503 * Checks if the input is a valid username, we don't want an empty string,
504 * an IP address, anything that containins slashes (would mess up subpages),
505 * is longer than the maximum allowed username size or doesn't begin with
508 * @param $name String to match
511 static function isValidUserName( $name ) {
512 global $wgContLang, $wgMaxNameChars;
515 || User
::isIP( $name )
516 ||
strpos( $name, '/' ) !== false
517 ||
strlen( $name ) > $wgMaxNameChars
518 ||
$name != $wgContLang->ucfirst( $name ) ) {
519 wfDebugLog( 'username', __METHOD__
.
520 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
524 // Ensure that the name can't be misresolved as a different title,
525 // such as with extra namespace keys at the start.
526 $parsed = Title
::newFromText( $name );
527 if( is_null( $parsed )
528 ||
$parsed->getNamespace()
529 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
530 wfDebugLog( 'username', __METHOD__
.
531 ": '$name' invalid due to ambiguous prefixes" );
535 // Check an additional blacklist of troublemaker characters.
536 // Should these be merged into the title char list?
537 $unicodeBlacklist = '/[' .
538 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
539 '\x{00a0}' . # non-breaking space
540 '\x{2000}-\x{200f}' . # various whitespace
541 '\x{2028}-\x{202f}' . # breaks and control chars
542 '\x{3000}' . # ideographic space
543 '\x{e000}-\x{f8ff}' . # private use
545 if( preg_match( $unicodeBlacklist, $name ) ) {
546 wfDebugLog( 'username', __METHOD__
.
547 ": '$name' invalid due to blacklisted characters" );
555 * Usernames which fail to pass this function will be blocked
556 * from user login and new account registrations, but may be used
557 * internally by batch processes.
559 * If an account already exists in this form, login will be blocked
560 * by a failure to pass this function.
562 * @param $name String to match
565 static function isUsableName( $name ) {
566 global $wgReservedUsernames;
567 // Must be a valid username, obviously ;)
568 if ( !self
::isValidUserName( $name ) ) {
572 static $reservedUsernames = false;
573 if ( !$reservedUsernames ) {
574 $reservedUsernames = $wgReservedUsernames;
575 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
578 // Certain names may be reserved for batch processes.
579 foreach ( $reservedUsernames as $reserved ) {
580 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
581 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
583 if ( $reserved == $name ) {
591 * Usernames which fail to pass this function will be blocked
592 * from new account registrations, but may be used internally
593 * either by batch processes or by user accounts which have
594 * already been created.
596 * Additional blacklisting may be added here rather than in
597 * isValidUserName() to avoid disrupting existing accounts.
599 * @param $name String to match
602 static function isCreatableName( $name ) {
603 global $wgInvalidUsernameCharacters;
605 // Ensure that the username isn't longer than 235 bytes, so that
606 // (at least for the builtin skins) user javascript and css files
607 // will work. (bug 23080)
608 if( strlen( $name ) > 235 ) {
609 wfDebugLog( 'username', __METHOD__
.
610 ": '$name' invalid due to length" );
614 // Preg yells if you try to give it an empty string
615 if( $wgInvalidUsernameCharacters !== '' ) {
616 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
617 wfDebugLog( 'username', __METHOD__
.
618 ": '$name' invalid due to wgInvalidUsernameCharacters" );
623 return self
::isUsableName( $name );
627 * Is the input a valid password for this user?
629 * @param $password String Desired password
632 function isValidPassword( $password ) {
633 //simple boolean wrapper for getPasswordValidity
634 return $this->getPasswordValidity( $password ) === true;
638 * Given unvalidated password input, return error message on failure.
640 * @param $password String Desired password
641 * @return mixed: true on success, string or array of error message on failure
643 function getPasswordValidity( $password ) {
644 global $wgMinimalPasswordLength, $wgContLang;
646 static $blockedLogins = array(
647 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
648 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
651 $result = false; //init $result to false for the internal checks
653 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
656 if ( $result === false ) {
657 if( strlen( $password ) < $wgMinimalPasswordLength ) {
658 return 'passwordtooshort';
659 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
660 return 'password-name-match';
661 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
662 return 'password-login-forbidden';
664 //it seems weird returning true here, but this is because of the
665 //initialization of $result to false above. If the hook is never run or it
666 //doesn't modify $result, then we will likely get down into this if with
670 } elseif( $result === true ) {
673 return $result; //the isValidPassword hook set a string $result and returned true
678 * Does a string look like an e-mail address?
680 * This validates an email address using an HTML5 specification found at:
681 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
682 * Which as of 2011-01-24 says:
684 * A valid e-mail address is a string that matches the ABNF production
685 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
686 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
689 * This function is an implementation of the specification as requested in
692 * Client-side forms will use the same standard validation rules via JS or
693 * HTML 5 validation; additional restrictions can be enforced server-side
694 * by extensions via the 'isValidEmailAddr' hook.
696 * Note that this validation doesn't 100% match RFC 2822, but is believed
697 * to be liberal enough for wide use. Some invalid addresses will still
698 * pass validation here.
700 * @param $addr String E-mail address
702 * @deprecated since 1.18 call Sanitizer::isValidEmail() directly
704 public static function isValidEmailAddr( $addr ) {
705 return Sanitizer
::validateEmail( $addr );
709 * Given unvalidated user input, return a canonical username, or false if
710 * the username is invalid.
711 * @param $name String User input
712 * @param $validate String|Bool type of validation to use:
713 * - false No validation
714 * - 'valid' Valid for batch processes
715 * - 'usable' Valid for batch processes and login
716 * - 'creatable' Valid for batch processes, login and account creation
718 static function getCanonicalName( $name, $validate = 'valid' ) {
719 # Force usernames to capital
721 $name = $wgContLang->ucfirst( $name );
723 # Reject names containing '#'; these will be cleaned up
724 # with title normalisation, but then it's too late to
726 if( strpos( $name, '#' ) !== false )
729 # Clean up name according to title rules
730 $t = ( $validate === 'valid' ) ?
731 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
732 # Check for invalid titles
733 if( is_null( $t ) ) {
737 # Reject various classes of invalid names
739 $name = $wgAuth->getCanonicalName( $t->getText() );
741 switch ( $validate ) {
745 if ( !User
::isValidUserName( $name ) ) {
750 if ( !User
::isUsableName( $name ) ) {
755 if ( !User
::isCreatableName( $name ) ) {
760 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
766 * Count the number of edits of a user
767 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
769 * @param $uid Int User ID to check
770 * @return Int the user's edit count
772 static function edits( $uid ) {
773 wfProfileIn( __METHOD__
);
774 $dbr = wfGetDB( DB_SLAVE
);
775 // check if the user_editcount field has been initialized
776 $field = $dbr->selectField(
777 'user', 'user_editcount',
778 array( 'user_id' => $uid ),
782 if( $field === null ) { // it has not been initialized. do so.
783 $dbw = wfGetDB( DB_MASTER
);
784 $count = $dbr->selectField(
785 'revision', 'count(*)',
786 array( 'rev_user' => $uid ),
791 array( 'user_editcount' => $count ),
792 array( 'user_id' => $uid ),
798 wfProfileOut( __METHOD__
);
803 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
804 * @todo hash random numbers to improve security, like generateToken()
806 * @return String new random password
808 static function randomPassword() {
809 global $wgMinimalPasswordLength;
810 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
811 $l = strlen( $pwchars ) - 1;
813 $pwlength = max( 7, $wgMinimalPasswordLength );
814 $digit = mt_rand( 0, $pwlength - 1 );
816 for ( $i = 0; $i < $pwlength; $i++
) {
817 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars[ mt_rand( 0, $l ) ];
823 * Set cached properties to default.
825 * @note This no longer clears uncached lazy-initialised properties;
826 * the constructor does that instead.
829 function loadDefaults( $name = false ) {
830 wfProfileIn( __METHOD__
);
835 $this->mName
= $name;
836 $this->mRealName
= '';
837 $this->mPassword
= $this->mNewpassword
= '';
838 $this->mNewpassTime
= null;
840 $this->mOptionOverrides
= null;
841 $this->mOptionsLoaded
= false;
843 if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) {
844 $this->mTouched
= wfTimestamp( TS_MW
, $wgRequest->getCookie( 'LoggedOut' ) );
846 $this->mTouched
= '0'; # Allow any pages to be cached
849 $this->setToken(); # Random
850 $this->mEmailAuthenticated
= null;
851 $this->mEmailToken
= '';
852 $this->mEmailTokenExpires
= null;
853 $this->mRegistration
= wfTimestamp( TS_MW
);
854 $this->mGroups
= array();
856 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
858 wfProfileOut( __METHOD__
);
862 * Return whether an item has been loaded.
864 * @param $item String: item to check. Current possibilities:
868 * @param $all String: 'all' to check if the whole object has been loaded
869 * or any other string to check if only the item is available (e.g.
873 public function isItemLoaded( $item, $all = 'all' ) {
874 return ( $this->mLoadedItems
=== true && $all === 'all' ) ||
875 ( isset( $this->mLoadedItems
[$item] ) && $this->mLoadedItems
[$item] === true );
879 * Set that an item has been loaded
881 * @param $item String
883 private function setItemLoaded( $item ) {
884 if ( is_array( $this->mLoadedItems
) ) {
885 $this->mLoadedItems
[$item] = true;
890 * Load user data from the session or login cookie. If there are no valid
891 * credentials, initialises the user as an anonymous user.
892 * @return Bool True if the user is logged in, false otherwise.
894 private function loadFromSession() {
895 global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy;
898 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
899 if ( $result !== null ) {
903 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
904 $extUser = ExternalUser
::newFromCookie();
906 # TODO: Automatically create the user here (or probably a bit
907 # lower down, in fact)
911 $cookieId = $wgRequest->getCookie( 'UserID' );
912 $sessId = $wgRequest->getSessionData( 'wsUserID' );
914 if ( $cookieId !== null ) {
915 $sId = intval( $cookieId );
916 if( $sessId !== null && $cookieId != $sessId ) {
917 $this->loadDefaults(); // Possible collision!
918 wfDebugLog( 'loginSessions', "Session user ID ($sessId) and
919 cookie user ID ($sId) don't match!" );
922 $wgRequest->setSessionData( 'wsUserID', $sId );
923 } else if ( $sessId !== null && $sessId != 0 ) {
926 $this->loadDefaults();
930 if ( $wgRequest->getSessionData( 'wsUserName' ) !== null ) {
931 $sName = $wgRequest->getSessionData( 'wsUserName' );
932 } else if ( $wgRequest->getCookie( 'UserName' ) !== null ) {
933 $sName = $wgRequest->getCookie( 'UserName' );
934 $wgRequest->setSessionData( 'wsUserName', $sName );
936 $this->loadDefaults();
941 if ( !$this->loadFromId() ) {
942 # Not a valid ID, loadFromId has switched the object to anon for us
946 global $wgBlockDisablesLogin;
947 if( $wgBlockDisablesLogin && $this->isBlocked() ) {
948 # User blocked and we've disabled blocked user logins
949 $this->loadDefaults();
953 if ( $wgRequest->getSessionData( 'wsToken' ) !== null ) {
954 $passwordCorrect = $this->mToken
== $wgRequest->getSessionData( 'wsToken' );
956 } else if ( $wgRequest->getCookie( 'Token' ) !== null ) {
957 $passwordCorrect = $this->mToken
== $wgRequest->getCookie( 'Token' );
960 # No session or persistent login cookie
961 $this->loadDefaults();
965 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
966 $wgRequest->setSessionData( 'wsToken', $this->mToken
);
967 wfDebug( "User: logged in from $from\n" );
970 # Invalid credentials
971 wfDebug( "User: can't log in from $from, invalid credentials\n" );
972 $this->loadDefaults();
978 * Load user and user_group data from the database.
979 * $this->mId must be set, this is how the user is identified.
981 * @return Bool True if the user exists, false if the user is anonymous
984 function loadFromDatabase() {
986 $this->mId
= intval( $this->mId
);
988 /** Anonymous user */
990 $this->loadDefaults();
994 $dbr = wfGetDB( DB_MASTER
);
995 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
997 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
999 if ( $s !== false ) {
1000 # Initialise user table data
1001 $this->loadFromRow( $s );
1002 $this->mGroups
= null; // deferred
1003 $this->getEditCount(); // revalidation for nulls
1008 $this->loadDefaults();
1014 * Initialize this object from a row from the user table.
1016 * @param $row Array Row from the user table to load.
1018 function loadFromRow( $row ) {
1021 if ( isset( $row->user_name
) ) {
1022 $this->mName
= $row->user_name
;
1023 $this->mFrom
= 'name';
1024 $this->setItemLoaded( 'name' );
1029 if ( isset( $row->user_name
) ) {
1030 $this->mRealName
= $row->user_real_name
;
1031 $this->setItemLoaded( 'realname' );
1036 if ( isset( $row->user_id
) ) {
1037 $this->mId
= intval( $row->user_id
);
1038 $this->mFrom
= 'id';
1039 $this->setItemLoaded( 'id' );
1044 if ( isset( $row->user_password
) ) {
1045 $this->mPassword
= $row->user_password
;
1046 $this->mNewpassword
= $row->user_newpassword
;
1047 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1048 $this->mEmail
= $row->user_email
;
1049 $this->decodeOptions( $row->user_options
);
1050 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
1051 $this->mToken
= $row->user_token
;
1052 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1053 $this->mEmailToken
= $row->user_email_token
;
1054 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1055 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1056 $this->mEditCount
= $row->user_editcount
;
1062 $this->mLoadedItems
= true;
1067 * Load the groups from the database if they aren't already loaded.
1070 function loadGroups() {
1071 if ( is_null( $this->mGroups
) ) {
1072 $dbr = wfGetDB( DB_MASTER
);
1073 $res = $dbr->select( 'user_groups',
1074 array( 'ug_group' ),
1075 array( 'ug_user' => $this->mId
),
1077 $this->mGroups
= array();
1078 foreach ( $res as $row ) {
1079 $this->mGroups
[] = $row->ug_group
;
1085 * Clear various cached data stored in this object.
1086 * @param $reloadFrom String Reload user and user_groups table data from a
1087 * given source. May be "name", "id", "defaults", "session", or false for
1090 function clearInstanceCache( $reloadFrom = false ) {
1091 $this->mNewtalk
= -1;
1092 $this->mDatePreference
= null;
1093 $this->mBlockedby
= -1; # Unset
1094 $this->mHash
= false;
1095 $this->mSkin
= null;
1096 $this->mRights
= null;
1097 $this->mEffectiveGroups
= null;
1098 $this->mOptions
= null;
1100 if ( $reloadFrom ) {
1101 $this->mLoadedItems
= array();
1102 $this->mFrom
= $reloadFrom;
1107 * Combine the language default options with any site-specific options
1108 * and add the default language variants.
1110 * @return Array of String options
1112 static function getDefaultOptions() {
1113 global $wgNamespacesToBeSearchedDefault;
1115 * Site defaults will override the global/language defaults
1117 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1118 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1121 * default language setting
1123 $variant = $wgContLang->getDefaultVariant();
1124 $defOpt['variant'] = $variant;
1125 $defOpt['language'] = $variant;
1126 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1127 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1129 $defOpt['skin'] = $wgDefaultSkin;
1135 * Get a given default option value.
1137 * @param $opt String Name of option to retrieve
1138 * @return String Default option value
1140 public static function getDefaultOption( $opt ) {
1141 $defOpts = self
::getDefaultOptions();
1142 if( isset( $defOpts[$opt] ) ) {
1143 return $defOpts[$opt];
1151 * Get blocking information
1153 * @param $bFromSlave Bool Whether to check the slave database first. To
1154 * improve performance, non-critical checks are done
1155 * against slaves. Check when actually saving should be
1156 * done against master.
1158 function getBlockedStatus( $bFromSlave = true ) {
1159 global $wgProxyWhitelist, $wgUser;
1161 if ( -1 != $this->mBlockedby
) {
1165 wfProfileIn( __METHOD__
);
1166 wfDebug( __METHOD__
.": checking...\n" );
1168 // Initialize data...
1169 // Otherwise something ends up stomping on $this->mBlockedby when
1170 // things get lazy-loaded later, causing false positive block hits
1171 // due to -1 !== 0. Probably session-related... Nothing should be
1172 // overwriting mBlockedby, surely?
1175 $this->mBlockedby
= 0;
1176 $this->mHideName
= 0;
1177 $this->mAllowUsertalk
= 0;
1179 # We only need to worry about passing the IP address to the Block generator if the
1180 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1181 # know which IP address they're actually coming from
1182 if ( !$this->isAllowed( 'ipblock-exempt' ) && $this->getID() == $wgUser->getID() ) {
1189 $this->mBlock
= Block
::newFromTarget( $this->getName(), $ip, !$bFromSlave );
1190 if ( $this->mBlock
instanceof Block
) {
1191 wfDebug( __METHOD__
. ": Found block.\n" );
1192 $this->mBlockedby
= $this->mBlock
->getBlocker()->getName();
1193 $this->mBlockreason
= $this->mBlock
->mReason
;
1194 $this->mHideName
= $this->mBlock
->mHideName
;
1195 $this->mAllowUsertalk
= !$this->mBlock
->prevents( 'editownusertalk' );
1196 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1197 $this->spreadBlock();
1202 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1204 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1205 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1206 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1210 if ( !$this->mBlockedby
&& !$this->getID() ) {
1211 if ( $this->isDnsBlacklisted( $ip ) ) {
1212 $this->mBlockedby
= wfMsg( 'sorbs' );
1213 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1219 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1221 wfProfileOut( __METHOD__
);
1225 * Whether the given IP is in a DNS blacklist.
1227 * @param $ip String IP to check
1228 * @param $checkWhitelist Bool: whether to check the whitelist first
1229 * @return Bool True if blacklisted.
1231 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1232 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1233 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1235 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1238 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1241 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1242 return $this->inDnsBlacklist( $ip, $urls );
1246 * Whether the given IP is in a given DNS blacklist.
1248 * @param $ip String IP to check
1249 * @param $bases String|Array of Strings: URL of the DNS blacklist
1250 * @return Bool True if blacklisted.
1252 function inDnsBlacklist( $ip, $bases ) {
1253 wfProfileIn( __METHOD__
);
1256 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1257 if( IP
::isIPv4( $ip ) ) {
1258 # Reverse IP, bug 21255
1259 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1261 foreach( (array)$bases as $base ) {
1263 $host = "$ipReversed.$base";
1266 $ipList = gethostbynamel( $host );
1269 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1273 wfDebug( "Requested $host, not found in $base.\n" );
1278 wfProfileOut( __METHOD__
);
1283 * Is this user subject to rate limiting?
1285 * @return Bool True if rate limited
1287 public function isPingLimitable() {
1288 global $wgRateLimitsExcludedGroups;
1289 global $wgRateLimitsExcludedIPs;
1290 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1291 // Deprecated, but kept for backwards-compatibility config
1294 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1295 // No other good way currently to disable rate limits
1296 // for specific IPs. :P
1297 // But this is a crappy hack and should die.
1300 return !$this->isAllowed('noratelimit');
1304 * Primitive rate limits: enforce maximum actions per time period
1305 * to put a brake on flooding.
1307 * @note When using a shared cache like memcached, IP-address
1308 * last-hit counters will be shared across wikis.
1310 * @param $action String Action to enforce; 'edit' if unspecified
1311 * @return Bool True if a rate limiter was tripped
1313 function pingLimiter( $action = 'edit' ) {
1314 # Call the 'PingLimiter' hook
1316 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1320 global $wgRateLimits;
1321 if( !isset( $wgRateLimits[$action] ) ) {
1325 # Some groups shouldn't trigger the ping limiter, ever
1326 if( !$this->isPingLimitable() )
1329 global $wgMemc, $wgRateLimitLog;
1330 wfProfileIn( __METHOD__
);
1332 $limits = $wgRateLimits[$action];
1334 $id = $this->getId();
1338 if( isset( $limits['anon'] ) && $id == 0 ) {
1339 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1342 if( isset( $limits['user'] ) && $id != 0 ) {
1343 $userLimit = $limits['user'];
1345 if( $this->isNewbie() ) {
1346 if( isset( $limits['newbie'] ) && $id != 0 ) {
1347 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1349 if( isset( $limits['ip'] ) ) {
1350 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1353 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1354 $subnet = $matches[1];
1355 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1358 // Check for group-specific permissions
1359 // If more than one group applies, use the group with the highest limit
1360 foreach ( $this->getGroups() as $group ) {
1361 if ( isset( $limits[$group] ) ) {
1362 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1363 $userLimit = $limits[$group];
1367 // Set the user limit key
1368 if ( $userLimit !== false ) {
1369 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1370 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1374 foreach( $keys as $key => $limit ) {
1375 list( $max, $period ) = $limit;
1376 $summary = "(limit $max in {$period}s)";
1377 $count = $wgMemc->get( $key );
1380 if( $count > $max ) {
1381 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1382 if( $wgRateLimitLog ) {
1383 @file_put_contents
( $wgRateLimitLog, wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", FILE_APPEND
);
1387 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1390 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1391 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1393 $wgMemc->incr( $key );
1396 wfProfileOut( __METHOD__
);
1401 * Check if user is blocked
1403 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1404 * @return Bool True if blocked, false otherwise
1406 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1407 $this->getBlockedStatus( $bFromSlave );
1408 return $this->mBlock
instanceof Block
&& $this->mBlock
->prevents( 'edit' );
1412 * Check if user is blocked from editing a particular article
1414 * @param $title Title to check
1415 * @param $bFromSlave Bool whether to check the slave database instead of the master
1418 function isBlockedFrom( $title, $bFromSlave = false ) {
1419 global $wgBlockAllowsUTEdit;
1420 wfProfileIn( __METHOD__
);
1422 $blocked = $this->isBlocked( $bFromSlave );
1423 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1424 # If a user's name is suppressed, they cannot make edits anywhere
1425 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1426 $title->getNamespace() == NS_USER_TALK
) {
1428 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1431 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1433 wfProfileOut( __METHOD__
);
1438 * If user is blocked, return the name of the user who placed the block
1439 * @return String name of blocker
1441 function blockedBy() {
1442 $this->getBlockedStatus();
1443 return $this->mBlockedby
;
1447 * If user is blocked, return the specified reason for the block
1448 * @return String Blocking reason
1450 function blockedFor() {
1451 $this->getBlockedStatus();
1452 return $this->mBlockreason
;
1456 * If user is blocked, return the ID for the block
1457 * @return Int Block ID
1459 function getBlockId() {
1460 $this->getBlockedStatus();
1461 return ( $this->mBlock ?
$this->mBlock
->getId() : false );
1465 * Check if user is blocked on all wikis.
1466 * Do not use for actual edit permission checks!
1467 * This is intented for quick UI checks.
1469 * @param $ip String IP address, uses current client if none given
1470 * @return Bool True if blocked, false otherwise
1472 function isBlockedGlobally( $ip = '' ) {
1473 if( $this->mBlockedGlobally
!== null ) {
1474 return $this->mBlockedGlobally
;
1476 // User is already an IP?
1477 if( IP
::isIPAddress( $this->getName() ) ) {
1478 $ip = $this->getName();
1483 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1484 $this->mBlockedGlobally
= (bool)$blocked;
1485 return $this->mBlockedGlobally
;
1489 * Check if user account is locked
1491 * @return Bool True if locked, false otherwise
1493 function isLocked() {
1494 if( $this->mLocked
!== null ) {
1495 return $this->mLocked
;
1498 $authUser = $wgAuth->getUserInstance( $this );
1499 $this->mLocked
= (bool)$authUser->isLocked();
1500 return $this->mLocked
;
1504 * Check if user account is hidden
1506 * @return Bool True if hidden, false otherwise
1508 function isHidden() {
1509 if( $this->mHideName
!== null ) {
1510 return $this->mHideName
;
1512 $this->getBlockedStatus();
1513 if( !$this->mHideName
) {
1515 $authUser = $wgAuth->getUserInstance( $this );
1516 $this->mHideName
= (bool)$authUser->isHidden();
1518 return $this->mHideName
;
1522 * Get the user's ID.
1523 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1526 if( $this->mId
=== null && $this->mName
!== null
1527 && User
::isIP( $this->mName
) ) {
1528 // Special case, we know the user is anonymous
1530 } elseif( !$this->isItemLoaded( 'id' ) ) {
1531 // Don't load if this was initialized from an ID
1538 * Set the user and reload all fields according to a given ID
1539 * @param $v Int User ID to reload
1541 function setId( $v ) {
1543 $this->clearInstanceCache( 'id' );
1547 * Get the user name, or the IP of an anonymous user
1548 * @return String User's name or IP address
1550 function getName() {
1551 if ( $this->isItemLoaded( 'name', 'only' ) ) {
1552 # Special case optimisation
1553 return $this->mName
;
1556 if ( $this->mName
=== false ) {
1558 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1560 return $this->mName
;
1565 * Set the user name.
1567 * This does not reload fields from the database according to the given
1568 * name. Rather, it is used to create a temporary "nonexistent user" for
1569 * later addition to the database. It can also be used to set the IP
1570 * address for an anonymous user to something other than the current
1573 * @note User::newFromName() has rougly the same function, when the named user
1575 * @param $str String New user name to set
1577 function setName( $str ) {
1579 $this->mName
= $str;
1583 * Get the user's name escaped by underscores.
1584 * @return String Username escaped by underscores.
1586 function getTitleKey() {
1587 return str_replace( ' ', '_', $this->getName() );
1591 * Check if the user has new messages.
1592 * @return Bool True if the user has new messages
1594 function getNewtalk() {
1597 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1598 if( $this->mNewtalk
=== -1 ) {
1599 $this->mNewtalk
= false; # reset talk page status
1601 # Check memcached separately for anons, who have no
1602 # entire User object stored in there.
1605 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1606 $newtalk = $wgMemc->get( $key );
1607 if( strval( $newtalk ) !== '' ) {
1608 $this->mNewtalk
= (bool)$newtalk;
1610 // Since we are caching this, make sure it is up to date by getting it
1612 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1613 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1616 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1620 return (bool)$this->mNewtalk
;
1624 * Return the talk page(s) this user has new messages on.
1625 * @return Array of String page URLs
1627 function getNewMessageLinks() {
1629 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1632 if( !$this->getNewtalk() )
1634 $up = $this->getUserPage();
1635 $utp = $up->getTalkPage();
1636 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1640 * Internal uncached check for new messages
1643 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1644 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1645 * @param $fromMaster Bool true to fetch from the master, false for a slave
1646 * @return Bool True if the user has new messages
1649 function checkNewtalk( $field, $id, $fromMaster = false ) {
1650 if ( $fromMaster ) {
1651 $db = wfGetDB( DB_MASTER
);
1653 $db = wfGetDB( DB_SLAVE
);
1655 $ok = $db->selectField( 'user_newtalk', $field,
1656 array( $field => $id ), __METHOD__
);
1657 return $ok !== false;
1661 * Add or update the new messages flag
1662 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1663 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1664 * @return Bool True if successful, false otherwise
1667 function updateNewtalk( $field, $id ) {
1668 $dbw = wfGetDB( DB_MASTER
);
1669 $dbw->insert( 'user_newtalk',
1670 array( $field => $id ),
1673 if ( $dbw->affectedRows() ) {
1674 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1677 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1683 * Clear the new messages flag for the given user
1684 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1685 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1686 * @return Bool True if successful, false otherwise
1689 function deleteNewtalk( $field, $id ) {
1690 $dbw = wfGetDB( DB_MASTER
);
1691 $dbw->delete( 'user_newtalk',
1692 array( $field => $id ),
1694 if ( $dbw->affectedRows() ) {
1695 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1698 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1704 * Update the 'You have new messages!' status.
1705 * @param $val Bool Whether the user has new messages
1707 function setNewtalk( $val ) {
1708 if( wfReadOnly() ) {
1713 $this->mNewtalk
= $val;
1715 if( $this->isAnon() ) {
1717 $id = $this->getName();
1720 $id = $this->getId();
1725 $changed = $this->updateNewtalk( $field, $id );
1727 $changed = $this->deleteNewtalk( $field, $id );
1730 if( $this->isAnon() ) {
1731 // Anons have a separate memcached space, since
1732 // user records aren't kept for them.
1733 $key = wfMemcKey( 'newtalk', 'ip', $id );
1734 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1737 $this->invalidateCache( true );
1742 * Generate a current or new-future timestamp to be stored in the
1743 * user_touched field when we update things.
1744 * @return String Timestamp in TS_MW format
1746 private static function newTouchedTimestamp() {
1747 global $wgClockSkewFudge;
1748 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1752 * Clear user data from memcached.
1753 * Use after applying fun updates to the database; caller's
1754 * responsibility to update user_touched if appropriate.
1756 * Called implicitly from invalidateCache() and saveSettings().
1758 private function clearSharedCache() {
1762 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1767 * Immediately touch the user data cache for this account.
1768 * Updates user_touched field, and removes account data from memcached
1769 * for reload on the next hit.
1771 * @param $doDatabaseUpdate bool Do you really need to update the database? Really?
1773 function invalidateCache( $doDatabaseUpdate = false ) {
1774 if( wfReadOnly() ) {
1778 if( $this->mId
&& $doDatabaseUpdate ) {
1779 $this->mTouched
= self
::newTouchedTimestamp();
1781 $dbw = wfGetDB( DB_MASTER
);
1782 $dbw->update( 'user',
1783 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1784 array( 'user_id' => $this->mId
),
1787 $this->clearSharedCache();
1792 * Validate the cache for this account.
1793 * @param $timestamp String A timestamp in TS_MW format
1795 function validateCache( $timestamp ) {
1797 return ( $timestamp >= $this->mTouched
);
1801 * Get the user touched timestamp
1802 * @return String timestamp
1804 function getTouched() {
1806 return $this->mTouched
;
1810 * Set the password and reset the random token.
1811 * Calls through to authentication plugin if necessary;
1812 * will have no effect if the auth plugin refuses to
1813 * pass the change through or if the legal password
1816 * As a special case, setting the password to null
1817 * wipes it, so the account cannot be logged in until
1818 * a new password is set, for instance via e-mail.
1820 * @param $str String New password to set
1821 * @throws PasswordError on failure
1823 function setPassword( $str ) {
1826 if( $str !== null ) {
1827 if( !$wgAuth->allowPasswordChange() ) {
1828 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1831 if( !$this->isValidPassword( $str ) ) {
1832 global $wgMinimalPasswordLength;
1833 $valid = $this->getPasswordValidity( $str );
1834 if ( is_array( $valid ) ) {
1835 $message = array_shift( $valid );
1839 $params = array( $wgMinimalPasswordLength );
1841 throw new PasswordError( wfMsgExt( $message, array( 'parsemag' ), $params ) );
1845 if( !$wgAuth->setPassword( $this, $str ) ) {
1846 throw new PasswordError( wfMsg( 'externaldberror' ) );
1849 $this->setInternalPassword( $str );
1855 * Set the password and reset the random token unconditionally.
1857 * @param $str String New password to set
1859 function setInternalPassword( $str ) {
1863 if( $str === null ) {
1864 // Save an invalid hash...
1865 $this->mPassword
= '';
1867 $this->mPassword
= self
::crypt( $str );
1869 $this->mNewpassword
= '';
1870 $this->mNewpassTime
= null;
1874 * Get the user's current token.
1875 * @return String Token
1877 function getToken() {
1879 return $this->mToken
;
1883 * Set the random token (used for persistent authentication)
1884 * Called from loadDefaults() among other places.
1886 * @param $token String If specified, set the token to this value
1889 function setToken( $token = false ) {
1890 global $wgSecretKey, $wgProxyKey;
1893 if ( $wgSecretKey ) {
1894 $key = $wgSecretKey;
1895 } elseif ( $wgProxyKey ) {
1900 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1902 $this->mToken
= $token;
1907 * Set the cookie password
1909 * @param $str String New cookie password
1912 function setCookiePassword( $str ) {
1914 $this->mCookiePassword
= md5( $str );
1918 * Set the password for a password reminder or new account email
1920 * @param $str String New password to set
1921 * @param $throttle Bool If true, reset the throttle timestamp to the present
1923 function setNewpassword( $str, $throttle = true ) {
1925 $this->mNewpassword
= self
::crypt( $str );
1927 $this->mNewpassTime
= wfTimestampNow();
1932 * Has password reminder email been sent within the last
1933 * $wgPasswordReminderResendTime hours?
1936 function isPasswordReminderThrottled() {
1937 global $wgPasswordReminderResendTime;
1939 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1942 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1943 return time() < $expiry;
1947 * Get the user's e-mail address
1948 * @return String User's email address
1950 function getEmail() {
1952 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1953 return $this->mEmail
;
1957 * Get the timestamp of the user's e-mail authentication
1958 * @return String TS_MW timestamp
1960 function getEmailAuthenticationTimestamp() {
1962 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1963 return $this->mEmailAuthenticated
;
1967 * Set the user's e-mail address
1968 * @param $str String New e-mail address
1970 function setEmail( $str ) {
1972 $this->mEmail
= $str;
1973 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1977 * Get the user's real name
1978 * @return String User's real name
1980 function getRealName() {
1981 if ( !$this->isItemLoaded( 'realname' ) ) {
1985 return $this->mRealName
;
1989 * Set the user's real name
1990 * @param $str String New real name
1992 function setRealName( $str ) {
1994 $this->mRealName
= $str;
1998 * Get the user's current setting for a given option.
2000 * @param $oname String The option to check
2001 * @param $defaultOverride String A default value returned if the option does not exist
2002 * @param $ignoreHidden Bool = whether to ignore the effects of $wgHiddenPrefs
2003 * @return String User's current value for the option
2004 * @see getBoolOption()
2005 * @see getIntOption()
2007 function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2008 global $wgHiddenPrefs;
2009 $this->loadOptions();
2011 if ( is_null( $this->mOptions
) ) {
2012 if($defaultOverride != '') {
2013 return $defaultOverride;
2015 $this->mOptions
= User
::getDefaultOptions();
2018 # We want 'disabled' preferences to always behave as the default value for
2019 # users, even if they have set the option explicitly in their settings (ie they
2020 # set it, and then it was disabled removing their ability to change it). But
2021 # we don't want to erase the preferences in the database in case the preference
2022 # is re-enabled again. So don't touch $mOptions, just override the returned value
2023 if( in_array( $oname, $wgHiddenPrefs ) && !$ignoreHidden ){
2024 return self
::getDefaultOption( $oname );
2027 if ( array_key_exists( $oname, $this->mOptions
) ) {
2028 return $this->mOptions
[$oname];
2030 return $defaultOverride;
2035 * Get all user's options
2039 public function getOptions() {
2040 global $wgHiddenPrefs;
2041 $this->loadOptions();
2042 $options = $this->mOptions
;
2044 # We want 'disabled' preferences to always behave as the default value for
2045 # users, even if they have set the option explicitly in their settings (ie they
2046 # set it, and then it was disabled removing their ability to change it). But
2047 # we don't want to erase the preferences in the database in case the preference
2048 # is re-enabled again. So don't touch $mOptions, just override the returned value
2049 foreach( $wgHiddenPrefs as $pref ){
2050 $default = self
::getDefaultOption( $pref );
2051 if( $default !== null ){
2052 $options[$pref] = $default;
2060 * Get the user's current setting for a given option, as a boolean value.
2062 * @param $oname String The option to check
2063 * @return Bool User's current value for the option
2066 function getBoolOption( $oname ) {
2067 return (bool)$this->getOption( $oname );
2072 * Get the user's current setting for a given option, as a boolean value.
2074 * @param $oname String The option to check
2075 * @param $defaultOverride Int A default value returned if the option does not exist
2076 * @return Int User's current value for the option
2079 function getIntOption( $oname, $defaultOverride=0 ) {
2080 $val = $this->getOption( $oname );
2082 $val = $defaultOverride;
2084 return intval( $val );
2088 * Set the given option for a user.
2090 * @param $oname String The option to set
2091 * @param $val mixed New value to set
2093 function setOption( $oname, $val ) {
2095 $this->loadOptions();
2097 if ( $oname == 'skin' ) {
2098 # Clear cached skin, so the new one displays immediately in Special:Preferences
2099 $this->mSkin
= null;
2102 // Explicitly NULL values should refer to defaults
2103 global $wgDefaultUserOptions;
2104 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2105 $val = $wgDefaultUserOptions[$oname];
2108 $this->mOptions
[$oname] = $val;
2112 * Reset all options to the site defaults
2114 function resetOptions() {
2115 $this->mOptions
= self
::getDefaultOptions();
2119 * Get the user's preferred date format.
2120 * @return String User's preferred date format
2122 function getDatePreference() {
2123 // Important migration for old data rows
2124 if ( is_null( $this->mDatePreference
) ) {
2126 $value = $this->getOption( 'date' );
2127 $map = $wgLang->getDatePreferenceMigrationMap();
2128 if ( isset( $map[$value] ) ) {
2129 $value = $map[$value];
2131 $this->mDatePreference
= $value;
2133 return $this->mDatePreference
;
2137 * Get the user preferred stub threshold
2139 function getStubThreshold() {
2140 global $wgMaxArticleSize; # Maximum article size, in Kb
2141 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2142 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2143 # If they have set an impossible value, disable the preference
2144 # so we can use the parser cache again.
2151 * Get the permissions this user has.
2152 * @return Array of String permission names
2154 function getRights() {
2155 if ( is_null( $this->mRights
) ) {
2156 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2157 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2158 // Force reindexation of rights when a hook has unset one of them
2159 $this->mRights
= array_values( $this->mRights
);
2161 return $this->mRights
;
2165 * Get the list of explicit group memberships this user has.
2166 * The implicit * and user groups are not included.
2167 * @return Array of String internal group names
2169 function getGroups() {
2171 return $this->mGroups
;
2175 * Get the list of implicit group memberships this user has.
2176 * This includes all explicit groups, plus 'user' if logged in,
2177 * '*' for all accounts, and autopromoted groups
2178 * @param $recache Bool Whether to avoid the cache
2179 * @return Array of String internal group names
2181 function getEffectiveGroups( $recache = false ) {
2182 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2183 wfProfileIn( __METHOD__
);
2184 $this->mEffectiveGroups
= $this->getGroups();
2185 $this->mEffectiveGroups
[] = '*';
2186 if( $this->getId() ) {
2187 $this->mEffectiveGroups
[] = 'user';
2189 $this->mEffectiveGroups
= array_unique( array_merge(
2190 $this->mEffectiveGroups
,
2191 Autopromote
::getAutopromoteGroups( $this )
2194 # Hook for additional groups
2195 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2197 wfProfileOut( __METHOD__
);
2199 return $this->mEffectiveGroups
;
2203 * Get the user's edit count.
2206 function getEditCount() {
2207 if( $this->getId() ) {
2208 if ( !isset( $this->mEditCount
) ) {
2209 /* Populate the count, if it has not been populated yet */
2210 $this->mEditCount
= User
::edits( $this->mId
);
2212 return $this->mEditCount
;
2220 * Add the user to the given group.
2221 * This takes immediate effect.
2222 * @param $group String Name of the group to add
2224 function addGroup( $group ) {
2225 if( wfRunHooks( 'UserAddGroup', array( &$this, &$group ) ) ) {
2226 $dbw = wfGetDB( DB_MASTER
);
2227 if( $this->getId() ) {
2228 $dbw->insert( 'user_groups',
2230 'ug_user' => $this->getID(),
2231 'ug_group' => $group,
2234 array( 'IGNORE' ) );
2237 $this->loadGroups();
2238 $this->mGroups
[] = $group;
2239 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2241 $this->invalidateCache( true );
2245 * Remove the user from the given group.
2246 * This takes immediate effect.
2247 * @param $group String Name of the group to remove
2249 function removeGroup( $group ) {
2251 if( wfRunHooks( 'UserRemoveGroup', array( &$this, &$group ) ) ) {
2252 $dbw = wfGetDB( DB_MASTER
);
2253 $dbw->delete( 'user_groups',
2255 'ug_user' => $this->getID(),
2256 'ug_group' => $group,
2259 $this->loadGroups();
2260 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2261 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2263 $this->invalidateCache( true );
2267 * Get whether the user is logged in
2270 function isLoggedIn() {
2271 return $this->getID() != 0;
2275 * Get whether the user is anonymous
2279 return !$this->isLoggedIn();
2283 * Check if user is allowed to access a feature / make an action
2284 * @param varargs String permissions to test
2285 * @return Boolean: True if user is allowed to perform *any* of the given actions
2287 public function isAllowedAny( /*...*/ ){
2288 $permissions = func_get_args();
2289 foreach( $permissions as $permission ){
2290 if( $this->isAllowed( $permission ) ){
2298 * @param varargs String
2299 * @return bool True if the user is allowed to perform *all* of the given actions
2301 public function isAllowedAll( /*...*/ ){
2302 $permissions = func_get_args();
2303 foreach( $permissions as $permission ){
2304 if( !$this->isAllowed( $permission ) ){
2312 * Internal mechanics of testing a permission
2313 * @param $action String
2316 public function isAllowed( $action = '' ) {
2317 if ( $action === '' ) {
2318 return true; // In the spirit of DWIM
2320 # Patrolling may not be enabled
2321 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2322 global $wgUseRCPatrol, $wgUseNPPatrol;
2323 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2326 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2327 # by misconfiguration: 0 == 'foo'
2328 return in_array( $action, $this->getRights(), true );
2332 * Check whether to enable recent changes patrol features for this user
2333 * @return Boolean: True or false
2335 public function useRCPatrol() {
2336 global $wgUseRCPatrol;
2337 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
2341 * Check whether to enable new pages patrol features for this user
2342 * @return Bool True or false
2344 public function useNPPatrol() {
2345 global $wgUseRCPatrol, $wgUseNPPatrol;
2346 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) ) );
2350 * Get the current skin, loading it if required
2351 * @return Skin The current skin
2352 * @todo: FIXME : need to check the old failback system [AV]
2353 * @deprecated Use ->getSkin() in the most relevant outputting context you have
2355 function getSkin() {
2356 return RequestContext
::getMain()->getSkin();
2360 * Check the watched status of an article.
2361 * @param $title Title of the article to look at
2364 function isWatched( $title ) {
2365 $wl = WatchedItem
::fromUserTitle( $this, $title );
2366 return $wl->isWatched();
2371 * @param $title Title of the article to look at
2373 function addWatch( $title ) {
2374 $wl = WatchedItem
::fromUserTitle( $this, $title );
2376 $this->invalidateCache();
2380 * Stop watching an article.
2381 * @param $title Title of the article to look at
2383 function removeWatch( $title ) {
2384 $wl = WatchedItem
::fromUserTitle( $this, $title );
2386 $this->invalidateCache();
2390 * Clear the user's notification timestamp for the given title.
2391 * If e-notif e-mails are on, they will receive notification mails on
2392 * the next change of the page if it's watched etc.
2393 * @param $title Title of the article to look at
2395 function clearNotification( &$title ) {
2396 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2398 # Do nothing if the database is locked to writes
2399 if( wfReadOnly() ) {
2403 if( $title->getNamespace() == NS_USER_TALK
&&
2404 $title->getText() == $this->getName() ) {
2405 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2407 $this->setNewtalk( false );
2410 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2414 if( $this->isAnon() ) {
2415 // Nothing else to do...
2419 // Only update the timestamp if the page is being watched.
2420 // The query to find out if it is watched is cached both in memcached and per-invocation,
2421 // and when it does have to be executed, it can be on a slave
2422 // If this is the user's newtalk page, we always update the timestamp
2423 if( $title->getNamespace() == NS_USER_TALK
&&
2424 $title->getText() == $wgUser->getName() )
2427 } elseif ( $this->getId() == $wgUser->getId() ) {
2428 $watched = $title->userIsWatching();
2433 // If the page is watched by the user (or may be watched), update the timestamp on any
2434 // any matching rows
2436 $dbw = wfGetDB( DB_MASTER
);
2437 $dbw->update( 'watchlist',
2439 'wl_notificationtimestamp' => null
2440 ), array( /* WHERE */
2441 'wl_title' => $title->getDBkey(),
2442 'wl_namespace' => $title->getNamespace(),
2443 'wl_user' => $this->getID()
2450 * Resets all of the given user's page-change notification timestamps.
2451 * If e-notif e-mails are on, they will receive notification mails on
2452 * the next change of any watched page.
2454 * @param $currentUser Int User ID
2456 function clearAllNotifications( $currentUser ) {
2457 global $wgUseEnotif, $wgShowUpdatedMarker;
2458 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2459 $this->setNewtalk( false );
2462 if( $currentUser != 0 ) {
2463 $dbw = wfGetDB( DB_MASTER
);
2464 $dbw->update( 'watchlist',
2466 'wl_notificationtimestamp' => null
2467 ), array( /* WHERE */
2468 'wl_user' => $currentUser
2471 # We also need to clear here the "you have new message" notification for the own user_talk page
2472 # This is cleared one page view later in Article::viewUpdates();
2477 * Set this user's options from an encoded string
2478 * @param $str String Encoded options to import
2481 function decodeOptions( $str ) {
2485 $this->mOptionsLoaded
= true;
2486 $this->mOptionOverrides
= array();
2488 // If an option is not set in $str, use the default value
2489 $this->mOptions
= self
::getDefaultOptions();
2491 $a = explode( "\n", $str );
2492 foreach ( $a as $s ) {
2494 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2495 $this->mOptions
[$m[1]] = $m[2];
2496 $this->mOptionOverrides
[$m[1]] = $m[2];
2502 * Set a cookie on the user's client. Wrapper for
2503 * WebResponse::setCookie
2504 * @param $name String Name of the cookie to set
2505 * @param $value String Value to set
2506 * @param $exp Int Expiration time, as a UNIX time value;
2507 * if 0 or not specified, use the default $wgCookieExpiration
2509 protected function setCookie( $name, $value, $exp = 0 ) {
2511 $wgRequest->response()->setcookie( $name, $value, $exp );
2515 * Clear a cookie on the user's client
2516 * @param $name String Name of the cookie to clear
2518 protected function clearCookie( $name ) {
2519 $this->setCookie( $name, '', time() - 86400 );
2523 * Set the default cookies for this session on the user's client.
2525 * @param $request WebRequest object to use; $wgRequest will be used if null
2528 function setCookies( $request = null ) {
2529 if ( $request === null ) {
2531 $request = $wgRequest;
2535 if ( 0 == $this->mId
) return;
2537 'wsUserID' => $this->mId
,
2538 'wsToken' => $this->mToken
,
2539 'wsUserName' => $this->getName()
2542 'UserID' => $this->mId
,
2543 'UserName' => $this->getName(),
2545 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2546 $cookies['Token'] = $this->mToken
;
2548 $cookies['Token'] = false;
2551 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2553 foreach ( $session as $name => $value ) {
2554 $request->setSessionData( $name, $value );
2556 foreach ( $cookies as $name => $value ) {
2557 if ( $value === false ) {
2558 $this->clearCookie( $name );
2560 $this->setCookie( $name, $value );
2566 * Log this user out.
2569 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2575 * Clear the user's cookies and session, and reset the instance cache.
2579 function doLogout() {
2582 $this->clearInstanceCache( 'defaults' );
2584 $wgRequest->setSessionData( 'wsUserID', 0 );
2586 $this->clearCookie( 'UserID' );
2587 $this->clearCookie( 'Token' );
2589 # Remember when user logged out, to prevent seeing cached pages
2590 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2594 * Save this user's settings into the database.
2595 * @todo Only rarely do all these fields need to be set!
2597 function saveSettings() {
2599 if ( wfReadOnly() ) { return; }
2600 if ( 0 == $this->mId
) { return; }
2602 $this->mTouched
= self
::newTouchedTimestamp();
2604 $dbw = wfGetDB( DB_MASTER
);
2605 $dbw->update( 'user',
2607 'user_name' => $this->mName
,
2608 'user_password' => $this->mPassword
,
2609 'user_newpassword' => $this->mNewpassword
,
2610 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2611 'user_real_name' => $this->mRealName
,
2612 'user_email' => $this->mEmail
,
2613 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2614 'user_options' => '',
2615 'user_touched' => $dbw->timestamp( $this->mTouched
),
2616 'user_token' => $this->mToken
,
2617 'user_email_token' => $this->mEmailToken
,
2618 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2619 ), array( /* WHERE */
2620 'user_id' => $this->mId
2624 $this->saveOptions();
2626 wfRunHooks( 'UserSaveSettings', array( $this ) );
2627 $this->clearSharedCache();
2628 $this->getUserPage()->invalidateCache();
2632 * If only this user's username is known, and it exists, return the user ID.
2635 function idForName() {
2636 $s = trim( $this->getName() );
2637 if ( $s === '' ) return 0;
2639 $dbr = wfGetDB( DB_SLAVE
);
2640 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2641 if ( $id === false ) {
2648 * Add a user to the database, return the user object
2650 * @param $name String Username to add
2651 * @param $params Array of Strings Non-default parameters to save to the database as user_* fields:
2652 * - password The user's password hash. Password logins will be disabled if this is omitted.
2653 * - newpassword Hash for a temporary password that has been mailed to the user
2654 * - email The user's email address
2655 * - email_authenticated The email authentication timestamp
2656 * - real_name The user's real name
2657 * - options An associative array of non-default options
2658 * - token Random authentication token. Do not set.
2659 * - registration Registration timestamp. Do not set.
2661 * @return User object, or null if the username already exists
2663 static function createNew( $name, $params = array() ) {
2666 if ( isset( $params['options'] ) ) {
2667 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2668 unset( $params['options'] );
2670 $dbw = wfGetDB( DB_MASTER
);
2671 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2674 'user_id' => $seqVal,
2675 'user_name' => $name,
2676 'user_password' => $user->mPassword
,
2677 'user_newpassword' => $user->mNewpassword
,
2678 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2679 'user_email' => $user->mEmail
,
2680 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2681 'user_real_name' => $user->mRealName
,
2682 'user_options' => '',
2683 'user_token' => $user->mToken
,
2684 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2685 'user_editcount' => 0,
2687 foreach ( $params as $name => $value ) {
2688 $fields["user_$name"] = $value;
2690 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2691 if ( $dbw->affectedRows() ) {
2692 $newUser = User
::newFromId( $dbw->insertId() );
2700 * Add this existing user object to the database
2702 function addToDatabase() {
2704 $dbw = wfGetDB( DB_MASTER
);
2705 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2706 $dbw->insert( 'user',
2708 'user_id' => $seqVal,
2709 'user_name' => $this->mName
,
2710 'user_password' => $this->mPassword
,
2711 'user_newpassword' => $this->mNewpassword
,
2712 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2713 'user_email' => $this->mEmail
,
2714 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2715 'user_real_name' => $this->mRealName
,
2716 'user_options' => '',
2717 'user_token' => $this->mToken
,
2718 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2719 'user_editcount' => 0,
2722 $this->mId
= $dbw->insertId();
2724 // Clear instance cache other than user table data, which is already accurate
2725 $this->clearInstanceCache();
2727 $this->saveOptions();
2731 * If this (non-anonymous) user is blocked, block any IP address
2732 * they've successfully logged in from.
2734 function spreadBlock() {
2735 wfDebug( __METHOD__
. "()\n" );
2737 if ( $this->mId
== 0 ) {
2741 $userblock = Block
::newFromTarget( $this->getName() );
2742 if ( !$userblock ) {
2746 $userblock->doAutoblock( wfGetIP() );
2750 * Generate a string which will be different for any combination of
2751 * user options which would produce different parser output.
2752 * This will be used as part of the hash key for the parser cache,
2753 * so users with the same options can share the same cached data
2756 * Extensions which require it should install 'PageRenderingHash' hook,
2757 * which will give them a chance to modify this key based on their own
2760 * @deprecated since 1.17 use the ParserOptions object to get the relevant options
2761 * @return String Page rendering hash
2763 function getPageRenderingHash() {
2764 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2766 return $this->mHash
;
2768 wfDeprecated( __METHOD__
);
2770 // stubthreshold is only included below for completeness,
2771 // since it disables the parser cache, its value will always
2772 // be 0 when this function is called by parsercache.
2774 $confstr = $this->getOption( 'math' );
2775 $confstr .= '!' . $this->getStubThreshold();
2776 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2777 $confstr .= '!' . $this->getDatePreference();
2779 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2780 $confstr .= '!' . $wgLang->getCode();
2781 $confstr .= '!' . $this->getOption( 'thumbsize' );
2782 // add in language specific options, if any
2783 $extra = $wgContLang->getExtraHashOptions();
2786 // Since the skin could be overloading link(), it should be
2787 // included here but in practice, none of our skins do that.
2789 $confstr .= $wgRenderHashAppend;
2791 // Give a chance for extensions to modify the hash, if they have
2792 // extra options or other effects on the parser cache.
2793 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2795 // Make it a valid memcached key fragment
2796 $confstr = str_replace( ' ', '_', $confstr );
2797 $this->mHash
= $confstr;
2802 * Get whether the user is explicitly blocked from account creation.
2803 * @return Bool|Block
2805 function isBlockedFromCreateAccount() {
2806 $this->getBlockedStatus();
2807 if( $this->mBlock
&& $this->mBlock
->prevents( 'createaccount' ) ){
2808 return $this->mBlock
;
2811 # bug 13611: if the IP address the user is trying to create an account from is
2812 # blocked with createaccount disabled, prevent new account creation there even
2813 # when the user is logged in
2814 static $accBlock = false;
2815 if( $accBlock === false ){
2816 $accBlock = Block
::newFromTarget( null, wfGetIP() );
2818 return $accBlock instanceof Block
&& $accBlock->prevents( 'createaccount' )
2824 * Get whether the user is blocked from using Special:Emailuser.
2827 function isBlockedFromEmailuser() {
2828 $this->getBlockedStatus();
2829 return $this->mBlock
&& $this->mBlock
->prevents( 'sendemail' );
2833 * Get whether the user is allowed to create an account.
2836 function isAllowedToCreateAccount() {
2837 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2841 * Get this user's personal page title.
2843 * @return Title: User's personal page title
2845 function getUserPage() {
2846 return Title
::makeTitle( NS_USER
, $this->getName() );
2850 * Get this user's talk page title.
2852 * @return Title: User's talk page title
2854 function getTalkPage() {
2855 $title = $this->getUserPage();
2856 return $title->getTalkPage();
2860 * Get the maximum valid user ID.
2861 * @return Integer: User ID
2864 function getMaxID() {
2865 static $res; // cache
2867 if ( isset( $res ) ) {
2870 $dbr = wfGetDB( DB_SLAVE
);
2871 return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__
);
2876 * Determine whether the user is a newbie. Newbies are either
2877 * anonymous IPs, or the most recently created accounts.
2880 function isNewbie() {
2881 return !$this->isAllowed( 'autoconfirmed' );
2885 * Check to see if the given clear-text password is one of the accepted passwords
2886 * @param $password String: user password.
2887 * @return Boolean: True if the given password is correct, otherwise False.
2889 function checkPassword( $password ) {
2890 global $wgAuth, $wgLegacyEncoding;
2893 // Even though we stop people from creating passwords that
2894 // are shorter than this, doesn't mean people wont be able
2895 // to. Certain authentication plugins do NOT want to save
2896 // domain passwords in a mysql database, so we should
2897 // check this (in case $wgAuth->strict() is false).
2898 if( !$this->isValidPassword( $password ) ) {
2902 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2904 } elseif( $wgAuth->strict() ) {
2905 /* Auth plugin doesn't allow local authentication */
2907 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2908 /* Auth plugin doesn't allow local authentication for this user name */
2911 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2913 } elseif ( $wgLegacyEncoding ) {
2914 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2915 # Check for this with iconv
2916 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2917 if ( $cp1252Password != $password &&
2918 self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) )
2927 * Check if the given clear-text password matches the temporary password
2928 * sent by e-mail for password reset operations.
2929 * @return Boolean: True if matches, false otherwise
2931 function checkTemporaryPassword( $plaintext ) {
2932 global $wgNewPasswordExpiry;
2935 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2936 if ( is_null( $this->mNewpassTime
) ) {
2939 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2940 return ( time() < $expiry );
2947 * Initialize (if necessary) and return a session token value
2948 * which can be used in edit forms to show that the user's
2949 * login credentials aren't being hijacked with a foreign form
2952 * @param $salt String|Array of Strings Optional function-specific data for hashing
2953 * @param $request WebRequest object to use or null to use $wgRequest
2954 * @return String The new edit token
2956 function editToken( $salt = '', $request = null ) {
2957 if ( $request == null ) {
2959 $request = $wgRequest;
2962 if ( $this->isAnon() ) {
2963 return EDIT_TOKEN_SUFFIX
;
2965 $token = $request->getSessionData( 'wsEditToken' );
2966 if ( $token === null ) {
2967 $token = self
::generateToken();
2968 $request->setSessionData( 'wsEditToken', $token );
2970 if( is_array( $salt ) ) {
2971 $salt = implode( '|', $salt );
2973 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2978 * Generate a looking random token for various uses.
2980 * @param $salt String Optional salt value
2981 * @return String The new random token
2983 public static function generateToken( $salt = '' ) {
2984 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2985 return md5( $token . $salt );
2989 * Check given value against the token value stored in the session.
2990 * A match should confirm that the form was submitted from the
2991 * user's own login session, not a form submission from a third-party
2994 * @param $val String Input value to compare
2995 * @param $salt String Optional function-specific data for hashing
2996 * @param $request WebRequest object to use or null to use $wgRequest
2997 * @return Boolean: Whether the token matches
2999 function matchEditToken( $val, $salt = '', $request = null ) {
3000 $sessionToken = $this->editToken( $salt, $request );
3001 if ( $val != $sessionToken ) {
3002 wfDebug( "User::matchEditToken: broken session data\n" );
3004 return $val == $sessionToken;
3008 * Check given value against the token value stored in the session,
3009 * ignoring the suffix.
3011 * @param $val String Input value to compare
3012 * @param $salt String Optional function-specific data for hashing
3013 * @param $request WebRequest object to use or null to use $wgRequest
3014 * @return Boolean: Whether the token matches
3016 function matchEditTokenNoSuffix( $val, $salt = '', $request = null ) {
3017 $sessionToken = $this->editToken( $salt, $request );
3018 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
3022 * Generate a new e-mail confirmation token and send a confirmation/invalidation
3023 * mail to the user's given address.
3025 * @param $type String: message to send, either "created", "changed" or "set"
3026 * @return Status object
3028 function sendConfirmationMail( $type = 'created' ) {
3030 $expiration = null; // gets passed-by-ref and defined in next line.
3031 $token = $this->confirmationToken( $expiration );
3032 $url = $this->confirmationTokenUrl( $token );
3033 $invalidateURL = $this->invalidationTokenUrl( $token );
3034 $this->saveSettings();
3036 if ( $type == 'created' ||
$type === false ) {
3037 $message = 'confirmemail_body';
3038 } elseif ( $type === true ) {
3039 $message = 'confirmemail_body_changed';
3041 $message = 'confirmemail_body_' . $type;
3044 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
3049 $wgLang->timeanddate( $expiration, false ),
3051 $wgLang->date( $expiration, false ),
3052 $wgLang->time( $expiration, false ) ) );
3056 * Send an e-mail to this user's account. Does not check for
3057 * confirmed status or validity.
3059 * @param $subject String Message subject
3060 * @param $body String Message body
3061 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
3062 * @param $replyto String Reply-To address
3065 function sendMail( $subject, $body, $from = null, $replyto = null ) {
3066 if( is_null( $from ) ) {
3067 global $wgPasswordSender, $wgPasswordSenderName;
3068 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
3070 $sender = new MailAddress( $from );
3073 $to = new MailAddress( $this );
3074 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
3078 * Generate, store, and return a new e-mail confirmation code.
3079 * A hash (unsalted, since it's used as a key) is stored.
3081 * @note Call saveSettings() after calling this function to commit
3082 * this change to the database.
3084 * @param[out] &$expiration \mixed Accepts the expiration time
3085 * @return String New token
3088 function confirmationToken( &$expiration ) {
3089 global $wgUserEmailConfirmationTokenExpiry;
3091 $expires = $now +
$wgUserEmailConfirmationTokenExpiry;
3092 $expiration = wfTimestamp( TS_MW
, $expires );
3093 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
3094 $hash = md5( $token );
3096 $this->mEmailToken
= $hash;
3097 $this->mEmailTokenExpires
= $expiration;
3102 * Return a URL the user can use to confirm their email address.
3103 * @param $token String Accepts the email confirmation token
3104 * @return String New token URL
3107 function confirmationTokenUrl( $token ) {
3108 return $this->getTokenUrl( 'ConfirmEmail', $token );
3112 * Return a URL the user can use to invalidate their email address.
3113 * @param $token String Accepts the email confirmation token
3114 * @return String New token URL
3117 function invalidationTokenUrl( $token ) {
3118 return $this->getTokenUrl( 'Invalidateemail', $token );
3122 * Internal function to format the e-mail validation/invalidation URLs.
3123 * This uses $wgArticlePath directly as a quickie hack to use the
3124 * hardcoded English names of the Special: pages, for ASCII safety.
3126 * @note Since these URLs get dropped directly into emails, using the
3127 * short English names avoids insanely long URL-encoded links, which
3128 * also sometimes can get corrupted in some browsers/mailers
3129 * (bug 6957 with Gmail and Internet Explorer).
3131 * @param $page String Special page
3132 * @param $token String Token
3133 * @return String Formatted URL
3135 protected function getTokenUrl( $page, $token ) {
3136 global $wgArticlePath;
3140 "Special:$page/$token",
3145 * Mark the e-mail address confirmed.
3147 * @note Call saveSettings() after calling this function to commit the change.
3149 function confirmEmail() {
3150 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3151 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3156 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3157 * address if it was already confirmed.
3159 * @note Call saveSettings() after calling this function to commit the change.
3161 function invalidateEmail() {
3163 $this->mEmailToken
= null;
3164 $this->mEmailTokenExpires
= null;
3165 $this->setEmailAuthenticationTimestamp( null );
3166 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3171 * Set the e-mail authentication timestamp.
3172 * @param $timestamp String TS_MW timestamp
3174 function setEmailAuthenticationTimestamp( $timestamp ) {
3176 $this->mEmailAuthenticated
= $timestamp;
3177 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3181 * Is this user allowed to send e-mails within limits of current
3182 * site configuration?
3185 function canSendEmail() {
3186 global $wgEnableEmail, $wgEnableUserEmail;
3187 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3190 $canSend = $this->isEmailConfirmed();
3191 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3196 * Is this user allowed to receive e-mails within limits of current
3197 * site configuration?
3200 function canReceiveEmail() {
3201 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3205 * Is this user's e-mail address valid-looking and confirmed within
3206 * limits of the current site configuration?
3208 * @note If $wgEmailAuthentication is on, this may require the user to have
3209 * confirmed their address by returning a code or using a password
3210 * sent to the address from the wiki.
3214 function isEmailConfirmed() {
3215 global $wgEmailAuthentication;
3218 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3219 if( $this->isAnon() )
3221 if( !self
::isValidEmailAddr( $this->mEmail
) )
3223 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3232 * Check whether there is an outstanding request for e-mail confirmation.
3235 function isEmailConfirmationPending() {
3236 global $wgEmailAuthentication;
3237 return $wgEmailAuthentication &&
3238 !$this->isEmailConfirmed() &&
3239 $this->mEmailToken
&&
3240 $this->mEmailTokenExpires
> wfTimestamp();
3244 * Get the timestamp of account creation.
3246 * @return String|Bool Timestamp of account creation, or false for
3247 * non-existent/anonymous user accounts.
3249 public function getRegistration() {
3250 if ( $this->isAnon() ) {
3254 return $this->mRegistration
;
3258 * Get the timestamp of the first edit
3260 * @return String|Bool Timestamp of first edit, or false for
3261 * non-existent/anonymous user accounts.
3263 public function getFirstEditTimestamp() {
3264 if( $this->getId() == 0 ) {
3265 return false; // anons
3267 $dbr = wfGetDB( DB_SLAVE
);
3268 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3269 array( 'rev_user' => $this->getId() ),
3271 array( 'ORDER BY' => 'rev_timestamp ASC' )
3274 return false; // no edits
3276 return wfTimestamp( TS_MW
, $time );
3280 * Get the permissions associated with a given list of groups
3282 * @param $groups Array of Strings List of internal group names
3283 * @return Array of Strings List of permission key names for given groups combined
3285 static function getGroupPermissions( $groups ) {
3286 global $wgGroupPermissions, $wgRevokePermissions;
3288 // grant every granted permission first
3289 foreach( $groups as $group ) {
3290 if( isset( $wgGroupPermissions[$group] ) ) {
3291 $rights = array_merge( $rights,
3292 // array_filter removes empty items
3293 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3296 // now revoke the revoked permissions
3297 foreach( $groups as $group ) {
3298 if( isset( $wgRevokePermissions[$group] ) ) {
3299 $rights = array_diff( $rights,
3300 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3303 return array_unique( $rights );
3307 * Get all the groups who have a given permission
3309 * @param $role String Role to check
3310 * @return Array of Strings List of internal group names with the given permission
3312 static function getGroupsWithPermission( $role ) {
3313 global $wgGroupPermissions;
3314 $allowedGroups = array();
3315 foreach ( $wgGroupPermissions as $group => $rights ) {
3316 if ( isset( $rights[$role] ) && $rights[$role] ) {
3317 $allowedGroups[] = $group;
3320 return $allowedGroups;
3324 * Get the localized descriptive name for a group, if it exists
3326 * @param $group String Internal group name
3327 * @return String Localized descriptive group name
3329 static function getGroupName( $group ) {
3330 $msg = wfMessage( "group-$group" );
3331 return $msg->isBlank() ?
$group : $msg->text();
3335 * Get the localized descriptive name for a member of a group, if it exists
3337 * @param $group String Internal group name
3338 * @return String Localized name for group member
3340 static function getGroupMember( $group ) {
3341 $msg = wfMessage( "group-$group-member" );
3342 return $msg->isBlank() ?
$group : $msg->text();
3346 * Return the set of defined explicit groups.
3347 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3348 * are not included, as they are defined automatically, not in the database.
3349 * @return Array of internal group names
3351 static function getAllGroups() {
3352 global $wgGroupPermissions, $wgRevokePermissions;
3354 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3355 self
::getImplicitGroups()
3360 * Get a list of all available permissions.
3361 * @return Array of permission names
3363 static function getAllRights() {
3364 if ( self
::$mAllRights === false ) {
3365 global $wgAvailableRights;
3366 if ( count( $wgAvailableRights ) ) {
3367 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3369 self
::$mAllRights = self
::$mCoreRights;
3371 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3373 return self
::$mAllRights;
3377 * Get a list of implicit groups
3378 * @return Array of Strings Array of internal group names
3380 public static function getImplicitGroups() {
3381 global $wgImplicitGroups;
3382 $groups = $wgImplicitGroups;
3383 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3388 * Get the title of a page describing a particular group
3390 * @param $group String Internal group name
3391 * @return Title|Bool Title of the page if it exists, false otherwise
3393 static function getGroupPage( $group ) {
3394 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3395 if( $msg->exists() ) {
3396 $title = Title
::newFromText( $msg->text() );
3397 if( is_object( $title ) )
3404 * Create a link to the group in HTML, if available;
3405 * else return the group name.
3407 * @param $group String Internal name of the group
3408 * @param $text String The text of the link
3409 * @return String HTML link to the group
3411 static function makeGroupLinkHTML( $group, $text = '' ) {
3413 $text = self
::getGroupName( $group );
3415 $title = self
::getGroupPage( $group );
3418 $sk = $wgUser->getSkin();
3419 return $sk->link( $title, htmlspecialchars( $text ) );
3426 * Create a link to the group in Wikitext, if available;
3427 * else return the group name.
3429 * @param $group String Internal name of the group
3430 * @param $text String The text of the link
3431 * @return String Wikilink to the group
3433 static function makeGroupLinkWiki( $group, $text = '' ) {
3435 $text = self
::getGroupName( $group );
3437 $title = self
::getGroupPage( $group );
3439 $page = $title->getPrefixedText();
3440 return "[[$page|$text]]";
3447 * Returns an array of the groups that a particular group can add/remove.
3449 * @param $group String: the group to check for whether it can add/remove
3450 * @return Array array( 'add' => array( addablegroups ),
3451 * 'remove' => array( removablegroups ),
3452 * 'add-self' => array( addablegroups to self),
3453 * 'remove-self' => array( removable groups from self) )
3455 static function changeableByGroup( $group ) {
3456 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3458 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3459 if( empty( $wgAddGroups[$group] ) ) {
3460 // Don't add anything to $groups
3461 } elseif( $wgAddGroups[$group] === true ) {
3462 // You get everything
3463 $groups['add'] = self
::getAllGroups();
3464 } elseif( is_array( $wgAddGroups[$group] ) ) {
3465 $groups['add'] = $wgAddGroups[$group];
3468 // Same thing for remove
3469 if( empty( $wgRemoveGroups[$group] ) ) {
3470 } elseif( $wgRemoveGroups[$group] === true ) {
3471 $groups['remove'] = self
::getAllGroups();
3472 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3473 $groups['remove'] = $wgRemoveGroups[$group];
3476 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3477 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3478 foreach( $wgGroupsAddToSelf as $key => $value ) {
3479 if( is_int( $key ) ) {
3480 $wgGroupsAddToSelf['user'][] = $value;
3485 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3486 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3487 if( is_int( $key ) ) {
3488 $wgGroupsRemoveFromSelf['user'][] = $value;
3493 // Now figure out what groups the user can add to him/herself
3494 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3495 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3496 // No idea WHY this would be used, but it's there
3497 $groups['add-self'] = User
::getAllGroups();
3498 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3499 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3502 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3503 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3504 $groups['remove-self'] = User
::getAllGroups();
3505 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3506 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3513 * Returns an array of groups that this user can add and remove
3514 * @return Array array( 'add' => array( addablegroups ),
3515 * 'remove' => array( removablegroups ),
3516 * 'add-self' => array( addablegroups to self),
3517 * 'remove-self' => array( removable groups from self) )
3519 function changeableGroups() {
3520 if( $this->isAllowed( 'userrights' ) ) {
3521 // This group gives the right to modify everything (reverse-
3522 // compatibility with old "userrights lets you change
3524 // Using array_merge to make the groups reindexed
3525 $all = array_merge( User
::getAllGroups() );
3529 'add-self' => array(),
3530 'remove-self' => array()
3534 // Okay, it's not so simple, we will have to go through the arrays
3537 'remove' => array(),
3538 'add-self' => array(),
3539 'remove-self' => array()
3541 $addergroups = $this->getEffectiveGroups();
3543 foreach( $addergroups as $addergroup ) {
3544 $groups = array_merge_recursive(
3545 $groups, $this->changeableByGroup( $addergroup )
3547 $groups['add'] = array_unique( $groups['add'] );
3548 $groups['remove'] = array_unique( $groups['remove'] );
3549 $groups['add-self'] = array_unique( $groups['add-self'] );
3550 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3556 * Increment the user's edit-count field.
3557 * Will have no effect for anonymous users.
3559 function incEditCount() {
3560 if( !$this->isAnon() ) {
3561 $dbw = wfGetDB( DB_MASTER
);
3562 $dbw->update( 'user',
3563 array( 'user_editcount=user_editcount+1' ),
3564 array( 'user_id' => $this->getId() ),
3567 // Lazy initialization check...
3568 if( $dbw->affectedRows() == 0 ) {
3569 // Pull from a slave to be less cruel to servers
3570 // Accuracy isn't the point anyway here
3571 $dbr = wfGetDB( DB_SLAVE
);
3572 $count = $dbr->selectField( 'revision',
3574 array( 'rev_user' => $this->getId() ),
3577 // Now here's a goddamn hack...
3578 if( $dbr !== $dbw ) {
3579 // If we actually have a slave server, the count is
3580 // at least one behind because the current transaction
3581 // has not been committed and replicated.
3584 // But if DB_SLAVE is selecting the master, then the
3585 // count we just read includes the revision that was
3586 // just added in the working transaction.
3589 $dbw->update( 'user',
3590 array( 'user_editcount' => $count ),
3591 array( 'user_id' => $this->getId() ),
3595 // edit count in user cache too
3596 $this->invalidateCache();
3600 * Get the description of a given right
3602 * @param $right String Right to query
3603 * @return String Localized description of the right
3605 static function getRightDescription( $right ) {
3606 $key = "right-$right";
3607 $name = wfMsg( $key );
3608 return $name == '' ||
wfEmptyMsg( $key )
3614 * Make an old-style password hash
3616 * @param $password String Plain-text password
3617 * @param $userId String User ID
3618 * @return String Password hash
3620 static function oldCrypt( $password, $userId ) {
3621 global $wgPasswordSalt;
3622 if ( $wgPasswordSalt ) {
3623 return md5( $userId . '-' . md5( $password ) );
3625 return md5( $password );
3630 * Make a new-style password hash
3632 * @param $password String Plain-text password
3633 * @param $salt String Optional salt, may be random or the user ID.
3634 * If unspecified or false, will generate one automatically
3635 * @return String Password hash
3637 static function crypt( $password, $salt = false ) {
3638 global $wgPasswordSalt;
3641 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3645 if( $wgPasswordSalt ) {
3646 if ( $salt === false ) {
3647 $salt = substr( wfGenerateToken(), 0, 8 );
3649 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3651 return ':A:' . md5( $password );
3656 * Compare a password hash with a plain-text password. Requires the user
3657 * ID if there's a chance that the hash is an old-style hash.
3659 * @param $hash String Password hash
3660 * @param $password String Plain-text password to compare
3661 * @param $userId String User ID for old-style password salt
3664 static function comparePasswords( $hash, $password, $userId = false ) {
3665 $type = substr( $hash, 0, 3 );
3668 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3672 if ( $type == ':A:' ) {
3674 return md5( $password ) === substr( $hash, 3 );
3675 } elseif ( $type == ':B:' ) {
3677 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3678 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3681 return self
::oldCrypt( $password, $userId ) === $hash;
3686 * Add a newuser log entry for this user
3688 * @param $byEmail Boolean: account made by email?
3689 * @param $reason String: user supplied reason
3691 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3692 global $wgUser, $wgContLang, $wgNewUserLog;
3693 if( empty( $wgNewUserLog ) ) {
3694 return true; // disabled
3697 if( $this->getName() == $wgUser->getName() ) {
3700 $action = 'create2';
3702 if ( $reason === '' ) {
3703 $reason = wfMsgForContent( 'newuserlog-byemail' );
3705 $reason = $wgContLang->commaList( array(
3706 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3710 $log = new LogPage( 'newusers' );
3713 $this->getUserPage(),
3715 array( $this->getId() )
3721 * Add an autocreate newuser log entry for this user
3722 * Used by things like CentralAuth and perhaps other authplugins.
3724 public function addNewUserLogEntryAutoCreate() {
3725 global $wgNewUserLog;
3726 if( !$wgNewUserLog ) {
3727 return true; // disabled
3729 $log = new LogPage( 'newusers', false );
3730 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3734 protected function loadOptions() {
3736 if ( $this->mOptionsLoaded ||
!$this->getId() )
3739 $this->mOptions
= self
::getDefaultOptions();
3741 // Maybe load from the object
3742 if ( !is_null( $this->mOptionOverrides
) ) {
3743 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3744 foreach( $this->mOptionOverrides
as $key => $value ) {
3745 $this->mOptions
[$key] = $value;
3748 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
3749 // Load from database
3750 $dbr = wfGetDB( DB_SLAVE
);
3752 $res = $dbr->select(
3755 array( 'up_user' => $this->getId() ),
3759 foreach ( $res as $row ) {
3760 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3761 $this->mOptions
[$row->up_property
] = $row->up_value
;
3765 $this->mOptionsLoaded
= true;
3767 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3770 protected function saveOptions() {
3771 global $wgAllowPrefChange;
3773 $extuser = ExternalUser
::newFromUser( $this );
3775 $this->loadOptions();
3776 $dbw = wfGetDB( DB_MASTER
);
3778 $insert_rows = array();
3780 $saveOptions = $this->mOptions
;
3782 // Allow hooks to abort, for instance to save to a global profile.
3783 // Reset options to default state before saving.
3784 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3787 foreach( $saveOptions as $key => $value ) {
3788 # Don't bother storing default values
3789 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3790 !( $value === false ||
is_null($value) ) ) ||
3791 $value != self
::getDefaultOption( $key ) ) {
3792 $insert_rows[] = array(
3793 'up_user' => $this->getId(),
3794 'up_property' => $key,
3795 'up_value' => $value,
3798 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3799 switch ( $wgAllowPrefChange[$key] ) {
3805 $extuser->setPref( $key, $value );
3811 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3812 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3817 * Provide an array of HTML5 attributes to put on an input element
3818 * intended for the user to enter a new password. This may include
3819 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3821 * Do *not* use this when asking the user to enter his current password!
3822 * Regardless of configuration, users may have invalid passwords for whatever
3823 * reason (e.g., they were set before requirements were tightened up).
3824 * Only use it when asking for a new password, like on account creation or
3827 * Obviously, you still need to do server-side checking.
3829 * NOTE: A combination of bugs in various browsers means that this function
3830 * actually just returns array() unconditionally at the moment. May as
3831 * well keep it around for when the browser bugs get fixed, though.
3833 * FIXME : This does not belong here; put it in Html or Linker or somewhere
3835 * @return array Array of HTML attributes suitable for feeding to
3836 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3837 * That will potentially output invalid XHTML 1.0 Transitional, and will
3838 * get confused by the boolean attribute syntax used.)
3840 public static function passwordChangeInputAttribs() {
3841 global $wgMinimalPasswordLength;
3843 if ( $wgMinimalPasswordLength == 0 ) {
3847 # Note that the pattern requirement will always be satisfied if the
3848 # input is empty, so we need required in all cases.
3850 # FIXME (bug 23769): This needs to not claim the password is required
3851 # if e-mail confirmation is being used. Since HTML5 input validation
3852 # is b0rked anyway in some browsers, just return nothing. When it's
3853 # re-enabled, fix this code to not output required for e-mail
3855 #$ret = array( 'required' );
3858 # We can't actually do this right now, because Opera 9.6 will print out
3859 # the entered password visibly in its error message! When other
3860 # browsers add support for this attribute, or Opera fixes its support,
3861 # we can add support with a version check to avoid doing this on Opera
3862 # versions where it will be a problem. Reported to Opera as
3863 # DSK-262266, but they don't have a public bug tracker for us to follow.
3865 if ( $wgMinimalPasswordLength > 1 ) {
3866 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3867 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3868 $wgMinimalPasswordLength );