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
46 * \type{\arrayof{\string}} A list of default user toggles, i.e., boolean user
47 * preferences that are displayed by Special:Preferences as checkboxes.
48 * This list can be extended via the UserToggles hook or by
49 * $wgContLang::getExtraUserToggles().
52 public static $mToggles = array(
62 'editsectiononrightclick',
74 'enotifwatchlistpages',
75 'enotifusertalkpages',
78 'shownumberswatching',
98 * \type{\arrayof{\string}} List of member variables which are saved to the
99 * shared cache (memcached). Any operation which changes the
100 * corresponding database fields must call a cache-clearing function.
103 static $mCacheVars = array(
114 'mEmailAuthenticated',
116 'mEmailTokenExpires',
121 // user_properties table
126 * \type{\arrayof{\string}} Core rights.
127 * Each of these should have a corresponding message of the form
131 static $mCoreRights = array(
158 'move-rootuserpages',
162 'override-export-depth',
182 'userrights-interwiki',
186 * \string Cached results of getAllRights()
188 static $mAllRights = false;
190 /** @name Cache variables */
192 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
193 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
194 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
198 * \bool Whether the cache variables have been loaded.
200 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
203 * \string Initialization data source if mDataLoaded==false. May be one of:
204 * - 'defaults' anonymous user initialised from class defaults
205 * - 'name' initialise from mName
206 * - 'id' initialise from mId
207 * - 'session' log in from cookies or session if possible
209 * Use the User::newFrom*() family of functions to set this.
213 /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
215 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
216 $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
217 $mLocked, $mHideName, $mOptions;
220 static $idCacheByName = array();
223 * Lightweight constructor for an anonymous user.
224 * Use the User::newFrom* factory functions for other kinds of users.
228 * @see newFromConfirmationCode()
229 * @see newFromSession()
233 $this->clearInstanceCache( 'defaults' );
237 * Load the user table data for this object from the source given by mFrom.
240 if ( $this->mDataLoaded
) {
243 wfProfileIn( __METHOD__
);
245 # Set it now to avoid infinite recursion in accessors
246 $this->mDataLoaded
= true;
248 switch ( $this->mFrom
) {
250 $this->loadDefaults();
253 $this->mId
= self
::idFromName( $this->mName
);
255 # Nonexistent user placeholder object
256 $this->loadDefaults( $this->mName
);
265 $this->loadFromSession();
266 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
269 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
271 wfProfileOut( __METHOD__
);
275 * Load user table data, given mId has already been set.
276 * @return \bool false if the ID does not exist, true otherwise
279 function loadFromId() {
281 if ( $this->mId
== 0 ) {
282 $this->loadDefaults();
287 $key = wfMemcKey( 'user', 'id', $this->mId
);
288 $data = $wgMemc->get( $key );
289 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
290 # Object is expired, load from DB
295 wfDebug( "Cache miss for user {$this->mId}\n" );
297 if ( !$this->loadFromDatabase() ) {
298 # Can't load from ID, user is anonymous
301 $this->saveToCache();
303 wfDebug( "Got user {$this->mId} from cache\n" );
305 foreach ( self
::$mCacheVars as $name ) {
306 $this->$name = $data[$name];
313 * Save user data to the shared cache
315 function saveToCache() {
318 $this->loadOptions();
319 if ( $this->isAnon() ) {
320 // Anonymous users are uncached
324 foreach ( self
::$mCacheVars as $name ) {
325 $data[$name] = $this->$name;
327 $data['mVersion'] = MW_USER_VERSION
;
328 $key = wfMemcKey( 'user', 'id', $this->mId
);
330 $wgMemc->set( $key, $data );
334 /** @name newFrom*() static factory methods */
338 * Static factory method for creation from username.
340 * This is slightly less efficient than newFromId(), so use newFromId() if
341 * you have both an ID and a name handy.
343 * @param $name \string Username, validated by Title::newFromText()
344 * @param $validate \mixed Validate username. Takes the same parameters as
345 * User::getCanonicalName(), except that true is accepted as an alias
346 * for 'valid', for BC.
348 * @return \type{User} The User object, or null if the username is invalid. If the
349 * username is not present in the database, the result will be a user object
350 * with a name, zero user ID and default settings.
352 static function newFromName( $name, $validate = 'valid' ) {
353 if ( $validate === true ) {
356 $name = self
::getCanonicalName( $name, $validate );
357 if ( WikiError
::isError( $name ) ) {
359 } elseif ( $name === false ) {
362 # Create unloaded user object
371 * Static factory method for creation from a given user ID.
373 * @param $id \int Valid user ID
374 * @return \type{User} The corresponding User object
376 static function newFromId( $id ) {
384 * Factory method to fetch whichever user has a given email confirmation code.
385 * This code is generated when an account is created or its e-mail address
388 * If the code is invalid or has expired, returns NULL.
390 * @param $code \string Confirmation code
391 * @return \type{User}
393 static function newFromConfirmationCode( $code ) {
394 $dbr = wfGetDB( DB_SLAVE
);
395 $id = $dbr->selectField( 'user', 'user_id', array(
396 'user_email_token' => md5( $code ),
397 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
399 if( $id !== false ) {
400 return User
::newFromId( $id );
407 * Create a new user object using data from session or cookies. If the
408 * login credentials are invalid, the result is an anonymous user.
410 * @return \type{User}
412 static function newFromSession() {
414 $user->mFrom
= 'session';
419 * Create a new user object from a user row.
420 * The row should have all fields from the user table in it.
421 * @param $row array A row from the user table
422 * @return \type{User}
424 static function newFromRow( $row ) {
426 $user->loadFromRow( $row );
434 * Get the username corresponding to a given user ID
435 * @param $id \int User ID
436 * @return \string The corresponding username
438 static function whoIs( $id ) {
439 $dbr = wfGetDB( DB_SLAVE
);
440 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
444 * Get the real name of a user given their user ID
446 * @param $id \int User ID
447 * @return \string The corresponding user's real name
449 static function whoIsReal( $id ) {
450 $dbr = wfGetDB( DB_SLAVE
);
451 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
455 * Get database id given a user name
456 * @param $name \string Username
457 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
459 static function idFromName( $name ) {
460 $nt = Title
::makeTitleSafe( NS_USER
, $name );
461 if( is_null( $nt ) ) {
466 if ( isset( self
::$idCacheByName[$name] ) ) {
467 return self
::$idCacheByName[$name];
470 $dbr = wfGetDB( DB_SLAVE
);
471 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
473 if ( $s === false ) {
476 $result = $s->user_id
;
479 self
::$idCacheByName[$name] = $result;
481 if ( count( self
::$idCacheByName ) > 1000 ) {
482 self
::$idCacheByName = array();
489 * Does the string match an anonymous IPv4 address?
491 * This function exists for username validation, in order to reject
492 * usernames which are similar in form to IP addresses. Strings such
493 * as 300.300.300.300 will return true because it looks like an IP
494 * address, despite not being strictly valid.
496 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
497 * address because the usemod software would "cloak" anonymous IP
498 * addresses like this, if we allowed accounts like this to be created
499 * new users could get the old edits of these anonymous users.
501 * @param $name \string String to match
502 * @return \bool True or false
504 static function isIP( $name ) {
505 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
509 * Is the input a valid username?
511 * Checks if the input is a valid username, we don't want an empty string,
512 * an IP address, anything that containins slashes (would mess up subpages),
513 * is longer than the maximum allowed username size or doesn't begin with
516 * @param $name \string String to match
517 * @return \bool True or false
519 static function isValidUserName( $name ) {
520 global $wgContLang, $wgMaxNameChars;
523 || User
::isIP( $name )
524 ||
strpos( $name, '/' ) !== false
525 ||
strlen( $name ) > $wgMaxNameChars
526 ||
$name != $wgContLang->ucfirst( $name ) ) {
527 wfDebugLog( 'username', __METHOD__
.
528 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
532 // Ensure that the name can't be misresolved as a different title,
533 // such as with extra namespace keys at the start.
534 $parsed = Title
::newFromText( $name );
535 if( is_null( $parsed )
536 ||
$parsed->getNamespace()
537 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
538 wfDebugLog( 'username', __METHOD__
.
539 ": '$name' invalid due to ambiguous prefixes" );
543 // Check an additional blacklist of troublemaker characters.
544 // Should these be merged into the title char list?
545 $unicodeBlacklist = '/[' .
546 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
547 '\x{00a0}' . # non-breaking space
548 '\x{2000}-\x{200f}' . # various whitespace
549 '\x{2028}-\x{202f}' . # breaks and control chars
550 '\x{3000}' . # ideographic space
551 '\x{e000}-\x{f8ff}' . # private use
553 if( preg_match( $unicodeBlacklist, $name ) ) {
554 wfDebugLog( 'username', __METHOD__
.
555 ": '$name' invalid due to blacklisted characters" );
563 * Usernames which fail to pass this function will be blocked
564 * from user login and new account registrations, but may be used
565 * internally by batch processes.
567 * If an account already exists in this form, login will be blocked
568 * by a failure to pass this function.
570 * @param $name \string String to match
571 * @return \bool True or false
573 static function isUsableName( $name ) {
574 global $wgReservedUsernames;
575 // Must be a valid username, obviously ;)
576 if ( !self
::isValidUserName( $name ) ) {
580 static $reservedUsernames = false;
581 if ( !$reservedUsernames ) {
582 $reservedUsernames = $wgReservedUsernames;
583 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
586 // Certain names may be reserved for batch processes.
587 foreach ( $reservedUsernames as $reserved ) {
588 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
589 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
591 if ( $reserved == $name ) {
599 * Usernames which fail to pass this function will be blocked
600 * from new account registrations, but may be used internally
601 * either by batch processes or by user accounts which have
602 * already been created.
604 * Additional character blacklisting may be added here
605 * rather than in isValidUserName() to avoid disrupting
608 * @param $name \string String to match
609 * @return \bool True or false
611 static function isCreatableName( $name ) {
612 global $wgInvalidUsernameCharacters;
614 self
::isUsableName( $name ) &&
616 // Registration-time character blacklisting...
617 !preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name );
621 * Is the input a valid password for this user?
623 * @param $password String Desired password
624 * @return bool True or false
626 function isValidPassword( $password ) {
627 global $wgMinimalPasswordLength, $wgContLang;
629 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
631 if( $result === false )
634 // Password needs to be long enough, and can't be the same as the username
635 return strlen( $password ) >= $wgMinimalPasswordLength
636 && $wgContLang->lc( $password ) !== $wgContLang->lc( $this->mName
);
640 * Given unvalidated password input, return error message on failure.
642 * @param $password String Desired password
643 * @return mixed: true on success, string of error message on failure
645 function getPasswordValidity( $password ) {
646 global $wgMinimalPasswordLength, $wgContLang;
648 if ( !$this->isValidPassword( $password ) ) {
649 if( strlen( $password ) < $wgMinimalPasswordLength ) {
650 return 'passwordtooshort';
651 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
652 return 'password-name-match';
660 * Does a string look like an e-mail address?
662 * There used to be a regular expression here, it got removed because it
663 * rejected valid addresses. Actually just check if there is '@' somewhere
664 * in the given address.
666 * @todo Check for RFC 2822 compilance (bug 959)
668 * @param $addr \string E-mail address
669 * @return \bool True or false
671 public static function isValidEmailAddr( $addr ) {
673 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
677 return strpos( $addr, '@' ) !== false;
681 * Given unvalidated user input, return a canonical username, or false if
682 * the username is invalid.
683 * @param $name \string User input
684 * @param $validate \types{\string,\bool} Type of validation to use:
685 * - false No validation
686 * - 'valid' Valid for batch processes
687 * - 'usable' Valid for batch processes and login
688 * - 'creatable' Valid for batch processes, login and account creation
690 static function getCanonicalName( $name, $validate = 'valid' ) {
691 # Maybe force usernames to capital
692 $name = Title
::capitalize( $name, NS_USER
);
694 # Reject names containing '#'; these will be cleaned up
695 # with title normalisation, but then it's too late to
697 if( strpos( $name, '#' ) !== false )
698 return new WikiError( 'usernamehasherror' );
700 # Clean up name according to title rules
701 $t = ( $validate === 'valid' ) ?
702 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
703 # Check for invalid titles
704 if( is_null( $t ) ) {
708 # Reject various classes of invalid names
709 $name = $t->getText();
711 $name = $wgAuth->getCanonicalName( $t->getText() );
713 switch ( $validate ) {
717 if ( !User
::isValidUserName( $name ) ) {
722 if ( !User
::isUsableName( $name ) ) {
727 if ( !User
::isCreatableName( $name ) ) {
732 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
738 * Count the number of edits of a user
739 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
741 * @param $uid \int User ID to check
742 * @return \int The user's edit count
744 static function edits( $uid ) {
745 wfProfileIn( __METHOD__
);
746 $dbr = wfGetDB( DB_SLAVE
);
747 // check if the user_editcount field has been initialized
748 $field = $dbr->selectField(
749 'user', 'user_editcount',
750 array( 'user_id' => $uid ),
754 if( $field === null ) { // it has not been initialized. do so.
755 $dbw = wfGetDB( DB_MASTER
);
756 $count = $dbr->selectField(
757 'revision', 'count(*)',
758 array( 'rev_user' => $uid ),
763 array( 'user_editcount' => $count ),
764 array( 'user_id' => $uid ),
770 wfProfileOut( __METHOD__
);
775 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
776 * @todo hash random numbers to improve security, like generateToken()
778 * @return \string New random password
780 static function randomPassword() {
781 global $wgMinimalPasswordLength;
782 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
783 $l = strlen( $pwchars ) - 1;
785 $pwlength = max( 7, $wgMinimalPasswordLength );
786 $digit = mt_rand( 0, $pwlength - 1 );
788 for ( $i = 0; $i < $pwlength; $i++
) {
789 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
795 * Set cached properties to default.
797 * @note This no longer clears uncached lazy-initialised properties;
798 * the constructor does that instead.
801 function loadDefaults( $name = false ) {
802 wfProfileIn( __METHOD__
);
804 global $wgCookiePrefix;
807 $this->mName
= $name;
808 $this->mRealName
= '';
809 $this->mPassword
= $this->mNewpassword
= '';
810 $this->mNewpassTime
= null;
812 $this->mOptionOverrides
= null;
813 $this->mOptionsLoaded
= false;
815 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
816 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
818 $this->mTouched
= '0'; # Allow any pages to be cached
821 $this->setToken(); # Random
822 $this->mEmailAuthenticated
= null;
823 $this->mEmailToken
= '';
824 $this->mEmailTokenExpires
= null;
825 $this->mRegistration
= wfTimestamp( TS_MW
);
826 $this->mGroups
= array();
828 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
830 wfProfileOut( __METHOD__
);
834 * @deprecated Use wfSetupSession().
836 function SetupSession() {
837 wfDeprecated( __METHOD__
);
842 * Load user data from the session or login cookie. If there are no valid
843 * credentials, initialises the user as an anonymous user.
844 * @return \bool True if the user is logged in, false otherwise.
846 private function loadFromSession() {
847 global $wgMemc, $wgCookiePrefix;
850 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
851 if ( $result !== null ) {
855 if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
856 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
857 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
858 $this->loadDefaults(); // Possible collision!
859 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
860 cookie user ID ($sId) don't match!" );
863 $_SESSION['wsUserID'] = $sId;
864 } else if ( isset( $_SESSION['wsUserID'] ) ) {
865 if ( $_SESSION['wsUserID'] != 0 ) {
866 $sId = $_SESSION['wsUserID'];
868 $this->loadDefaults();
872 $this->loadDefaults();
876 if ( isset( $_SESSION['wsUserName'] ) ) {
877 $sName = $_SESSION['wsUserName'];
878 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
879 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
880 $_SESSION['wsUserName'] = $sName;
882 $this->loadDefaults();
886 $passwordCorrect = FALSE;
888 if ( !$this->loadFromId() ) {
889 # Not a valid ID, loadFromId has switched the object to anon for us
893 if ( isset( $_SESSION['wsToken'] ) ) {
894 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
896 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
897 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
900 # No session or persistent login cookie
901 $this->loadDefaults();
905 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
906 $_SESSION['wsToken'] = $this->mToken
;
907 wfDebug( "Logged in from $from\n" );
910 # Invalid credentials
911 wfDebug( "Can't log in from $from, invalid credentials\n" );
912 $this->loadDefaults();
918 * Load user and user_group data from the database.
919 * $this::mId must be set, this is how the user is identified.
921 * @return \bool True if the user exists, false if the user is anonymous
924 function loadFromDatabase() {
926 $this->mId
= intval( $this->mId
);
928 /** Anonymous user */
930 $this->loadDefaults();
934 $dbr = wfGetDB( DB_MASTER
);
935 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
937 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
939 if ( $s !== false ) {
940 # Initialise user table data
941 $this->loadFromRow( $s );
942 $this->mGroups
= null; // deferred
943 $this->getEditCount(); // revalidation for nulls
948 $this->loadDefaults();
954 * Initialize this object from a row from the user table.
956 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
958 function loadFromRow( $row ) {
959 $this->mDataLoaded
= true;
961 if ( isset( $row->user_id
) ) {
962 $this->mId
= intval( $row->user_id
);
964 $this->mName
= $row->user_name
;
965 $this->mRealName
= $row->user_real_name
;
966 $this->mPassword
= $row->user_password
;
967 $this->mNewpassword
= $row->user_newpassword
;
968 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
969 $this->mEmail
= $row->user_email
;
970 $this->decodeOptions( $row->user_options
);
971 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
972 $this->mToken
= $row->user_token
;
973 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
974 $this->mEmailToken
= $row->user_email_token
;
975 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
976 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
977 $this->mEditCount
= $row->user_editcount
;
981 * Load the groups from the database if they aren't already loaded.
984 function loadGroups() {
985 if ( is_null( $this->mGroups
) ) {
986 $dbr = wfGetDB( DB_MASTER
);
987 $res = $dbr->select( 'user_groups',
989 array( 'ug_user' => $this->mId
),
991 $this->mGroups
= array();
992 while( $row = $dbr->fetchObject( $res ) ) {
993 $this->mGroups
[] = $row->ug_group
;
999 * Clear various cached data stored in this object.
1000 * @param $reloadFrom \string Reload user and user_groups table data from a
1001 * given source. May be "name", "id", "defaults", "session", or false for
1004 function clearInstanceCache( $reloadFrom = false ) {
1005 $this->mNewtalk
= -1;
1006 $this->mDatePreference
= null;
1007 $this->mBlockedby
= -1; # Unset
1008 $this->mHash
= false;
1009 $this->mSkin
= null;
1010 $this->mRights
= null;
1011 $this->mEffectiveGroups
= null;
1012 $this->mOptions
= null;
1014 if ( $reloadFrom ) {
1015 $this->mDataLoaded
= false;
1016 $this->mFrom
= $reloadFrom;
1021 * Combine the language default options with any site-specific options
1022 * and add the default language variants.
1024 * @return \type{\arrayof{\string}} Array of options
1026 static function getDefaultOptions() {
1027 global $wgNamespacesToBeSearchedDefault;
1029 * Site defaults will override the global/language defaults
1031 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1032 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1035 * default language setting
1037 $variant = $wgContLang->getPreferredVariant( false );
1038 $defOpt['variant'] = $variant;
1039 $defOpt['language'] = $variant;
1040 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1041 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1043 $defOpt['skin'] = $wgDefaultSkin;
1049 * Get a given default option value.
1051 * @param $opt \string Name of option to retrieve
1052 * @return \string Default option value
1054 public static function getDefaultOption( $opt ) {
1055 $defOpts = self
::getDefaultOptions();
1056 if( isset( $defOpts[$opt] ) ) {
1057 return $defOpts[$opt];
1064 * Get a list of user toggle names
1065 * @return \type{\arrayof{\string}} Array of user toggle names
1067 static function getToggles() {
1068 global $wgContLang, $wgUseRCPatrol;
1069 $extraToggles = array();
1070 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1071 if( $wgUseRCPatrol ) {
1072 $extraToggles[] = 'hidepatrolled';
1073 $extraToggles[] = 'newpageshidepatrolled';
1074 $extraToggles[] = 'watchlisthidepatrolled';
1076 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1081 * Get blocking information
1083 * @param $bFromSlave \bool Whether to check the slave database first. To
1084 * improve performance, non-critical checks are done
1085 * against slaves. Check when actually saving should be
1086 * done against master.
1088 function getBlockedStatus( $bFromSlave = true ) {
1089 global $wgEnableSorbs, $wgProxyWhitelist, $wgUser;
1091 if ( -1 != $this->mBlockedby
) {
1092 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1096 wfProfileIn( __METHOD__
);
1097 wfDebug( __METHOD__
.": checking...\n" );
1099 // Initialize data...
1100 // Otherwise something ends up stomping on $this->mBlockedby when
1101 // things get lazy-loaded later, causing false positive block hits
1102 // due to -1 !== 0. Probably session-related... Nothing should be
1103 // overwriting mBlockedby, surely?
1106 $this->mBlockedby
= 0;
1107 $this->mHideName
= 0;
1108 $this->mAllowUsertalk
= 0;
1110 # Check if we are looking at an IP or a logged-in user
1111 if ( $this->isIP( $this->getName() ) ) {
1112 $ip = $this->getName();
1114 # Check if we are looking at the current user
1115 # If we don't, and the user is logged in, we don't know about
1116 # his IP / autoblock status, so ignore autoblock of current user's IP
1117 if ( $this->getID() != $wgUser->getID() ) {
1120 # Get IP of current user
1125 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1126 # Exempt from all types of IP-block
1131 $this->mBlock
= new Block();
1132 $this->mBlock
->fromMaster( !$bFromSlave );
1133 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1134 wfDebug( __METHOD__
. ": Found block.\n" );
1135 $this->mBlockedby
= $this->mBlock
->mBy
;
1136 $this->mBlockreason
= $this->mBlock
->mReason
;
1137 $this->mHideName
= $this->mBlock
->mHideName
;
1138 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1139 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1140 $this->spreadBlock();
1143 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1144 // apply to users. Note that the existence of $this->mBlock is not used to
1145 // check for edit blocks, $this->mBlockedby is instead.
1149 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1151 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1152 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1153 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1157 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1158 if ( $this->inSorbsBlacklist( $ip ) ) {
1159 $this->mBlockedby
= wfMsg( 'sorbs' );
1160 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1166 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1168 wfProfileOut( __METHOD__
);
1172 * Whether the given IP is in the SORBS blacklist.
1174 * @param $ip \string IP to check
1175 * @return \bool True if blacklisted.
1177 function inSorbsBlacklist( $ip ) {
1178 global $wgEnableSorbs, $wgSorbsUrl;
1180 return $wgEnableSorbs &&
1181 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1185 * Whether the given IP is in a given DNS blacklist.
1187 * @param $ip \string IP to check
1188 * @param $bases \string or Array of Strings: URL of the DNS blacklist
1189 * @return \bool True if blacklisted.
1191 function inDnsBlacklist( $ip, $bases ) {
1192 wfProfileIn( __METHOD__
);
1196 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1197 if( IP
::isIPv4( $ip ) ) {
1198 # Reverse IP, bug 21255
1199 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1201 foreach( (array)$bases as $base ) {
1203 $host = "$ipReversed.$base";
1206 $ipList = gethostbynamel( $host );
1209 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1213 wfDebug( "Requested $host, not found in $base.\n" );
1218 wfProfileOut( __METHOD__
);
1223 * Is this user subject to rate limiting?
1225 * @return \bool True if rate limited
1227 public function isPingLimitable() {
1228 global $wgRateLimitsExcludedGroups;
1229 global $wgRateLimitsExcludedIPs;
1230 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1231 // Deprecated, but kept for backwards-compatibility config
1234 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1235 // No other good way currently to disable rate limits
1236 // for specific IPs. :P
1237 // But this is a crappy hack and should die.
1240 return !$this->isAllowed('noratelimit');
1244 * Primitive rate limits: enforce maximum actions per time period
1245 * to put a brake on flooding.
1247 * @note When using a shared cache like memcached, IP-address
1248 * last-hit counters will be shared across wikis.
1250 * @param $action \string Action to enforce; 'edit' if unspecified
1251 * @return \bool True if a rate limiter was tripped
1253 function pingLimiter( $action = 'edit' ) {
1254 # Call the 'PingLimiter' hook
1256 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1260 global $wgRateLimits;
1261 if( !isset( $wgRateLimits[$action] ) ) {
1265 # Some groups shouldn't trigger the ping limiter, ever
1266 if( !$this->isPingLimitable() )
1269 global $wgMemc, $wgRateLimitLog;
1270 wfProfileIn( __METHOD__
);
1272 $limits = $wgRateLimits[$action];
1274 $id = $this->getId();
1278 if( isset( $limits['anon'] ) && $id == 0 ) {
1279 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1282 if( isset( $limits['user'] ) && $id != 0 ) {
1283 $userLimit = $limits['user'];
1285 if( $this->isNewbie() ) {
1286 if( isset( $limits['newbie'] ) && $id != 0 ) {
1287 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1289 if( isset( $limits['ip'] ) ) {
1290 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1293 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1294 $subnet = $matches[1];
1295 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1298 // Check for group-specific permissions
1299 // If more than one group applies, use the group with the highest limit
1300 foreach ( $this->getGroups() as $group ) {
1301 if ( isset( $limits[$group] ) ) {
1302 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1303 $userLimit = $limits[$group];
1307 // Set the user limit key
1308 if ( $userLimit !== false ) {
1309 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1310 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1314 foreach( $keys as $key => $limit ) {
1315 list( $max, $period ) = $limit;
1316 $summary = "(limit $max in {$period}s)";
1317 $count = $wgMemc->get( $key );
1320 if( $count > $max ) {
1321 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1322 if( $wgRateLimitLog ) {
1323 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1327 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1329 $wgMemc->incr( $key );
1331 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1332 $wgMemc->set( $key, 1, intval( $period ) ); // first ping
1336 wfProfileOut( __METHOD__
);
1341 * Check if user is blocked
1343 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1344 * @return \bool True if blocked, false otherwise
1346 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1347 wfDebug( "User::isBlocked: enter\n" );
1348 $this->getBlockedStatus( $bFromSlave );
1349 return $this->mBlockedby
!== 0;
1353 * Check if user is blocked from editing a particular article
1355 * @param $title \string Title to check
1356 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1357 * @return \bool True if blocked, false otherwise
1359 function isBlockedFrom( $title, $bFromSlave = false ) {
1360 global $wgBlockAllowsUTEdit;
1361 wfProfileIn( __METHOD__
);
1362 wfDebug( __METHOD__
. ": enter\n" );
1364 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1365 $blocked = $this->isBlocked( $bFromSlave );
1366 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1367 # If a user's name is suppressed, they cannot make edits anywhere
1368 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1369 $title->getNamespace() == NS_USER_TALK
) {
1371 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1374 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1376 wfProfileOut( __METHOD__
);
1381 * If user is blocked, return the name of the user who placed the block
1382 * @return \string name of blocker
1384 function blockedBy() {
1385 $this->getBlockedStatus();
1386 return $this->mBlockedby
;
1390 * If user is blocked, return the specified reason for the block
1391 * @return \string Blocking reason
1393 function blockedFor() {
1394 $this->getBlockedStatus();
1395 return $this->mBlockreason
;
1399 * If user is blocked, return the ID for the block
1400 * @return \int Block ID
1402 function getBlockId() {
1403 $this->getBlockedStatus();
1404 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1408 * Check if user is blocked on all wikis.
1409 * Do not use for actual edit permission checks!
1410 * This is intented for quick UI checks.
1412 * @param $ip \type{\string} IP address, uses current client if none given
1413 * @return \type{\bool} True if blocked, false otherwise
1415 function isBlockedGlobally( $ip = '' ) {
1416 if( $this->mBlockedGlobally
!== null ) {
1417 return $this->mBlockedGlobally
;
1419 // User is already an IP?
1420 if( IP
::isIPAddress( $this->getName() ) ) {
1421 $ip = $this->getName();
1426 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1427 $this->mBlockedGlobally
= (bool)$blocked;
1428 return $this->mBlockedGlobally
;
1432 * Check if user account is locked
1434 * @return \type{\bool} True if locked, false otherwise
1436 function isLocked() {
1437 if( $this->mLocked
!== null ) {
1438 return $this->mLocked
;
1441 $authUser = $wgAuth->getUserInstance( $this );
1442 $this->mLocked
= (bool)$authUser->isLocked();
1443 return $this->mLocked
;
1447 * Check if user account is hidden
1449 * @return \type{\bool} True if hidden, false otherwise
1451 function isHidden() {
1452 if( $this->mHideName
!== null ) {
1453 return $this->mHideName
;
1455 $this->getBlockedStatus();
1456 if( !$this->mHideName
) {
1458 $authUser = $wgAuth->getUserInstance( $this );
1459 $this->mHideName
= (bool)$authUser->isHidden();
1461 return $this->mHideName
;
1465 * Get the user's ID.
1466 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1469 if( $this->mId
=== null and $this->mName
!== null
1470 and User
::isIP( $this->mName
) ) {
1471 // Special case, we know the user is anonymous
1473 } elseif( $this->mId
=== null ) {
1474 // Don't load if this was initialized from an ID
1481 * Set the user and reload all fields according to a given ID
1482 * @param $v \int User ID to reload
1484 function setId( $v ) {
1486 $this->clearInstanceCache( 'id' );
1490 * Get the user name, or the IP of an anonymous user
1491 * @return \string User's name or IP address
1493 function getName() {
1494 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1495 # Special case optimisation
1496 return $this->mName
;
1499 if ( $this->mName
=== false ) {
1501 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1503 return $this->mName
;
1508 * Set the user name.
1510 * This does not reload fields from the database according to the given
1511 * name. Rather, it is used to create a temporary "nonexistent user" for
1512 * later addition to the database. It can also be used to set the IP
1513 * address for an anonymous user to something other than the current
1516 * @note User::newFromName() has rougly the same function, when the named user
1518 * @param $str \string New user name to set
1520 function setName( $str ) {
1522 $this->mName
= $str;
1526 * Get the user's name escaped by underscores.
1527 * @return \string Username escaped by underscores.
1529 function getTitleKey() {
1530 return str_replace( ' ', '_', $this->getName() );
1534 * Check if the user has new messages.
1535 * @return \bool True if the user has new messages
1537 function getNewtalk() {
1540 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1541 if( $this->mNewtalk
=== -1 ) {
1542 $this->mNewtalk
= false; # reset talk page status
1544 # Check memcached separately for anons, who have no
1545 # entire User object stored in there.
1548 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1549 $newtalk = $wgMemc->get( $key );
1550 if( strval( $newtalk ) !== '' ) {
1551 $this->mNewtalk
= (bool)$newtalk;
1553 // Since we are caching this, make sure it is up to date by getting it
1555 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1556 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1559 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1563 return (bool)$this->mNewtalk
;
1567 * Return the talk page(s) this user has new messages on.
1568 * @return \type{\arrayof{\string}} Array of page URLs
1570 function getNewMessageLinks() {
1572 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1575 if( !$this->getNewtalk() )
1577 $up = $this->getUserPage();
1578 $utp = $up->getTalkPage();
1579 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1583 * Internal uncached check for new messages
1586 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1587 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1588 * @param $fromMaster \bool true to fetch from the master, false for a slave
1589 * @return \bool True if the user has new messages
1592 function checkNewtalk( $field, $id, $fromMaster = false ) {
1593 if ( $fromMaster ) {
1594 $db = wfGetDB( DB_MASTER
);
1596 $db = wfGetDB( DB_SLAVE
);
1598 $ok = $db->selectField( 'user_newtalk', $field,
1599 array( $field => $id ), __METHOD__
);
1600 return $ok !== false;
1604 * Add or update the new messages flag
1605 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1606 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1607 * @return \bool True if successful, false otherwise
1610 function updateNewtalk( $field, $id ) {
1611 $dbw = wfGetDB( DB_MASTER
);
1612 $dbw->insert( 'user_newtalk',
1613 array( $field => $id ),
1616 if ( $dbw->affectedRows() ) {
1617 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1620 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1626 * Clear the new messages flag for the given user
1627 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1628 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1629 * @return \bool True if successful, false otherwise
1632 function deleteNewtalk( $field, $id ) {
1633 $dbw = wfGetDB( DB_MASTER
);
1634 $dbw->delete( 'user_newtalk',
1635 array( $field => $id ),
1637 if ( $dbw->affectedRows() ) {
1638 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1641 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1647 * Update the 'You have new messages!' status.
1648 * @param $val \bool Whether the user has new messages
1650 function setNewtalk( $val ) {
1651 if( wfReadOnly() ) {
1656 $this->mNewtalk
= $val;
1658 if( $this->isAnon() ) {
1660 $id = $this->getName();
1663 $id = $this->getId();
1668 $changed = $this->updateNewtalk( $field, $id );
1670 $changed = $this->deleteNewtalk( $field, $id );
1673 if( $this->isAnon() ) {
1674 // Anons have a separate memcached space, since
1675 // user records aren't kept for them.
1676 $key = wfMemcKey( 'newtalk', 'ip', $id );
1677 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1680 $this->invalidateCache();
1685 * Generate a current or new-future timestamp to be stored in the
1686 * user_touched field when we update things.
1687 * @return \string Timestamp in TS_MW format
1689 private static function newTouchedTimestamp() {
1690 global $wgClockSkewFudge;
1691 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1695 * Clear user data from memcached.
1696 * Use after applying fun updates to the database; caller's
1697 * responsibility to update user_touched if appropriate.
1699 * Called implicitly from invalidateCache() and saveSettings().
1701 private function clearSharedCache() {
1705 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1710 * Immediately touch the user data cache for this account.
1711 * Updates user_touched field, and removes account data from memcached
1712 * for reload on the next hit.
1714 function invalidateCache() {
1715 if( wfReadOnly() ) {
1720 $this->mTouched
= self
::newTouchedTimestamp();
1722 $dbw = wfGetDB( DB_MASTER
);
1723 $dbw->update( 'user',
1724 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1725 array( 'user_id' => $this->mId
),
1728 $this->clearSharedCache();
1733 * Validate the cache for this account.
1734 * @param $timestamp \string A timestamp in TS_MW format
1736 function validateCache( $timestamp ) {
1738 return ( $timestamp >= $this->mTouched
);
1742 * Get the user touched timestamp
1744 function getTouched() {
1746 return $this->mTouched
;
1750 * Set the password and reset the random token.
1751 * Calls through to authentication plugin if necessary;
1752 * will have no effect if the auth plugin refuses to
1753 * pass the change through or if the legal password
1756 * As a special case, setting the password to null
1757 * wipes it, so the account cannot be logged in until
1758 * a new password is set, for instance via e-mail.
1760 * @param $str \string New password to set
1761 * @throws PasswordError on failure
1763 function setPassword( $str ) {
1766 if( $str !== null ) {
1767 if( !$wgAuth->allowPasswordChange() ) {
1768 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1771 if( !$this->isValidPassword( $str ) ) {
1772 global $wgMinimalPasswordLength;
1773 $valid = $this->getPasswordValidity( $str );
1774 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1775 $wgMinimalPasswordLength ) );
1779 if( !$wgAuth->setPassword( $this, $str ) ) {
1780 throw new PasswordError( wfMsg( 'externaldberror' ) );
1783 $this->setInternalPassword( $str );
1789 * Set the password and reset the random token unconditionally.
1791 * @param $str \string New password to set
1793 function setInternalPassword( $str ) {
1797 if( $str === null ) {
1798 // Save an invalid hash...
1799 $this->mPassword
= '';
1801 $this->mPassword
= self
::crypt( $str );
1803 $this->mNewpassword
= '';
1804 $this->mNewpassTime
= null;
1808 * Get the user's current token.
1809 * @return \string Token
1811 function getToken() {
1813 return $this->mToken
;
1817 * Set the random token (used for persistent authentication)
1818 * Called from loadDefaults() among other places.
1820 * @param $token \string If specified, set the token to this value
1823 function setToken( $token = false ) {
1824 global $wgSecretKey, $wgProxyKey;
1827 if ( $wgSecretKey ) {
1828 $key = $wgSecretKey;
1829 } elseif ( $wgProxyKey ) {
1834 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1836 $this->mToken
= $token;
1841 * Set the cookie password
1843 * @param $str \string New cookie password
1846 function setCookiePassword( $str ) {
1848 $this->mCookiePassword
= md5( $str );
1852 * Set the password for a password reminder or new account email
1854 * @param $str \string New password to set
1855 * @param $throttle \bool If true, reset the throttle timestamp to the present
1857 function setNewpassword( $str, $throttle = true ) {
1859 $this->mNewpassword
= self
::crypt( $str );
1861 $this->mNewpassTime
= wfTimestampNow();
1866 * Has password reminder email been sent within the last
1867 * $wgPasswordReminderResendTime hours?
1868 * @return \bool True or false
1870 function isPasswordReminderThrottled() {
1871 global $wgPasswordReminderResendTime;
1873 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1876 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1877 return time() < $expiry;
1881 * Get the user's e-mail address
1882 * @return \string User's email address
1884 function getEmail() {
1886 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1887 return $this->mEmail
;
1891 * Get the timestamp of the user's e-mail authentication
1892 * @return \string TS_MW timestamp
1894 function getEmailAuthenticationTimestamp() {
1896 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1897 return $this->mEmailAuthenticated
;
1901 * Set the user's e-mail address
1902 * @param $str \string New e-mail address
1904 function setEmail( $str ) {
1906 $this->mEmail
= $str;
1907 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1911 * Get the user's real name
1912 * @return \string User's real name
1914 function getRealName() {
1916 return $this->mRealName
;
1920 * Set the user's real name
1921 * @param $str \string New real name
1923 function setRealName( $str ) {
1925 $this->mRealName
= $str;
1929 * Get the user's current setting for a given option.
1931 * @param $oname \string The option to check
1932 * @param $defaultOverride \string A default value returned if the option does not exist
1933 * @return \string User's current value for the option
1934 * @see getBoolOption()
1935 * @see getIntOption()
1937 function getOption( $oname, $defaultOverride = null ) {
1938 $this->loadOptions();
1940 if ( is_null( $this->mOptions
) ) {
1941 if($defaultOverride != '') {
1942 return $defaultOverride;
1944 $this->mOptions
= User
::getDefaultOptions();
1947 if ( array_key_exists( $oname, $this->mOptions
) ) {
1948 return $this->mOptions
[$oname];
1950 return $defaultOverride;
1955 * Get the user's current setting for a given option, as a boolean value.
1957 * @param $oname \string The option to check
1958 * @return \bool User's current value for the option
1961 function getBoolOption( $oname ) {
1962 return (bool)$this->getOption( $oname );
1967 * Get the user's current setting for a given option, as a boolean value.
1969 * @param $oname \string The option to check
1970 * @param $defaultOverride \int A default value returned if the option does not exist
1971 * @return \int User's current value for the option
1974 function getIntOption( $oname, $defaultOverride=0 ) {
1975 $val = $this->getOption( $oname );
1977 $val = $defaultOverride;
1979 return intval( $val );
1983 * Set the given option for a user.
1985 * @param $oname \string The option to set
1986 * @param $val \mixed New value to set
1988 function setOption( $oname, $val ) {
1990 $this->loadOptions();
1992 if ( $oname == 'skin' ) {
1993 # Clear cached skin, so the new one displays immediately in Special:Preferences
1994 unset( $this->mSkin
);
1997 // Explicitly NULL values should refer to defaults
1998 global $wgDefaultUserOptions;
1999 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2000 $val = $wgDefaultUserOptions[$oname];
2003 $this->mOptions
[$oname] = $val;
2007 * Reset all options to the site defaults
2009 function resetOptions() {
2010 $this->mOptions
= User
::getDefaultOptions();
2014 * Get the user's preferred date format.
2015 * @return \string User's preferred date format
2017 function getDatePreference() {
2018 // Important migration for old data rows
2019 if ( is_null( $this->mDatePreference
) ) {
2021 $value = $this->getOption( 'date' );
2022 $map = $wgLang->getDatePreferenceMigrationMap();
2023 if ( isset( $map[$value] ) ) {
2024 $value = $map[$value];
2026 $this->mDatePreference
= $value;
2028 return $this->mDatePreference
;
2032 * Get the permissions this user has.
2033 * @return \type{\arrayof{\string}} Array of permission names
2035 function getRights() {
2036 if ( is_null( $this->mRights
) ) {
2037 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2038 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2039 // Force reindexation of rights when a hook has unset one of them
2040 $this->mRights
= array_values( $this->mRights
);
2042 return $this->mRights
;
2046 * Get the list of explicit group memberships this user has.
2047 * The implicit * and user groups are not included.
2048 * @return \type{\arrayof{\string}} Array of internal group names
2050 function getGroups() {
2052 return $this->mGroups
;
2056 * Get the list of implicit group memberships this user has.
2057 * This includes all explicit groups, plus 'user' if logged in,
2058 * '*' for all accounts and autopromoted groups
2059 * @param $recache \bool Whether to avoid the cache
2060 * @return \type{\arrayof{\string}} Array of internal group names
2062 function getEffectiveGroups( $recache = false ) {
2063 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2064 wfProfileIn( __METHOD__
);
2065 $this->mEffectiveGroups
= $this->getGroups();
2066 $this->mEffectiveGroups
[] = '*';
2067 if( $this->getId() ) {
2068 $this->mEffectiveGroups
[] = 'user';
2070 $this->mEffectiveGroups
= array_unique( array_merge(
2071 $this->mEffectiveGroups
,
2072 Autopromote
::getAutopromoteGroups( $this )
2075 # Hook for additional groups
2076 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2078 wfProfileOut( __METHOD__
);
2080 return $this->mEffectiveGroups
;
2084 * Get the user's edit count.
2085 * @return \int User'e edit count
2087 function getEditCount() {
2088 if( $this->getId() ) {
2089 if ( !isset( $this->mEditCount
) ) {
2090 /* Populate the count, if it has not been populated yet */
2091 $this->mEditCount
= User
::edits( $this->mId
);
2093 return $this->mEditCount
;
2101 * Add the user to the given group.
2102 * This takes immediate effect.
2103 * @param $group \string Name of the group to add
2105 function addGroup( $group ) {
2106 $dbw = wfGetDB( DB_MASTER
);
2107 if( $this->getId() ) {
2108 $dbw->insert( 'user_groups',
2110 'ug_user' => $this->getID(),
2111 'ug_group' => $group,
2114 array( 'IGNORE' ) );
2117 $this->loadGroups();
2118 $this->mGroups
[] = $group;
2119 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2121 $this->invalidateCache();
2125 * Remove the user from the given group.
2126 * This takes immediate effect.
2127 * @param $group \string Name of the group to remove
2129 function removeGroup( $group ) {
2131 $dbw = wfGetDB( DB_MASTER
);
2132 $dbw->delete( 'user_groups',
2134 'ug_user' => $this->getID(),
2135 'ug_group' => $group,
2137 'User::removeGroup' );
2139 $this->loadGroups();
2140 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2141 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2143 $this->invalidateCache();
2147 * Get whether the user is logged in
2148 * @return \bool True or false
2150 function isLoggedIn() {
2151 return $this->getID() != 0;
2155 * Get whether the user is anonymous
2156 * @return \bool True or false
2159 return !$this->isLoggedIn();
2163 * Get whether the user is a bot
2164 * @return \bool True or false
2168 wfDeprecated( __METHOD__
);
2169 return $this->isAllowed( 'bot' );
2173 * Check if user is allowed to access a feature / make an action
2174 * @param $action \string action to be checked
2175 * @return \bool True if action is allowed, else false
2177 function isAllowed( $action = '' ) {
2178 if ( $action === '' )
2179 return true; // In the spirit of DWIM
2180 # Patrolling may not be enabled
2181 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2182 global $wgUseRCPatrol, $wgUseNPPatrol;
2183 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2186 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2187 # by misconfiguration: 0 == 'foo'
2188 return in_array( $action, $this->getRights(), true );
2192 * Check whether to enable recent changes patrol features for this user
2193 * @return \bool True or false
2195 public function useRCPatrol() {
2196 global $wgUseRCPatrol;
2197 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2201 * Check whether to enable new pages patrol features for this user
2202 * @return \bool True or false
2204 public function useNPPatrol() {
2205 global $wgUseRCPatrol, $wgUseNPPatrol;
2206 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2210 * Get the current skin, loading it if required, and setting a title
2211 * @param $t Title: the title to use in the skin
2212 * @return Skin The current skin
2213 * @todo FIXME : need to check the old failback system [AV]
2215 function &getSkin( $t = null ) {
2216 if ( !isset( $this->mSkin
) ) {
2217 wfProfileIn( __METHOD__
);
2219 global $wgHiddenPrefs;
2220 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2223 $userSkin = $this->getOption( 'skin' );
2224 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2226 # if we're not allowing users to override, then use the default
2227 global $wgDefaultSkin;
2228 $userSkin = $wgDefaultSkin;
2231 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2232 wfProfileOut( __METHOD__
);
2234 if( $t ||
!$this->mSkin
->getTitle() ) {
2237 $t = $wgOut->getTitle();
2239 $this->mSkin
->setTitle( $t );
2241 return $this->mSkin
;
2245 * Check the watched status of an article.
2246 * @param $title \type{Title} Title of the article to look at
2247 * @return \bool True if article is watched
2249 function isWatched( $title ) {
2250 $wl = WatchedItem
::fromUserTitle( $this, $title );
2251 return $wl->isWatched();
2256 * @param $title \type{Title} Title of the article to look at
2258 function addWatch( $title ) {
2259 $wl = WatchedItem
::fromUserTitle( $this, $title );
2261 $this->invalidateCache();
2265 * Stop watching an article.
2266 * @param $title \type{Title} Title of the article to look at
2268 function removeWatch( $title ) {
2269 $wl = WatchedItem
::fromUserTitle( $this, $title );
2271 $this->invalidateCache();
2275 * Clear the user's notification timestamp for the given title.
2276 * If e-notif e-mails are on, they will receive notification mails on
2277 * the next change of the page if it's watched etc.
2278 * @param $title \type{Title} Title of the article to look at
2280 function clearNotification( &$title ) {
2281 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2283 # Do nothing if the database is locked to writes
2284 if( wfReadOnly() ) {
2288 if( $title->getNamespace() == NS_USER_TALK
&&
2289 $title->getText() == $this->getName() ) {
2290 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2292 $this->setNewtalk( false );
2295 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2299 if( $this->isAnon() ) {
2300 // Nothing else to do...
2304 // Only update the timestamp if the page is being watched.
2305 // The query to find out if it is watched is cached both in memcached and per-invocation,
2306 // and when it does have to be executed, it can be on a slave
2307 // If this is the user's newtalk page, we always update the timestamp
2308 if( $title->getNamespace() == NS_USER_TALK
&&
2309 $title->getText() == $wgUser->getName() )
2312 } elseif ( $this->getId() == $wgUser->getId() ) {
2313 $watched = $title->userIsWatching();
2318 // If the page is watched by the user (or may be watched), update the timestamp on any
2319 // any matching rows
2321 $dbw = wfGetDB( DB_MASTER
);
2322 $dbw->update( 'watchlist',
2324 'wl_notificationtimestamp' => NULL
2325 ), array( /* WHERE */
2326 'wl_title' => $title->getDBkey(),
2327 'wl_namespace' => $title->getNamespace(),
2328 'wl_user' => $this->getID()
2335 * Resets all of the given user's page-change notification timestamps.
2336 * If e-notif e-mails are on, they will receive notification mails on
2337 * the next change of any watched page.
2339 * @param $currentUser \int User ID
2341 function clearAllNotifications( $currentUser ) {
2342 global $wgUseEnotif, $wgShowUpdatedMarker;
2343 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2344 $this->setNewtalk( false );
2347 if( $currentUser != 0 ) {
2348 $dbw = wfGetDB( DB_MASTER
);
2349 $dbw->update( 'watchlist',
2351 'wl_notificationtimestamp' => NULL
2352 ), array( /* WHERE */
2353 'wl_user' => $currentUser
2356 # We also need to clear here the "you have new message" notification for the own user_talk page
2357 # This is cleared one page view later in Article::viewUpdates();
2362 * Set this user's options from an encoded string
2363 * @param $str \string Encoded options to import
2366 function decodeOptions( $str ) {
2370 $this->mOptionsLoaded
= true;
2371 $this->mOptionOverrides
= array();
2373 $this->mOptions
= array();
2374 $a = explode( "\n", $str );
2375 foreach ( $a as $s ) {
2377 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2378 $this->mOptions
[$m[1]] = $m[2];
2379 $this->mOptionOverrides
[$m[1]] = $m[2];
2385 * Set a cookie on the user's client. Wrapper for
2386 * WebResponse::setCookie
2387 * @param $name \string Name of the cookie to set
2388 * @param $value \string Value to set
2389 * @param $exp \int Expiration time, as a UNIX time value;
2390 * if 0 or not specified, use the default $wgCookieExpiration
2392 protected function setCookie( $name, $value, $exp = 0 ) {
2394 $wgRequest->response()->setcookie( $name, $value, $exp );
2398 * Clear a cookie on the user's client
2399 * @param $name \string Name of the cookie to clear
2401 protected function clearCookie( $name ) {
2402 $this->setCookie( $name, '', time() - 86400 );
2406 * Set the default cookies for this session on the user's client.
2408 function setCookies() {
2410 if ( 0 == $this->mId
) return;
2412 'wsUserID' => $this->mId
,
2413 'wsToken' => $this->mToken
,
2414 'wsUserName' => $this->getName()
2417 'UserID' => $this->mId
,
2418 'UserName' => $this->getName(),
2420 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2421 $cookies['Token'] = $this->mToken
;
2423 $cookies['Token'] = false;
2426 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2427 #check for null, since the hook could cause a null value
2428 if ( !is_null( $session ) && isset( $_SESSION ) ){
2429 $_SESSION = $session +
$_SESSION;
2431 foreach ( $cookies as $name => $value ) {
2432 if ( $value === false ) {
2433 $this->clearCookie( $name );
2435 $this->setCookie( $name, $value );
2441 * Log this user out.
2444 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2450 * Clear the user's cookies and session, and reset the instance cache.
2454 function doLogout() {
2455 $this->clearInstanceCache( 'defaults' );
2457 $_SESSION['wsUserID'] = 0;
2459 $this->clearCookie( 'UserID' );
2460 $this->clearCookie( 'Token' );
2462 # Remember when user logged out, to prevent seeing cached pages
2463 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2467 * Save this user's settings into the database.
2468 * @todo Only rarely do all these fields need to be set!
2470 function saveSettings() {
2472 if ( wfReadOnly() ) { return; }
2473 if ( 0 == $this->mId
) { return; }
2475 $this->mTouched
= self
::newTouchedTimestamp();
2477 $dbw = wfGetDB( DB_MASTER
);
2478 $dbw->update( 'user',
2480 'user_name' => $this->mName
,
2481 'user_password' => $this->mPassword
,
2482 'user_newpassword' => $this->mNewpassword
,
2483 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2484 'user_real_name' => $this->mRealName
,
2485 'user_email' => $this->mEmail
,
2486 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2487 'user_options' => '',
2488 'user_touched' => $dbw->timestamp( $this->mTouched
),
2489 'user_token' => $this->mToken
,
2490 'user_email_token' => $this->mEmailToken
,
2491 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2492 ), array( /* WHERE */
2493 'user_id' => $this->mId
2497 $this->saveOptions();
2499 wfRunHooks( 'UserSaveSettings', array( $this ) );
2500 $this->clearSharedCache();
2501 $this->getUserPage()->invalidateCache();
2505 * If only this user's username is known, and it exists, return the user ID.
2507 function idForName() {
2508 $s = trim( $this->getName() );
2509 if ( $s === '' ) return 0;
2511 $dbr = wfGetDB( DB_SLAVE
);
2512 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2513 if ( $id === false ) {
2520 * Add a user to the database, return the user object
2522 * @param $name \string Username to add
2523 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2524 * - password The user's password. Password logins will be disabled if this is omitted.
2525 * - newpassword A temporary password mailed to the user
2526 * - email The user's email address
2527 * - email_authenticated The email authentication timestamp
2528 * - real_name The user's real name
2529 * - options An associative array of non-default options
2530 * - token Random authentication token. Do not set.
2531 * - registration Registration timestamp. Do not set.
2533 * @return \type{User} A new User object, or null if the username already exists
2535 static function createNew( $name, $params = array() ) {
2538 if ( isset( $params['options'] ) ) {
2539 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2540 unset( $params['options'] );
2542 $dbw = wfGetDB( DB_MASTER
);
2543 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2545 'user_id' => $seqVal,
2546 'user_name' => $name,
2547 'user_password' => $user->mPassword
,
2548 'user_newpassword' => $user->mNewpassword
,
2549 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2550 'user_email' => $user->mEmail
,
2551 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2552 'user_real_name' => $user->mRealName
,
2553 'user_options' => '',
2554 'user_token' => $user->mToken
,
2555 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2556 'user_editcount' => 0,
2558 foreach ( $params as $name => $value ) {
2559 $fields["user_$name"] = $value;
2561 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2562 if ( $dbw->affectedRows() ) {
2563 $newUser = User
::newFromId( $dbw->insertId() );
2571 * Add this existing user object to the database
2573 function addToDatabase() {
2575 $dbw = wfGetDB( DB_MASTER
);
2576 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2577 $dbw->insert( 'user',
2579 'user_id' => $seqVal,
2580 'user_name' => $this->mName
,
2581 'user_password' => $this->mPassword
,
2582 'user_newpassword' => $this->mNewpassword
,
2583 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2584 'user_email' => $this->mEmail
,
2585 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2586 'user_real_name' => $this->mRealName
,
2587 'user_options' => '',
2588 'user_token' => $this->mToken
,
2589 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2590 'user_editcount' => 0,
2593 $this->mId
= $dbw->insertId();
2595 // Clear instance cache other than user table data, which is already accurate
2596 $this->clearInstanceCache();
2598 $this->saveOptions();
2602 * If this (non-anonymous) user is blocked, block any IP address
2603 * they've successfully logged in from.
2605 function spreadBlock() {
2606 wfDebug( __METHOD__
. "()\n" );
2608 if ( $this->mId
== 0 ) {
2612 $userblock = Block
::newFromDB( '', $this->mId
);
2613 if ( !$userblock ) {
2617 $userblock->doAutoblock( wfGetIP() );
2621 * Generate a string which will be different for any combination of
2622 * user options which would produce different parser output.
2623 * This will be used as part of the hash key for the parser cache,
2624 * so users with the same options can share the same cached data
2627 * Extensions which require it should install 'PageRenderingHash' hook,
2628 * which will give them a chance to modify this key based on their own
2631 * @return \string Page rendering hash
2633 function getPageRenderingHash() {
2634 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2636 return $this->mHash
;
2639 // stubthreshold is only included below for completeness,
2640 // it will always be 0 when this function is called by parsercache.
2642 $confstr = $this->getOption( 'math' );
2643 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2644 if ( $wgUseDynamicDates ) {
2645 $confstr .= '!' . $this->getDatePreference();
2647 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2648 $confstr .= '!' . $wgLang->getCode();
2649 $confstr .= '!' . $this->getOption( 'thumbsize' );
2650 // add in language specific options, if any
2651 $extra = $wgContLang->getExtraHashOptions();
2654 $confstr .= $wgRenderHashAppend;
2656 // Give a chance for extensions to modify the hash, if they have
2657 // extra options or other effects on the parser cache.
2658 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2660 // Make it a valid memcached key fragment
2661 $confstr = str_replace( ' ', '_', $confstr );
2662 $this->mHash
= $confstr;
2667 * Get whether the user is explicitly blocked from account creation.
2668 * @return \bool True if blocked
2670 function isBlockedFromCreateAccount() {
2671 $this->getBlockedStatus();
2672 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2676 * Get whether the user is blocked from using Special:Emailuser.
2677 * @return \bool True if blocked
2679 function isBlockedFromEmailuser() {
2680 $this->getBlockedStatus();
2681 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2685 * Get whether the user is allowed to create an account.
2686 * @return \bool True if allowed
2688 function isAllowedToCreateAccount() {
2689 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2695 function setLoaded( $loaded ) {
2696 wfDeprecated( __METHOD__
);
2700 * Get this user's personal page title.
2702 * @return \type{Title} User's personal page title
2704 function getUserPage() {
2705 return Title
::makeTitle( NS_USER
, $this->getName() );
2709 * Get this user's talk page title.
2711 * @return \type{Title} User's talk page title
2713 function getTalkPage() {
2714 $title = $this->getUserPage();
2715 return $title->getTalkPage();
2719 * Get the maximum valid user ID.
2720 * @return \int User ID
2723 function getMaxID() {
2724 static $res; // cache
2726 if ( isset( $res ) )
2729 $dbr = wfGetDB( DB_SLAVE
);
2730 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2735 * Determine whether the user is a newbie. Newbies are either
2736 * anonymous IPs, or the most recently created accounts.
2737 * @return \bool True if the user is a newbie
2739 function isNewbie() {
2740 return !$this->isAllowed( 'autoconfirmed' );
2744 * Check to see if the given clear-text password is one of the accepted passwords
2745 * @param $password \string user password.
2746 * @return \bool True if the given password is correct, otherwise False.
2748 function checkPassword( $password ) {
2752 // Even though we stop people from creating passwords that
2753 // are shorter than this, doesn't mean people wont be able
2754 // to. Certain authentication plugins do NOT want to save
2755 // domain passwords in a mysql database, so we should
2756 // check this (incase $wgAuth->strict() is false).
2757 if( !$this->isValidPassword( $password ) ) {
2761 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2763 } elseif( $wgAuth->strict() ) {
2764 /* Auth plugin doesn't allow local authentication */
2766 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2767 /* Auth plugin doesn't allow local authentication for this user name */
2770 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2772 } elseif ( function_exists( 'iconv' ) ) {
2773 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2774 # Check for this with iconv
2775 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2776 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2784 * Check if the given clear-text password matches the temporary password
2785 * sent by e-mail for password reset operations.
2786 * @return \bool True if matches, false otherwise
2788 function checkTemporaryPassword( $plaintext ) {
2789 global $wgNewPasswordExpiry;
2790 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2792 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2793 return ( time() < $expiry );
2800 * Initialize (if necessary) and return a session token value
2801 * which can be used in edit forms to show that the user's
2802 * login credentials aren't being hijacked with a foreign form
2805 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2806 * @return \string The new edit token
2808 function editToken( $salt = '' ) {
2809 if ( $this->isAnon() ) {
2810 return EDIT_TOKEN_SUFFIX
;
2812 if( !isset( $_SESSION['wsEditToken'] ) ) {
2813 $token = $this->generateToken();
2814 $_SESSION['wsEditToken'] = $token;
2816 $token = $_SESSION['wsEditToken'];
2818 if( is_array( $salt ) ) {
2819 $salt = implode( '|', $salt );
2821 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2826 * Generate a looking random token for various uses.
2828 * @param $salt \string Optional salt value
2829 * @return \string The new random token
2831 function generateToken( $salt = '' ) {
2832 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2833 return md5( $token . $salt );
2837 * Check given value against the token value stored in the session.
2838 * A match should confirm that the form was submitted from the
2839 * user's own login session, not a form submission from a third-party
2842 * @param $val \string Input value to compare
2843 * @param $salt \string Optional function-specific data for hashing
2844 * @return \bool Whether the token matches
2846 function matchEditToken( $val, $salt = '' ) {
2847 $sessionToken = $this->editToken( $salt );
2848 if ( $val != $sessionToken ) {
2849 wfDebug( "User::matchEditToken: broken session data\n" );
2851 return $val == $sessionToken;
2855 * Check given value against the token value stored in the session,
2856 * ignoring the suffix.
2858 * @param $val \string Input value to compare
2859 * @param $salt \string Optional function-specific data for hashing
2860 * @return \bool Whether the token matches
2862 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2863 $sessionToken = $this->editToken( $salt );
2864 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2868 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2869 * mail to the user's given address.
2871 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2873 function sendConfirmationMail() {
2875 $expiration = null; // gets passed-by-ref and defined in next line.
2876 $token = $this->confirmationToken( $expiration );
2877 $url = $this->confirmationTokenUrl( $token );
2878 $invalidateURL = $this->invalidationTokenUrl( $token );
2879 $this->saveSettings();
2881 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2882 wfMsg( 'confirmemail_body',
2886 $wgLang->timeanddate( $expiration, false ),
2888 $wgLang->date( $expiration, false ),
2889 $wgLang->time( $expiration, false ) ) );
2893 * Send an e-mail to this user's account. Does not check for
2894 * confirmed status or validity.
2896 * @param $subject \string Message subject
2897 * @param $body \string Message body
2898 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2899 * @param $replyto \string Reply-To address
2900 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2902 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2903 if( is_null( $from ) ) {
2904 global $wgPasswordSender;
2905 $from = $wgPasswordSender;
2908 $to = new MailAddress( $this );
2909 $sender = new MailAddress( $from );
2910 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2914 * Generate, store, and return a new e-mail confirmation code.
2915 * A hash (unsalted, since it's used as a key) is stored.
2917 * @note Call saveSettings() after calling this function to commit
2918 * this change to the database.
2920 * @param[out] &$expiration \mixed Accepts the expiration time
2921 * @return \string New token
2924 function confirmationToken( &$expiration ) {
2926 $expires = $now +
7 * 24 * 60 * 60;
2927 $expiration = wfTimestamp( TS_MW
, $expires );
2928 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2929 $hash = md5( $token );
2931 $this->mEmailToken
= $hash;
2932 $this->mEmailTokenExpires
= $expiration;
2937 * Return a URL the user can use to confirm their email address.
2938 * @param $token \string Accepts the email confirmation token
2939 * @return \string New token URL
2942 function confirmationTokenUrl( $token ) {
2943 return $this->getTokenUrl( 'ConfirmEmail', $token );
2947 * Return a URL the user can use to invalidate their email address.
2948 * @param $token \string Accepts the email confirmation token
2949 * @return \string New token URL
2952 function invalidationTokenUrl( $token ) {
2953 return $this->getTokenUrl( 'Invalidateemail', $token );
2957 * Internal function to format the e-mail validation/invalidation URLs.
2958 * This uses $wgArticlePath directly as a quickie hack to use the
2959 * hardcoded English names of the Special: pages, for ASCII safety.
2961 * @note Since these URLs get dropped directly into emails, using the
2962 * short English names avoids insanely long URL-encoded links, which
2963 * also sometimes can get corrupted in some browsers/mailers
2964 * (bug 6957 with Gmail and Internet Explorer).
2966 * @param $page \string Special page
2967 * @param $token \string Token
2968 * @return \string Formatted URL
2970 protected function getTokenUrl( $page, $token ) {
2971 global $wgArticlePath;
2975 "Special:$page/$token",
2980 * Mark the e-mail address confirmed.
2982 * @note Call saveSettings() after calling this function to commit the change.
2984 function confirmEmail() {
2985 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2986 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
2991 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2992 * address if it was already confirmed.
2994 * @note Call saveSettings() after calling this function to commit the change.
2996 function invalidateEmail() {
2998 $this->mEmailToken
= null;
2999 $this->mEmailTokenExpires
= null;
3000 $this->setEmailAuthenticationTimestamp( null );
3001 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3006 * Set the e-mail authentication timestamp.
3007 * @param $timestamp \string TS_MW timestamp
3009 function setEmailAuthenticationTimestamp( $timestamp ) {
3011 $this->mEmailAuthenticated
= $timestamp;
3012 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3016 * Is this user allowed to send e-mails within limits of current
3017 * site configuration?
3018 * @return \bool True if allowed
3020 function canSendEmail() {
3021 global $wgEnableEmail, $wgEnableUserEmail, $wgUser;
3022 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$wgUser->isAllowed( 'sendemail' ) ) {
3025 $canSend = $this->isEmailConfirmed();
3026 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3031 * Is this user allowed to receive e-mails within limits of current
3032 * site configuration?
3033 * @return \bool True if allowed
3035 function canReceiveEmail() {
3036 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3040 * Is this user's e-mail address valid-looking and confirmed within
3041 * limits of the current site configuration?
3043 * @note If $wgEmailAuthentication is on, this may require the user to have
3044 * confirmed their address by returning a code or using a password
3045 * sent to the address from the wiki.
3047 * @return \bool True if confirmed
3049 function isEmailConfirmed() {
3050 global $wgEmailAuthentication;
3053 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3054 if( $this->isAnon() )
3056 if( !self
::isValidEmailAddr( $this->mEmail
) )
3058 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3067 * Check whether there is an outstanding request for e-mail confirmation.
3068 * @return \bool True if pending
3070 function isEmailConfirmationPending() {
3071 global $wgEmailAuthentication;
3072 return $wgEmailAuthentication &&
3073 !$this->isEmailConfirmed() &&
3074 $this->mEmailToken
&&
3075 $this->mEmailTokenExpires
> wfTimestamp();
3079 * Get the timestamp of account creation.
3081 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3082 * non-existent/anonymous user accounts.
3084 public function getRegistration() {
3085 return $this->getId() > 0
3086 ?
$this->mRegistration
3091 * Get the timestamp of the first edit
3093 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3094 * non-existent/anonymous user accounts.
3096 public function getFirstEditTimestamp() {
3097 if( $this->getId() == 0 ) return false; // anons
3098 $dbr = wfGetDB( DB_SLAVE
);
3099 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3100 array( 'rev_user' => $this->getId() ),
3102 array( 'ORDER BY' => 'rev_timestamp ASC' )
3104 if( !$time ) return false; // no edits
3105 return wfTimestamp( TS_MW
, $time );
3109 * Get the permissions associated with a given list of groups
3111 * @param $groups \type{\arrayof{\string}} List of internal group names
3112 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3114 static function getGroupPermissions( $groups ) {
3115 global $wgGroupPermissions, $wgRevokePermissions;
3117 // grant every granted permission first
3118 foreach( $groups as $group ) {
3119 if( isset( $wgGroupPermissions[$group] ) ) {
3120 $rights = array_merge( $rights,
3121 // array_filter removes empty items
3122 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3125 // now revoke the revoked permissions
3126 foreach( $groups as $group ) {
3127 if( isset( $wgRevokePermissions[$group] ) ) {
3128 $rights = array_diff( $rights,
3129 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3132 return array_unique( $rights );
3136 * Get all the groups who have a given permission
3138 * @param $role \string Role to check
3139 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3141 static function getGroupsWithPermission( $role ) {
3142 global $wgGroupPermissions;
3143 $allowedGroups = array();
3144 foreach ( $wgGroupPermissions as $group => $rights ) {
3145 if ( isset( $rights[$role] ) && $rights[$role] ) {
3146 $allowedGroups[] = $group;
3149 return $allowedGroups;
3153 * Get the localized descriptive name for a group, if it exists
3155 * @param $group \string Internal group name
3156 * @return \string Localized descriptive group name
3158 static function getGroupName( $group ) {
3159 global $wgMessageCache;
3160 $wgMessageCache->loadAllMessages();
3161 $key = "group-$group";
3162 $name = wfMsg( $key );
3163 return $name == '' ||
wfEmptyMsg( $key, $name )
3169 * Get the localized descriptive name for a member of a group, if it exists
3171 * @param $group \string Internal group name
3172 * @return \string Localized name for group member
3174 static function getGroupMember( $group ) {
3175 global $wgMessageCache;
3176 $wgMessageCache->loadAllMessages();
3177 $key = "group-$group-member";
3178 $name = wfMsg( $key );
3179 return $name == '' ||
wfEmptyMsg( $key, $name )
3185 * Return the set of defined explicit groups.
3186 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3187 * are not included, as they are defined automatically, not in the database.
3188 * @return \type{\arrayof{\string}} Array of internal group names
3190 static function getAllGroups() {
3191 global $wgGroupPermissions, $wgRevokePermissions;
3193 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3194 self
::getImplicitGroups()
3199 * Get a list of all available permissions.
3200 * @return \type{\arrayof{\string}} Array of permission names
3202 static function getAllRights() {
3203 if ( self
::$mAllRights === false ) {
3204 global $wgAvailableRights;
3205 if ( count( $wgAvailableRights ) ) {
3206 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3208 self
::$mAllRights = self
::$mCoreRights;
3210 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3212 return self
::$mAllRights;
3216 * Get a list of implicit groups
3217 * @return \type{\arrayof{\string}} Array of internal group names
3219 public static function getImplicitGroups() {
3220 global $wgImplicitGroups;
3221 $groups = $wgImplicitGroups;
3222 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3227 * Get the title of a page describing a particular group
3229 * @param $group \string Internal group name
3230 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3232 static function getGroupPage( $group ) {
3233 global $wgMessageCache;
3234 $wgMessageCache->loadAllMessages();
3235 $page = wfMsgForContent( 'grouppage-' . $group );
3236 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3237 $title = Title
::newFromText( $page );
3238 if( is_object( $title ) )
3245 * Create a link to the group in HTML, if available;
3246 * else return the group name.
3248 * @param $group \string Internal name of the group
3249 * @param $text \string The text of the link
3250 * @return \string HTML link to the group
3252 static function makeGroupLinkHTML( $group, $text = '' ) {
3254 $text = self
::getGroupName( $group );
3256 $title = self
::getGroupPage( $group );
3259 $sk = $wgUser->getSkin();
3260 return $sk->link( $title, htmlspecialchars( $text ) );
3267 * Create a link to the group in Wikitext, if available;
3268 * else return the group name.
3270 * @param $group \string Internal name of the group
3271 * @param $text \string The text of the link
3272 * @return \string Wikilink to the group
3274 static function makeGroupLinkWiki( $group, $text = '' ) {
3276 $text = self
::getGroupName( $group );
3278 $title = self
::getGroupPage( $group );
3280 $page = $title->getPrefixedText();
3281 return "[[$page|$text]]";
3288 * Returns an array of the groups that a particular group can add/remove.
3290 * @param $group String: the group to check for whether it can add/remove
3291 * @return Array array( 'add' => array( addablegroups ),
3292 * 'remove' => array( removablegroups ),
3293 * 'add-self' => array( addablegroups to self),
3294 * 'remove-self' => array( removable groups from self) )
3296 static function changeableByGroup( $group ) {
3297 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3299 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3300 if( empty( $wgAddGroups[$group] ) ) {
3301 // Don't add anything to $groups
3302 } elseif( $wgAddGroups[$group] === true ) {
3303 // You get everything
3304 $groups['add'] = self
::getAllGroups();
3305 } elseif( is_array( $wgAddGroups[$group] ) ) {
3306 $groups['add'] = $wgAddGroups[$group];
3309 // Same thing for remove
3310 if( empty( $wgRemoveGroups[$group] ) ) {
3311 } elseif( $wgRemoveGroups[$group] === true ) {
3312 $groups['remove'] = self
::getAllGroups();
3313 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3314 $groups['remove'] = $wgRemoveGroups[$group];
3317 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3318 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3319 foreach( $wgGroupsAddToSelf as $key => $value ) {
3320 if( is_int( $key ) ) {
3321 $wgGroupsAddToSelf['user'][] = $value;
3326 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3327 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3328 if( is_int( $key ) ) {
3329 $wgGroupsRemoveFromSelf['user'][] = $value;
3334 // Now figure out what groups the user can add to him/herself
3335 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3336 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3337 // No idea WHY this would be used, but it's there
3338 $groups['add-self'] = User
::getAllGroups();
3339 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3340 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3343 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3344 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3345 $groups['remove-self'] = User
::getAllGroups();
3346 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3347 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3354 * Returns an array of groups that this user can add and remove
3355 * @return Array array( 'add' => array( addablegroups ),
3356 * 'remove' => array( removablegroups ),
3357 * 'add-self' => array( addablegroups to self),
3358 * 'remove-self' => array( removable groups from self) )
3360 function changeableGroups() {
3361 if( $this->isAllowed( 'userrights' ) ) {
3362 // This group gives the right to modify everything (reverse-
3363 // compatibility with old "userrights lets you change
3365 // Using array_merge to make the groups reindexed
3366 $all = array_merge( User
::getAllGroups() );
3370 'add-self' => array(),
3371 'remove-self' => array()
3375 // Okay, it's not so simple, we will have to go through the arrays
3378 'remove' => array(),
3379 'add-self' => array(),
3380 'remove-self' => array()
3382 $addergroups = $this->getEffectiveGroups();
3384 foreach( $addergroups as $addergroup ) {
3385 $groups = array_merge_recursive(
3386 $groups, $this->changeableByGroup( $addergroup )
3388 $groups['add'] = array_unique( $groups['add'] );
3389 $groups['remove'] = array_unique( $groups['remove'] );
3390 $groups['add-self'] = array_unique( $groups['add-self'] );
3391 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3397 * Increment the user's edit-count field.
3398 * Will have no effect for anonymous users.
3400 function incEditCount() {
3401 if( !$this->isAnon() ) {
3402 $dbw = wfGetDB( DB_MASTER
);
3403 $dbw->update( 'user',
3404 array( 'user_editcount=user_editcount+1' ),
3405 array( 'user_id' => $this->getId() ),
3408 // Lazy initialization check...
3409 if( $dbw->affectedRows() == 0 ) {
3410 // Pull from a slave to be less cruel to servers
3411 // Accuracy isn't the point anyway here
3412 $dbr = wfGetDB( DB_SLAVE
);
3413 $count = $dbr->selectField( 'revision',
3415 array( 'rev_user' => $this->getId() ),
3418 // Now here's a goddamn hack...
3419 if( $dbr !== $dbw ) {
3420 // If we actually have a slave server, the count is
3421 // at least one behind because the current transaction
3422 // has not been committed and replicated.
3425 // But if DB_SLAVE is selecting the master, then the
3426 // count we just read includes the revision that was
3427 // just added in the working transaction.
3430 $dbw->update( 'user',
3431 array( 'user_editcount' => $count ),
3432 array( 'user_id' => $this->getId() ),
3436 // edit count in user cache too
3437 $this->invalidateCache();
3441 * Get the description of a given right
3443 * @param $right \string Right to query
3444 * @return \string Localized description of the right
3446 static function getRightDescription( $right ) {
3447 global $wgMessageCache;
3448 $wgMessageCache->loadAllMessages();
3449 $key = "right-$right";
3450 $name = wfMsg( $key );
3451 return $name == '' ||
wfEmptyMsg( $key, $name )
3457 * Make an old-style password hash
3459 * @param $password \string Plain-text password
3460 * @param $userId \string User ID
3461 * @return \string Password hash
3463 static function oldCrypt( $password, $userId ) {
3464 global $wgPasswordSalt;
3465 if ( $wgPasswordSalt ) {
3466 return md5( $userId . '-' . md5( $password ) );
3468 return md5( $password );
3473 * Make a new-style password hash
3475 * @param $password \string Plain-text password
3476 * @param $salt \string Optional salt, may be random or the user ID.
3477 * If unspecified or false, will generate one automatically
3478 * @return \string Password hash
3480 static function crypt( $password, $salt = false ) {
3481 global $wgPasswordSalt;
3484 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3488 if( $wgPasswordSalt ) {
3489 if ( $salt === false ) {
3490 $salt = substr( wfGenerateToken(), 0, 8 );
3492 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3494 return ':A:' . md5( $password );
3499 * Compare a password hash with a plain-text password. Requires the user
3500 * ID if there's a chance that the hash is an old-style hash.
3502 * @param $hash \string Password hash
3503 * @param $password \string Plain-text password to compare
3504 * @param $userId \string User ID for old-style password salt
3507 static function comparePasswords( $hash, $password, $userId = false ) {
3509 $type = substr( $hash, 0, 3 );
3512 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3516 if ( $type == ':A:' ) {
3518 return md5( $password ) === substr( $hash, 3 );
3519 } elseif ( $type == ':B:' ) {
3521 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3522 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3525 return self
::oldCrypt( $password, $userId ) === $hash;
3530 * Add a newuser log entry for this user
3531 * @param $byEmail Boolean: account made by email?
3533 public function addNewUserLogEntry( $byEmail = false ) {
3534 global $wgUser, $wgContLang, $wgNewUserLog;
3535 if( empty( $wgNewUserLog ) ) {
3536 return true; // disabled
3538 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3539 if( $this->getName() == $wgUser->getName() ) {
3543 $action = 'create2';
3545 ?
wfMsgForContent( 'newuserlog-byemail' )
3548 $log = new LogPage( 'newusers' );
3551 $this->getUserPage(),
3553 array( $this->getId() )
3559 * Add an autocreate newuser log entry for this user
3560 * Used by things like CentralAuth and perhaps other authplugins.
3562 public function addNewUserLogEntryAutoCreate() {
3563 global $wgNewUserLog;
3564 if( empty( $wgNewUserLog ) ) {
3565 return true; // disabled
3567 $log = new LogPage( 'newusers', false );
3568 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3572 protected function loadOptions() {
3574 if ( $this->mOptionsLoaded ||
!$this->getId() )
3577 $this->mOptions
= self
::getDefaultOptions();
3579 // Maybe load from the object
3580 if ( !is_null( $this->mOptionOverrides
) ) {
3581 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3582 foreach( $this->mOptionOverrides
as $key => $value ) {
3583 $this->mOptions
[$key] = $value;
3586 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3587 // Load from database
3588 $dbr = wfGetDB( DB_SLAVE
);
3590 $res = $dbr->select(
3593 array( 'up_user' => $this->getId() ),
3597 while( $row = $dbr->fetchObject( $res ) ) {
3598 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3599 $this->mOptions
[$row->up_property
] = $row->up_value
;
3603 $this->mOptionsLoaded
= true;
3605 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3608 protected function saveOptions() {
3609 global $wgAllowPrefChange;
3611 $extuser = ExternalUser
::newFromUser( $this );
3613 $this->loadOptions();
3614 $dbw = wfGetDB( DB_MASTER
);
3616 $insert_rows = array();
3618 $saveOptions = $this->mOptions
;
3620 // Allow hooks to abort, for instance to save to a global profile.
3621 // Reset options to default state before saving.
3622 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3625 foreach( $saveOptions as $key => $value ) {
3626 # Don't bother storing default values
3627 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3628 !( $value === false ||
is_null($value) ) ) ||
3629 $value != self
::getDefaultOption( $key ) ) {
3630 $insert_rows[] = array(
3631 'up_user' => $this->getId(),
3632 'up_property' => $key,
3633 'up_value' => $value,
3636 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3637 switch ( $wgAllowPrefChange[$key] ) {
3643 $extuser->setPref( $key, $value );
3649 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3650 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3655 * Provide an array of HTML 5 attributes to put on an input element
3656 * intended for the user to enter a new password. This may include
3657 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3659 * Do *not* use this when asking the user to enter his current password!
3660 * Regardless of configuration, users may have invalid passwords for whatever
3661 * reason (e.g., they were set before requirements were tightened up).
3662 * Only use it when asking for a new password, like on account creation or
3665 * Obviously, you still need to do server-side checking.
3667 * @return array Array of HTML attributes suitable for feeding to
3668 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3669 * That will potentially output invalid XHTML 1.0 Transitional, and will
3670 * get confused by the boolean attribute syntax used.)
3672 public static function passwordChangeInputAttribs() {
3673 global $wgMinimalPasswordLength;
3675 if ( $wgMinimalPasswordLength == 0 ) {
3679 # Note that the pattern requirement will always be satisfied if the
3680 # input is empty, so we need required in all cases.
3681 $ret = array( 'required' );
3683 # We can't actually do this right now, because Opera 9.6 will print out
3684 # the entered password visibly in its error message! When other
3685 # browsers add support for this attribute, or Opera fixes its support,
3686 # we can add support with a version check to avoid doing this on Opera
3687 # versions where it will be a problem. Reported to Opera as
3688 # DSK-262266, but they don't have a public bug tracker for us to follow.
3690 if ( $wgMinimalPasswordLength > 1 ) {
3691 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3692 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3693 $wgMinimalPasswordLength );