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 * \type{\arrayof{\string}} 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 * \type{\arrayof{\string}} Core rights.
82 * Each of these should have a corresponding message of the form
86 static $mCoreRights = array(
113 'move-rootuserpages',
117 'override-export-depth',
138 'userrights-interwiki',
142 * \string Cached results of getAllRights()
144 static $mAllRights = false;
146 /** @name Cache variables */
148 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
149 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
150 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
154 * \bool Whether the cache variables have been loaded.
156 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
159 * \string Initialization data source if mDataLoaded==false. May be one of:
160 * - 'defaults' anonymous user initialised from class defaults
161 * - 'name' initialise from mName
162 * - 'id' initialise from mId
163 * - 'session' log in from cookies or session if possible
165 * Use the User::newFrom*() family of functions to set this.
169 /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
171 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
172 $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
173 $mLocked, $mHideName, $mOptions;
176 static $idCacheByName = array();
179 * Lightweight constructor for an anonymous user.
180 * Use the User::newFrom* factory functions for other kinds of users.
184 * @see newFromConfirmationCode()
185 * @see newFromSession()
188 function __construct() {
189 $this->clearInstanceCache( 'defaults' );
193 * Load the user table data for this object from the source given by mFrom.
196 if ( $this->mDataLoaded
) {
199 wfProfileIn( __METHOD__
);
201 # Set it now to avoid infinite recursion in accessors
202 $this->mDataLoaded
= true;
204 switch ( $this->mFrom
) {
206 $this->loadDefaults();
209 $this->mId
= self
::idFromName( $this->mName
);
211 # Nonexistent user placeholder object
212 $this->loadDefaults( $this->mName
);
221 $this->loadFromSession();
222 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
225 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
227 wfProfileOut( __METHOD__
);
231 * Load user table data, given mId has already been set.
232 * @return \bool false if the ID does not exist, true otherwise
235 function loadFromId() {
237 if ( $this->mId
== 0 ) {
238 $this->loadDefaults();
243 $key = wfMemcKey( 'user', 'id', $this->mId
);
244 $data = $wgMemc->get( $key );
245 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
246 # Object is expired, load from DB
251 wfDebug( "User: cache miss for user {$this->mId}\n" );
253 if ( !$this->loadFromDatabase() ) {
254 # Can't load from ID, user is anonymous
257 $this->saveToCache();
259 wfDebug( "User: got user {$this->mId} from cache\n" );
261 foreach ( self
::$mCacheVars as $name ) {
262 $this->$name = $data[$name];
269 * Save user data to the shared cache
271 function saveToCache() {
274 $this->loadOptions();
275 if ( $this->isAnon() ) {
276 // Anonymous users are uncached
280 foreach ( self
::$mCacheVars as $name ) {
281 $data[$name] = $this->$name;
283 $data['mVersion'] = MW_USER_VERSION
;
284 $key = wfMemcKey( 'user', 'id', $this->mId
);
286 $wgMemc->set( $key, $data );
290 /** @name newFrom*() static factory methods */
294 * Static factory method for creation from username.
296 * This is slightly less efficient than newFromId(), so use newFromId() if
297 * you have both an ID and a name handy.
299 * @param $name \string Username, validated by Title::newFromText()
300 * @param $validate \mixed Validate username. Takes the same parameters as
301 * User::getCanonicalName(), except that true is accepted as an alias
302 * for 'valid', for BC.
304 * @return \type{User} The User object, or false if the username is invalid
305 * (e.g. if it contains illegal characters or is an IP address). If the
306 * username is not present in the database, the result will be a user object
307 * with a name, zero user ID and default settings.
309 static function newFromName( $name, $validate = 'valid' ) {
310 if ( $validate === true ) {
313 $name = self
::getCanonicalName( $name, $validate );
314 if ( $name === false ) {
317 # Create unloaded user object
326 * Static factory method for creation from a given user ID.
328 * @param $id \int Valid user ID
329 * @return \type{User} The corresponding User object
331 static function newFromId( $id ) {
339 * Factory method to fetch whichever user has a given email confirmation code.
340 * This code is generated when an account is created or its e-mail address
343 * If the code is invalid or has expired, returns NULL.
345 * @param $code \string Confirmation code
346 * @return \type{User}
348 static function newFromConfirmationCode( $code ) {
349 $dbr = wfGetDB( DB_SLAVE
);
350 $id = $dbr->selectField( 'user', 'user_id', array(
351 'user_email_token' => md5( $code ),
352 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
354 if( $id !== false ) {
355 return User
::newFromId( $id );
362 * Create a new user object using data from session or cookies. If the
363 * login credentials are invalid, the result is an anonymous user.
365 * @return \type{User}
367 static function newFromSession() {
369 $user->mFrom
= 'session';
374 * Create a new user object from a user row.
375 * The row should have all fields from the user table in it.
376 * @param $row array A row from the user table
377 * @return \type{User}
379 static function newFromRow( $row ) {
381 $user->loadFromRow( $row );
389 * Get the username corresponding to a given user ID
390 * @param $id \int User ID
391 * @return \string The corresponding username
393 static function whoIs( $id ) {
394 $dbr = wfGetDB( DB_SLAVE
);
395 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
399 * Get the real name of a user given their user ID
401 * @param $id \int User ID
402 * @return \string The corresponding user's real name
404 static function whoIsReal( $id ) {
405 $dbr = wfGetDB( DB_SLAVE
);
406 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
410 * Get database id given a user name
411 * @param $name \string Username
412 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
414 static function idFromName( $name ) {
415 $nt = Title
::makeTitleSafe( NS_USER
, $name );
416 if( is_null( $nt ) ) {
421 if ( isset( self
::$idCacheByName[$name] ) ) {
422 return self
::$idCacheByName[$name];
425 $dbr = wfGetDB( DB_SLAVE
);
426 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
428 if ( $s === false ) {
431 $result = $s->user_id
;
434 self
::$idCacheByName[$name] = $result;
436 if ( count( self
::$idCacheByName ) > 1000 ) {
437 self
::$idCacheByName = array();
444 * Does the string match an anonymous IPv4 address?
446 * This function exists for username validation, in order to reject
447 * usernames which are similar in form to IP addresses. Strings such
448 * as 300.300.300.300 will return true because it looks like an IP
449 * address, despite not being strictly valid.
451 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
452 * address because the usemod software would "cloak" anonymous IP
453 * addresses like this, if we allowed accounts like this to be created
454 * new users could get the old edits of these anonymous users.
456 * @param $name \string String to match
457 * @return \bool True or false
459 static function isIP( $name ) {
460 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
464 * Is the input a valid username?
466 * Checks if the input is a valid username, we don't want an empty string,
467 * an IP address, anything that containins slashes (would mess up subpages),
468 * is longer than the maximum allowed username size or doesn't begin with
471 * @param $name \string String to match
472 * @return \bool True or false
474 static function isValidUserName( $name ) {
475 global $wgContLang, $wgMaxNameChars;
478 || User
::isIP( $name )
479 ||
strpos( $name, '/' ) !== false
480 ||
strlen( $name ) > $wgMaxNameChars
481 ||
$name != $wgContLang->ucfirst( $name ) ) {
482 wfDebugLog( 'username', __METHOD__
.
483 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
487 // Ensure that the name can't be misresolved as a different title,
488 // such as with extra namespace keys at the start.
489 $parsed = Title
::newFromText( $name );
490 if( is_null( $parsed )
491 ||
$parsed->getNamespace()
492 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
493 wfDebugLog( 'username', __METHOD__
.
494 ": '$name' invalid due to ambiguous prefixes" );
498 // Check an additional blacklist of troublemaker characters.
499 // Should these be merged into the title char list?
500 $unicodeBlacklist = '/[' .
501 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
502 '\x{00a0}' . # non-breaking space
503 '\x{2000}-\x{200f}' . # various whitespace
504 '\x{2028}-\x{202f}' . # breaks and control chars
505 '\x{3000}' . # ideographic space
506 '\x{e000}-\x{f8ff}' . # private use
508 if( preg_match( $unicodeBlacklist, $name ) ) {
509 wfDebugLog( 'username', __METHOD__
.
510 ": '$name' invalid due to blacklisted characters" );
518 * Usernames which fail to pass this function will be blocked
519 * from user login and new account registrations, but may be used
520 * internally by batch processes.
522 * If an account already exists in this form, login will be blocked
523 * by a failure to pass this function.
525 * @param $name \string String to match
526 * @return \bool True or false
528 static function isUsableName( $name ) {
529 global $wgReservedUsernames;
530 // Must be a valid username, obviously ;)
531 if ( !self
::isValidUserName( $name ) ) {
535 static $reservedUsernames = false;
536 if ( !$reservedUsernames ) {
537 $reservedUsernames = $wgReservedUsernames;
538 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
541 // Certain names may be reserved for batch processes.
542 foreach ( $reservedUsernames as $reserved ) {
543 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
544 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
546 if ( $reserved == $name ) {
554 * Usernames which fail to pass this function will be blocked
555 * from new account registrations, but may be used internally
556 * either by batch processes or by user accounts which have
557 * already been created.
559 * Additional blacklisting may be added here rather than in
560 * isValidUserName() to avoid disrupting existing accounts.
562 * @param $name \string String to match
563 * @return \bool True or false
565 static function isCreatableName( $name ) {
566 global $wgInvalidUsernameCharacters;
568 // Ensure that the username isn't longer than 235 bytes, so that
569 // (at least for the builtin skins) user javascript and css files
570 // will work. (bug 23080)
571 if( strlen( $name ) > 235 ) {
572 wfDebugLog( 'username', __METHOD__
.
573 ": '$name' invalid due to length" );
577 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
578 wfDebugLog( 'username', __METHOD__
.
579 ": '$name' invalid due to wgInvalidUsernameCharacters" );
583 return self
::isUsableName( $name );
587 * Is the input a valid password for this user?
589 * @param $password String Desired password
590 * @return bool True or false
592 function isValidPassword( $password ) {
593 //simple boolean wrapper for getPasswordValidity
594 return $this->getPasswordValidity( $password ) === true;
598 * Given unvalidated password input, return error message on failure.
600 * @param $password String Desired password
601 * @return mixed: true on success, string of error message on failure
603 function getPasswordValidity( $password ) {
604 global $wgMinimalPasswordLength, $wgWeakPasswords, $wgContLang;
606 $result = false; //init $result to false for the internal checks
608 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
611 $lcPassword = $wgContLang->lc( $password );
613 if ( $result === false ) {
614 if( strlen( $password ) < $wgMinimalPasswordLength ) {
615 return 'passwordtooshort';
616 } elseif ( $lcPassword == $wgContLang->lc( $this->mName
) ) {
617 return 'password-name-match';
618 } elseif ( in_array( $lcPassword, $wgWeakPasswords ) ) {
619 return 'password-too-weak';
621 //it seems weird returning true here, but this is because of the
622 //initialization of $result to false above. If the hook is never run or it
623 //doesn't modify $result, then we will likely get down into this if with
627 } elseif( $result === true ) {
630 return $result; //the isValidPassword hook set a string $result and returned true
635 * Does a string look like an e-mail address?
637 * There used to be a regular expression here, it got removed because it
638 * rejected valid addresses. Actually just check if there is '@' somewhere
639 * in the given address.
641 * @todo Check for RFC 2822 compilance (bug 959)
643 * @param $addr \string E-mail address
644 * @return \bool True or false
646 public static function isValidEmailAddr( $addr ) {
648 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
651 $rfc5322_atext = "a-z0-9!#$%&'*+-\/=?^_`{|}—~" ;
652 $rfc1034_ldh_str = "a-z0-9-" ;
654 $HTML5_email_regexp = "/
656 [$rfc5322_atext\\.]+ # user part which is liberal :p
658 [$rfc1034_ldh_str]+ # First domain part
659 (\\.[$rfc1034_ldh_str]+)+ # Following part prefixed with a dot
661 /ix" ; // case Insensitive, eXtended
663 return (bool) preg_match( $HTML5_email_regexp, $addr );
667 * Given unvalidated user input, return a canonical username, or false if
668 * the username is invalid.
669 * @param $name \string User input
670 * @param $validate \types{\string,\bool} Type of validation to use:
671 * - false No validation
672 * - 'valid' Valid for batch processes
673 * - 'usable' Valid for batch processes and login
674 * - 'creatable' Valid for batch processes, login and account creation
676 static function getCanonicalName( $name, $validate = 'valid' ) {
677 # Force usernames to capital
679 $name = $wgContLang->ucfirst( $name );
681 # Reject names containing '#'; these will be cleaned up
682 # with title normalisation, but then it's too late to
684 if( strpos( $name, '#' ) !== false )
687 # Clean up name according to title rules
688 $t = ( $validate === 'valid' ) ?
689 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
690 # Check for invalid titles
691 if( is_null( $t ) ) {
695 # Reject various classes of invalid names
697 $name = $wgAuth->getCanonicalName( $t->getText() );
699 switch ( $validate ) {
703 if ( !User
::isValidUserName( $name ) ) {
708 if ( !User
::isUsableName( $name ) ) {
713 if ( !User
::isCreatableName( $name ) ) {
718 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
724 * Count the number of edits of a user
725 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
727 * @param $uid \int User ID to check
728 * @return \int The user's edit count
730 static function edits( $uid ) {
731 wfProfileIn( __METHOD__
);
732 $dbr = wfGetDB( DB_SLAVE
);
733 // check if the user_editcount field has been initialized
734 $field = $dbr->selectField(
735 'user', 'user_editcount',
736 array( 'user_id' => $uid ),
740 if( $field === null ) { // it has not been initialized. do so.
741 $dbw = wfGetDB( DB_MASTER
);
742 $count = $dbr->selectField(
743 'revision', 'count(*)',
744 array( 'rev_user' => $uid ),
749 array( 'user_editcount' => $count ),
750 array( 'user_id' => $uid ),
756 wfProfileOut( __METHOD__
);
761 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
762 * @todo hash random numbers to improve security, like generateToken()
764 * @return \string New random password
766 static function randomPassword() {
767 global $wgMinimalPasswordLength;
768 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
769 $l = strlen( $pwchars ) - 1;
771 $pwlength = max( 7, $wgMinimalPasswordLength );
772 $digit = mt_rand( 0, $pwlength - 1 );
774 for ( $i = 0; $i < $pwlength; $i++
) {
775 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
781 * Set cached properties to default.
783 * @note This no longer clears uncached lazy-initialised properties;
784 * the constructor does that instead.
787 function loadDefaults( $name = false ) {
788 wfProfileIn( __METHOD__
);
793 $this->mName
= $name;
794 $this->mRealName
= '';
795 $this->mPassword
= $this->mNewpassword
= '';
796 $this->mNewpassTime
= null;
798 $this->mOptionOverrides
= null;
799 $this->mOptionsLoaded
= false;
801 if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) {
802 $this->mTouched
= wfTimestamp( TS_MW
, $wgRequest->getCookie( 'LoggedOut' ) );
804 $this->mTouched
= '0'; # Allow any pages to be cached
807 $this->setToken(); # Random
808 $this->mEmailAuthenticated
= null;
809 $this->mEmailToken
= '';
810 $this->mEmailTokenExpires
= null;
811 $this->mRegistration
= wfTimestamp( TS_MW
);
812 $this->mGroups
= array();
814 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
816 wfProfileOut( __METHOD__
);
820 * @deprecated Use wfSetupSession().
822 function SetupSession() {
823 wfDeprecated( __METHOD__
);
828 * Load user data from the session or login cookie. If there are no valid
829 * credentials, initialises the user as an anonymous user.
830 * @return \bool True if the user is logged in, false otherwise.
832 private function loadFromSession() {
833 global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy;
836 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
837 if ( $result !== null ) {
841 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
842 $extUser = ExternalUser
::newFromCookie();
844 # TODO: Automatically create the user here (or probably a bit
845 # lower down, in fact)
849 if ( $wgRequest->getCookie( 'UserID' ) !== null ) {
850 $sId = intval( $wgRequest->getCookie( 'UserID' ) );
851 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
852 $this->loadDefaults(); // Possible collision!
853 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
854 cookie user ID ($sId) don't match!" );
857 $_SESSION['wsUserID'] = $sId;
858 } else if ( isset( $_SESSION['wsUserID'] ) ) {
859 if ( $_SESSION['wsUserID'] != 0 ) {
860 $sId = $_SESSION['wsUserID'];
862 $this->loadDefaults();
866 $this->loadDefaults();
870 if ( isset( $_SESSION['wsUserName'] ) ) {
871 $sName = $_SESSION['wsUserName'];
872 } else if ( $wgRequest->getCookie('UserName') !== null ) {
873 $sName = $wgRequest->getCookie('UserName');
874 $_SESSION['wsUserName'] = $sName;
876 $this->loadDefaults();
881 if ( !$this->loadFromId() ) {
882 # Not a valid ID, loadFromId has switched the object to anon for us
886 global $wgBlockDisablesLogin;
887 if( $wgBlockDisablesLogin && $this->isBlocked() ) {
888 # User blocked and we've disabled blocked user logins
889 $this->loadDefaults();
893 if ( isset( $_SESSION['wsToken'] ) ) {
894 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
896 } else if ( $wgRequest->getCookie( 'Token' ) !== null ) {
897 $passwordCorrect = $this->mToken
== $wgRequest->getCookie( 'Token' );
900 # No session or persistent login cookie
901 $this->loadDefaults();
905 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
906 $_SESSION['wsToken'] = $this->mToken
;
907 wfDebug( "User: logged in from $from\n" );
910 # Invalid credentials
911 wfDebug( "User: can't log in from $from, invalid credentials\n" );
912 $this->loadDefaults();
918 * Load user and user_group data from the database.
919 * $this::mId must be set, this is how the user is identified.
921 * @return \bool True if the user exists, false if the user is anonymous
924 function loadFromDatabase() {
926 $this->mId
= intval( $this->mId
);
928 /** Anonymous user */
930 $this->loadDefaults();
934 $dbr = wfGetDB( DB_MASTER
);
935 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
937 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
939 if ( $s !== false ) {
940 # Initialise user table data
941 $this->loadFromRow( $s );
942 $this->mGroups
= null; // deferred
943 $this->getEditCount(); // revalidation for nulls
948 $this->loadDefaults();
954 * Initialize this object from a row from the user table.
956 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
958 function loadFromRow( $row ) {
959 $this->mDataLoaded
= true;
961 if ( isset( $row->user_id
) ) {
962 $this->mId
= intval( $row->user_id
);
964 $this->mName
= $row->user_name
;
965 $this->mRealName
= $row->user_real_name
;
966 $this->mPassword
= $row->user_password
;
967 $this->mNewpassword
= $row->user_newpassword
;
968 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
969 $this->mEmail
= $row->user_email
;
970 $this->decodeOptions( $row->user_options
);
971 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
972 $this->mToken
= $row->user_token
;
973 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
974 $this->mEmailToken
= $row->user_email_token
;
975 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
976 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
977 $this->mEditCount
= $row->user_editcount
;
981 * Load the groups from the database if they aren't already loaded.
984 function loadGroups() {
985 if ( is_null( $this->mGroups
) ) {
986 $dbr = wfGetDB( DB_MASTER
);
987 $res = $dbr->select( 'user_groups',
989 array( 'ug_user' => $this->mId
),
991 $this->mGroups
= array();
992 foreach ( $res as $row ) {
993 $this->mGroups
[] = $row->ug_group
;
999 * Clear various cached data stored in this object.
1000 * @param $reloadFrom \string Reload user and user_groups table data from a
1001 * given source. May be "name", "id", "defaults", "session", or false for
1004 function clearInstanceCache( $reloadFrom = false ) {
1005 $this->mNewtalk
= -1;
1006 $this->mDatePreference
= null;
1007 $this->mBlockedby
= -1; # Unset
1008 $this->mHash
= false;
1009 $this->mSkin
= null;
1010 $this->mRights
= null;
1011 $this->mEffectiveGroups
= null;
1012 $this->mOptions
= null;
1014 if ( $reloadFrom ) {
1015 $this->mDataLoaded
= false;
1016 $this->mFrom
= $reloadFrom;
1021 * Combine the language default options with any site-specific options
1022 * and add the default language variants.
1024 * @return \type{\arrayof{\string}} Array of options
1026 static function getDefaultOptions() {
1027 global $wgNamespacesToBeSearchedDefault;
1029 * Site defaults will override the global/language defaults
1031 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1032 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1035 * default language setting
1037 $variant = $wgContLang->getDefaultVariant();
1038 $defOpt['variant'] = $variant;
1039 $defOpt['language'] = $variant;
1040 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1041 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1043 $defOpt['skin'] = $wgDefaultSkin;
1049 * Get a given default option value.
1051 * @param $opt \string Name of option to retrieve
1052 * @return \string Default option value
1054 public static function getDefaultOption( $opt ) {
1055 $defOpts = self
::getDefaultOptions();
1056 if( isset( $defOpts[$opt] ) ) {
1057 return $defOpts[$opt];
1065 * Get blocking information
1067 * @param $bFromSlave \bool Whether to check the slave database first. To
1068 * improve performance, non-critical checks are done
1069 * against slaves. Check when actually saving should be
1070 * done against master.
1072 function getBlockedStatus( $bFromSlave = true ) {
1073 global $wgProxyWhitelist, $wgUser;
1075 if ( -1 != $this->mBlockedby
) {
1076 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1080 wfProfileIn( __METHOD__
);
1081 wfDebug( __METHOD__
.": checking...\n" );
1083 // Initialize data...
1084 // Otherwise something ends up stomping on $this->mBlockedby when
1085 // things get lazy-loaded later, causing false positive block hits
1086 // due to -1 !== 0. Probably session-related... Nothing should be
1087 // overwriting mBlockedby, surely?
1090 $this->mBlockedby
= 0;
1091 $this->mHideName
= 0;
1092 $this->mAllowUsertalk
= 0;
1094 # Check if we are looking at an IP or a logged-in user
1095 if ( $this->isIP( $this->getName() ) ) {
1096 $ip = $this->getName();
1098 # Check if we are looking at the current user
1099 # If we don't, and the user is logged in, we don't know about
1100 # his IP / autoblock status, so ignore autoblock of current user's IP
1101 if ( $this->getID() != $wgUser->getID() ) {
1104 # Get IP of current user
1109 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1110 # Exempt from all types of IP-block
1115 $this->mBlock
= new Block();
1116 $this->mBlock
->fromMaster( !$bFromSlave );
1117 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1118 wfDebug( __METHOD__
. ": Found block.\n" );
1119 $this->mBlockedby
= $this->mBlock
->mBy
;
1120 if( $this->mBlockedby
== 0 )
1121 $this->mBlockedby
= $this->mBlock
->mByName
;
1122 $this->mBlockreason
= $this->mBlock
->mReason
;
1123 $this->mHideName
= $this->mBlock
->mHideName
;
1124 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1125 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1126 $this->spreadBlock();
1129 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1130 // apply to users. Note that the existence of $this->mBlock is not used to
1131 // check for edit blocks, $this->mBlockedby is instead.
1135 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1137 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1138 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1139 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1143 if ( !$this->mBlockedby
&& !$this->getID() ) {
1144 if ( $this->isDnsBlacklisted( $ip ) ) {
1145 $this->mBlockedby
= wfMsg( 'sorbs' );
1146 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1152 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1154 wfProfileOut( __METHOD__
);
1158 * Whether the given IP is in a DNS blacklist.
1160 * @param $ip \string IP to check
1161 * @param $checkWhitelist Boolean: whether to check the whitelist first
1162 * @return \bool True if blacklisted.
1164 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1165 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1166 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1168 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1171 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1174 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1175 return $this->inDnsBlacklist( $ip, $urls );
1179 * Whether the given IP is in a given DNS blacklist.
1181 * @param $ip \string IP to check
1182 * @param $bases \string or Array of Strings: URL of the DNS blacklist
1183 * @return \bool True if blacklisted.
1185 function inDnsBlacklist( $ip, $bases ) {
1186 wfProfileIn( __METHOD__
);
1189 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1190 if( IP
::isIPv4( $ip ) ) {
1191 # Reverse IP, bug 21255
1192 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1194 foreach( (array)$bases as $base ) {
1196 $host = "$ipReversed.$base";
1199 $ipList = gethostbynamel( $host );
1202 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1206 wfDebug( "Requested $host, not found in $base.\n" );
1211 wfProfileOut( __METHOD__
);
1216 * Is this user subject to rate limiting?
1218 * @return \bool True if rate limited
1220 public function isPingLimitable() {
1221 global $wgRateLimitsExcludedGroups;
1222 global $wgRateLimitsExcludedIPs;
1223 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1224 // Deprecated, but kept for backwards-compatibility config
1228 wfDebug( "Checking the list of IP addresses excluded from rate limit..\n" );
1230 // Read list of IP addresses from MediaWiki namespace
1231 $message = wfMsgForContentNoTrans( 'ratelimit-excluded-ips' );
1232 $lines = explode( "\n", $message );
1233 foreach( $lines as $line ) {
1234 // Remove comment lines
1235 $comment = substr( trim( $line ), 0, 1 );
1236 if ( $comment == '#' ||
$comment == '' ) {
1239 // Remove additional comments after an IP address
1240 $comment = strpos( $line, '#' );
1241 if ( $comment > 0 ) {
1242 $line = trim( substr( $line, 0, $comment-1 ) );
1243 if ( IP
::isValid( $line ) ) {
1244 $wgRateLimitsExcludedIPs[] = IP
::sanitizeIP( $line );
1249 $ip = IP
::sanitizeIP( wfGetIP() );
1250 if( in_array( $ip, $wgRateLimitsExcludedIPs ) ) {
1251 // No other good way currently to disable rate limits
1252 // for specific IPs. :P
1253 // But this is a crappy hack and should die.
1254 wfDebug( "IP $ip matches the list of rate limit excluded IPs\n" );
1257 return !$this->isAllowed('noratelimit');
1261 * Primitive rate limits: enforce maximum actions per time period
1262 * to put a brake on flooding.
1264 * @note When using a shared cache like memcached, IP-address
1265 * last-hit counters will be shared across wikis.
1267 * @param $action \string Action to enforce; 'edit' if unspecified
1268 * @return \bool True if a rate limiter was tripped
1270 function pingLimiter( $action = 'edit' ) {
1271 # Call the 'PingLimiter' hook
1273 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1277 global $wgRateLimits;
1278 if( !isset( $wgRateLimits[$action] ) ) {
1282 # Some groups shouldn't trigger the ping limiter, ever
1283 if( !$this->isPingLimitable() )
1286 global $wgMemc, $wgRateLimitLog;
1287 wfProfileIn( __METHOD__
);
1289 $limits = $wgRateLimits[$action];
1291 $id = $this->getId();
1295 if( isset( $limits['anon'] ) && $id == 0 ) {
1296 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1299 if( isset( $limits['user'] ) && $id != 0 ) {
1300 $userLimit = $limits['user'];
1302 if( $this->isNewbie() ) {
1303 if( isset( $limits['newbie'] ) && $id != 0 ) {
1304 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1306 if( isset( $limits['ip'] ) ) {
1307 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1310 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1311 $subnet = $matches[1];
1312 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1315 // Check for group-specific permissions
1316 // If more than one group applies, use the group with the highest limit
1317 foreach ( $this->getGroups() as $group ) {
1318 if ( isset( $limits[$group] ) ) {
1319 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1320 $userLimit = $limits[$group];
1324 // Set the user limit key
1325 if ( $userLimit !== false ) {
1326 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1327 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1331 foreach( $keys as $key => $limit ) {
1332 list( $max, $period ) = $limit;
1333 $summary = "(limit $max in {$period}s)";
1334 $count = $wgMemc->get( $key );
1337 if( $count > $max ) {
1338 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1339 if( $wgRateLimitLog ) {
1340 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1344 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1347 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1348 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1350 $wgMemc->incr( $key );
1353 wfProfileOut( __METHOD__
);
1358 * Check if user is blocked
1360 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1361 * @return \bool True if blocked, false otherwise
1363 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1364 wfDebug( "User::isBlocked: enter\n" );
1365 $this->getBlockedStatus( $bFromSlave );
1366 return $this->mBlockedby
!== 0;
1370 * Check if user is blocked from editing a particular article
1372 * @param $title \string Title to check
1373 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1374 * @return \bool True if blocked, false otherwise
1376 function isBlockedFrom( $title, $bFromSlave = false ) {
1377 global $wgBlockAllowsUTEdit;
1378 wfProfileIn( __METHOD__
);
1379 wfDebug( __METHOD__
. ": enter\n" );
1381 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1382 $blocked = $this->isBlocked( $bFromSlave );
1383 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1384 # If a user's name is suppressed, they cannot make edits anywhere
1385 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1386 $title->getNamespace() == NS_USER_TALK
) {
1388 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1391 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1393 wfProfileOut( __METHOD__
);
1398 * If user is blocked, return the name of the user who placed the block
1399 * @return \string name of blocker
1401 function blockedBy() {
1402 $this->getBlockedStatus();
1403 return $this->mBlockedby
;
1407 * If user is blocked, return the specified reason for the block
1408 * @return \string Blocking reason
1410 function blockedFor() {
1411 $this->getBlockedStatus();
1412 return $this->mBlockreason
;
1416 * If user is blocked, return the ID for the block
1417 * @return \int Block ID
1419 function getBlockId() {
1420 $this->getBlockedStatus();
1421 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1425 * Check if user is blocked on all wikis.
1426 * Do not use for actual edit permission checks!
1427 * This is intented for quick UI checks.
1429 * @param $ip \type{\string} IP address, uses current client if none given
1430 * @return \type{\bool} True if blocked, false otherwise
1432 function isBlockedGlobally( $ip = '' ) {
1433 if( $this->mBlockedGlobally
!== null ) {
1434 return $this->mBlockedGlobally
;
1436 // User is already an IP?
1437 if( IP
::isIPAddress( $this->getName() ) ) {
1438 $ip = $this->getName();
1443 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1444 $this->mBlockedGlobally
= (bool)$blocked;
1445 return $this->mBlockedGlobally
;
1449 * Check if user account is locked
1451 * @return \type{\bool} True if locked, false otherwise
1453 function isLocked() {
1454 if( $this->mLocked
!== null ) {
1455 return $this->mLocked
;
1458 $authUser = $wgAuth->getUserInstance( $this );
1459 $this->mLocked
= (bool)$authUser->isLocked();
1460 return $this->mLocked
;
1464 * Check if user account is hidden
1466 * @return \type{\bool} True if hidden, false otherwise
1468 function isHidden() {
1469 if( $this->mHideName
!== null ) {
1470 return $this->mHideName
;
1472 $this->getBlockedStatus();
1473 if( !$this->mHideName
) {
1475 $authUser = $wgAuth->getUserInstance( $this );
1476 $this->mHideName
= (bool)$authUser->isHidden();
1478 return $this->mHideName
;
1482 * Get the user's ID.
1483 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1486 if( $this->mId
=== null and $this->mName
!== null
1487 and User
::isIP( $this->mName
) ) {
1488 // Special case, we know the user is anonymous
1490 } elseif( $this->mId
=== null ) {
1491 // Don't load if this was initialized from an ID
1498 * Set the user and reload all fields according to a given ID
1499 * @param $v \int User ID to reload
1501 function setId( $v ) {
1503 $this->clearInstanceCache( 'id' );
1507 * Get the user name, or the IP of an anonymous user
1508 * @return \string User's name or IP address
1510 function getName() {
1511 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1512 # Special case optimisation
1513 return $this->mName
;
1516 if ( $this->mName
=== false ) {
1518 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1520 return $this->mName
;
1525 * Set the user name.
1527 * This does not reload fields from the database according to the given
1528 * name. Rather, it is used to create a temporary "nonexistent user" for
1529 * later addition to the database. It can also be used to set the IP
1530 * address for an anonymous user to something other than the current
1533 * @note User::newFromName() has rougly the same function, when the named user
1535 * @param $str \string New user name to set
1537 function setName( $str ) {
1539 $this->mName
= $str;
1543 * Get the user's name escaped by underscores.
1544 * @return \string Username escaped by underscores.
1546 function getTitleKey() {
1547 return str_replace( ' ', '_', $this->getName() );
1551 * Check if the user has new messages.
1552 * @return \bool True if the user has new messages
1554 function getNewtalk() {
1557 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1558 if( $this->mNewtalk
=== -1 ) {
1559 $this->mNewtalk
= false; # reset talk page status
1561 # Check memcached separately for anons, who have no
1562 # entire User object stored in there.
1565 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1566 $newtalk = $wgMemc->get( $key );
1567 if( strval( $newtalk ) !== '' ) {
1568 $this->mNewtalk
= (bool)$newtalk;
1570 // Since we are caching this, make sure it is up to date by getting it
1572 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1573 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1576 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1580 return (bool)$this->mNewtalk
;
1584 * Return the talk page(s) this user has new messages on.
1585 * @return \type{\arrayof{\string}} Array of page URLs
1587 function getNewMessageLinks() {
1589 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1592 if( !$this->getNewtalk() )
1594 $up = $this->getUserPage();
1595 $utp = $up->getTalkPage();
1596 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1600 * Internal uncached check for new messages
1603 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1604 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1605 * @param $fromMaster \bool true to fetch from the master, false for a slave
1606 * @return \bool True if the user has new messages
1609 function checkNewtalk( $field, $id, $fromMaster = false ) {
1610 if ( $fromMaster ) {
1611 $db = wfGetDB( DB_MASTER
);
1613 $db = wfGetDB( DB_SLAVE
);
1615 $ok = $db->selectField( 'user_newtalk', $field,
1616 array( $field => $id ), __METHOD__
);
1617 return $ok !== false;
1621 * Add or update the new messages flag
1622 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1623 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1624 * @return \bool True if successful, false otherwise
1627 function updateNewtalk( $field, $id ) {
1628 $dbw = wfGetDB( DB_MASTER
);
1629 $dbw->insert( 'user_newtalk',
1630 array( $field => $id ),
1633 if ( $dbw->affectedRows() ) {
1634 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1637 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1643 * Clear the new messages flag for the given user
1644 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1645 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1646 * @return \bool True if successful, false otherwise
1649 function deleteNewtalk( $field, $id ) {
1650 $dbw = wfGetDB( DB_MASTER
);
1651 $dbw->delete( 'user_newtalk',
1652 array( $field => $id ),
1654 if ( $dbw->affectedRows() ) {
1655 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1658 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1664 * Update the 'You have new messages!' status.
1665 * @param $val \bool Whether the user has new messages
1667 function setNewtalk( $val ) {
1668 if( wfReadOnly() ) {
1673 $this->mNewtalk
= $val;
1675 if( $this->isAnon() ) {
1677 $id = $this->getName();
1680 $id = $this->getId();
1685 $changed = $this->updateNewtalk( $field, $id );
1687 $changed = $this->deleteNewtalk( $field, $id );
1690 if( $this->isAnon() ) {
1691 // Anons have a separate memcached space, since
1692 // user records aren't kept for them.
1693 $key = wfMemcKey( 'newtalk', 'ip', $id );
1694 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1697 $this->invalidateCache();
1702 * Generate a current or new-future timestamp to be stored in the
1703 * user_touched field when we update things.
1704 * @return \string Timestamp in TS_MW format
1706 private static function newTouchedTimestamp() {
1707 global $wgClockSkewFudge;
1708 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1712 * Clear user data from memcached.
1713 * Use after applying fun updates to the database; caller's
1714 * responsibility to update user_touched if appropriate.
1716 * Called implicitly from invalidateCache() and saveSettings().
1718 private function clearSharedCache() {
1722 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1727 * Immediately touch the user data cache for this account.
1728 * Updates user_touched field, and removes account data from memcached
1729 * for reload on the next hit.
1731 function invalidateCache() {
1732 if( wfReadOnly() ) {
1737 $this->mTouched
= self
::newTouchedTimestamp();
1739 $dbw = wfGetDB( DB_MASTER
);
1740 $dbw->update( 'user',
1741 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1742 array( 'user_id' => $this->mId
),
1745 $this->clearSharedCache();
1750 * Validate the cache for this account.
1751 * @param $timestamp \string A timestamp in TS_MW format
1753 function validateCache( $timestamp ) {
1755 return ( $timestamp >= $this->mTouched
);
1759 * Get the user touched timestamp
1761 function getTouched() {
1763 return $this->mTouched
;
1767 * Set the password and reset the random token.
1768 * Calls through to authentication plugin if necessary;
1769 * will have no effect if the auth plugin refuses to
1770 * pass the change through or if the legal password
1773 * As a special case, setting the password to null
1774 * wipes it, so the account cannot be logged in until
1775 * a new password is set, for instance via e-mail.
1777 * @param $str \string New password to set
1778 * @throws PasswordError on failure
1780 function setPassword( $str ) {
1783 if( $str !== null ) {
1784 if( !$wgAuth->allowPasswordChange() ) {
1785 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1788 if( !$this->isValidPassword( $str ) ) {
1789 global $wgMinimalPasswordLength;
1790 $valid = $this->getPasswordValidity( $str );
1791 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1792 $wgMinimalPasswordLength ) );
1796 if( !$wgAuth->setPassword( $this, $str ) ) {
1797 throw new PasswordError( wfMsg( 'externaldberror' ) );
1800 $this->setInternalPassword( $str );
1806 * Set the password and reset the random token unconditionally.
1808 * @param $str \string New password to set
1810 function setInternalPassword( $str ) {
1814 if( $str === null ) {
1815 // Save an invalid hash...
1816 $this->mPassword
= '';
1818 $this->mPassword
= self
::crypt( $str );
1820 $this->mNewpassword
= '';
1821 $this->mNewpassTime
= null;
1825 * Get the user's current token.
1826 * @return \string Token
1828 function getToken() {
1830 return $this->mToken
;
1834 * Set the random token (used for persistent authentication)
1835 * Called from loadDefaults() among other places.
1837 * @param $token \string If specified, set the token to this value
1840 function setToken( $token = false ) {
1841 global $wgSecretKey, $wgProxyKey;
1844 if ( $wgSecretKey ) {
1845 $key = $wgSecretKey;
1846 } elseif ( $wgProxyKey ) {
1851 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1853 $this->mToken
= $token;
1858 * Set the cookie password
1860 * @param $str \string New cookie password
1863 function setCookiePassword( $str ) {
1865 $this->mCookiePassword
= md5( $str );
1869 * Set the password for a password reminder or new account email
1871 * @param $str \string New password to set
1872 * @param $throttle \bool If true, reset the throttle timestamp to the present
1874 function setNewpassword( $str, $throttle = true ) {
1876 $this->mNewpassword
= self
::crypt( $str );
1878 $this->mNewpassTime
= wfTimestampNow();
1883 * Has password reminder email been sent within the last
1884 * $wgPasswordReminderResendTime hours?
1885 * @return \bool True or false
1887 function isPasswordReminderThrottled() {
1888 global $wgPasswordReminderResendTime;
1890 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1893 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1894 return time() < $expiry;
1898 * Get the user's e-mail address
1899 * @return \string User's email address
1901 function getEmail() {
1903 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1904 return $this->mEmail
;
1908 * Get the timestamp of the user's e-mail authentication
1909 * @return \string TS_MW timestamp
1911 function getEmailAuthenticationTimestamp() {
1913 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1914 return $this->mEmailAuthenticated
;
1918 * Set the user's e-mail address
1919 * @param $str \string New e-mail address
1921 function setEmail( $str ) {
1923 $this->mEmail
= $str;
1924 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1928 * Get the user's real name
1929 * @return \string User's real name
1931 function getRealName() {
1933 return $this->mRealName
;
1937 * Set the user's real name
1938 * @param $str \string New real name
1940 function setRealName( $str ) {
1942 $this->mRealName
= $str;
1946 * Get the user's current setting for a given option.
1948 * @param $oname \string The option to check
1949 * @param $defaultOverride \string A default value returned if the option does not exist
1950 * @return \string User's current value for the option
1951 * @see getBoolOption()
1952 * @see getIntOption()
1954 function getOption( $oname, $defaultOverride = null ) {
1955 $this->loadOptions();
1957 if ( is_null( $this->mOptions
) ) {
1958 if($defaultOverride != '') {
1959 return $defaultOverride;
1961 $this->mOptions
= User
::getDefaultOptions();
1964 if ( array_key_exists( $oname, $this->mOptions
) ) {
1965 return $this->mOptions
[$oname];
1967 return $defaultOverride;
1972 * Get all user's options
1976 public function getOptions() {
1977 $this->loadOptions();
1978 return $this->mOptions
;
1982 * Get the user's current setting for a given option, as a boolean value.
1984 * @param $oname \string The option to check
1985 * @return \bool User's current value for the option
1988 function getBoolOption( $oname ) {
1989 return (bool)$this->getOption( $oname );
1994 * Get the user's current setting for a given option, as a boolean value.
1996 * @param $oname \string The option to check
1997 * @param $defaultOverride \int A default value returned if the option does not exist
1998 * @return \int User's current value for the option
2001 function getIntOption( $oname, $defaultOverride=0 ) {
2002 $val = $this->getOption( $oname );
2004 $val = $defaultOverride;
2006 return intval( $val );
2010 * Set the given option for a user.
2012 * @param $oname \string The option to set
2013 * @param $val \mixed New value to set
2015 function setOption( $oname, $val ) {
2017 $this->loadOptions();
2019 if ( $oname == 'skin' ) {
2020 # Clear cached skin, so the new one displays immediately in Special:Preferences
2021 $this->mSkin
= null;
2024 // Explicitly NULL values should refer to defaults
2025 global $wgDefaultUserOptions;
2026 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2027 $val = $wgDefaultUserOptions[$oname];
2030 $this->mOptions
[$oname] = $val;
2034 * Reset all options to the site defaults
2036 function resetOptions() {
2037 $this->mOptions
= User
::getDefaultOptions();
2041 * Get the user's preferred date format.
2042 * @return \string User's preferred date format
2044 function getDatePreference() {
2045 // Important migration for old data rows
2046 if ( is_null( $this->mDatePreference
) ) {
2048 $value = $this->getOption( 'date' );
2049 $map = $wgLang->getDatePreferenceMigrationMap();
2050 if ( isset( $map[$value] ) ) {
2051 $value = $map[$value];
2053 $this->mDatePreference
= $value;
2055 return $this->mDatePreference
;
2059 * Get the user preferred stub threshold
2061 function getStubThreshold() {
2062 global $wgMaxArticleSize; # Maximum article size, in Kb
2063 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2064 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2065 # If they have set an impossible value, disable the preference
2066 # so we can use the parser cache again.
2073 * Get the permissions this user has.
2074 * @return \type{\arrayof{\string}} Array of permission names
2076 function getRights() {
2077 if ( is_null( $this->mRights
) ) {
2078 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2079 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2080 // Force reindexation of rights when a hook has unset one of them
2081 $this->mRights
= array_values( $this->mRights
);
2083 return $this->mRights
;
2087 * Get the list of explicit group memberships this user has.
2088 * The implicit * and user groups are not included.
2089 * @return \type{\arrayof{\string}} Array of internal group names
2091 function getGroups() {
2093 return $this->mGroups
;
2097 * Get the list of implicit group memberships this user has.
2098 * This includes all explicit groups, plus 'user' if logged in,
2099 * '*' for all accounts and autopromoted groups
2100 * @param $recache \bool Whether to avoid the cache
2101 * @return \type{\arrayof{\string}} Array of internal group names
2103 function getEffectiveGroups( $recache = false ) {
2104 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2105 wfProfileIn( __METHOD__
);
2106 $this->mEffectiveGroups
= $this->getGroups();
2107 $this->mEffectiveGroups
[] = '*';
2108 if( $this->getId() ) {
2109 $this->mEffectiveGroups
[] = 'user';
2111 $this->mEffectiveGroups
= array_unique( array_merge(
2112 $this->mEffectiveGroups
,
2113 Autopromote
::getAutopromoteGroups( $this )
2116 # Hook for additional groups
2117 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2119 wfProfileOut( __METHOD__
);
2121 return $this->mEffectiveGroups
;
2125 * Get the user's edit count.
2126 * @return \int User'e edit count
2128 function getEditCount() {
2129 if( $this->getId() ) {
2130 if ( !isset( $this->mEditCount
) ) {
2131 /* Populate the count, if it has not been populated yet */
2132 $this->mEditCount
= User
::edits( $this->mId
);
2134 return $this->mEditCount
;
2142 * Add the user to the given group.
2143 * This takes immediate effect.
2144 * @param $group \string Name of the group to add
2146 function addGroup( $group ) {
2147 $dbw = wfGetDB( DB_MASTER
);
2148 if( $this->getId() ) {
2149 $dbw->insert( 'user_groups',
2151 'ug_user' => $this->getID(),
2152 'ug_group' => $group,
2155 array( 'IGNORE' ) );
2158 $this->loadGroups();
2159 $this->mGroups
[] = $group;
2160 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2162 $this->invalidateCache();
2166 * Remove the user from the given group.
2167 * This takes immediate effect.
2168 * @param $group \string Name of the group to remove
2170 function removeGroup( $group ) {
2172 $dbw = wfGetDB( DB_MASTER
);
2173 $dbw->delete( 'user_groups',
2175 'ug_user' => $this->getID(),
2176 'ug_group' => $group,
2179 $this->loadGroups();
2180 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2181 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2183 $this->invalidateCache();
2187 * Get whether the user is logged in
2188 * @return \bool True or false
2190 function isLoggedIn() {
2191 return $this->getID() != 0;
2195 * Get whether the user is anonymous
2196 * @return \bool True or false
2199 return !$this->isLoggedIn();
2203 * Get whether the user is a bot
2204 * @return \bool True or false
2208 wfDeprecated( __METHOD__
);
2209 return $this->isAllowed( 'bot' );
2213 * Check if user is allowed to access a feature / make an action
2214 * @param $action \string action to be checked
2215 * @return \bool True if action is allowed, else false
2217 function isAllowed( $action = '' ) {
2218 if ( $action === '' )
2219 return true; // In the spirit of DWIM
2220 # Patrolling may not be enabled
2221 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2222 global $wgUseRCPatrol, $wgUseNPPatrol;
2223 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2226 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2227 # by misconfiguration: 0 == 'foo'
2228 return in_array( $action, $this->getRights(), true );
2232 * Check whether to enable recent changes patrol features for this user
2233 * @return \bool True or false
2235 public function useRCPatrol() {
2236 global $wgUseRCPatrol;
2237 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2241 * Check whether to enable new pages patrol features for this user
2242 * @return \bool True or false
2244 public function useNPPatrol() {
2245 global $wgUseRCPatrol, $wgUseNPPatrol;
2246 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2250 * Get the current skin, loading it if required, and setting a title
2251 * @param $t Title: the title to use in the skin
2252 * @return Skin The current skin
2253 * @todo FIXME : need to check the old failback system [AV]
2255 function getSkin( $t = null ) {
2257 $skin = $this->createSkinObject();
2258 $skin->setTitle( $t );
2261 if ( !$this->mSkin
) {
2262 $this->mSkin
= $this->createSkinObject();
2265 if ( !$this->mSkin
->getTitle() ) {
2267 $t = $wgOut->getTitle();
2268 $this->mSkin
->setTitle($t);
2271 return $this->mSkin
;
2275 // Creates a Skin object, for getSkin()
2276 private function createSkinObject() {
2277 wfProfileIn( __METHOD__
);
2279 global $wgHiddenPrefs;
2280 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2283 $userSkin = $this->getOption( 'skin' );
2284 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2286 # if we're not allowing users to override, then use the default
2287 global $wgDefaultSkin;
2288 $userSkin = $wgDefaultSkin;
2291 $skin = Skin
::newFromKey( $userSkin );
2292 wfProfileOut( __METHOD__
);
2298 * Check the watched status of an article.
2299 * @param $title \type{Title} Title of the article to look at
2300 * @return \bool True if article is watched
2302 function isWatched( $title ) {
2303 $wl = WatchedItem
::fromUserTitle( $this, $title );
2304 return $wl->isWatched();
2309 * @param $title \type{Title} Title of the article to look at
2311 function addWatch( $title ) {
2312 $wl = WatchedItem
::fromUserTitle( $this, $title );
2314 $this->invalidateCache();
2318 * Stop watching an article.
2319 * @param $title \type{Title} Title of the article to look at
2321 function removeWatch( $title ) {
2322 $wl = WatchedItem
::fromUserTitle( $this, $title );
2324 $this->invalidateCache();
2328 * Clear the user's notification timestamp for the given title.
2329 * If e-notif e-mails are on, they will receive notification mails on
2330 * the next change of the page if it's watched etc.
2331 * @param $title \type{Title} Title of the article to look at
2333 function clearNotification( &$title ) {
2334 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2336 # Do nothing if the database is locked to writes
2337 if( wfReadOnly() ) {
2341 if( $title->getNamespace() == NS_USER_TALK
&&
2342 $title->getText() == $this->getName() ) {
2343 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2345 $this->setNewtalk( false );
2348 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2352 if( $this->isAnon() ) {
2353 // Nothing else to do...
2357 // Only update the timestamp if the page is being watched.
2358 // The query to find out if it is watched is cached both in memcached and per-invocation,
2359 // and when it does have to be executed, it can be on a slave
2360 // If this is the user's newtalk page, we always update the timestamp
2361 if( $title->getNamespace() == NS_USER_TALK
&&
2362 $title->getText() == $wgUser->getName() )
2365 } elseif ( $this->getId() == $wgUser->getId() ) {
2366 $watched = $title->userIsWatching();
2371 // If the page is watched by the user (or may be watched), update the timestamp on any
2372 // any matching rows
2374 $dbw = wfGetDB( DB_MASTER
);
2375 $dbw->update( 'watchlist',
2377 'wl_notificationtimestamp' => null
2378 ), array( /* WHERE */
2379 'wl_title' => $title->getDBkey(),
2380 'wl_namespace' => $title->getNamespace(),
2381 'wl_user' => $this->getID()
2388 * Resets all of the given user's page-change notification timestamps.
2389 * If e-notif e-mails are on, they will receive notification mails on
2390 * the next change of any watched page.
2392 * @param $currentUser \int User ID
2394 function clearAllNotifications( $currentUser ) {
2395 global $wgUseEnotif, $wgShowUpdatedMarker;
2396 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2397 $this->setNewtalk( false );
2400 if( $currentUser != 0 ) {
2401 $dbw = wfGetDB( DB_MASTER
);
2402 $dbw->update( 'watchlist',
2404 'wl_notificationtimestamp' => null
2405 ), array( /* WHERE */
2406 'wl_user' => $currentUser
2409 # We also need to clear here the "you have new message" notification for the own user_talk page
2410 # This is cleared one page view later in Article::viewUpdates();
2415 * Set this user's options from an encoded string
2416 * @param $str \string Encoded options to import
2419 function decodeOptions( $str ) {
2423 $this->mOptionsLoaded
= true;
2424 $this->mOptionOverrides
= array();
2426 // If an option is not set in $str, use the default value
2427 $this->mOptions
= self
::getDefaultOptions();
2429 $a = explode( "\n", $str );
2430 foreach ( $a as $s ) {
2432 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2433 $this->mOptions
[$m[1]] = $m[2];
2434 $this->mOptionOverrides
[$m[1]] = $m[2];
2440 * Set a cookie on the user's client. Wrapper for
2441 * WebResponse::setCookie
2442 * @param $name \string Name of the cookie to set
2443 * @param $value \string Value to set
2444 * @param $exp \int Expiration time, as a UNIX time value;
2445 * if 0 or not specified, use the default $wgCookieExpiration
2447 protected function setCookie( $name, $value, $exp = 0 ) {
2449 $wgRequest->response()->setcookie( $name, $value, $exp );
2453 * Clear a cookie on the user's client
2454 * @param $name \string Name of the cookie to clear
2456 protected function clearCookie( $name ) {
2457 $this->setCookie( $name, '', time() - 86400 );
2461 * Set the default cookies for this session on the user's client.
2463 function setCookies() {
2465 if ( 0 == $this->mId
) return;
2467 'wsUserID' => $this->mId
,
2468 'wsToken' => $this->mToken
,
2469 'wsUserName' => $this->getName()
2472 'UserID' => $this->mId
,
2473 'UserName' => $this->getName(),
2475 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2476 $cookies['Token'] = $this->mToken
;
2478 $cookies['Token'] = false;
2481 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2482 #check for null, since the hook could cause a null value
2483 if ( !is_null( $session ) && isset( $_SESSION ) ){
2484 $_SESSION = $session +
$_SESSION;
2486 foreach ( $cookies as $name => $value ) {
2487 if ( $value === false ) {
2488 $this->clearCookie( $name );
2490 $this->setCookie( $name, $value );
2496 * Log this user out.
2499 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2505 * Clear the user's cookies and session, and reset the instance cache.
2509 function doLogout() {
2510 $this->clearInstanceCache( 'defaults' );
2512 $_SESSION['wsUserID'] = 0;
2514 $this->clearCookie( 'UserID' );
2515 $this->clearCookie( 'Token' );
2517 # Remember when user logged out, to prevent seeing cached pages
2518 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2522 * Save this user's settings into the database.
2523 * @todo Only rarely do all these fields need to be set!
2525 function saveSettings() {
2527 if ( wfReadOnly() ) { return; }
2528 if ( 0 == $this->mId
) { return; }
2530 $this->mTouched
= self
::newTouchedTimestamp();
2532 $dbw = wfGetDB( DB_MASTER
);
2533 $dbw->update( 'user',
2535 'user_name' => $this->mName
,
2536 'user_password' => $this->mPassword
,
2537 'user_newpassword' => $this->mNewpassword
,
2538 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2539 'user_real_name' => $this->mRealName
,
2540 'user_email' => $this->mEmail
,
2541 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2542 'user_options' => '',
2543 'user_touched' => $dbw->timestamp( $this->mTouched
),
2544 'user_token' => $this->mToken
,
2545 'user_email_token' => $this->mEmailToken
,
2546 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2547 ), array( /* WHERE */
2548 'user_id' => $this->mId
2552 $this->saveOptions();
2554 wfRunHooks( 'UserSaveSettings', array( $this ) );
2555 $this->clearSharedCache();
2556 $this->getUserPage()->invalidateCache();
2560 * If only this user's username is known, and it exists, return the user ID.
2562 function idForName() {
2563 $s = trim( $this->getName() );
2564 if ( $s === '' ) return 0;
2566 $dbr = wfGetDB( DB_SLAVE
);
2567 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2568 if ( $id === false ) {
2575 * Add a user to the database, return the user object
2577 * @param $name \string Username to add
2578 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2579 * - password The user's password. Password logins will be disabled if this is omitted.
2580 * - newpassword A temporary password mailed to the user
2581 * - email The user's email address
2582 * - email_authenticated The email authentication timestamp
2583 * - real_name The user's real name
2584 * - options An associative array of non-default options
2585 * - token Random authentication token. Do not set.
2586 * - registration Registration timestamp. Do not set.
2588 * @return \type{User} A new User object, or null if the username already exists
2590 static function createNew( $name, $params = array() ) {
2593 if ( isset( $params['options'] ) ) {
2594 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2595 unset( $params['options'] );
2597 $dbw = wfGetDB( DB_MASTER
);
2598 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2600 'user_id' => $seqVal,
2601 'user_name' => $name,
2602 'user_password' => $user->mPassword
,
2603 'user_newpassword' => $user->mNewpassword
,
2604 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2605 'user_email' => $user->mEmail
,
2606 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2607 'user_real_name' => $user->mRealName
,
2608 'user_options' => '',
2609 'user_token' => $user->mToken
,
2610 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2611 'user_editcount' => 0,
2613 foreach ( $params as $name => $value ) {
2614 $fields["user_$name"] = $value;
2616 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2617 if ( $dbw->affectedRows() ) {
2618 $newUser = User
::newFromId( $dbw->insertId() );
2626 * Add this existing user object to the database
2628 function addToDatabase() {
2630 $dbw = wfGetDB( DB_MASTER
);
2631 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2632 $dbw->insert( 'user',
2634 'user_id' => $seqVal,
2635 'user_name' => $this->mName
,
2636 'user_password' => $this->mPassword
,
2637 'user_newpassword' => $this->mNewpassword
,
2638 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2639 'user_email' => $this->mEmail
,
2640 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2641 'user_real_name' => $this->mRealName
,
2642 'user_options' => '',
2643 'user_token' => $this->mToken
,
2644 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2645 'user_editcount' => 0,
2648 $this->mId
= $dbw->insertId();
2650 // Clear instance cache other than user table data, which is already accurate
2651 $this->clearInstanceCache();
2653 $this->saveOptions();
2657 * If this (non-anonymous) user is blocked, block any IP address
2658 * they've successfully logged in from.
2660 function spreadBlock() {
2661 wfDebug( __METHOD__
. "()\n" );
2663 if ( $this->mId
== 0 ) {
2667 $userblock = Block
::newFromDB( '', $this->mId
);
2668 if ( !$userblock ) {
2672 $userblock->doAutoblock( wfGetIP() );
2676 * Generate a string which will be different for any combination of
2677 * user options which would produce different parser output.
2678 * This will be used as part of the hash key for the parser cache,
2679 * so users with the same options can share the same cached data
2682 * Extensions which require it should install 'PageRenderingHash' hook,
2683 * which will give them a chance to modify this key based on their own
2686 * @deprecated use the ParserOptions object to get the relevant options
2687 * @return \string Page rendering hash
2689 function getPageRenderingHash() {
2690 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2692 return $this->mHash
;
2694 wfDeprecated( __METHOD__
);
2696 // stubthreshold is only included below for completeness,
2697 // since it disables the parser cache, its value will always
2698 // be 0 when this function is called by parsercache.
2700 $confstr = $this->getOption( 'math' );
2701 $confstr .= '!' . $this->getStubThreshold();
2702 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2703 $confstr .= '!' . $this->getDatePreference();
2705 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2706 $confstr .= '!' . $wgLang->getCode();
2707 $confstr .= '!' . $this->getOption( 'thumbsize' );
2708 // add in language specific options, if any
2709 $extra = $wgContLang->getExtraHashOptions();
2712 // Since the skin could be overloading link(), it should be
2713 // included here but in practice, none of our skins do that.
2715 $confstr .= $wgRenderHashAppend;
2717 // Give a chance for extensions to modify the hash, if they have
2718 // extra options or other effects on the parser cache.
2719 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2721 // Make it a valid memcached key fragment
2722 $confstr = str_replace( ' ', '_', $confstr );
2723 $this->mHash
= $confstr;
2728 * Get whether the user is explicitly blocked from account creation.
2729 * @return \bool True if blocked
2731 function isBlockedFromCreateAccount() {
2732 $this->getBlockedStatus();
2733 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2737 * Get whether the user is blocked from using Special:Emailuser.
2738 * @return \bool True if blocked
2740 function isBlockedFromEmailuser() {
2741 $this->getBlockedStatus();
2742 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2746 * Get whether the user is allowed to create an account.
2747 * @return \bool True if allowed
2749 function isAllowedToCreateAccount() {
2750 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2754 * Get this user's personal page title.
2756 * @return \type{Title} User's personal page title
2758 function getUserPage() {
2759 return Title
::makeTitle( NS_USER
, $this->getName() );
2763 * Get this user's talk page title.
2765 * @return \type{Title} User's talk page title
2767 function getTalkPage() {
2768 $title = $this->getUserPage();
2769 return $title->getTalkPage();
2773 * Get the maximum valid user ID.
2774 * @return \int User ID
2777 function getMaxID() {
2778 static $res; // cache
2780 if ( isset( $res ) ) {
2783 $dbr = wfGetDB( DB_SLAVE
);
2784 return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__
);
2789 * Determine whether the user is a newbie. Newbies are either
2790 * anonymous IPs, or the most recently created accounts.
2791 * @return \bool True if the user is a newbie
2793 function isNewbie() {
2794 return !$this->isAllowed( 'autoconfirmed' );
2798 * Check to see if the given clear-text password is one of the accepted passwords
2799 * @param $password \string user password.
2800 * @return \bool True if the given password is correct, otherwise False.
2802 function checkPassword( $password ) {
2806 // Even though we stop people from creating passwords that
2807 // are shorter than this, doesn't mean people wont be able
2808 // to. Certain authentication plugins do NOT want to save
2809 // domain passwords in a mysql database, so we should
2810 // check this (incase $wgAuth->strict() is false).
2811 if( !$this->isValidPassword( $password ) ) {
2815 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2817 } elseif( $wgAuth->strict() ) {
2818 /* Auth plugin doesn't allow local authentication */
2820 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2821 /* Auth plugin doesn't allow local authentication for this user name */
2824 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2826 } elseif ( function_exists( 'iconv' ) ) {
2827 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2828 # Check for this with iconv
2829 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2830 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2838 * Check if the given clear-text password matches the temporary password
2839 * sent by e-mail for password reset operations.
2840 * @return \bool True if matches, false otherwise
2842 function checkTemporaryPassword( $plaintext ) {
2843 global $wgNewPasswordExpiry;
2844 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2846 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2847 return ( time() < $expiry );
2854 * Initialize (if necessary) and return a session token value
2855 * which can be used in edit forms to show that the user's
2856 * login credentials aren't being hijacked with a foreign form
2859 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2860 * @return \string The new edit token
2862 function editToken( $salt = '' ) {
2863 if ( $this->isAnon() ) {
2864 return EDIT_TOKEN_SUFFIX
;
2866 if( !isset( $_SESSION['wsEditToken'] ) ) {
2867 $token = self
::generateToken();
2868 $_SESSION['wsEditToken'] = $token;
2870 $token = $_SESSION['wsEditToken'];
2872 if( is_array( $salt ) ) {
2873 $salt = implode( '|', $salt );
2875 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2880 * Generate a looking random token for various uses.
2882 * @param $salt \string Optional salt value
2883 * @return \string The new random token
2885 public static function generateToken( $salt = '' ) {
2886 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2887 return md5( $token . $salt );
2891 * Check given value against the token value stored in the session.
2892 * A match should confirm that the form was submitted from the
2893 * user's own login session, not a form submission from a third-party
2896 * @param $val \string Input value to compare
2897 * @param $salt \string Optional function-specific data for hashing
2898 * @return \bool Whether the token matches
2900 function matchEditToken( $val, $salt = '' ) {
2901 $sessionToken = $this->editToken( $salt );
2902 if ( $val != $sessionToken ) {
2903 wfDebug( "User::matchEditToken: broken session data\n" );
2905 return $val == $sessionToken;
2909 * Check given value against the token value stored in the session,
2910 * ignoring the suffix.
2912 * @param $val \string Input value to compare
2913 * @param $salt \string Optional function-specific data for hashing
2914 * @return \bool Whether the token matches
2916 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2917 $sessionToken = $this->editToken( $salt );
2918 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2922 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2923 * mail to the user's given address.
2925 * @param $changed Boolean: whether the adress changed
2926 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2928 function sendConfirmationMail( $changed = false ) {
2930 $expiration = null; // gets passed-by-ref and defined in next line.
2931 $token = $this->confirmationToken( $expiration );
2932 $url = $this->confirmationTokenUrl( $token );
2933 $invalidateURL = $this->invalidationTokenUrl( $token );
2934 $this->saveSettings();
2936 $message = $changed ?
'confirmemail_body_changed' : 'confirmemail_body';
2937 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2942 $wgLang->timeanddate( $expiration, false ),
2944 $wgLang->date( $expiration, false ),
2945 $wgLang->time( $expiration, false ) ) );
2949 * Send an e-mail to this user's account. Does not check for
2950 * confirmed status or validity.
2952 * @param $subject \string Message subject
2953 * @param $body \string Message body
2954 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2955 * @param $replyto \string Reply-To address
2956 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2958 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2959 if( is_null( $from ) ) {
2960 global $wgPasswordSender, $wgPasswordSenderName;
2961 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
2963 $sender = new MailAddress( $from );
2966 $to = new MailAddress( $this );
2967 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2971 * Generate, store, and return a new e-mail confirmation code.
2972 * A hash (unsalted, since it's used as a key) is stored.
2974 * @note Call saveSettings() after calling this function to commit
2975 * this change to the database.
2977 * @param[out] &$expiration \mixed Accepts the expiration time
2978 * @return \string New token
2981 function confirmationToken( &$expiration ) {
2983 $expires = $now +
7 * 24 * 60 * 60;
2984 $expiration = wfTimestamp( TS_MW
, $expires );
2985 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
2986 $hash = md5( $token );
2988 $this->mEmailToken
= $hash;
2989 $this->mEmailTokenExpires
= $expiration;
2994 * Return a URL the user can use to confirm their email address.
2995 * @param $token \string Accepts the email confirmation token
2996 * @return \string New token URL
2999 function confirmationTokenUrl( $token ) {
3000 return $this->getTokenUrl( 'ConfirmEmail', $token );
3004 * Return a URL the user can use to invalidate their email address.
3005 * @param $token \string Accepts the email confirmation token
3006 * @return \string New token URL
3009 function invalidationTokenUrl( $token ) {
3010 return $this->getTokenUrl( 'Invalidateemail', $token );
3014 * Internal function to format the e-mail validation/invalidation URLs.
3015 * This uses $wgArticlePath directly as a quickie hack to use the
3016 * hardcoded English names of the Special: pages, for ASCII safety.
3018 * @note Since these URLs get dropped directly into emails, using the
3019 * short English names avoids insanely long URL-encoded links, which
3020 * also sometimes can get corrupted in some browsers/mailers
3021 * (bug 6957 with Gmail and Internet Explorer).
3023 * @param $page \string Special page
3024 * @param $token \string Token
3025 * @return \string Formatted URL
3027 protected function getTokenUrl( $page, $token ) {
3028 global $wgArticlePath;
3032 "Special:$page/$token",
3037 * Mark the e-mail address confirmed.
3039 * @note Call saveSettings() after calling this function to commit the change.
3041 function confirmEmail() {
3042 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3043 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3048 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3049 * address if it was already confirmed.
3051 * @note Call saveSettings() after calling this function to commit the change.
3053 function invalidateEmail() {
3055 $this->mEmailToken
= null;
3056 $this->mEmailTokenExpires
= null;
3057 $this->setEmailAuthenticationTimestamp( null );
3058 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3063 * Set the e-mail authentication timestamp.
3064 * @param $timestamp \string TS_MW timestamp
3066 function setEmailAuthenticationTimestamp( $timestamp ) {
3068 $this->mEmailAuthenticated
= $timestamp;
3069 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3073 * Is this user allowed to send e-mails within limits of current
3074 * site configuration?
3075 * @return \bool True if allowed
3077 function canSendEmail() {
3078 global $wgEnableEmail, $wgEnableUserEmail;
3079 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3082 $canSend = $this->isEmailConfirmed();
3083 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3088 * Is this user allowed to receive e-mails within limits of current
3089 * site configuration?
3090 * @return \bool True if allowed
3092 function canReceiveEmail() {
3093 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3097 * Is this user's e-mail address valid-looking and confirmed within
3098 * limits of the current site configuration?
3100 * @note If $wgEmailAuthentication is on, this may require the user to have
3101 * confirmed their address by returning a code or using a password
3102 * sent to the address from the wiki.
3104 * @return \bool True if confirmed
3106 function isEmailConfirmed() {
3107 global $wgEmailAuthentication;
3110 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3111 if( $this->isAnon() )
3113 if( !self
::isValidEmailAddr( $this->mEmail
) )
3115 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3124 * Check whether there is an outstanding request for e-mail confirmation.
3125 * @return \bool True if pending
3127 function isEmailConfirmationPending() {
3128 global $wgEmailAuthentication;
3129 return $wgEmailAuthentication &&
3130 !$this->isEmailConfirmed() &&
3131 $this->mEmailToken
&&
3132 $this->mEmailTokenExpires
> wfTimestamp();
3136 * Get the timestamp of account creation.
3138 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3139 * non-existent/anonymous user accounts.
3141 public function getRegistration() {
3142 return $this->getId() > 0
3143 ?
$this->mRegistration
3148 * Get the timestamp of the first edit
3150 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3151 * non-existent/anonymous user accounts.
3153 public function getFirstEditTimestamp() {
3154 if( $this->getId() == 0 ) return false; // anons
3155 $dbr = wfGetDB( DB_SLAVE
);
3156 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3157 array( 'rev_user' => $this->getId() ),
3159 array( 'ORDER BY' => 'rev_timestamp ASC' )
3161 if( !$time ) return false; // no edits
3162 return wfTimestamp( TS_MW
, $time );
3166 * Get the permissions associated with a given list of groups
3168 * @param $groups \type{\arrayof{\string}} List of internal group names
3169 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3171 static function getGroupPermissions( $groups ) {
3172 global $wgGroupPermissions, $wgRevokePermissions;
3174 // grant every granted permission first
3175 foreach( $groups as $group ) {
3176 if( isset( $wgGroupPermissions[$group] ) ) {
3177 $rights = array_merge( $rights,
3178 // array_filter removes empty items
3179 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3182 // now revoke the revoked permissions
3183 foreach( $groups as $group ) {
3184 if( isset( $wgRevokePermissions[$group] ) ) {
3185 $rights = array_diff( $rights,
3186 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3189 return array_unique( $rights );
3193 * Get all the groups who have a given permission
3195 * @param $role \string Role to check
3196 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3198 static function getGroupsWithPermission( $role ) {
3199 global $wgGroupPermissions;
3200 $allowedGroups = array();
3201 foreach ( $wgGroupPermissions as $group => $rights ) {
3202 if ( isset( $rights[$role] ) && $rights[$role] ) {
3203 $allowedGroups[] = $group;
3206 return $allowedGroups;
3210 * Get the localized descriptive name for a group, if it exists
3212 * @param $group \string Internal group name
3213 * @return \string Localized descriptive group name
3215 static function getGroupName( $group ) {
3216 $key = "group-$group";
3217 $name = wfMsg( $key );
3218 return $name == '' ||
wfEmptyMsg( $key, $name )
3224 * Get the localized descriptive name for a member of a group, if it exists
3226 * @param $group \string Internal group name
3227 * @return \string Localized name for group member
3229 static function getGroupMember( $group ) {
3230 $key = "group-$group-member";
3231 $name = wfMsg( $key );
3232 return $name == '' ||
wfEmptyMsg( $key, $name )
3238 * Return the set of defined explicit groups.
3239 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3240 * are not included, as they are defined automatically, not in the database.
3241 * @return \type{\arrayof{\string}} Array of internal group names
3243 static function getAllGroups() {
3244 global $wgGroupPermissions, $wgRevokePermissions;
3246 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3247 self
::getImplicitGroups()
3252 * Get a list of all available permissions.
3253 * @return \type{\arrayof{\string}} Array of permission names
3255 static function getAllRights() {
3256 if ( self
::$mAllRights === false ) {
3257 global $wgAvailableRights;
3258 if ( count( $wgAvailableRights ) ) {
3259 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3261 self
::$mAllRights = self
::$mCoreRights;
3263 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3265 return self
::$mAllRights;
3269 * Get a list of implicit groups
3270 * @return \type{\arrayof{\string}} Array of internal group names
3272 public static function getImplicitGroups() {
3273 global $wgImplicitGroups;
3274 $groups = $wgImplicitGroups;
3275 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3280 * Get the title of a page describing a particular group
3282 * @param $group \string Internal group name
3283 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3285 static function getGroupPage( $group ) {
3286 $page = wfMsgForContent( 'grouppage-' . $group );
3287 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3288 $title = Title
::newFromText( $page );
3289 if( is_object( $title ) )
3296 * Create a link to the group in HTML, if available;
3297 * else return the group name.
3299 * @param $group \string Internal name of the group
3300 * @param $text \string The text of the link
3301 * @return \string HTML link to the group
3303 static function makeGroupLinkHTML( $group, $text = '' ) {
3305 $text = self
::getGroupName( $group );
3307 $title = self
::getGroupPage( $group );
3310 $sk = $wgUser->getSkin();
3311 return $sk->link( $title, htmlspecialchars( $text ) );
3318 * Create a link to the group in Wikitext, if available;
3319 * else return the group name.
3321 * @param $group \string Internal name of the group
3322 * @param $text \string The text of the link
3323 * @return \string Wikilink to the group
3325 static function makeGroupLinkWiki( $group, $text = '' ) {
3327 $text = self
::getGroupName( $group );
3329 $title = self
::getGroupPage( $group );
3331 $page = $title->getPrefixedText();
3332 return "[[$page|$text]]";
3339 * Returns an array of the groups that a particular group can add/remove.
3341 * @param $group String: the group to check for whether it can add/remove
3342 * @return Array array( 'add' => array( addablegroups ),
3343 * 'remove' => array( removablegroups ),
3344 * 'add-self' => array( addablegroups to self),
3345 * 'remove-self' => array( removable groups from self) )
3347 static function changeableByGroup( $group ) {
3348 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3350 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3351 if( empty( $wgAddGroups[$group] ) ) {
3352 // Don't add anything to $groups
3353 } elseif( $wgAddGroups[$group] === true ) {
3354 // You get everything
3355 $groups['add'] = self
::getAllGroups();
3356 } elseif( is_array( $wgAddGroups[$group] ) ) {
3357 $groups['add'] = $wgAddGroups[$group];
3360 // Same thing for remove
3361 if( empty( $wgRemoveGroups[$group] ) ) {
3362 } elseif( $wgRemoveGroups[$group] === true ) {
3363 $groups['remove'] = self
::getAllGroups();
3364 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3365 $groups['remove'] = $wgRemoveGroups[$group];
3368 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3369 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3370 foreach( $wgGroupsAddToSelf as $key => $value ) {
3371 if( is_int( $key ) ) {
3372 $wgGroupsAddToSelf['user'][] = $value;
3377 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3378 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3379 if( is_int( $key ) ) {
3380 $wgGroupsRemoveFromSelf['user'][] = $value;
3385 // Now figure out what groups the user can add to him/herself
3386 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3387 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3388 // No idea WHY this would be used, but it's there
3389 $groups['add-self'] = User
::getAllGroups();
3390 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3391 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3394 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3395 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3396 $groups['remove-self'] = User
::getAllGroups();
3397 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3398 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3405 * Returns an array of groups that this user can add and remove
3406 * @return Array array( 'add' => array( addablegroups ),
3407 * 'remove' => array( removablegroups ),
3408 * 'add-self' => array( addablegroups to self),
3409 * 'remove-self' => array( removable groups from self) )
3411 function changeableGroups() {
3412 if( $this->isAllowed( 'userrights' ) ) {
3413 // This group gives the right to modify everything (reverse-
3414 // compatibility with old "userrights lets you change
3416 // Using array_merge to make the groups reindexed
3417 $all = array_merge( User
::getAllGroups() );
3421 'add-self' => array(),
3422 'remove-self' => array()
3426 // Okay, it's not so simple, we will have to go through the arrays
3429 'remove' => array(),
3430 'add-self' => array(),
3431 'remove-self' => array()
3433 $addergroups = $this->getEffectiveGroups();
3435 foreach( $addergroups as $addergroup ) {
3436 $groups = array_merge_recursive(
3437 $groups, $this->changeableByGroup( $addergroup )
3439 $groups['add'] = array_unique( $groups['add'] );
3440 $groups['remove'] = array_unique( $groups['remove'] );
3441 $groups['add-self'] = array_unique( $groups['add-self'] );
3442 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3448 * Increment the user's edit-count field.
3449 * Will have no effect for anonymous users.
3451 function incEditCount() {
3452 if( !$this->isAnon() ) {
3453 $dbw = wfGetDB( DB_MASTER
);
3454 $dbw->update( 'user',
3455 array( 'user_editcount=user_editcount+1' ),
3456 array( 'user_id' => $this->getId() ),
3459 // Lazy initialization check...
3460 if( $dbw->affectedRows() == 0 ) {
3461 // Pull from a slave to be less cruel to servers
3462 // Accuracy isn't the point anyway here
3463 $dbr = wfGetDB( DB_SLAVE
);
3464 $count = $dbr->selectField( 'revision',
3466 array( 'rev_user' => $this->getId() ),
3469 // Now here's a goddamn hack...
3470 if( $dbr !== $dbw ) {
3471 // If we actually have a slave server, the count is
3472 // at least one behind because the current transaction
3473 // has not been committed and replicated.
3476 // But if DB_SLAVE is selecting the master, then the
3477 // count we just read includes the revision that was
3478 // just added in the working transaction.
3481 $dbw->update( 'user',
3482 array( 'user_editcount' => $count ),
3483 array( 'user_id' => $this->getId() ),
3487 // edit count in user cache too
3488 $this->invalidateCache();
3492 * Get the description of a given right
3494 * @param $right \string Right to query
3495 * @return \string Localized description of the right
3497 static function getRightDescription( $right ) {
3498 $key = "right-$right";
3499 $name = wfMsg( $key );
3500 return $name == '' ||
wfEmptyMsg( $key, $name )
3506 * Make an old-style password hash
3508 * @param $password \string Plain-text password
3509 * @param $userId \string User ID
3510 * @return \string Password hash
3512 static function oldCrypt( $password, $userId ) {
3513 global $wgPasswordSalt;
3514 if ( $wgPasswordSalt ) {
3515 return md5( $userId . '-' . md5( $password ) );
3517 return md5( $password );
3522 * Make a new-style password hash
3524 * @param $password \string Plain-text password
3525 * @param $salt \string Optional salt, may be random or the user ID.
3526 * If unspecified or false, will generate one automatically
3527 * @return \string Password hash
3529 static function crypt( $password, $salt = false ) {
3530 global $wgPasswordSalt;
3533 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3537 if( $wgPasswordSalt ) {
3538 if ( $salt === false ) {
3539 $salt = substr( wfGenerateToken(), 0, 8 );
3541 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3543 return ':A:' . md5( $password );
3548 * Compare a password hash with a plain-text password. Requires the user
3549 * ID if there's a chance that the hash is an old-style hash.
3551 * @param $hash \string Password hash
3552 * @param $password \string Plain-text password to compare
3553 * @param $userId \string User ID for old-style password salt
3556 static function comparePasswords( $hash, $password, $userId = false ) {
3557 $type = substr( $hash, 0, 3 );
3560 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3564 if ( $type == ':A:' ) {
3566 return md5( $password ) === substr( $hash, 3 );
3567 } elseif ( $type == ':B:' ) {
3569 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3570 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3573 return self
::oldCrypt( $password, $userId ) === $hash;
3578 * Add a newuser log entry for this user
3580 * @param $byEmail Boolean: account made by email?
3581 * @param $reason String: user supplied reason
3583 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3584 global $wgUser, $wgContLang, $wgNewUserLog;
3585 if( empty( $wgNewUserLog ) ) {
3586 return true; // disabled
3589 if( $this->getName() == $wgUser->getName() ) {
3592 $action = 'create2';
3594 if ( $reason === '' ) {
3595 $reason = wfMsgForContent( 'newuserlog-byemail' );
3597 $reason = $wgContLang->commaList( array(
3598 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3602 $log = new LogPage( 'newusers' );
3605 $this->getUserPage(),
3607 array( $this->getId() )
3613 * Add an autocreate newuser log entry for this user
3614 * Used by things like CentralAuth and perhaps other authplugins.
3616 public function addNewUserLogEntryAutoCreate() {
3617 global $wgNewUserLog, $wgLogAutocreatedAccounts;
3618 if( !$wgNewUserLog ||
!$wgLogAutocreatedAccounts ) {
3619 return true; // disabled
3621 $log = new LogPage( 'newusers', false );
3622 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3626 protected function loadOptions() {
3628 if ( $this->mOptionsLoaded ||
!$this->getId() )
3631 $this->mOptions
= self
::getDefaultOptions();
3633 // Maybe load from the object
3634 if ( !is_null( $this->mOptionOverrides
) ) {
3635 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3636 foreach( $this->mOptionOverrides
as $key => $value ) {
3637 $this->mOptions
[$key] = $value;
3640 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
3641 // Load from database
3642 $dbr = wfGetDB( DB_SLAVE
);
3644 $res = $dbr->select(
3647 array( 'up_user' => $this->getId() ),
3651 foreach ( $res as $row ) {
3652 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3653 $this->mOptions
[$row->up_property
] = $row->up_value
;
3657 $this->mOptionsLoaded
= true;
3659 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3662 protected function saveOptions() {
3663 global $wgAllowPrefChange;
3665 $extuser = ExternalUser
::newFromUser( $this );
3667 $this->loadOptions();
3668 $dbw = wfGetDB( DB_MASTER
);
3670 $insert_rows = array();
3672 $saveOptions = $this->mOptions
;
3674 // Allow hooks to abort, for instance to save to a global profile.
3675 // Reset options to default state before saving.
3676 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3679 foreach( $saveOptions as $key => $value ) {
3680 # Don't bother storing default values
3681 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3682 !( $value === false ||
is_null($value) ) ) ||
3683 $value != self
::getDefaultOption( $key ) ) {
3684 $insert_rows[] = array(
3685 'up_user' => $this->getId(),
3686 'up_property' => $key,
3687 'up_value' => $value,
3690 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3691 switch ( $wgAllowPrefChange[$key] ) {
3697 $extuser->setPref( $key, $value );
3703 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3704 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3709 * Provide an array of HTML5 attributes to put on an input element
3710 * intended for the user to enter a new password. This may include
3711 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3713 * Do *not* use this when asking the user to enter his current password!
3714 * Regardless of configuration, users may have invalid passwords for whatever
3715 * reason (e.g., they were set before requirements were tightened up).
3716 * Only use it when asking for a new password, like on account creation or
3719 * Obviously, you still need to do server-side checking.
3721 * NOTE: A combination of bugs in various browsers means that this function
3722 * actually just returns array() unconditionally at the moment. May as
3723 * well keep it around for when the browser bugs get fixed, though.
3725 * @return array Array of HTML attributes suitable for feeding to
3726 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3727 * That will potentially output invalid XHTML 1.0 Transitional, and will
3728 * get confused by the boolean attribute syntax used.)
3730 public static function passwordChangeInputAttribs() {
3731 global $wgMinimalPasswordLength;
3733 if ( $wgMinimalPasswordLength == 0 ) {
3737 # Note that the pattern requirement will always be satisfied if the
3738 # input is empty, so we need required in all cases.
3740 # FIXME (bug 23769): This needs to not claim the password is required
3741 # if e-mail confirmation is being used. Since HTML5 input validation
3742 # is b0rked anyway in some browsers, just return nothing. When it's
3743 # re-enabled, fix this code to not output required for e-mail
3745 #$ret = array( 'required' );
3748 # We can't actually do this right now, because Opera 9.6 will print out
3749 # the entered password visibly in its error message! When other
3750 # browsers add support for this attribute, or Opera fixes its support,
3751 # we can add support with a version check to avoid doing this on Opera
3752 # versions where it will be a problem. Reported to Opera as
3753 # DSK-262266, but they don't have a public bug tracker for us to follow.
3755 if ( $wgMinimalPasswordLength > 1 ) {
3756 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3757 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3758 $wgMinimalPasswordLength );
3766 * Format the user message using a hook, a template, or, failing these, a static format.
3767 * @param $subject String the subject of the message
3768 * @param $text String the content of the message
3769 * @param $signature String the signature, if provided.
3771 static protected function formatUserMessage( $subject, $text, $signature ) {
3772 if ( wfRunHooks( 'FormatUserMessage',
3773 array( $subject, &$text, $signature ) ) ) {
3775 $signature = empty($signature) ?
"~~~~~" : "{$signature} ~~~~~";
3777 $template = Title
::newFromText( wfMsgForContent( 'usermessage-template' ) );
3779 ||
$template->getNamespace() !== NS_TEMPLATE
3780 ||
!$template->exists() ) {
3781 $text = "\n== $subject ==\n\n$text\n\n-- $signature";
3783 $text = '{{'. $template->getText()
3784 . " | subject=$subject | body=$text | signature=$signature }}";
3792 * Leave a user a message
3793 * @param $subject String the subject of the message
3794 * @param $text String the message to leave
3795 * @param $signature String Text to leave in the signature
3796 * @param $summary String the summary for this change, defaults to
3797 * "Leave system message."
3798 * @param $editor User The user leaving the message, defaults to
3799 * "{{MediaWiki:usermessage-editor}}"
3800 * @param $flags Int default edit flags
3802 * @return boolean true if it was successful
3804 public function leaveUserMessage( $subject, $text, $signature = "",
3805 $summary = null, $editor = null, $flags = 0 ) {
3806 if ( !isset( $summary ) ) {
3807 $summary = wfMsgForContent( 'usermessage-summary' );
3810 if ( !isset( $editor ) ) {
3811 $editor = User
::newFromName( wfMsgForContent( 'usermessage-editor' ) );
3812 if ( !$editor->isLoggedIn() ) {
3813 $editor->addToDatabase();
3817 $article = new Article( $this->getTalkPage() );
3818 wfRunHooks( 'SetupUserMessageArticle',
3819 array( $this, &$article, $subject, $text, $signature, $summary, $editor ) );
3822 $text = self
::formatUserMessage( $subject, $text, $signature );
3823 $flags = $article->checkFlags( $flags );
3825 if ( $flags & EDIT_UPDATE
) {
3826 $text = $article->getContent() . $text;
3829 $dbw = wfGetDB( DB_MASTER
);
3833 $status = $article->doEdit( $text, $summary, $flags, false, $editor );
3834 } catch ( DBQueryError
$e ) {
3835 $status = Status
::newFatal("DB Error");
3838 if ( $status->isGood() ) {
3839 // Set newtalk with the right user ID
3840 $this->setNewtalk( true );
3841 wfRunHooks( 'AfterUserMessage',
3842 array( $this, $article, $summary, $text, $signature, $summary, $editor ) );
3845 // The article was concurrently created
3846 wfDebug( __METHOD__
. ": Error ".$status->getWikiText() );
3850 return $status->isGood();