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, $wgContLang;
606 $result = false; //init $result to false for the internal checks
608 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
611 if ( $result === false ) {
612 if( strlen( $password ) < $wgMinimalPasswordLength ) {
613 return 'passwordtooshort';
614 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
615 return 'password-name-match';
617 //it seems weird returning true here, but this is because of the
618 //initialization of $result to false above. If the hook is never run or it
619 //doesn't modify $result, then we will likely get down into this if with
623 } elseif( $result === true ) {
626 return $result; //the isValidPassword hook set a string $result and returned true
631 * Does a string look like an e-mail address?
633 * There used to be a regular expression here, it got removed because it
634 * rejected valid addresses. Actually just check if there is '@' somewhere
635 * in the given address.
637 * @todo Check for RFC 2822 compilance (bug 959)
639 * @param $addr \string E-mail address
640 * @return \bool True or false
642 public static function isValidEmailAddr( $addr ) {
644 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
648 return strpos( $addr, '@' ) !== false;
652 * Given unvalidated user input, return a canonical username, or false if
653 * the username is invalid.
654 * @param $name \string User input
655 * @param $validate \types{\string,\bool} Type of validation to use:
656 * - false No validation
657 * - 'valid' Valid for batch processes
658 * - 'usable' Valid for batch processes and login
659 * - 'creatable' Valid for batch processes, login and account creation
661 static function getCanonicalName( $name, $validate = 'valid' ) {
662 # Force usernames to capital
664 $name = $wgContLang->ucfirst( $name );
666 # Reject names containing '#'; these will be cleaned up
667 # with title normalisation, but then it's too late to
669 if( strpos( $name, '#' ) !== false )
672 # Clean up name according to title rules
673 $t = ( $validate === 'valid' ) ?
674 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
675 # Check for invalid titles
676 if( is_null( $t ) ) {
680 # Reject various classes of invalid names
681 $name = $t->getText();
683 $name = $wgAuth->getCanonicalName( $t->getText() );
685 switch ( $validate ) {
689 if ( !User
::isValidUserName( $name ) ) {
694 if ( !User
::isUsableName( $name ) ) {
699 if ( !User
::isCreatableName( $name ) ) {
704 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
710 * Count the number of edits of a user
711 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
713 * @param $uid \int User ID to check
714 * @return \int The user's edit count
716 static function edits( $uid ) {
717 wfProfileIn( __METHOD__
);
718 $dbr = wfGetDB( DB_SLAVE
);
719 // check if the user_editcount field has been initialized
720 $field = $dbr->selectField(
721 'user', 'user_editcount',
722 array( 'user_id' => $uid ),
726 if( $field === null ) { // it has not been initialized. do so.
727 $dbw = wfGetDB( DB_MASTER
);
728 $count = $dbr->selectField(
729 'revision', 'count(*)',
730 array( 'rev_user' => $uid ),
735 array( 'user_editcount' => $count ),
736 array( 'user_id' => $uid ),
742 wfProfileOut( __METHOD__
);
747 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
748 * @todo hash random numbers to improve security, like generateToken()
750 * @return \string New random password
752 static function randomPassword() {
753 global $wgMinimalPasswordLength;
754 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
755 $l = strlen( $pwchars ) - 1;
757 $pwlength = max( 7, $wgMinimalPasswordLength );
758 $digit = mt_rand( 0, $pwlength - 1 );
760 for ( $i = 0; $i < $pwlength; $i++
) {
761 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
767 * Set cached properties to default.
769 * @note This no longer clears uncached lazy-initialised properties;
770 * the constructor does that instead.
773 function loadDefaults( $name = false ) {
774 wfProfileIn( __METHOD__
);
779 $this->mName
= $name;
780 $this->mRealName
= '';
781 $this->mPassword
= $this->mNewpassword
= '';
782 $this->mNewpassTime
= null;
784 $this->mOptionOverrides
= null;
785 $this->mOptionsLoaded
= false;
787 if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) {
788 $this->mTouched
= wfTimestamp( TS_MW
, $wgRequest->getCookie( 'LoggedOut' ) );
790 $this->mTouched
= '0'; # Allow any pages to be cached
793 $this->setToken(); # Random
794 $this->mEmailAuthenticated
= null;
795 $this->mEmailToken
= '';
796 $this->mEmailTokenExpires
= null;
797 $this->mRegistration
= wfTimestamp( TS_MW
);
798 $this->mGroups
= array();
800 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
802 wfProfileOut( __METHOD__
);
806 * @deprecated Use wfSetupSession().
808 function SetupSession() {
809 wfDeprecated( __METHOD__
);
814 * Load user data from the session or login cookie. If there are no valid
815 * credentials, initialises the user as an anonymous user.
816 * @return \bool True if the user is logged in, false otherwise.
818 private function loadFromSession() {
819 global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy;
822 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
823 if ( $result !== null ) {
827 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
828 $extUser = ExternalUser
::newFromCookie();
830 # TODO: Automatically create the user here (or probably a bit
831 # lower down, in fact)
835 if ( $wgRequest->getCookie( 'UserID' ) !== null ) {
836 $sId = intval( $wgRequest->getCookie( 'UserID' ) );
837 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
838 $this->loadDefaults(); // Possible collision!
839 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
840 cookie user ID ($sId) don't match!" );
843 $_SESSION['wsUserID'] = $sId;
844 } else if ( isset( $_SESSION['wsUserID'] ) ) {
845 if ( $_SESSION['wsUserID'] != 0 ) {
846 $sId = $_SESSION['wsUserID'];
848 $this->loadDefaults();
852 $this->loadDefaults();
856 if ( isset( $_SESSION['wsUserName'] ) ) {
857 $sName = $_SESSION['wsUserName'];
858 } else if ( $wgRequest->getCookie('UserName') !== null ) {
859 $sName = $wgRequest->getCookie('UserName');
860 $_SESSION['wsUserName'] = $sName;
862 $this->loadDefaults();
867 if ( !$this->loadFromId() ) {
868 # Not a valid ID, loadFromId has switched the object to anon for us
872 global $wgBlockDisablesLogin;
873 if( $wgBlockDisablesLogin && $this->isBlocked() ) {
874 # User blocked and we've disabled blocked user logins
875 $this->loadDefaults();
879 if ( isset( $_SESSION['wsToken'] ) ) {
880 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
882 } else if ( $wgRequest->getCookie( 'Token' ) !== null ) {
883 $passwordCorrect = $this->mToken
== $wgRequest->getCookie( 'Token' );
886 # No session or persistent login cookie
887 $this->loadDefaults();
891 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
892 $_SESSION['wsToken'] = $this->mToken
;
893 wfDebug( "User: logged in from $from\n" );
896 # Invalid credentials
897 wfDebug( "User: can't log in from $from, invalid credentials\n" );
898 $this->loadDefaults();
904 * Load user and user_group data from the database.
905 * $this::mId must be set, this is how the user is identified.
907 * @return \bool True if the user exists, false if the user is anonymous
910 function loadFromDatabase() {
912 $this->mId
= intval( $this->mId
);
914 /** Anonymous user */
916 $this->loadDefaults();
920 $dbr = wfGetDB( DB_MASTER
);
921 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
923 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
925 if ( $s !== false ) {
926 # Initialise user table data
927 $this->loadFromRow( $s );
928 $this->mGroups
= null; // deferred
929 $this->getEditCount(); // revalidation for nulls
934 $this->loadDefaults();
940 * Initialize this object from a row from the user table.
942 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
944 function loadFromRow( $row ) {
945 $this->mDataLoaded
= true;
947 if ( isset( $row->user_id
) ) {
948 $this->mId
= intval( $row->user_id
);
950 $this->mName
= $row->user_name
;
951 $this->mRealName
= $row->user_real_name
;
952 $this->mPassword
= $row->user_password
;
953 $this->mNewpassword
= $row->user_newpassword
;
954 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
955 $this->mEmail
= $row->user_email
;
956 $this->decodeOptions( $row->user_options
);
957 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
958 $this->mToken
= $row->user_token
;
959 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
960 $this->mEmailToken
= $row->user_email_token
;
961 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
962 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
963 $this->mEditCount
= $row->user_editcount
;
967 * Load the groups from the database if they aren't already loaded.
970 function loadGroups() {
971 if ( is_null( $this->mGroups
) ) {
972 $dbr = wfGetDB( DB_MASTER
);
973 $res = $dbr->select( 'user_groups',
975 array( 'ug_user' => $this->mId
),
977 $this->mGroups
= array();
978 foreach ( $res as $row ) {
979 $this->mGroups
[] = $row->ug_group
;
985 * Clear various cached data stored in this object.
986 * @param $reloadFrom \string Reload user and user_groups table data from a
987 * given source. May be "name", "id", "defaults", "session", or false for
990 function clearInstanceCache( $reloadFrom = false ) {
991 $this->mNewtalk
= -1;
992 $this->mDatePreference
= null;
993 $this->mBlockedby
= -1; # Unset
994 $this->mHash
= false;
996 $this->mRights
= null;
997 $this->mEffectiveGroups
= null;
998 $this->mOptions
= null;
1000 if ( $reloadFrom ) {
1001 $this->mDataLoaded
= false;
1002 $this->mFrom
= $reloadFrom;
1007 * Combine the language default options with any site-specific options
1008 * and add the default language variants.
1010 * @return \type{\arrayof{\string}} Array of options
1012 static function getDefaultOptions() {
1013 global $wgNamespacesToBeSearchedDefault;
1015 * Site defaults will override the global/language defaults
1017 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1018 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1021 * default language setting
1023 $variant = $wgContLang->getPreferredVariant( false );
1024 $defOpt['variant'] = $variant;
1025 $defOpt['language'] = $variant;
1026 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1027 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1029 $defOpt['skin'] = $wgDefaultSkin;
1035 * Get a given default option value.
1037 * @param $opt \string Name of option to retrieve
1038 * @return \string Default option value
1040 public static function getDefaultOption( $opt ) {
1041 $defOpts = self
::getDefaultOptions();
1042 if( isset( $defOpts[$opt] ) ) {
1043 return $defOpts[$opt];
1051 * Get blocking information
1053 * @param $bFromSlave \bool Whether to check the slave database first. To
1054 * improve performance, non-critical checks are done
1055 * against slaves. Check when actually saving should be
1056 * done against master.
1058 function getBlockedStatus( $bFromSlave = true ) {
1059 global $wgProxyWhitelist, $wgUser;
1061 if ( -1 != $this->mBlockedby
) {
1062 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1066 wfProfileIn( __METHOD__
);
1067 wfDebug( __METHOD__
.": checking...\n" );
1069 // Initialize data...
1070 // Otherwise something ends up stomping on $this->mBlockedby when
1071 // things get lazy-loaded later, causing false positive block hits
1072 // due to -1 !== 0. Probably session-related... Nothing should be
1073 // overwriting mBlockedby, surely?
1076 $this->mBlockedby
= 0;
1077 $this->mHideName
= 0;
1078 $this->mAllowUsertalk
= 0;
1080 # Check if we are looking at an IP or a logged-in user
1081 if ( $this->isIP( $this->getName() ) ) {
1082 $ip = $this->getName();
1084 # Check if we are looking at the current user
1085 # If we don't, and the user is logged in, we don't know about
1086 # his IP / autoblock status, so ignore autoblock of current user's IP
1087 if ( $this->getID() != $wgUser->getID() ) {
1090 # Get IP of current user
1095 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1096 # Exempt from all types of IP-block
1101 $this->mBlock
= new Block();
1102 $this->mBlock
->fromMaster( !$bFromSlave );
1103 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1104 wfDebug( __METHOD__
. ": Found block.\n" );
1105 $this->mBlockedby
= $this->mBlock
->mBy
;
1106 if( $this->mBlockedby
== 0 )
1107 $this->mBlockedby
= $this->mBlock
->mByName
;
1108 $this->mBlockreason
= $this->mBlock
->mReason
;
1109 $this->mHideName
= $this->mBlock
->mHideName
;
1110 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1111 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1112 $this->spreadBlock();
1115 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1116 // apply to users. Note that the existence of $this->mBlock is not used to
1117 // check for edit blocks, $this->mBlockedby is instead.
1121 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1123 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1124 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1125 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1129 if ( !$this->mBlockedby
&& !$this->getID() ) {
1130 if ( $this->isDnsBlacklisted( $ip ) ) {
1131 $this->mBlockedby
= wfMsg( 'sorbs' );
1132 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1138 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1140 wfProfileOut( __METHOD__
);
1144 * Whether the given IP is in a DNS blacklist.
1146 * @param $ip \string IP to check
1147 * @param $checkWhitelist Boolean: whether to check the whitelist first
1148 * @return \bool True if blacklisted.
1150 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1151 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1152 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1154 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1157 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1160 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1161 return $this->inDnsBlacklist( $ip, $urls );
1165 * Whether the given IP is in a given DNS blacklist.
1167 * @param $ip \string IP to check
1168 * @param $bases \string or Array of Strings: URL of the DNS blacklist
1169 * @return \bool True if blacklisted.
1171 function inDnsBlacklist( $ip, $bases ) {
1172 wfProfileIn( __METHOD__
);
1175 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1176 if( IP
::isIPv4( $ip ) ) {
1177 # Reverse IP, bug 21255
1178 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1180 foreach( (array)$bases as $base ) {
1182 $host = "$ipReversed.$base";
1185 $ipList = gethostbynamel( $host );
1188 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1192 wfDebug( "Requested $host, not found in $base.\n" );
1197 wfProfileOut( __METHOD__
);
1202 * Is this user subject to rate limiting?
1204 * @return \bool True if rate limited
1206 public function isPingLimitable() {
1207 global $wgRateLimitsExcludedGroups;
1208 global $wgRateLimitsExcludedIPs;
1209 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1210 // Deprecated, but kept for backwards-compatibility config
1214 wfDebug( "Checking the list of IP addresses excluded from rate limit..\n" );
1216 // Read list of IP addresses from MediaWiki namespace
1217 $message = wfMsgForContentNoTrans( 'ratelimit-excluded-ips' );
1218 $lines = explode( "\n", $message );
1219 foreach( $lines as $line ) {
1220 // Remove comment lines
1221 $comment = substr( trim( $line ), 0, 1 );
1222 if ( $comment == '#' ||
$comment == '' ) {
1225 // Remove additional comments after an IP address
1226 $comment = strpos( $line, '#' );
1227 if ( $comment > 0 ) {
1228 $line = trim( substr( $line, 0, $comment-1 ) );
1229 if ( IP
::isValid( $line ) ) {
1230 $wgRateLimitsExcludedIPs[] = IP
::sanitizeIP( $line );
1235 $ip = IP
::sanitizeIP( wfGetIP() );
1236 if( in_array( $ip, $wgRateLimitsExcludedIPs ) ) {
1237 // No other good way currently to disable rate limits
1238 // for specific IPs. :P
1239 // But this is a crappy hack and should die.
1240 wfDebug( "IP $ip matches the list of rate limit excluded IPs\n" );
1243 return !$this->isAllowed('noratelimit');
1247 * Primitive rate limits: enforce maximum actions per time period
1248 * to put a brake on flooding.
1250 * @note When using a shared cache like memcached, IP-address
1251 * last-hit counters will be shared across wikis.
1253 * @param $action \string Action to enforce; 'edit' if unspecified
1254 * @return \bool True if a rate limiter was tripped
1256 function pingLimiter( $action = 'edit' ) {
1257 # Call the 'PingLimiter' hook
1259 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1263 global $wgRateLimits;
1264 if( !isset( $wgRateLimits[$action] ) ) {
1268 # Some groups shouldn't trigger the ping limiter, ever
1269 if( !$this->isPingLimitable() )
1272 global $wgMemc, $wgRateLimitLog;
1273 wfProfileIn( __METHOD__
);
1275 $limits = $wgRateLimits[$action];
1277 $id = $this->getId();
1281 if( isset( $limits['anon'] ) && $id == 0 ) {
1282 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1285 if( isset( $limits['user'] ) && $id != 0 ) {
1286 $userLimit = $limits['user'];
1288 if( $this->isNewbie() ) {
1289 if( isset( $limits['newbie'] ) && $id != 0 ) {
1290 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1292 if( isset( $limits['ip'] ) ) {
1293 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1296 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1297 $subnet = $matches[1];
1298 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1301 // Check for group-specific permissions
1302 // If more than one group applies, use the group with the highest limit
1303 foreach ( $this->getGroups() as $group ) {
1304 if ( isset( $limits[$group] ) ) {
1305 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1306 $userLimit = $limits[$group];
1310 // Set the user limit key
1311 if ( $userLimit !== false ) {
1312 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1313 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1317 foreach( $keys as $key => $limit ) {
1318 list( $max, $period ) = $limit;
1319 $summary = "(limit $max in {$period}s)";
1320 $count = $wgMemc->get( $key );
1323 if( $count > $max ) {
1324 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1325 if( $wgRateLimitLog ) {
1326 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1330 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1333 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1334 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1336 $wgMemc->incr( $key );
1339 wfProfileOut( __METHOD__
);
1344 * Check if user is blocked
1346 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1347 * @return \bool True if blocked, false otherwise
1349 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1350 wfDebug( "User::isBlocked: enter\n" );
1351 $this->getBlockedStatus( $bFromSlave );
1352 return $this->mBlockedby
!== 0;
1356 * Check if user is blocked from editing a particular article
1358 * @param $title \string Title to check
1359 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1360 * @return \bool True if blocked, false otherwise
1362 function isBlockedFrom( $title, $bFromSlave = false ) {
1363 global $wgBlockAllowsUTEdit;
1364 wfProfileIn( __METHOD__
);
1365 wfDebug( __METHOD__
. ": enter\n" );
1367 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1368 $blocked = $this->isBlocked( $bFromSlave );
1369 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1370 # If a user's name is suppressed, they cannot make edits anywhere
1371 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1372 $title->getNamespace() == NS_USER_TALK
) {
1374 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1377 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1379 wfProfileOut( __METHOD__
);
1384 * If user is blocked, return the name of the user who placed the block
1385 * @return \string name of blocker
1387 function blockedBy() {
1388 $this->getBlockedStatus();
1389 return $this->mBlockedby
;
1393 * If user is blocked, return the specified reason for the block
1394 * @return \string Blocking reason
1396 function blockedFor() {
1397 $this->getBlockedStatus();
1398 return $this->mBlockreason
;
1402 * If user is blocked, return the ID for the block
1403 * @return \int Block ID
1405 function getBlockId() {
1406 $this->getBlockedStatus();
1407 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1411 * Check if user is blocked on all wikis.
1412 * Do not use for actual edit permission checks!
1413 * This is intented for quick UI checks.
1415 * @param $ip \type{\string} IP address, uses current client if none given
1416 * @return \type{\bool} True if blocked, false otherwise
1418 function isBlockedGlobally( $ip = '' ) {
1419 if( $this->mBlockedGlobally
!== null ) {
1420 return $this->mBlockedGlobally
;
1422 // User is already an IP?
1423 if( IP
::isIPAddress( $this->getName() ) ) {
1424 $ip = $this->getName();
1429 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1430 $this->mBlockedGlobally
= (bool)$blocked;
1431 return $this->mBlockedGlobally
;
1435 * Check if user account is locked
1437 * @return \type{\bool} True if locked, false otherwise
1439 function isLocked() {
1440 if( $this->mLocked
!== null ) {
1441 return $this->mLocked
;
1444 $authUser = $wgAuth->getUserInstance( $this );
1445 $this->mLocked
= (bool)$authUser->isLocked();
1446 return $this->mLocked
;
1450 * Check if user account is hidden
1452 * @return \type{\bool} True if hidden, false otherwise
1454 function isHidden() {
1455 if( $this->mHideName
!== null ) {
1456 return $this->mHideName
;
1458 $this->getBlockedStatus();
1459 if( !$this->mHideName
) {
1461 $authUser = $wgAuth->getUserInstance( $this );
1462 $this->mHideName
= (bool)$authUser->isHidden();
1464 return $this->mHideName
;
1468 * Get the user's ID.
1469 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1472 if( $this->mId
=== null and $this->mName
!== null
1473 and User
::isIP( $this->mName
) ) {
1474 // Special case, we know the user is anonymous
1476 } elseif( $this->mId
=== null ) {
1477 // Don't load if this was initialized from an ID
1484 * Set the user and reload all fields according to a given ID
1485 * @param $v \int User ID to reload
1487 function setId( $v ) {
1489 $this->clearInstanceCache( 'id' );
1493 * Get the user name, or the IP of an anonymous user
1494 * @return \string User's name or IP address
1496 function getName() {
1497 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1498 # Special case optimisation
1499 return $this->mName
;
1502 if ( $this->mName
=== false ) {
1504 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1506 return $this->mName
;
1511 * Set the user name.
1513 * This does not reload fields from the database according to the given
1514 * name. Rather, it is used to create a temporary "nonexistent user" for
1515 * later addition to the database. It can also be used to set the IP
1516 * address for an anonymous user to something other than the current
1519 * @note User::newFromName() has rougly the same function, when the named user
1521 * @param $str \string New user name to set
1523 function setName( $str ) {
1525 $this->mName
= $str;
1529 * Get the user's name escaped by underscores.
1530 * @return \string Username escaped by underscores.
1532 function getTitleKey() {
1533 return str_replace( ' ', '_', $this->getName() );
1537 * Check if the user has new messages.
1538 * @return \bool True if the user has new messages
1540 function getNewtalk() {
1543 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1544 if( $this->mNewtalk
=== -1 ) {
1545 $this->mNewtalk
= false; # reset talk page status
1547 # Check memcached separately for anons, who have no
1548 # entire User object stored in there.
1551 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1552 $newtalk = $wgMemc->get( $key );
1553 if( strval( $newtalk ) !== '' ) {
1554 $this->mNewtalk
= (bool)$newtalk;
1556 // Since we are caching this, make sure it is up to date by getting it
1558 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1559 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1562 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1566 return (bool)$this->mNewtalk
;
1570 * Return the talk page(s) this user has new messages on.
1571 * @return \type{\arrayof{\string}} Array of page URLs
1573 function getNewMessageLinks() {
1575 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1578 if( !$this->getNewtalk() )
1580 $up = $this->getUserPage();
1581 $utp = $up->getTalkPage();
1582 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1586 * Internal uncached check for new messages
1589 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1590 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1591 * @param $fromMaster \bool true to fetch from the master, false for a slave
1592 * @return \bool True if the user has new messages
1595 function checkNewtalk( $field, $id, $fromMaster = false ) {
1596 if ( $fromMaster ) {
1597 $db = wfGetDB( DB_MASTER
);
1599 $db = wfGetDB( DB_SLAVE
);
1601 $ok = $db->selectField( 'user_newtalk', $field,
1602 array( $field => $id ), __METHOD__
);
1603 return $ok !== false;
1607 * Add or update the new messages flag
1608 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1609 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1610 * @return \bool True if successful, false otherwise
1613 function updateNewtalk( $field, $id ) {
1614 $dbw = wfGetDB( DB_MASTER
);
1615 $dbw->insert( 'user_newtalk',
1616 array( $field => $id ),
1619 if ( $dbw->affectedRows() ) {
1620 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1623 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1629 * Clear the new messages flag for the given user
1630 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1631 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1632 * @return \bool True if successful, false otherwise
1635 function deleteNewtalk( $field, $id ) {
1636 $dbw = wfGetDB( DB_MASTER
);
1637 $dbw->delete( 'user_newtalk',
1638 array( $field => $id ),
1640 if ( $dbw->affectedRows() ) {
1641 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1644 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1650 * Update the 'You have new messages!' status.
1651 * @param $val \bool Whether the user has new messages
1653 function setNewtalk( $val ) {
1654 if( wfReadOnly() ) {
1659 $this->mNewtalk
= $val;
1661 if( $this->isAnon() ) {
1663 $id = $this->getName();
1666 $id = $this->getId();
1671 $changed = $this->updateNewtalk( $field, $id );
1673 $changed = $this->deleteNewtalk( $field, $id );
1676 if( $this->isAnon() ) {
1677 // Anons have a separate memcached space, since
1678 // user records aren't kept for them.
1679 $key = wfMemcKey( 'newtalk', 'ip', $id );
1680 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1683 $this->invalidateCache();
1688 * Generate a current or new-future timestamp to be stored in the
1689 * user_touched field when we update things.
1690 * @return \string Timestamp in TS_MW format
1692 private static function newTouchedTimestamp() {
1693 global $wgClockSkewFudge;
1694 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1698 * Clear user data from memcached.
1699 * Use after applying fun updates to the database; caller's
1700 * responsibility to update user_touched if appropriate.
1702 * Called implicitly from invalidateCache() and saveSettings().
1704 private function clearSharedCache() {
1708 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1713 * Immediately touch the user data cache for this account.
1714 * Updates user_touched field, and removes account data from memcached
1715 * for reload on the next hit.
1717 function invalidateCache() {
1718 if( wfReadOnly() ) {
1723 $this->mTouched
= self
::newTouchedTimestamp();
1725 $dbw = wfGetDB( DB_MASTER
);
1726 $dbw->update( 'user',
1727 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1728 array( 'user_id' => $this->mId
),
1731 $this->clearSharedCache();
1736 * Validate the cache for this account.
1737 * @param $timestamp \string A timestamp in TS_MW format
1739 function validateCache( $timestamp ) {
1741 return ( $timestamp >= $this->mTouched
);
1745 * Get the user touched timestamp
1747 function getTouched() {
1749 return $this->mTouched
;
1753 * Set the password and reset the random token.
1754 * Calls through to authentication plugin if necessary;
1755 * will have no effect if the auth plugin refuses to
1756 * pass the change through or if the legal password
1759 * As a special case, setting the password to null
1760 * wipes it, so the account cannot be logged in until
1761 * a new password is set, for instance via e-mail.
1763 * @param $str \string New password to set
1764 * @throws PasswordError on failure
1766 function setPassword( $str ) {
1769 if( $str !== null ) {
1770 if( !$wgAuth->allowPasswordChange() ) {
1771 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1774 if( !$this->isValidPassword( $str ) ) {
1775 global $wgMinimalPasswordLength;
1776 $valid = $this->getPasswordValidity( $str );
1777 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1778 $wgMinimalPasswordLength ) );
1782 if( !$wgAuth->setPassword( $this, $str ) ) {
1783 throw new PasswordError( wfMsg( 'externaldberror' ) );
1786 $this->setInternalPassword( $str );
1792 * Set the password and reset the random token unconditionally.
1794 * @param $str \string New password to set
1796 function setInternalPassword( $str ) {
1800 if( $str === null ) {
1801 // Save an invalid hash...
1802 $this->mPassword
= '';
1804 $this->mPassword
= self
::crypt( $str );
1806 $this->mNewpassword
= '';
1807 $this->mNewpassTime
= null;
1811 * Get the user's current token.
1812 * @return \string Token
1814 function getToken() {
1816 return $this->mToken
;
1820 * Set the random token (used for persistent authentication)
1821 * Called from loadDefaults() among other places.
1823 * @param $token \string If specified, set the token to this value
1826 function setToken( $token = false ) {
1827 global $wgSecretKey, $wgProxyKey;
1830 if ( $wgSecretKey ) {
1831 $key = $wgSecretKey;
1832 } elseif ( $wgProxyKey ) {
1837 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1839 $this->mToken
= $token;
1844 * Set the cookie password
1846 * @param $str \string New cookie password
1849 function setCookiePassword( $str ) {
1851 $this->mCookiePassword
= md5( $str );
1855 * Set the password for a password reminder or new account email
1857 * @param $str \string New password to set
1858 * @param $throttle \bool If true, reset the throttle timestamp to the present
1860 function setNewpassword( $str, $throttle = true ) {
1862 $this->mNewpassword
= self
::crypt( $str );
1864 $this->mNewpassTime
= wfTimestampNow();
1869 * Has password reminder email been sent within the last
1870 * $wgPasswordReminderResendTime hours?
1871 * @return \bool True or false
1873 function isPasswordReminderThrottled() {
1874 global $wgPasswordReminderResendTime;
1876 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1879 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1880 return time() < $expiry;
1884 * Get the user's e-mail address
1885 * @return \string User's email address
1887 function getEmail() {
1889 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1890 return $this->mEmail
;
1894 * Get the timestamp of the user's e-mail authentication
1895 * @return \string TS_MW timestamp
1897 function getEmailAuthenticationTimestamp() {
1899 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1900 return $this->mEmailAuthenticated
;
1904 * Set the user's e-mail address
1905 * @param $str \string New e-mail address
1907 function setEmail( $str ) {
1909 $this->mEmail
= $str;
1910 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1914 * Get the user's real name
1915 * @return \string User's real name
1917 function getRealName() {
1919 return $this->mRealName
;
1923 * Set the user's real name
1924 * @param $str \string New real name
1926 function setRealName( $str ) {
1928 $this->mRealName
= $str;
1932 * Get the user's current setting for a given option.
1934 * @param $oname \string The option to check
1935 * @param $defaultOverride \string A default value returned if the option does not exist
1936 * @return \string User's current value for the option
1937 * @see getBoolOption()
1938 * @see getIntOption()
1940 function getOption( $oname, $defaultOverride = null ) {
1941 $this->loadOptions();
1943 if ( is_null( $this->mOptions
) ) {
1944 if($defaultOverride != '') {
1945 return $defaultOverride;
1947 $this->mOptions
= User
::getDefaultOptions();
1950 if ( array_key_exists( $oname, $this->mOptions
) ) {
1951 return $this->mOptions
[$oname];
1953 return $defaultOverride;
1958 * Get all user's options
1962 public function getOptions() {
1963 $this->loadOptions();
1964 return $this->mOptions
;
1968 * Get the user's current setting for a given option, as a boolean value.
1970 * @param $oname \string The option to check
1971 * @return \bool User's current value for the option
1974 function getBoolOption( $oname ) {
1975 return (bool)$this->getOption( $oname );
1980 * Get the user's current setting for a given option, as a boolean value.
1982 * @param $oname \string The option to check
1983 * @param $defaultOverride \int A default value returned if the option does not exist
1984 * @return \int User's current value for the option
1987 function getIntOption( $oname, $defaultOverride=0 ) {
1988 $val = $this->getOption( $oname );
1990 $val = $defaultOverride;
1992 return intval( $val );
1996 * Set the given option for a user.
1998 * @param $oname \string The option to set
1999 * @param $val \mixed New value to set
2001 function setOption( $oname, $val ) {
2003 $this->loadOptions();
2005 if ( $oname == 'skin' ) {
2006 # Clear cached skin, so the new one displays immediately in Special:Preferences
2007 $this->mSkin
= null;
2010 // Explicitly NULL values should refer to defaults
2011 global $wgDefaultUserOptions;
2012 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2013 $val = $wgDefaultUserOptions[$oname];
2016 $this->mOptions
[$oname] = $val;
2020 * Reset all options to the site defaults
2022 function resetOptions() {
2023 $this->mOptions
= User
::getDefaultOptions();
2027 * Get the user's preferred date format.
2028 * @return \string User's preferred date format
2030 function getDatePreference() {
2031 // Important migration for old data rows
2032 if ( is_null( $this->mDatePreference
) ) {
2034 $value = $this->getOption( 'date' );
2035 $map = $wgLang->getDatePreferenceMigrationMap();
2036 if ( isset( $map[$value] ) ) {
2037 $value = $map[$value];
2039 $this->mDatePreference
= $value;
2041 return $this->mDatePreference
;
2045 * Get the user preferred stub threshold
2047 function getStubThreshold() {
2048 global $wgMaxArticleSize; # Maximum article size, in Kb
2049 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2050 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2051 # If they have set an impossible value, disable the preference
2052 # so we can use the parser cache again.
2059 * Get the permissions this user has.
2060 * @return \type{\arrayof{\string}} Array of permission names
2062 function getRights() {
2063 if ( is_null( $this->mRights
) ) {
2064 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2065 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2066 // Force reindexation of rights when a hook has unset one of them
2067 $this->mRights
= array_values( $this->mRights
);
2069 return $this->mRights
;
2073 * Get the list of explicit group memberships this user has.
2074 * The implicit * and user groups are not included.
2075 * @return \type{\arrayof{\string}} Array of internal group names
2077 function getGroups() {
2079 return $this->mGroups
;
2083 * Get the list of implicit group memberships this user has.
2084 * This includes all explicit groups, plus 'user' if logged in,
2085 * '*' for all accounts and autopromoted groups
2086 * @param $recache \bool Whether to avoid the cache
2087 * @return \type{\arrayof{\string}} Array of internal group names
2089 function getEffectiveGroups( $recache = false ) {
2090 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2091 wfProfileIn( __METHOD__
);
2092 $this->mEffectiveGroups
= $this->getGroups();
2093 $this->mEffectiveGroups
[] = '*';
2094 if( $this->getId() ) {
2095 $this->mEffectiveGroups
[] = 'user';
2097 $this->mEffectiveGroups
= array_unique( array_merge(
2098 $this->mEffectiveGroups
,
2099 Autopromote
::getAutopromoteGroups( $this )
2102 # Hook for additional groups
2103 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2105 wfProfileOut( __METHOD__
);
2107 return $this->mEffectiveGroups
;
2111 * Get the user's edit count.
2112 * @return \int User'e edit count
2114 function getEditCount() {
2115 if( $this->getId() ) {
2116 if ( !isset( $this->mEditCount
) ) {
2117 /* Populate the count, if it has not been populated yet */
2118 $this->mEditCount
= User
::edits( $this->mId
);
2120 return $this->mEditCount
;
2128 * Add the user to the given group.
2129 * This takes immediate effect.
2130 * @param $group \string Name of the group to add
2132 function addGroup( $group ) {
2133 $dbw = wfGetDB( DB_MASTER
);
2134 if( $this->getId() ) {
2135 $dbw->insert( 'user_groups',
2137 'ug_user' => $this->getID(),
2138 'ug_group' => $group,
2141 array( 'IGNORE' ) );
2144 $this->loadGroups();
2145 $this->mGroups
[] = $group;
2146 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2148 $this->invalidateCache();
2152 * Remove the user from the given group.
2153 * This takes immediate effect.
2154 * @param $group \string Name of the group to remove
2156 function removeGroup( $group ) {
2158 $dbw = wfGetDB( DB_MASTER
);
2159 $dbw->delete( 'user_groups',
2161 'ug_user' => $this->getID(),
2162 'ug_group' => $group,
2165 $this->loadGroups();
2166 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2167 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2169 $this->invalidateCache();
2173 * Get whether the user is logged in
2174 * @return \bool True or false
2176 function isLoggedIn() {
2177 return $this->getID() != 0;
2181 * Get whether the user is anonymous
2182 * @return \bool True or false
2185 return !$this->isLoggedIn();
2189 * Get whether the user is a bot
2190 * @return \bool True or false
2194 wfDeprecated( __METHOD__
);
2195 return $this->isAllowed( 'bot' );
2199 * Check if user is allowed to access a feature / make an action
2200 * @param $action \string action to be checked
2201 * @return \bool True if action is allowed, else false
2203 function isAllowed( $action = '' ) {
2204 if ( $action === '' )
2205 return true; // In the spirit of DWIM
2206 # Patrolling may not be enabled
2207 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2208 global $wgUseRCPatrol, $wgUseNPPatrol;
2209 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2212 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2213 # by misconfiguration: 0 == 'foo'
2214 return in_array( $action, $this->getRights(), true );
2218 * Check whether to enable recent changes patrol features for this user
2219 * @return \bool True or false
2221 public function useRCPatrol() {
2222 global $wgUseRCPatrol;
2223 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2227 * Check whether to enable new pages patrol features for this user
2228 * @return \bool True or false
2230 public function useNPPatrol() {
2231 global $wgUseRCPatrol, $wgUseNPPatrol;
2232 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2236 * Get the current skin, loading it if required, and setting a title
2237 * @param $t Title: the title to use in the skin
2238 * @return Skin The current skin
2239 * @todo FIXME : need to check the old failback system [AV]
2241 function getSkin( $t = null ) {
2243 $skin = $this->createSkinObject();
2244 $skin->setTitle( $t );
2247 if ( ! $this->mSkin
) {
2248 $this->mSkin
= $this->createSkinObject();
2251 if ( ! $this->mSkin
->getTitle() ) {
2253 $t = $wgOut->getTitle();
2254 $this->mSkin
->setTitle($t);
2257 return $this->mSkin
;
2261 // Creates a Skin object, for getSkin()
2262 private function createSkinObject() {
2263 wfProfileIn( __METHOD__
);
2265 global $wgHiddenPrefs;
2266 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2269 $userSkin = $this->getOption( 'skin' );
2270 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2272 # if we're not allowing users to override, then use the default
2273 global $wgDefaultSkin;
2274 $userSkin = $wgDefaultSkin;
2277 $skin = Skin
::newFromKey( $userSkin );
2278 wfProfileOut( __METHOD__
);
2284 * Check the watched status of an article.
2285 * @param $title \type{Title} Title of the article to look at
2286 * @return \bool True if article is watched
2288 function isWatched( $title ) {
2289 $wl = WatchedItem
::fromUserTitle( $this, $title );
2290 return $wl->isWatched();
2295 * @param $title \type{Title} Title of the article to look at
2297 function addWatch( $title ) {
2298 $wl = WatchedItem
::fromUserTitle( $this, $title );
2300 $this->invalidateCache();
2304 * Stop watching an article.
2305 * @param $title \type{Title} Title of the article to look at
2307 function removeWatch( $title ) {
2308 $wl = WatchedItem
::fromUserTitle( $this, $title );
2310 $this->invalidateCache();
2314 * Clear the user's notification timestamp for the given title.
2315 * If e-notif e-mails are on, they will receive notification mails on
2316 * the next change of the page if it's watched etc.
2317 * @param $title \type{Title} Title of the article to look at
2319 function clearNotification( &$title ) {
2320 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2322 # Do nothing if the database is locked to writes
2323 if( wfReadOnly() ) {
2327 if( $title->getNamespace() == NS_USER_TALK
&&
2328 $title->getText() == $this->getName() ) {
2329 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2331 $this->setNewtalk( false );
2334 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2338 if( $this->isAnon() ) {
2339 // Nothing else to do...
2343 // Only update the timestamp if the page is being watched.
2344 // The query to find out if it is watched is cached both in memcached and per-invocation,
2345 // and when it does have to be executed, it can be on a slave
2346 // If this is the user's newtalk page, we always update the timestamp
2347 if( $title->getNamespace() == NS_USER_TALK
&&
2348 $title->getText() == $wgUser->getName() )
2351 } elseif ( $this->getId() == $wgUser->getId() ) {
2352 $watched = $title->userIsWatching();
2357 // If the page is watched by the user (or may be watched), update the timestamp on any
2358 // any matching rows
2360 $dbw = wfGetDB( DB_MASTER
);
2361 $dbw->update( 'watchlist',
2363 'wl_notificationtimestamp' => null
2364 ), array( /* WHERE */
2365 'wl_title' => $title->getDBkey(),
2366 'wl_namespace' => $title->getNamespace(),
2367 'wl_user' => $this->getID()
2374 * Resets all of the given user's page-change notification timestamps.
2375 * If e-notif e-mails are on, they will receive notification mails on
2376 * the next change of any watched page.
2378 * @param $currentUser \int User ID
2380 function clearAllNotifications( $currentUser ) {
2381 global $wgUseEnotif, $wgShowUpdatedMarker;
2382 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2383 $this->setNewtalk( false );
2386 if( $currentUser != 0 ) {
2387 $dbw = wfGetDB( DB_MASTER
);
2388 $dbw->update( 'watchlist',
2390 'wl_notificationtimestamp' => null
2391 ), array( /* WHERE */
2392 'wl_user' => $currentUser
2395 # We also need to clear here the "you have new message" notification for the own user_talk page
2396 # This is cleared one page view later in Article::viewUpdates();
2401 * Set this user's options from an encoded string
2402 * @param $str \string Encoded options to import
2405 function decodeOptions( $str ) {
2409 $this->mOptionsLoaded
= true;
2410 $this->mOptionOverrides
= array();
2412 // If an option is not set in $str, use the default value
2413 $this->mOptions
= self
::getDefaultOptions();
2415 $a = explode( "\n", $str );
2416 foreach ( $a as $s ) {
2418 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2419 $this->mOptions
[$m[1]] = $m[2];
2420 $this->mOptionOverrides
[$m[1]] = $m[2];
2426 * Set a cookie on the user's client. Wrapper for
2427 * WebResponse::setCookie
2428 * @param $name \string Name of the cookie to set
2429 * @param $value \string Value to set
2430 * @param $exp \int Expiration time, as a UNIX time value;
2431 * if 0 or not specified, use the default $wgCookieExpiration
2433 protected function setCookie( $name, $value, $exp = 0 ) {
2435 $wgRequest->response()->setcookie( $name, $value, $exp );
2439 * Clear a cookie on the user's client
2440 * @param $name \string Name of the cookie to clear
2442 protected function clearCookie( $name ) {
2443 $this->setCookie( $name, '', time() - 86400 );
2447 * Set the default cookies for this session on the user's client.
2449 function setCookies() {
2451 if ( 0 == $this->mId
) return;
2453 'wsUserID' => $this->mId
,
2454 'wsToken' => $this->mToken
,
2455 'wsUserName' => $this->getName()
2458 'UserID' => $this->mId
,
2459 'UserName' => $this->getName(),
2461 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2462 $cookies['Token'] = $this->mToken
;
2464 $cookies['Token'] = false;
2467 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2468 #check for null, since the hook could cause a null value
2469 if ( !is_null( $session ) && isset( $_SESSION ) ){
2470 $_SESSION = $session +
$_SESSION;
2472 foreach ( $cookies as $name => $value ) {
2473 if ( $value === false ) {
2474 $this->clearCookie( $name );
2476 $this->setCookie( $name, $value );
2482 * Log this user out.
2485 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2491 * Clear the user's cookies and session, and reset the instance cache.
2495 function doLogout() {
2496 $this->clearInstanceCache( 'defaults' );
2498 $_SESSION['wsUserID'] = 0;
2500 $this->clearCookie( 'UserID' );
2501 $this->clearCookie( 'Token' );
2503 # Remember when user logged out, to prevent seeing cached pages
2504 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2508 * Save this user's settings into the database.
2509 * @todo Only rarely do all these fields need to be set!
2511 function saveSettings() {
2513 if ( wfReadOnly() ) { return; }
2514 if ( 0 == $this->mId
) { return; }
2516 $this->mTouched
= self
::newTouchedTimestamp();
2518 $dbw = wfGetDB( DB_MASTER
);
2519 $dbw->update( 'user',
2521 'user_name' => $this->mName
,
2522 'user_password' => $this->mPassword
,
2523 'user_newpassword' => $this->mNewpassword
,
2524 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2525 'user_real_name' => $this->mRealName
,
2526 'user_email' => $this->mEmail
,
2527 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2528 'user_options' => '',
2529 'user_touched' => $dbw->timestamp( $this->mTouched
),
2530 'user_token' => $this->mToken
,
2531 'user_email_token' => $this->mEmailToken
,
2532 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2533 ), array( /* WHERE */
2534 'user_id' => $this->mId
2538 $this->saveOptions();
2540 wfRunHooks( 'UserSaveSettings', array( $this ) );
2541 $this->clearSharedCache();
2542 $this->getUserPage()->invalidateCache();
2546 * If only this user's username is known, and it exists, return the user ID.
2548 function idForName() {
2549 $s = trim( $this->getName() );
2550 if ( $s === '' ) return 0;
2552 $dbr = wfGetDB( DB_SLAVE
);
2553 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2554 if ( $id === false ) {
2561 * Add a user to the database, return the user object
2563 * @param $name \string Username to add
2564 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2565 * - password The user's password. Password logins will be disabled if this is omitted.
2566 * - newpassword A temporary password mailed to the user
2567 * - email The user's email address
2568 * - email_authenticated The email authentication timestamp
2569 * - real_name The user's real name
2570 * - options An associative array of non-default options
2571 * - token Random authentication token. Do not set.
2572 * - registration Registration timestamp. Do not set.
2574 * @return \type{User} A new User object, or null if the username already exists
2576 static function createNew( $name, $params = array() ) {
2579 if ( isset( $params['options'] ) ) {
2580 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2581 unset( $params['options'] );
2583 $dbw = wfGetDB( DB_MASTER
);
2584 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2586 'user_id' => $seqVal,
2587 'user_name' => $name,
2588 'user_password' => $user->mPassword
,
2589 'user_newpassword' => $user->mNewpassword
,
2590 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2591 'user_email' => $user->mEmail
,
2592 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2593 'user_real_name' => $user->mRealName
,
2594 'user_options' => '',
2595 'user_token' => $user->mToken
,
2596 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2597 'user_editcount' => 0,
2599 foreach ( $params as $name => $value ) {
2600 $fields["user_$name"] = $value;
2602 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2603 if ( $dbw->affectedRows() ) {
2604 $newUser = User
::newFromId( $dbw->insertId() );
2612 * Add this existing user object to the database
2614 function addToDatabase() {
2616 $dbw = wfGetDB( DB_MASTER
);
2617 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2618 $dbw->insert( 'user',
2620 'user_id' => $seqVal,
2621 'user_name' => $this->mName
,
2622 'user_password' => $this->mPassword
,
2623 'user_newpassword' => $this->mNewpassword
,
2624 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2625 'user_email' => $this->mEmail
,
2626 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2627 'user_real_name' => $this->mRealName
,
2628 'user_options' => '',
2629 'user_token' => $this->mToken
,
2630 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2631 'user_editcount' => 0,
2634 $this->mId
= $dbw->insertId();
2636 // Clear instance cache other than user table data, which is already accurate
2637 $this->clearInstanceCache();
2639 $this->saveOptions();
2643 * If this (non-anonymous) user is blocked, block any IP address
2644 * they've successfully logged in from.
2646 function spreadBlock() {
2647 wfDebug( __METHOD__
. "()\n" );
2649 if ( $this->mId
== 0 ) {
2653 $userblock = Block
::newFromDB( '', $this->mId
);
2654 if ( !$userblock ) {
2658 $userblock->doAutoblock( wfGetIP() );
2662 * Generate a string which will be different for any combination of
2663 * user options which would produce different parser output.
2664 * This will be used as part of the hash key for the parser cache,
2665 * so users with the same options can share the same cached data
2668 * Extensions which require it should install 'PageRenderingHash' hook,
2669 * which will give them a chance to modify this key based on their own
2672 * @deprecated use the ParserOptions object to get the relevant options
2673 * @return \string Page rendering hash
2675 function getPageRenderingHash() {
2676 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2678 return $this->mHash
;
2680 wfDeprecated( __METHOD__
);
2682 // stubthreshold is only included below for completeness,
2683 // since it disables the parser cache, its value will always
2684 // be 0 when this function is called by parsercache.
2686 $confstr = $this->getOption( 'math' );
2687 $confstr .= '!' . $this->getStubThreshold();
2688 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2689 $confstr .= '!' . $this->getDatePreference();
2691 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2692 $confstr .= '!' . $wgLang->getCode();
2693 $confstr .= '!' . $this->getOption( 'thumbsize' );
2694 // add in language specific options, if any
2695 $extra = $wgContLang->getExtraHashOptions();
2698 // Since the skin could be overloading link(), it should be
2699 // included here but in practice, none of our skins do that.
2701 $confstr .= $wgRenderHashAppend;
2703 // Give a chance for extensions to modify the hash, if they have
2704 // extra options or other effects on the parser cache.
2705 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2707 // Make it a valid memcached key fragment
2708 $confstr = str_replace( ' ', '_', $confstr );
2709 $this->mHash
= $confstr;
2714 * Get whether the user is explicitly blocked from account creation.
2715 * @return \bool True if blocked
2717 function isBlockedFromCreateAccount() {
2718 $this->getBlockedStatus();
2719 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2723 * Get whether the user is blocked from using Special:Emailuser.
2724 * @return \bool True if blocked
2726 function isBlockedFromEmailuser() {
2727 $this->getBlockedStatus();
2728 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2732 * Get whether the user is allowed to create an account.
2733 * @return \bool True if allowed
2735 function isAllowedToCreateAccount() {
2736 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2740 * Get this user's personal page title.
2742 * @return \type{Title} User's personal page title
2744 function getUserPage() {
2745 return Title
::makeTitle( NS_USER
, $this->getName() );
2749 * Get this user's talk page title.
2751 * @return \type{Title} User's talk page title
2753 function getTalkPage() {
2754 $title = $this->getUserPage();
2755 return $title->getTalkPage();
2759 * Get the maximum valid user ID.
2760 * @return \int User ID
2763 function getMaxID() {
2764 static $res; // cache
2766 if ( isset( $res ) ) {
2769 $dbr = wfGetDB( DB_SLAVE
);
2770 return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__
);
2775 * Determine whether the user is a newbie. Newbies are either
2776 * anonymous IPs, or the most recently created accounts.
2777 * @return \bool True if the user is a newbie
2779 function isNewbie() {
2780 return !$this->isAllowed( 'autoconfirmed' );
2784 * Check to see if the given clear-text password is one of the accepted passwords
2785 * @param $password \string user password.
2786 * @return \bool True if the given password is correct, otherwise False.
2788 function checkPassword( $password ) {
2792 // Even though we stop people from creating passwords that
2793 // are shorter than this, doesn't mean people wont be able
2794 // to. Certain authentication plugins do NOT want to save
2795 // domain passwords in a mysql database, so we should
2796 // check this (incase $wgAuth->strict() is false).
2797 if( !$this->isValidPassword( $password ) ) {
2801 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2803 } elseif( $wgAuth->strict() ) {
2804 /* Auth plugin doesn't allow local authentication */
2806 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2807 /* Auth plugin doesn't allow local authentication for this user name */
2810 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2812 } elseif ( function_exists( 'iconv' ) ) {
2813 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2814 # Check for this with iconv
2815 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2816 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2824 * Check if the given clear-text password matches the temporary password
2825 * sent by e-mail for password reset operations.
2826 * @return \bool True if matches, false otherwise
2828 function checkTemporaryPassword( $plaintext ) {
2829 global $wgNewPasswordExpiry;
2830 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2832 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2833 return ( time() < $expiry );
2840 * Initialize (if necessary) and return a session token value
2841 * which can be used in edit forms to show that the user's
2842 * login credentials aren't being hijacked with a foreign form
2845 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2846 * @return \string The new edit token
2848 function editToken( $salt = '' ) {
2849 if ( $this->isAnon() ) {
2850 return EDIT_TOKEN_SUFFIX
;
2852 if( !isset( $_SESSION['wsEditToken'] ) ) {
2853 $token = self
::generateToken();
2854 $_SESSION['wsEditToken'] = $token;
2856 $token = $_SESSION['wsEditToken'];
2858 if( is_array( $salt ) ) {
2859 $salt = implode( '|', $salt );
2861 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2866 * Generate a looking random token for various uses.
2868 * @param $salt \string Optional salt value
2869 * @return \string The new random token
2871 public static function generateToken( $salt = '' ) {
2872 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2873 return md5( $token . $salt );
2877 * Check given value against the token value stored in the session.
2878 * A match should confirm that the form was submitted from the
2879 * user's own login session, not a form submission from a third-party
2882 * @param $val \string Input value to compare
2883 * @param $salt \string Optional function-specific data for hashing
2884 * @return \bool Whether the token matches
2886 function matchEditToken( $val, $salt = '' ) {
2887 $sessionToken = $this->editToken( $salt );
2888 if ( $val != $sessionToken ) {
2889 wfDebug( "User::matchEditToken: broken session data\n" );
2891 return $val == $sessionToken;
2895 * Check given value against the token value stored in the session,
2896 * ignoring the suffix.
2898 * @param $val \string Input value to compare
2899 * @param $salt \string Optional function-specific data for hashing
2900 * @return \bool Whether the token matches
2902 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2903 $sessionToken = $this->editToken( $salt );
2904 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2908 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2909 * mail to the user's given address.
2911 * @param $changed Boolean: whether the adress changed
2912 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2914 function sendConfirmationMail( $changed = false ) {
2916 $expiration = null; // gets passed-by-ref and defined in next line.
2917 $token = $this->confirmationToken( $expiration );
2918 $url = $this->confirmationTokenUrl( $token );
2919 $invalidateURL = $this->invalidationTokenUrl( $token );
2920 $this->saveSettings();
2922 $message = $changed ?
'confirmemail_body_changed' : 'confirmemail_body';
2923 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2928 $wgLang->timeanddate( $expiration, false ),
2930 $wgLang->date( $expiration, false ),
2931 $wgLang->time( $expiration, false ) ) );
2935 * Send an e-mail to this user's account. Does not check for
2936 * confirmed status or validity.
2938 * @param $subject \string Message subject
2939 * @param $body \string Message body
2940 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2941 * @param $replyto \string Reply-To address
2942 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2944 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2945 if( is_null( $from ) ) {
2946 global $wgPasswordSender;
2947 $from = $wgPasswordSender;
2950 $to = new MailAddress( $this );
2951 $sender = new MailAddress( $from );
2952 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2956 * Generate, store, and return a new e-mail confirmation code.
2957 * A hash (unsalted, since it's used as a key) is stored.
2959 * @note Call saveSettings() after calling this function to commit
2960 * this change to the database.
2962 * @param[out] &$expiration \mixed Accepts the expiration time
2963 * @return \string New token
2966 function confirmationToken( &$expiration ) {
2968 $expires = $now +
7 * 24 * 60 * 60;
2969 $expiration = wfTimestamp( TS_MW
, $expires );
2970 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
2971 $hash = md5( $token );
2973 $this->mEmailToken
= $hash;
2974 $this->mEmailTokenExpires
= $expiration;
2979 * Return a URL the user can use to confirm their email address.
2980 * @param $token \string Accepts the email confirmation token
2981 * @return \string New token URL
2984 function confirmationTokenUrl( $token ) {
2985 return $this->getTokenUrl( 'ConfirmEmail', $token );
2989 * Return a URL the user can use to invalidate their email address.
2990 * @param $token \string Accepts the email confirmation token
2991 * @return \string New token URL
2994 function invalidationTokenUrl( $token ) {
2995 return $this->getTokenUrl( 'Invalidateemail', $token );
2999 * Internal function to format the e-mail validation/invalidation URLs.
3000 * This uses $wgArticlePath directly as a quickie hack to use the
3001 * hardcoded English names of the Special: pages, for ASCII safety.
3003 * @note Since these URLs get dropped directly into emails, using the
3004 * short English names avoids insanely long URL-encoded links, which
3005 * also sometimes can get corrupted in some browsers/mailers
3006 * (bug 6957 with Gmail and Internet Explorer).
3008 * @param $page \string Special page
3009 * @param $token \string Token
3010 * @return \string Formatted URL
3012 protected function getTokenUrl( $page, $token ) {
3013 global $wgArticlePath;
3017 "Special:$page/$token",
3022 * Mark the e-mail address confirmed.
3024 * @note Call saveSettings() after calling this function to commit the change.
3026 function confirmEmail() {
3027 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3028 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3033 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3034 * address if it was already confirmed.
3036 * @note Call saveSettings() after calling this function to commit the change.
3038 function invalidateEmail() {
3040 $this->mEmailToken
= null;
3041 $this->mEmailTokenExpires
= null;
3042 $this->setEmailAuthenticationTimestamp( null );
3043 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3048 * Set the e-mail authentication timestamp.
3049 * @param $timestamp \string TS_MW timestamp
3051 function setEmailAuthenticationTimestamp( $timestamp ) {
3053 $this->mEmailAuthenticated
= $timestamp;
3054 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3058 * Is this user allowed to send e-mails within limits of current
3059 * site configuration?
3060 * @return \bool True if allowed
3062 function canSendEmail() {
3063 global $wgEnableEmail, $wgEnableUserEmail;
3064 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3067 $canSend = $this->isEmailConfirmed();
3068 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3073 * Is this user allowed to receive e-mails within limits of current
3074 * site configuration?
3075 * @return \bool True if allowed
3077 function canReceiveEmail() {
3078 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3082 * Is this user's e-mail address valid-looking and confirmed within
3083 * limits of the current site configuration?
3085 * @note If $wgEmailAuthentication is on, this may require the user to have
3086 * confirmed their address by returning a code or using a password
3087 * sent to the address from the wiki.
3089 * @return \bool True if confirmed
3091 function isEmailConfirmed() {
3092 global $wgEmailAuthentication;
3095 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3096 if( $this->isAnon() )
3098 if( !self
::isValidEmailAddr( $this->mEmail
) )
3100 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3109 * Check whether there is an outstanding request for e-mail confirmation.
3110 * @return \bool True if pending
3112 function isEmailConfirmationPending() {
3113 global $wgEmailAuthentication;
3114 return $wgEmailAuthentication &&
3115 !$this->isEmailConfirmed() &&
3116 $this->mEmailToken
&&
3117 $this->mEmailTokenExpires
> wfTimestamp();
3121 * Get the timestamp of account creation.
3123 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3124 * non-existent/anonymous user accounts.
3126 public function getRegistration() {
3127 return $this->getId() > 0
3128 ?
$this->mRegistration
3133 * Get the timestamp of the first edit
3135 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3136 * non-existent/anonymous user accounts.
3138 public function getFirstEditTimestamp() {
3139 if( $this->getId() == 0 ) return false; // anons
3140 $dbr = wfGetDB( DB_SLAVE
);
3141 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3142 array( 'rev_user' => $this->getId() ),
3144 array( 'ORDER BY' => 'rev_timestamp ASC' )
3146 if( !$time ) return false; // no edits
3147 return wfTimestamp( TS_MW
, $time );
3151 * Get the permissions associated with a given list of groups
3153 * @param $groups \type{\arrayof{\string}} List of internal group names
3154 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3156 static function getGroupPermissions( $groups ) {
3157 global $wgGroupPermissions, $wgRevokePermissions;
3159 // grant every granted permission first
3160 foreach( $groups as $group ) {
3161 if( isset( $wgGroupPermissions[$group] ) ) {
3162 $rights = array_merge( $rights,
3163 // array_filter removes empty items
3164 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3167 // now revoke the revoked permissions
3168 foreach( $groups as $group ) {
3169 if( isset( $wgRevokePermissions[$group] ) ) {
3170 $rights = array_diff( $rights,
3171 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3174 return array_unique( $rights );
3178 * Get all the groups who have a given permission
3180 * @param $role \string Role to check
3181 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3183 static function getGroupsWithPermission( $role ) {
3184 global $wgGroupPermissions;
3185 $allowedGroups = array();
3186 foreach ( $wgGroupPermissions as $group => $rights ) {
3187 if ( isset( $rights[$role] ) && $rights[$role] ) {
3188 $allowedGroups[] = $group;
3191 return $allowedGroups;
3195 * Get the localized descriptive name for a group, if it exists
3197 * @param $group \string Internal group name
3198 * @return \string Localized descriptive group name
3200 static function getGroupName( $group ) {
3201 $key = "group-$group";
3202 $name = wfMsg( $key );
3203 return $name == '' ||
wfEmptyMsg( $key, $name )
3209 * Get the localized descriptive name for a member of a group, if it exists
3211 * @param $group \string Internal group name
3212 * @return \string Localized name for group member
3214 static function getGroupMember( $group ) {
3215 $key = "group-$group-member";
3216 $name = wfMsg( $key );
3217 return $name == '' ||
wfEmptyMsg( $key, $name )
3223 * Return the set of defined explicit groups.
3224 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3225 * are not included, as they are defined automatically, not in the database.
3226 * @return \type{\arrayof{\string}} Array of internal group names
3228 static function getAllGroups() {
3229 global $wgGroupPermissions, $wgRevokePermissions;
3231 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3232 self
::getImplicitGroups()
3237 * Get a list of all available permissions.
3238 * @return \type{\arrayof{\string}} Array of permission names
3240 static function getAllRights() {
3241 if ( self
::$mAllRights === false ) {
3242 global $wgAvailableRights;
3243 if ( count( $wgAvailableRights ) ) {
3244 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3246 self
::$mAllRights = self
::$mCoreRights;
3248 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3250 return self
::$mAllRights;
3254 * Get a list of implicit groups
3255 * @return \type{\arrayof{\string}} Array of internal group names
3257 public static function getImplicitGroups() {
3258 global $wgImplicitGroups;
3259 $groups = $wgImplicitGroups;
3260 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3265 * Get the title of a page describing a particular group
3267 * @param $group \string Internal group name
3268 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3270 static function getGroupPage( $group ) {
3271 $page = wfMsgForContent( 'grouppage-' . $group );
3272 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3273 $title = Title
::newFromText( $page );
3274 if( is_object( $title ) )
3281 * Create a link to the group in HTML, if available;
3282 * else return the group name.
3284 * @param $group \string Internal name of the group
3285 * @param $text \string The text of the link
3286 * @return \string HTML link to the group
3288 static function makeGroupLinkHTML( $group, $text = '' ) {
3290 $text = self
::getGroupName( $group );
3292 $title = self
::getGroupPage( $group );
3295 $sk = $wgUser->getSkin();
3296 return $sk->link( $title, htmlspecialchars( $text ) );
3303 * Create a link to the group in Wikitext, if available;
3304 * else return the group name.
3306 * @param $group \string Internal name of the group
3307 * @param $text \string The text of the link
3308 * @return \string Wikilink to the group
3310 static function makeGroupLinkWiki( $group, $text = '' ) {
3312 $text = self
::getGroupName( $group );
3314 $title = self
::getGroupPage( $group );
3316 $page = $title->getPrefixedText();
3317 return "[[$page|$text]]";
3324 * Returns an array of the groups that a particular group can add/remove.
3326 * @param $group String: the group to check for whether it can add/remove
3327 * @return Array array( 'add' => array( addablegroups ),
3328 * 'remove' => array( removablegroups ),
3329 * 'add-self' => array( addablegroups to self),
3330 * 'remove-self' => array( removable groups from self) )
3332 static function changeableByGroup( $group ) {
3333 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3335 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3336 if( empty( $wgAddGroups[$group] ) ) {
3337 // Don't add anything to $groups
3338 } elseif( $wgAddGroups[$group] === true ) {
3339 // You get everything
3340 $groups['add'] = self
::getAllGroups();
3341 } elseif( is_array( $wgAddGroups[$group] ) ) {
3342 $groups['add'] = $wgAddGroups[$group];
3345 // Same thing for remove
3346 if( empty( $wgRemoveGroups[$group] ) ) {
3347 } elseif( $wgRemoveGroups[$group] === true ) {
3348 $groups['remove'] = self
::getAllGroups();
3349 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3350 $groups['remove'] = $wgRemoveGroups[$group];
3353 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3354 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3355 foreach( $wgGroupsAddToSelf as $key => $value ) {
3356 if( is_int( $key ) ) {
3357 $wgGroupsAddToSelf['user'][] = $value;
3362 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3363 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3364 if( is_int( $key ) ) {
3365 $wgGroupsRemoveFromSelf['user'][] = $value;
3370 // Now figure out what groups the user can add to him/herself
3371 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3372 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3373 // No idea WHY this would be used, but it's there
3374 $groups['add-self'] = User
::getAllGroups();
3375 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3376 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3379 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3380 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3381 $groups['remove-self'] = User
::getAllGroups();
3382 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3383 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3390 * Returns an array of groups that this user can add and remove
3391 * @return Array array( 'add' => array( addablegroups ),
3392 * 'remove' => array( removablegroups ),
3393 * 'add-self' => array( addablegroups to self),
3394 * 'remove-self' => array( removable groups from self) )
3396 function changeableGroups() {
3397 if( $this->isAllowed( 'userrights' ) ) {
3398 // This group gives the right to modify everything (reverse-
3399 // compatibility with old "userrights lets you change
3401 // Using array_merge to make the groups reindexed
3402 $all = array_merge( User
::getAllGroups() );
3406 'add-self' => array(),
3407 'remove-self' => array()
3411 // Okay, it's not so simple, we will have to go through the arrays
3414 'remove' => array(),
3415 'add-self' => array(),
3416 'remove-self' => array()
3418 $addergroups = $this->getEffectiveGroups();
3420 foreach( $addergroups as $addergroup ) {
3421 $groups = array_merge_recursive(
3422 $groups, $this->changeableByGroup( $addergroup )
3424 $groups['add'] = array_unique( $groups['add'] );
3425 $groups['remove'] = array_unique( $groups['remove'] );
3426 $groups['add-self'] = array_unique( $groups['add-self'] );
3427 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3433 * Increment the user's edit-count field.
3434 * Will have no effect for anonymous users.
3436 function incEditCount() {
3437 if( !$this->isAnon() ) {
3438 $dbw = wfGetDB( DB_MASTER
);
3439 $dbw->update( 'user',
3440 array( 'user_editcount=user_editcount+1' ),
3441 array( 'user_id' => $this->getId() ),
3444 // Lazy initialization check...
3445 if( $dbw->affectedRows() == 0 ) {
3446 // Pull from a slave to be less cruel to servers
3447 // Accuracy isn't the point anyway here
3448 $dbr = wfGetDB( DB_SLAVE
);
3449 $count = $dbr->selectField( 'revision',
3451 array( 'rev_user' => $this->getId() ),
3454 // Now here's a goddamn hack...
3455 if( $dbr !== $dbw ) {
3456 // If we actually have a slave server, the count is
3457 // at least one behind because the current transaction
3458 // has not been committed and replicated.
3461 // But if DB_SLAVE is selecting the master, then the
3462 // count we just read includes the revision that was
3463 // just added in the working transaction.
3466 $dbw->update( 'user',
3467 array( 'user_editcount' => $count ),
3468 array( 'user_id' => $this->getId() ),
3472 // edit count in user cache too
3473 $this->invalidateCache();
3477 * Get the description of a given right
3479 * @param $right \string Right to query
3480 * @return \string Localized description of the right
3482 static function getRightDescription( $right ) {
3483 $key = "right-$right";
3484 $name = wfMsg( $key );
3485 return $name == '' ||
wfEmptyMsg( $key, $name )
3491 * Make an old-style password hash
3493 * @param $password \string Plain-text password
3494 * @param $userId \string User ID
3495 * @return \string Password hash
3497 static function oldCrypt( $password, $userId ) {
3498 global $wgPasswordSalt;
3499 if ( $wgPasswordSalt ) {
3500 return md5( $userId . '-' . md5( $password ) );
3502 return md5( $password );
3507 * Make a new-style password hash
3509 * @param $password \string Plain-text password
3510 * @param $salt \string Optional salt, may be random or the user ID.
3511 * If unspecified or false, will generate one automatically
3512 * @return \string Password hash
3514 static function crypt( $password, $salt = false ) {
3515 global $wgPasswordSalt;
3518 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3522 if( $wgPasswordSalt ) {
3523 if ( $salt === false ) {
3524 $salt = substr( wfGenerateToken(), 0, 8 );
3526 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3528 return ':A:' . md5( $password );
3533 * Compare a password hash with a plain-text password. Requires the user
3534 * ID if there's a chance that the hash is an old-style hash.
3536 * @param $hash \string Password hash
3537 * @param $password \string Plain-text password to compare
3538 * @param $userId \string User ID for old-style password salt
3541 static function comparePasswords( $hash, $password, $userId = false ) {
3542 $type = substr( $hash, 0, 3 );
3545 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3549 if ( $type == ':A:' ) {
3551 return md5( $password ) === substr( $hash, 3 );
3552 } elseif ( $type == ':B:' ) {
3554 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3555 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3558 return self
::oldCrypt( $password, $userId ) === $hash;
3563 * Add a newuser log entry for this user
3565 * @param $byEmail Boolean: account made by email?
3566 * @param $reason String: user supplied reason
3568 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3569 global $wgUser, $wgContLang, $wgNewUserLog;
3570 if( empty( $wgNewUserLog ) ) {
3571 return true; // disabled
3574 if( $this->getName() == $wgUser->getName() ) {
3577 $action = 'create2';
3579 if ( $reason === '' ) {
3580 $reason = wfMsgForContent( 'newuserlog-byemail' );
3582 $reason = $wgContLang->commaList( array(
3583 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3587 $log = new LogPage( 'newusers' );
3590 $this->getUserPage(),
3592 array( $this->getId() )
3598 * Add an autocreate newuser log entry for this user
3599 * Used by things like CentralAuth and perhaps other authplugins.
3601 public function addNewUserLogEntryAutoCreate() {
3602 global $wgNewUserLog, $wgLogAutocreatedAccounts;
3603 if( !$wgNewUserLog ||
!$wgLogAutocreatedAccounts ) {
3604 return true; // disabled
3606 $log = new LogPage( 'newusers', false );
3607 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3611 protected function loadOptions() {
3613 if ( $this->mOptionsLoaded ||
!$this->getId() )
3616 $this->mOptions
= self
::getDefaultOptions();
3618 // Maybe load from the object
3619 if ( !is_null( $this->mOptionOverrides
) ) {
3620 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3621 foreach( $this->mOptionOverrides
as $key => $value ) {
3622 $this->mOptions
[$key] = $value;
3625 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
3626 // Load from database
3627 $dbr = wfGetDB( DB_SLAVE
);
3629 $res = $dbr->select(
3632 array( 'up_user' => $this->getId() ),
3636 foreach ( $res as $row ) {
3637 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3638 $this->mOptions
[$row->up_property
] = $row->up_value
;
3642 $this->mOptionsLoaded
= true;
3644 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3647 protected function saveOptions() {
3648 global $wgAllowPrefChange;
3650 $extuser = ExternalUser
::newFromUser( $this );
3652 $this->loadOptions();
3653 $dbw = wfGetDB( DB_MASTER
);
3655 $insert_rows = array();
3657 $saveOptions = $this->mOptions
;
3659 // Allow hooks to abort, for instance to save to a global profile.
3660 // Reset options to default state before saving.
3661 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3664 foreach( $saveOptions as $key => $value ) {
3665 # Don't bother storing default values
3666 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3667 !( $value === false ||
is_null($value) ) ) ||
3668 $value != self
::getDefaultOption( $key ) ) {
3669 $insert_rows[] = array(
3670 'up_user' => $this->getId(),
3671 'up_property' => $key,
3672 'up_value' => $value,
3675 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3676 switch ( $wgAllowPrefChange[$key] ) {
3682 $extuser->setPref( $key, $value );
3688 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3689 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3694 * Provide an array of HTML5 attributes to put on an input element
3695 * intended for the user to enter a new password. This may include
3696 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3698 * Do *not* use this when asking the user to enter his current password!
3699 * Regardless of configuration, users may have invalid passwords for whatever
3700 * reason (e.g., they were set before requirements were tightened up).
3701 * Only use it when asking for a new password, like on account creation or
3704 * Obviously, you still need to do server-side checking.
3706 * NOTE: A combination of bugs in various browsers means that this function
3707 * actually just returns array() unconditionally at the moment. May as
3708 * well keep it around for when the browser bugs get fixed, though.
3710 * @return array Array of HTML attributes suitable for feeding to
3711 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3712 * That will potentially output invalid XHTML 1.0 Transitional, and will
3713 * get confused by the boolean attribute syntax used.)
3715 public static function passwordChangeInputAttribs() {
3716 global $wgMinimalPasswordLength;
3718 if ( $wgMinimalPasswordLength == 0 ) {
3722 # Note that the pattern requirement will always be satisfied if the
3723 # input is empty, so we need required in all cases.
3725 # FIXME (bug 23769): This needs to not claim the password is required
3726 # if e-mail confirmation is being used. Since HTML5 input validation
3727 # is b0rked anyway in some browsers, just return nothing. When it's
3728 # re-enabled, fix this code to not output required for e-mail
3730 #$ret = array( 'required' );
3733 # We can't actually do this right now, because Opera 9.6 will print out
3734 # the entered password visibly in its error message! When other
3735 # browsers add support for this attribute, or Opera fixes its support,
3736 # we can add support with a version check to avoid doing this on Opera
3737 # versions where it will be a problem. Reported to Opera as
3738 # DSK-262266, but they don't have a public bug tracker for us to follow.
3740 if ( $wgMinimalPasswordLength > 1 ) {
3741 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3742 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3743 $wgMinimalPasswordLength );
3751 * Format the user message using a hook, a template, or, failing these, a static format.
3752 * @param $subject String the subject of the message
3753 * @param $text String the content of the message
3754 * @param $signature String the signature, if provided.
3756 static protected function formatUserMessage( $subject, $text, $signature ) {
3757 if ( wfRunHooks( 'FormatUserMessage',
3758 array( $subject, &$text, $signature ) ) ) {
3760 $signature = empty($signature) ?
"~~~~~" : "{$signature} ~~~~~";
3762 $template = Title
::newFromText( wfMsgForContent( 'usermessage-template' ) );
3764 ||
$template->getNamespace() !== NS_TEMPLATE
3765 ||
!$template->exists() ) {
3766 $text = "\n== $subject ==\n\n$text\n\n-- $signature";
3768 $text = '{{'. $template->getText()
3769 . " | subject=$subject | body=$text | signature=$signature }}";
3777 * Leave a user a message
3778 * @param $subject String the subject of the message
3779 * @param $text String the message to leave
3780 * @param $signature String Text to leave in the signature
3781 * @param $summary String the summary for this change, defaults to
3782 * "Leave system message."
3783 * @param $editor User The user leaving the message, defaults to
3784 * "{{MediaWiki:usermessage-editor}}"
3785 * @param $flags Int default edit flags
3787 * @return boolean true if it was successful
3789 public function leaveUserMessage( $subject, $text, $signature = "",
3790 $summary = null, $editor = null, $flags = 0 ) {
3791 if ( !isset( $summary ) ) {
3792 $summary = wfMsgForContent( 'usermessage-summary' );
3795 if ( !isset( $editor ) ) {
3796 $editor = User
::newFromName( wfMsgForContent( 'usermessage-editor' ) );
3797 if ( !$editor->isLoggedIn() ) {
3798 $editor->addToDatabase();
3802 $article = new Article( $this->getTalkPage() );
3803 wfRunHooks( 'SetupUserMessageArticle',
3804 array( $this, &$article, $subject, $text, $signature, $summary, $editor ) );
3807 $text = self
::formatUserMessage( $subject, $text, $signature );
3808 $flags = $article->checkFlags( $flags );
3810 if ( $flags & EDIT_UPDATE
) {
3811 $text = $article->getContent() . $text;
3814 $dbw = wfGetDB( DB_MASTER
);
3818 $status = $article->doEdit( $text, $summary, $flags, false, $editor );
3819 } catch ( DBQueryError
$e ) {
3820 $status = Status
::newFatal("DB Error");
3823 if ( $status->isGood() ) {
3824 // Set newtalk with the right user ID
3825 $this->setNewtalk( true );
3826 wfRunHooks( 'AfterUserMessage',
3827 array( $this, $article, $summary, $text, $signature, $summary, $editor ) );
3830 // The article was concurrently created
3831 wfDebug( __METHOD__
. ": Error ".$status->getWikiText() );
3835 return $status->isGood();