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 ( $name === false ) {
360 # Create unloaded user object
369 * Static factory method for creation from a given user ID.
371 * @param $id \int Valid user ID
372 * @return \type{User} The corresponding User object
374 static function newFromId( $id ) {
382 * Factory method to fetch whichever user has a given email confirmation code.
383 * This code is generated when an account is created or its e-mail address
386 * If the code is invalid or has expired, returns NULL.
388 * @param $code \string Confirmation code
389 * @return \type{User}
391 static function newFromConfirmationCode( $code ) {
392 $dbr = wfGetDB( DB_SLAVE
);
393 $id = $dbr->selectField( 'user', 'user_id', array(
394 'user_email_token' => md5( $code ),
395 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
397 if( $id !== false ) {
398 return User
::newFromId( $id );
405 * Create a new user object using data from session or cookies. If the
406 * login credentials are invalid, the result is an anonymous user.
408 * @return \type{User}
410 static function newFromSession() {
412 $user->mFrom
= 'session';
417 * Create a new user object from a user row.
418 * The row should have all fields from the user table in it.
419 * @param $row array A row from the user table
420 * @return \type{User}
422 static function newFromRow( $row ) {
424 $user->loadFromRow( $row );
432 * Get the username corresponding to a given user ID
433 * @param $id \int User ID
434 * @return \string The corresponding username
436 static function whoIs( $id ) {
437 $dbr = wfGetDB( DB_SLAVE
);
438 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
442 * Get the real name of a user given their user ID
444 * @param $id \int User ID
445 * @return \string The corresponding user's real name
447 static function whoIsReal( $id ) {
448 $dbr = wfGetDB( DB_SLAVE
);
449 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
453 * Get database id given a user name
454 * @param $name \string Username
455 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
457 static function idFromName( $name ) {
458 $nt = Title
::makeTitleSafe( NS_USER
, $name );
459 if( is_null( $nt ) ) {
464 if ( isset( self
::$idCacheByName[$name] ) ) {
465 return self
::$idCacheByName[$name];
468 $dbr = wfGetDB( DB_SLAVE
);
469 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
471 if ( $s === false ) {
474 $result = $s->user_id
;
477 self
::$idCacheByName[$name] = $result;
479 if ( count( self
::$idCacheByName ) > 1000 ) {
480 self
::$idCacheByName = array();
487 * Does the string match an anonymous IPv4 address?
489 * This function exists for username validation, in order to reject
490 * usernames which are similar in form to IP addresses. Strings such
491 * as 300.300.300.300 will return true because it looks like an IP
492 * address, despite not being strictly valid.
494 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
495 * address because the usemod software would "cloak" anonymous IP
496 * addresses like this, if we allowed accounts like this to be created
497 * new users could get the old edits of these anonymous users.
499 * @param $name \string String to match
500 * @return \bool True or false
502 static function isIP( $name ) {
503 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
507 * Is the input a valid username?
509 * Checks if the input is a valid username, we don't want an empty string,
510 * an IP address, anything that containins slashes (would mess up subpages),
511 * is longer than the maximum allowed username size or doesn't begin with
514 * @param $name \string String to match
515 * @return \bool True or false
517 static function isValidUserName( $name ) {
518 global $wgContLang, $wgMaxNameChars;
521 || User
::isIP( $name )
522 ||
strpos( $name, '/' ) !== false
523 ||
strlen( $name ) > $wgMaxNameChars
524 ||
$name != $wgContLang->ucfirst( $name ) ) {
525 wfDebugLog( 'username', __METHOD__
.
526 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
530 // Ensure that the name can't be misresolved as a different title,
531 // such as with extra namespace keys at the start.
532 $parsed = Title
::newFromText( $name );
533 if( is_null( $parsed )
534 ||
$parsed->getNamespace()
535 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
536 wfDebugLog( 'username', __METHOD__
.
537 ": '$name' invalid due to ambiguous prefixes" );
541 // Check an additional blacklist of troublemaker characters.
542 // Should these be merged into the title char list?
543 $unicodeBlacklist = '/[' .
544 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
545 '\x{00a0}' . # non-breaking space
546 '\x{2000}-\x{200f}' . # various whitespace
547 '\x{2028}-\x{202f}' . # breaks and control chars
548 '\x{3000}' . # ideographic space
549 '\x{e000}-\x{f8ff}' . # private use
551 if( preg_match( $unicodeBlacklist, $name ) ) {
552 wfDebugLog( 'username', __METHOD__
.
553 ": '$name' invalid due to blacklisted characters" );
561 * Usernames which fail to pass this function will be blocked
562 * from user login and new account registrations, but may be used
563 * internally by batch processes.
565 * If an account already exists in this form, login will be blocked
566 * by a failure to pass this function.
568 * @param $name \string String to match
569 * @return \bool True or false
571 static function isUsableName( $name ) {
572 global $wgReservedUsernames;
573 // Must be a valid username, obviously ;)
574 if ( !self
::isValidUserName( $name ) ) {
578 static $reservedUsernames = false;
579 if ( !$reservedUsernames ) {
580 $reservedUsernames = $wgReservedUsernames;
581 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
584 // Certain names may be reserved for batch processes.
585 foreach ( $reservedUsernames as $reserved ) {
586 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
587 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
589 if ( $reserved == $name ) {
597 * Usernames which fail to pass this function will be blocked
598 * from new account registrations, but may be used internally
599 * either by batch processes or by user accounts which have
600 * already been created.
602 * Additional character blacklisting may be added here
603 * rather than in isValidUserName() to avoid disrupting
606 * @param $name \string String to match
607 * @return \bool True or false
609 static function isCreatableName( $name ) {
610 global $wgInvalidUsernameCharacters;
612 self
::isUsableName( $name ) &&
614 // Registration-time character blacklisting...
615 !preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name );
619 * Is the input a valid password for this user?
621 * @param $password String Desired password
622 * @return bool True or false
624 function isValidPassword( $password ) {
625 global $wgMinimalPasswordLength, $wgContLang;
627 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
629 if( $result === false )
632 // Password needs to be long enough, and can't be the same as the username
633 return strlen( $password ) >= $wgMinimalPasswordLength
634 && $wgContLang->lc( $password ) !== $wgContLang->lc( $this->mName
);
638 * Given unvalidated password input, return error message on failure.
640 * @param $password String Desired password
641 * @return mixed: true on success, string of error message on failure
643 static function getPasswordValidity( $password ) {
644 global $wgMinimalPasswordLength, $wgContLang;
646 if(!$this->isValidPassword( $password )) {
647 if( strlen( $password ) < $wgMinimalPasswordLength ) {
648 return 'passwordtooshort';
649 } elseif( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
650 return 'password-name-match';
659 * Does a string look like an e-mail address?
661 * There used to be a regular expression here, it got removed because it
662 * rejected valid addresses. Actually just check if there is '@' somewhere
663 * in the given address.
665 * @todo Check for RFC 2822 compilance (bug 959)
667 * @param $addr \string E-mail address
668 * @return \bool True or false
670 public static function isValidEmailAddr( $addr ) {
672 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
676 return strpos( $addr, '@' ) !== false;
680 * Given unvalidated user input, return a canonical username, or false if
681 * the username is invalid.
682 * @param $name \string User input
683 * @param $validate \types{\string,\bool} Type of validation to use:
684 * - false No validation
685 * - 'valid' Valid for batch processes
686 * - 'usable' Valid for batch processes and login
687 * - 'creatable' Valid for batch processes, login and account creation
689 static function getCanonicalName( $name, $validate = 'valid' ) {
690 # Maybe force usernames to capital
691 $name = Title
::capitalize( $name, NS_USER
);
693 # Reject names containing '#'; these will be cleaned up
694 # with title normalisation, but then it's too late to
696 if( strpos( $name, '#' ) !== false )
699 # Clean up name according to title rules
700 $t = ( $validate === 'valid' ) ?
701 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
702 # Check for invalid titles
703 if( is_null( $t ) ) {
707 # Reject various classes of invalid names
708 $name = $t->getText();
710 $name = $wgAuth->getCanonicalName( $t->getText() );
712 switch ( $validate ) {
716 if ( !User
::isValidUserName( $name ) ) {
721 if ( !User
::isUsableName( $name ) ) {
726 if ( !User
::isCreatableName( $name ) ) {
731 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
737 * Count the number of edits of a user
738 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
740 * @param $uid \int User ID to check
741 * @return \int The user's edit count
743 static function edits( $uid ) {
744 wfProfileIn( __METHOD__
);
745 $dbr = wfGetDB( DB_SLAVE
);
746 // check if the user_editcount field has been initialized
747 $field = $dbr->selectField(
748 'user', 'user_editcount',
749 array( 'user_id' => $uid ),
753 if( $field === null ) { // it has not been initialized. do so.
754 $dbw = wfGetDB( DB_MASTER
);
755 $count = $dbr->selectField(
756 'revision', 'count(*)',
757 array( 'rev_user' => $uid ),
762 array( 'user_editcount' => $count ),
763 array( 'user_id' => $uid ),
769 wfProfileOut( __METHOD__
);
774 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
775 * @todo hash random numbers to improve security, like generateToken()
777 * @return \string New random password
779 static function randomPassword() {
780 global $wgMinimalPasswordLength;
781 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
782 $l = strlen( $pwchars ) - 1;
784 $pwlength = max( 7, $wgMinimalPasswordLength );
785 $digit = mt_rand( 0, $pwlength - 1 );
787 for ( $i = 0; $i < $pwlength; $i++
) {
788 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
794 * Set cached properties to default.
796 * @note This no longer clears uncached lazy-initialised properties;
797 * the constructor does that instead.
800 function loadDefaults( $name = false ) {
801 wfProfileIn( __METHOD__
);
803 global $wgCookiePrefix;
806 $this->mName
= $name;
807 $this->mRealName
= '';
808 $this->mPassword
= $this->mNewpassword
= '';
809 $this->mNewpassTime
= null;
811 $this->mOptionOverrides
= null;
812 $this->mOptionsLoaded
= false;
814 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
815 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
817 $this->mTouched
= '0'; # Allow any pages to be cached
820 $this->setToken(); # Random
821 $this->mEmailAuthenticated
= null;
822 $this->mEmailToken
= '';
823 $this->mEmailTokenExpires
= null;
824 $this->mRegistration
= wfTimestamp( TS_MW
);
825 $this->mGroups
= array();
827 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
829 wfProfileOut( __METHOD__
);
833 * @deprecated Use wfSetupSession().
835 function SetupSession() {
836 wfDeprecated( __METHOD__
);
841 * Load user data from the session or login cookie. If there are no valid
842 * credentials, initialises the user as an anonymous user.
843 * @return \bool True if the user is logged in, false otherwise.
845 private function loadFromSession() {
846 global $wgMemc, $wgCookiePrefix;
849 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
850 if ( $result !== null ) {
854 if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
855 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
856 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
857 $this->loadDefaults(); // Possible collision!
858 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
859 cookie user ID ($sId) don't match!" );
862 $_SESSION['wsUserID'] = $sId;
863 } else if ( isset( $_SESSION['wsUserID'] ) ) {
864 if ( $_SESSION['wsUserID'] != 0 ) {
865 $sId = $_SESSION['wsUserID'];
867 $this->loadDefaults();
871 $this->loadDefaults();
875 if ( isset( $_SESSION['wsUserName'] ) ) {
876 $sName = $_SESSION['wsUserName'];
877 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
878 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
879 $_SESSION['wsUserName'] = $sName;
881 $this->loadDefaults();
885 $passwordCorrect = FALSE;
887 if ( !$this->loadFromId() ) {
888 # Not a valid ID, loadFromId has switched the object to anon for us
892 if ( isset( $_SESSION['wsToken'] ) ) {
893 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
895 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
896 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
899 # No session or persistent login cookie
900 $this->loadDefaults();
904 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
905 $_SESSION['wsToken'] = $this->mToken
;
906 wfDebug( "Logged in from $from\n" );
909 # Invalid credentials
910 wfDebug( "Can't log in from $from, invalid credentials\n" );
911 $this->loadDefaults();
917 * Load user and user_group data from the database.
918 * $this::mId must be set, this is how the user is identified.
920 * @return \bool True if the user exists, false if the user is anonymous
923 function loadFromDatabase() {
925 $this->mId
= intval( $this->mId
);
927 /** Anonymous user */
929 $this->loadDefaults();
933 $dbr = wfGetDB( DB_MASTER
);
934 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
936 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
938 if ( $s !== false ) {
939 # Initialise user table data
940 $this->loadFromRow( $s );
941 $this->mGroups
= null; // deferred
942 $this->getEditCount(); // revalidation for nulls
947 $this->loadDefaults();
953 * Initialize this object from a row from the user table.
955 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
957 function loadFromRow( $row ) {
958 $this->mDataLoaded
= true;
960 if ( isset( $row->user_id
) ) {
961 $this->mId
= intval( $row->user_id
);
963 $this->mName
= $row->user_name
;
964 $this->mRealName
= $row->user_real_name
;
965 $this->mPassword
= $row->user_password
;
966 $this->mNewpassword
= $row->user_newpassword
;
967 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
968 $this->mEmail
= $row->user_email
;
969 $this->decodeOptions( $row->user_options
);
970 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
971 $this->mToken
= $row->user_token
;
972 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
973 $this->mEmailToken
= $row->user_email_token
;
974 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
975 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
976 $this->mEditCount
= $row->user_editcount
;
980 * Load the groups from the database if they aren't already loaded.
983 function loadGroups() {
984 if ( is_null( $this->mGroups
) ) {
985 $dbr = wfGetDB( DB_MASTER
);
986 $res = $dbr->select( 'user_groups',
988 array( 'ug_user' => $this->mId
),
990 $this->mGroups
= array();
991 while( $row = $dbr->fetchObject( $res ) ) {
992 $this->mGroups
[] = $row->ug_group
;
998 * Clear various cached data stored in this object.
999 * @param $reloadFrom \string Reload user and user_groups table data from a
1000 * given source. May be "name", "id", "defaults", "session", or false for
1003 function clearInstanceCache( $reloadFrom = false ) {
1004 $this->mNewtalk
= -1;
1005 $this->mDatePreference
= null;
1006 $this->mBlockedby
= -1; # Unset
1007 $this->mHash
= false;
1008 $this->mSkin
= null;
1009 $this->mRights
= null;
1010 $this->mEffectiveGroups
= null;
1011 $this->mOptions
= null;
1013 if ( $reloadFrom ) {
1014 $this->mDataLoaded
= false;
1015 $this->mFrom
= $reloadFrom;
1020 * Combine the language default options with any site-specific options
1021 * and add the default language variants.
1023 * @return \type{\arrayof{\string}} Array of options
1025 static function getDefaultOptions() {
1026 global $wgNamespacesToBeSearchedDefault;
1028 * Site defaults will override the global/language defaults
1030 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1031 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1034 * default language setting
1036 $variant = $wgContLang->getPreferredVariant( false );
1037 $defOpt['variant'] = $variant;
1038 $defOpt['language'] = $variant;
1039 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1040 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1042 $defOpt['skin'] = $wgDefaultSkin;
1048 * Get a given default option value.
1050 * @param $opt \string Name of option to retrieve
1051 * @return \string Default option value
1053 public static function getDefaultOption( $opt ) {
1054 $defOpts = self
::getDefaultOptions();
1055 if( isset( $defOpts[$opt] ) ) {
1056 return $defOpts[$opt];
1063 * Get a list of user toggle names
1064 * @return \type{\arrayof{\string}} Array of user toggle names
1066 static function getToggles() {
1067 global $wgContLang, $wgUseRCPatrol;
1068 $extraToggles = array();
1069 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1070 if( $wgUseRCPatrol ) {
1071 $extraToggles[] = 'hidepatrolled';
1072 $extraToggles[] = 'newpageshidepatrolled';
1073 $extraToggles[] = 'watchlisthidepatrolled';
1075 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1080 * Get blocking information
1082 * @param $bFromSlave \bool Whether to check the slave database first. To
1083 * improve performance, non-critical checks are done
1084 * against slaves. Check when actually saving should be
1085 * done against master.
1087 function getBlockedStatus( $bFromSlave = true ) {
1088 global $wgEnableSorbs, $wgProxyWhitelist, $wgUser;
1090 if ( -1 != $this->mBlockedby
) {
1091 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1095 wfProfileIn( __METHOD__
);
1096 wfDebug( __METHOD__
.": checking...\n" );
1098 // Initialize data...
1099 // Otherwise something ends up stomping on $this->mBlockedby when
1100 // things get lazy-loaded later, causing false positive block hits
1101 // due to -1 !== 0. Probably session-related... Nothing should be
1102 // overwriting mBlockedby, surely?
1105 $this->mBlockedby
= 0;
1106 $this->mHideName
= 0;
1107 $this->mAllowUsertalk
= 0;
1109 # Check if we are looking at an IP or a logged-in user
1110 if ( $this->isIP( $this->getName() ) ) {
1111 $ip = $this->getName();
1113 # Check if we are looking at the current user
1114 # If we don't, and the user is logged in, we don't know about
1115 # his IP / autoblock status, so ignore autoblock of current user's IP
1116 if ( $this->getID() != $wgUser->getID() ) {
1119 # Get IP of current user
1124 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1125 # Exempt from all types of IP-block
1130 $this->mBlock
= new Block();
1131 $this->mBlock
->fromMaster( !$bFromSlave );
1132 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1133 wfDebug( __METHOD__
. ": Found block.\n" );
1134 $this->mBlockedby
= $this->mBlock
->mBy
;
1135 $this->mBlockreason
= $this->mBlock
->mReason
;
1136 $this->mHideName
= $this->mBlock
->mHideName
;
1137 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1138 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1139 $this->spreadBlock();
1142 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1143 // apply to users. Note that the existence of $this->mBlock is not used to
1144 // check for edit blocks, $this->mBlockedby is instead.
1148 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1150 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1151 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1152 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1156 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1157 if ( $this->inSorbsBlacklist( $ip ) ) {
1158 $this->mBlockedby
= wfMsg( 'sorbs' );
1159 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1165 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1167 wfProfileOut( __METHOD__
);
1171 * Whether the given IP is in the SORBS blacklist.
1173 * @param $ip \string IP to check
1174 * @return \bool True if blacklisted.
1176 function inSorbsBlacklist( $ip ) {
1177 global $wgEnableSorbs, $wgSorbsUrl;
1179 return $wgEnableSorbs &&
1180 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1184 * Whether the given IP is in a given DNS blacklist.
1186 * @param $ip \string IP to check
1187 * @param $base \string URL of the DNS blacklist
1188 * @return \bool True if blacklisted.
1190 function inDnsBlacklist( $ip, $base ) {
1191 wfProfileIn( __METHOD__
);
1195 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1196 if( IP
::isIPv4( $ip ) ) {
1198 $host = "$ip.$base";
1201 $ipList = gethostbynamel( $host );
1204 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1207 wfDebug( "Requested $host, not found in $base.\n" );
1211 wfProfileOut( __METHOD__
);
1216 * Is this user subject to rate limiting?
1218 * @return \bool True if rate limited
1220 public function isPingLimitable() {
1221 global $wgRateLimitsExcludedGroups;
1222 global $wgRateLimitsExcludedIPs;
1223 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1224 // Deprecated, but kept for backwards-compatibility config
1227 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1228 // No other good way currently to disable rate limits
1229 // for specific IPs. :P
1230 // But this is a crappy hack and should die.
1233 return !$this->isAllowed('noratelimit');
1237 * Primitive rate limits: enforce maximum actions per time period
1238 * to put a brake on flooding.
1240 * @note When using a shared cache like memcached, IP-address
1241 * last-hit counters will be shared across wikis.
1243 * @param $action \string Action to enforce; 'edit' if unspecified
1244 * @return \bool True if a rate limiter was tripped
1246 function pingLimiter( $action = 'edit' ) {
1247 # Call the 'PingLimiter' hook
1249 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1253 global $wgRateLimits;
1254 if( !isset( $wgRateLimits[$action] ) ) {
1258 # Some groups shouldn't trigger the ping limiter, ever
1259 if( !$this->isPingLimitable() )
1262 global $wgMemc, $wgRateLimitLog;
1263 wfProfileIn( __METHOD__
);
1265 $limits = $wgRateLimits[$action];
1267 $id = $this->getId();
1271 if( isset( $limits['anon'] ) && $id == 0 ) {
1272 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1275 if( isset( $limits['user'] ) && $id != 0 ) {
1276 $userLimit = $limits['user'];
1278 if( $this->isNewbie() ) {
1279 if( isset( $limits['newbie'] ) && $id != 0 ) {
1280 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1282 if( isset( $limits['ip'] ) ) {
1283 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1286 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1287 $subnet = $matches[1];
1288 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1291 // Check for group-specific permissions
1292 // If more than one group applies, use the group with the highest limit
1293 foreach ( $this->getGroups() as $group ) {
1294 if ( isset( $limits[$group] ) ) {
1295 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1296 $userLimit = $limits[$group];
1300 // Set the user limit key
1301 if ( $userLimit !== false ) {
1302 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1303 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1307 foreach( $keys as $key => $limit ) {
1308 list( $max, $period ) = $limit;
1309 $summary = "(limit $max in {$period}s)";
1310 $count = $wgMemc->get( $key );
1313 if( $count > $max ) {
1314 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1315 if( $wgRateLimitLog ) {
1316 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1320 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1322 $wgMemc->incr( $key );
1324 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1325 $wgMemc->set( $key, 1, intval( $period ) ); // first ping
1329 wfProfileOut( __METHOD__
);
1334 * Check if user is blocked
1336 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1337 * @return \bool True if blocked, false otherwise
1339 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1340 wfDebug( "User::isBlocked: enter\n" );
1341 $this->getBlockedStatus( $bFromSlave );
1342 return $this->mBlockedby
!== 0;
1346 * Check if user is blocked from editing a particular article
1348 * @param $title \string Title to check
1349 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1350 * @return \bool True if blocked, false otherwise
1352 function isBlockedFrom( $title, $bFromSlave = false ) {
1353 global $wgBlockAllowsUTEdit;
1354 wfProfileIn( __METHOD__
);
1355 wfDebug( __METHOD__
. ": enter\n" );
1357 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1358 $blocked = $this->isBlocked( $bFromSlave );
1359 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1360 # If a user's name is suppressed, they cannot make edits anywhere
1361 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1362 $title->getNamespace() == NS_USER_TALK
) {
1364 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1367 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1369 wfProfileOut( __METHOD__
);
1374 * If user is blocked, return the name of the user who placed the block
1375 * @return \string name of blocker
1377 function blockedBy() {
1378 $this->getBlockedStatus();
1379 return $this->mBlockedby
;
1383 * If user is blocked, return the specified reason for the block
1384 * @return \string Blocking reason
1386 function blockedFor() {
1387 $this->getBlockedStatus();
1388 return $this->mBlockreason
;
1392 * If user is blocked, return the ID for the block
1393 * @return \int Block ID
1395 function getBlockId() {
1396 $this->getBlockedStatus();
1397 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1401 * Check if user is blocked on all wikis.
1402 * Do not use for actual edit permission checks!
1403 * This is intented for quick UI checks.
1405 * @param $ip \type{\string} IP address, uses current client if none given
1406 * @return \type{\bool} True if blocked, false otherwise
1408 function isBlockedGlobally( $ip = '' ) {
1409 if( $this->mBlockedGlobally
!== null ) {
1410 return $this->mBlockedGlobally
;
1412 // User is already an IP?
1413 if( IP
::isIPAddress( $this->getName() ) ) {
1414 $ip = $this->getName();
1419 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1420 $this->mBlockedGlobally
= (bool)$blocked;
1421 return $this->mBlockedGlobally
;
1425 * Check if user account is locked
1427 * @return \type{\bool} True if locked, false otherwise
1429 function isLocked() {
1430 if( $this->mLocked
!== null ) {
1431 return $this->mLocked
;
1434 $authUser = $wgAuth->getUserInstance( $this );
1435 $this->mLocked
= (bool)$authUser->isLocked();
1436 return $this->mLocked
;
1440 * Check if user account is hidden
1442 * @return \type{\bool} True if hidden, false otherwise
1444 function isHidden() {
1445 if( $this->mHideName
!== null ) {
1446 return $this->mHideName
;
1448 $this->getBlockedStatus();
1449 if( !$this->mHideName
) {
1451 $authUser = $wgAuth->getUserInstance( $this );
1452 $this->mHideName
= (bool)$authUser->isHidden();
1454 return $this->mHideName
;
1458 * Get the user's ID.
1459 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1462 if( $this->mId
=== null and $this->mName
!== null
1463 and User
::isIP( $this->mName
) ) {
1464 // Special case, we know the user is anonymous
1466 } elseif( $this->mId
=== null ) {
1467 // Don't load if this was initialized from an ID
1474 * Set the user and reload all fields according to a given ID
1475 * @param $v \int User ID to reload
1477 function setId( $v ) {
1479 $this->clearInstanceCache( 'id' );
1483 * Get the user name, or the IP of an anonymous user
1484 * @return \string User's name or IP address
1486 function getName() {
1487 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1488 # Special case optimisation
1489 return $this->mName
;
1492 if ( $this->mName
=== false ) {
1494 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1496 return $this->mName
;
1501 * Set the user name.
1503 * This does not reload fields from the database according to the given
1504 * name. Rather, it is used to create a temporary "nonexistent user" for
1505 * later addition to the database. It can also be used to set the IP
1506 * address for an anonymous user to something other than the current
1509 * @note User::newFromName() has rougly the same function, when the named user
1511 * @param $str \string New user name to set
1513 function setName( $str ) {
1515 $this->mName
= $str;
1519 * Get the user's name escaped by underscores.
1520 * @return \string Username escaped by underscores.
1522 function getTitleKey() {
1523 return str_replace( ' ', '_', $this->getName() );
1527 * Check if the user has new messages.
1528 * @return \bool True if the user has new messages
1530 function getNewtalk() {
1533 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1534 if( $this->mNewtalk
=== -1 ) {
1535 $this->mNewtalk
= false; # reset talk page status
1537 # Check memcached separately for anons, who have no
1538 # entire User object stored in there.
1541 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1542 $newtalk = $wgMemc->get( $key );
1543 if( strval( $newtalk ) !== '' ) {
1544 $this->mNewtalk
= (bool)$newtalk;
1546 // Since we are caching this, make sure it is up to date by getting it
1548 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1549 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1552 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1556 return (bool)$this->mNewtalk
;
1560 * Return the talk page(s) this user has new messages on.
1561 * @return \type{\arrayof{\string}} Array of page URLs
1563 function getNewMessageLinks() {
1565 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1568 if( !$this->getNewtalk() )
1570 $up = $this->getUserPage();
1571 $utp = $up->getTalkPage();
1572 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1576 * Internal uncached check for new messages
1579 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1580 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1581 * @param $fromMaster \bool true to fetch from the master, false for a slave
1582 * @return \bool True if the user has new messages
1585 function checkNewtalk( $field, $id, $fromMaster = false ) {
1586 if ( $fromMaster ) {
1587 $db = wfGetDB( DB_MASTER
);
1589 $db = wfGetDB( DB_SLAVE
);
1591 $ok = $db->selectField( 'user_newtalk', $field,
1592 array( $field => $id ), __METHOD__
);
1593 return $ok !== false;
1597 * Add or update the new messages flag
1598 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1599 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1600 * @return \bool True if successful, false otherwise
1603 function updateNewtalk( $field, $id ) {
1604 $dbw = wfGetDB( DB_MASTER
);
1605 $dbw->insert( 'user_newtalk',
1606 array( $field => $id ),
1609 if ( $dbw->affectedRows() ) {
1610 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1613 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1619 * Clear the new messages flag for the given user
1620 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1621 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1622 * @return \bool True if successful, false otherwise
1625 function deleteNewtalk( $field, $id ) {
1626 $dbw = wfGetDB( DB_MASTER
);
1627 $dbw->delete( 'user_newtalk',
1628 array( $field => $id ),
1630 if ( $dbw->affectedRows() ) {
1631 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1634 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1640 * Update the 'You have new messages!' status.
1641 * @param $val \bool Whether the user has new messages
1643 function setNewtalk( $val ) {
1644 if( wfReadOnly() ) {
1649 $this->mNewtalk
= $val;
1651 if( $this->isAnon() ) {
1653 $id = $this->getName();
1656 $id = $this->getId();
1661 $changed = $this->updateNewtalk( $field, $id );
1663 $changed = $this->deleteNewtalk( $field, $id );
1666 if( $this->isAnon() ) {
1667 // Anons have a separate memcached space, since
1668 // user records aren't kept for them.
1669 $key = wfMemcKey( 'newtalk', 'ip', $id );
1670 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1673 $this->invalidateCache();
1678 * Generate a current or new-future timestamp to be stored in the
1679 * user_touched field when we update things.
1680 * @return \string Timestamp in TS_MW format
1682 private static function newTouchedTimestamp() {
1683 global $wgClockSkewFudge;
1684 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1688 * Clear user data from memcached.
1689 * Use after applying fun updates to the database; caller's
1690 * responsibility to update user_touched if appropriate.
1692 * Called implicitly from invalidateCache() and saveSettings().
1694 private function clearSharedCache() {
1698 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1703 * Immediately touch the user data cache for this account.
1704 * Updates user_touched field, and removes account data from memcached
1705 * for reload on the next hit.
1707 function invalidateCache() {
1708 if( wfReadOnly() ) {
1713 $this->mTouched
= self
::newTouchedTimestamp();
1715 $dbw = wfGetDB( DB_MASTER
);
1716 $dbw->update( 'user',
1717 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1718 array( 'user_id' => $this->mId
),
1721 $this->clearSharedCache();
1726 * Validate the cache for this account.
1727 * @param $timestamp \string A timestamp in TS_MW format
1729 function validateCache( $timestamp ) {
1731 return ( $timestamp >= $this->mTouched
);
1735 * Get the user touched timestamp
1737 function getTouched() {
1739 return $this->mTouched
;
1743 * Set the password and reset the random token.
1744 * Calls through to authentication plugin if necessary;
1745 * will have no effect if the auth plugin refuses to
1746 * pass the change through or if the legal password
1749 * As a special case, setting the password to null
1750 * wipes it, so the account cannot be logged in until
1751 * a new password is set, for instance via e-mail.
1753 * @param $str \string New password to set
1754 * @throws PasswordError on failure
1756 function setPassword( $str ) {
1759 if( $str !== null ) {
1760 if( !$wgAuth->allowPasswordChange() ) {
1761 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1764 if( !$this->isValidPassword( $str ) ) {
1765 global $wgMinimalPasswordLength;
1766 $valid = $this->getPasswordValidity( $str );
1767 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1768 $wgMinimalPasswordLength ) );
1772 if( !$wgAuth->setPassword( $this, $str ) ) {
1773 throw new PasswordError( wfMsg( 'externaldberror' ) );
1776 $this->setInternalPassword( $str );
1782 * Set the password and reset the random token unconditionally.
1784 * @param $str \string New password to set
1786 function setInternalPassword( $str ) {
1790 if( $str === null ) {
1791 // Save an invalid hash...
1792 $this->mPassword
= '';
1794 $this->mPassword
= self
::crypt( $str );
1796 $this->mNewpassword
= '';
1797 $this->mNewpassTime
= null;
1801 * Get the user's current token.
1802 * @return \string Token
1804 function getToken() {
1806 return $this->mToken
;
1810 * Set the random token (used for persistent authentication)
1811 * Called from loadDefaults() among other places.
1813 * @param $token \string If specified, set the token to this value
1816 function setToken( $token = false ) {
1817 global $wgSecretKey, $wgProxyKey;
1820 if ( $wgSecretKey ) {
1821 $key = $wgSecretKey;
1822 } elseif ( $wgProxyKey ) {
1827 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1829 $this->mToken
= $token;
1834 * Set the cookie password
1836 * @param $str \string New cookie password
1839 function setCookiePassword( $str ) {
1841 $this->mCookiePassword
= md5( $str );
1845 * Set the password for a password reminder or new account email
1847 * @param $str \string New password to set
1848 * @param $throttle \bool If true, reset the throttle timestamp to the present
1850 function setNewpassword( $str, $throttle = true ) {
1852 $this->mNewpassword
= self
::crypt( $str );
1854 $this->mNewpassTime
= wfTimestampNow();
1859 * Has password reminder email been sent within the last
1860 * $wgPasswordReminderResendTime hours?
1861 * @return \bool True or false
1863 function isPasswordReminderThrottled() {
1864 global $wgPasswordReminderResendTime;
1866 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1869 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1870 return time() < $expiry;
1874 * Get the user's e-mail address
1875 * @return \string User's email address
1877 function getEmail() {
1879 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1880 return $this->mEmail
;
1884 * Get the timestamp of the user's e-mail authentication
1885 * @return \string TS_MW timestamp
1887 function getEmailAuthenticationTimestamp() {
1889 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1890 return $this->mEmailAuthenticated
;
1894 * Set the user's e-mail address
1895 * @param $str \string New e-mail address
1897 function setEmail( $str ) {
1899 $this->mEmail
= $str;
1900 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1904 * Get the user's real name
1905 * @return \string User's real name
1907 function getRealName() {
1909 return $this->mRealName
;
1913 * Set the user's real name
1914 * @param $str \string New real name
1916 function setRealName( $str ) {
1918 $this->mRealName
= $str;
1922 * Get the user's current setting for a given option.
1924 * @param $oname \string The option to check
1925 * @param $defaultOverride \string A default value returned if the option does not exist
1926 * @return \string User's current value for the option
1927 * @see getBoolOption()
1928 * @see getIntOption()
1930 function getOption( $oname, $defaultOverride = null ) {
1931 $this->loadOptions();
1933 if ( is_null( $this->mOptions
) ) {
1934 if($defaultOverride != '') {
1935 return $defaultOverride;
1937 $this->mOptions
= User
::getDefaultOptions();
1940 if ( array_key_exists( $oname, $this->mOptions
) ) {
1941 return $this->mOptions
[$oname];
1943 return $defaultOverride;
1948 * Get the user's current setting for a given option, as a boolean value.
1950 * @param $oname \string The option to check
1951 * @return \bool User's current value for the option
1954 function getBoolOption( $oname ) {
1955 return (bool)$this->getOption( $oname );
1960 * Get the user's current setting for a given option, as a boolean value.
1962 * @param $oname \string The option to check
1963 * @param $defaultOverride \int A default value returned if the option does not exist
1964 * @return \int User's current value for the option
1967 function getIntOption( $oname, $defaultOverride=0 ) {
1968 $val = $this->getOption( $oname );
1970 $val = $defaultOverride;
1972 return intval( $val );
1976 * Set the given option for a user.
1978 * @param $oname \string The option to set
1979 * @param $val \mixed New value to set
1981 function setOption( $oname, $val ) {
1983 $this->loadOptions();
1985 if ( $oname == 'skin' ) {
1986 # Clear cached skin, so the new one displays immediately in Special:Preferences
1987 unset( $this->mSkin
);
1990 // Explicitly NULL values should refer to defaults
1991 global $wgDefaultUserOptions;
1992 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
1993 $val = $wgDefaultUserOptions[$oname];
1996 $this->mOptions
[$oname] = $val;
2000 * Reset all options to the site defaults
2002 function resetOptions() {
2003 $this->mOptions
= User
::getDefaultOptions();
2007 * Get the user's preferred date format.
2008 * @return \string User's preferred date format
2010 function getDatePreference() {
2011 // Important migration for old data rows
2012 if ( is_null( $this->mDatePreference
) ) {
2014 $value = $this->getOption( 'date' );
2015 $map = $wgLang->getDatePreferenceMigrationMap();
2016 if ( isset( $map[$value] ) ) {
2017 $value = $map[$value];
2019 $this->mDatePreference
= $value;
2021 return $this->mDatePreference
;
2025 * Get the permissions this user has.
2026 * @return \type{\arrayof{\string}} Array of permission names
2028 function getRights() {
2029 if ( is_null( $this->mRights
) ) {
2030 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2031 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2032 // Force reindexation of rights when a hook has unset one of them
2033 $this->mRights
= array_values( $this->mRights
);
2035 return $this->mRights
;
2039 * Get the list of explicit group memberships this user has.
2040 * The implicit * and user groups are not included.
2041 * @return \type{\arrayof{\string}} Array of internal group names
2043 function getGroups() {
2045 return $this->mGroups
;
2049 * Get the list of implicit group memberships this user has.
2050 * This includes all explicit groups, plus 'user' if logged in,
2051 * '*' for all accounts and autopromoted groups
2052 * @param $recache \bool Whether to avoid the cache
2053 * @return \type{\arrayof{\string}} Array of internal group names
2055 function getEffectiveGroups( $recache = false ) {
2056 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2057 $this->mEffectiveGroups
= $this->getGroups();
2058 $this->mEffectiveGroups
[] = '*';
2059 if( $this->getId() ) {
2060 $this->mEffectiveGroups
[] = 'user';
2062 $this->mEffectiveGroups
= array_unique( array_merge(
2063 $this->mEffectiveGroups
,
2064 Autopromote
::getAutopromoteGroups( $this )
2067 # Hook for additional groups
2068 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2071 return $this->mEffectiveGroups
;
2075 * Get the user's edit count.
2076 * @return \int User'e edit count
2078 function getEditCount() {
2079 if( $this->getId() ) {
2080 if ( !isset( $this->mEditCount
) ) {
2081 /* Populate the count, if it has not been populated yet */
2082 $this->mEditCount
= User
::edits( $this->mId
);
2084 return $this->mEditCount
;
2092 * Add the user to the given group.
2093 * This takes immediate effect.
2094 * @param $group \string Name of the group to add
2096 function addGroup( $group ) {
2097 $dbw = wfGetDB( DB_MASTER
);
2098 if( $this->getId() ) {
2099 $dbw->insert( 'user_groups',
2101 'ug_user' => $this->getID(),
2102 'ug_group' => $group,
2105 array( 'IGNORE' ) );
2108 $this->loadGroups();
2109 $this->mGroups
[] = $group;
2110 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2112 $this->invalidateCache();
2116 * Remove the user from the given group.
2117 * This takes immediate effect.
2118 * @param $group \string Name of the group to remove
2120 function removeGroup( $group ) {
2122 $dbw = wfGetDB( DB_MASTER
);
2123 $dbw->delete( 'user_groups',
2125 'ug_user' => $this->getID(),
2126 'ug_group' => $group,
2128 'User::removeGroup' );
2130 $this->loadGroups();
2131 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2132 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2134 $this->invalidateCache();
2138 * Get whether the user is logged in
2139 * @return \bool True or false
2141 function isLoggedIn() {
2142 return $this->getID() != 0;
2146 * Get whether the user is anonymous
2147 * @return \bool True or false
2150 return !$this->isLoggedIn();
2154 * Get whether the user is a bot
2155 * @return \bool True or false
2159 wfDeprecated( __METHOD__
);
2160 return $this->isAllowed( 'bot' );
2164 * Check if user is allowed to access a feature / make an action
2165 * @param $action \string action to be checked
2166 * @return \bool True if action is allowed, else false
2168 function isAllowed( $action = '' ) {
2169 if ( $action === '' )
2170 return true; // In the spirit of DWIM
2171 # Patrolling may not be enabled
2172 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2173 global $wgUseRCPatrol, $wgUseNPPatrol;
2174 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2177 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2178 # by misconfiguration: 0 == 'foo'
2179 return in_array( $action, $this->getRights(), true );
2183 * Check whether to enable recent changes patrol features for this user
2184 * @return \bool True or false
2186 public function useRCPatrol() {
2187 global $wgUseRCPatrol;
2188 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2192 * Check whether to enable new pages patrol features for this user
2193 * @return \bool True or false
2195 public function useNPPatrol() {
2196 global $wgUseRCPatrol, $wgUseNPPatrol;
2197 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2201 * Get the current skin, loading it if required, and setting a title
2202 * @param $t Title: the title to use in the skin
2203 * @return Skin The current skin
2204 * @todo FIXME : need to check the old failback system [AV]
2206 function &getSkin( $t = null ) {
2207 if ( !isset( $this->mSkin
) ) {
2208 wfProfileIn( __METHOD__
);
2210 global $wgHiddenPrefs;
2211 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2214 $userSkin = $this->getOption( 'skin' );
2215 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2217 # if we're not allowing users to override, then use the default
2218 global $wgDefaultSkin;
2219 $userSkin = $wgDefaultSkin;
2222 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2223 wfProfileOut( __METHOD__
);
2225 if( $t ||
!$this->mSkin
->getTitle() ) {
2228 $t = $wgOut->getTitle();
2230 $this->mSkin
->setTitle( $t );
2232 return $this->mSkin
;
2236 * Check the watched status of an article.
2237 * @param $title \type{Title} Title of the article to look at
2238 * @return \bool True if article is watched
2240 function isWatched( $title ) {
2241 $wl = WatchedItem
::fromUserTitle( $this, $title );
2242 return $wl->isWatched();
2247 * @param $title \type{Title} Title of the article to look at
2249 function addWatch( $title ) {
2250 $wl = WatchedItem
::fromUserTitle( $this, $title );
2252 $this->invalidateCache();
2256 * Stop watching an article.
2257 * @param $title \type{Title} Title of the article to look at
2259 function removeWatch( $title ) {
2260 $wl = WatchedItem
::fromUserTitle( $this, $title );
2262 $this->invalidateCache();
2266 * Clear the user's notification timestamp for the given title.
2267 * If e-notif e-mails are on, they will receive notification mails on
2268 * the next change of the page if it's watched etc.
2269 * @param $title \type{Title} Title of the article to look at
2271 function clearNotification( &$title ) {
2272 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2274 # Do nothing if the database is locked to writes
2275 if( wfReadOnly() ) {
2279 if( $title->getNamespace() == NS_USER_TALK
&&
2280 $title->getText() == $this->getName() ) {
2281 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2283 $this->setNewtalk( false );
2286 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2290 if( $this->isAnon() ) {
2291 // Nothing else to do...
2295 // Only update the timestamp if the page is being watched.
2296 // The query to find out if it is watched is cached both in memcached and per-invocation,
2297 // and when it does have to be executed, it can be on a slave
2298 // If this is the user's newtalk page, we always update the timestamp
2299 if( $title->getNamespace() == NS_USER_TALK
&&
2300 $title->getText() == $wgUser->getName() )
2303 } elseif ( $this->getId() == $wgUser->getId() ) {
2304 $watched = $title->userIsWatching();
2309 // If the page is watched by the user (or may be watched), update the timestamp on any
2310 // any matching rows
2312 $dbw = wfGetDB( DB_MASTER
);
2313 $dbw->update( 'watchlist',
2315 'wl_notificationtimestamp' => NULL
2316 ), array( /* WHERE */
2317 'wl_title' => $title->getDBkey(),
2318 'wl_namespace' => $title->getNamespace(),
2319 'wl_user' => $this->getID()
2326 * Resets all of the given user's page-change notification timestamps.
2327 * If e-notif e-mails are on, they will receive notification mails on
2328 * the next change of any watched page.
2330 * @param $currentUser \int User ID
2332 function clearAllNotifications( $currentUser ) {
2333 global $wgUseEnotif, $wgShowUpdatedMarker;
2334 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2335 $this->setNewtalk( false );
2338 if( $currentUser != 0 ) {
2339 $dbw = wfGetDB( DB_MASTER
);
2340 $dbw->update( 'watchlist',
2342 'wl_notificationtimestamp' => NULL
2343 ), array( /* WHERE */
2344 'wl_user' => $currentUser
2347 # We also need to clear here the "you have new message" notification for the own user_talk page
2348 # This is cleared one page view later in Article::viewUpdates();
2353 * Set this user's options from an encoded string
2354 * @param $str \string Encoded options to import
2357 function decodeOptions( $str ) {
2361 $this->mOptionsLoaded
= true;
2362 $this->mOptionOverrides
= array();
2364 $this->mOptions
= array();
2365 $a = explode( "\n", $str );
2366 foreach ( $a as $s ) {
2368 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2369 $this->mOptions
[$m[1]] = $m[2];
2370 $this->mOptionOverrides
[$m[1]] = $m[2];
2376 * Set a cookie on the user's client. Wrapper for
2377 * WebResponse::setCookie
2378 * @param $name \string Name of the cookie to set
2379 * @param $value \string Value to set
2380 * @param $exp \int Expiration time, as a UNIX time value;
2381 * if 0 or not specified, use the default $wgCookieExpiration
2383 protected function setCookie( $name, $value, $exp = 0 ) {
2385 $wgRequest->response()->setcookie( $name, $value, $exp );
2389 * Clear a cookie on the user's client
2390 * @param $name \string Name of the cookie to clear
2392 protected function clearCookie( $name ) {
2393 $this->setCookie( $name, '', time() - 86400 );
2397 * Set the default cookies for this session on the user's client.
2399 function setCookies() {
2401 if ( 0 == $this->mId
) return;
2403 'wsUserID' => $this->mId
,
2404 'wsToken' => $this->mToken
,
2405 'wsUserName' => $this->getName()
2408 'UserID' => $this->mId
,
2409 'UserName' => $this->getName(),
2411 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2412 $cookies['Token'] = $this->mToken
;
2414 $cookies['Token'] = false;
2417 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2418 #check for null, since the hook could cause a null value
2419 if ( !is_null( $session ) && isset( $_SESSION ) ){
2420 $_SESSION = $session +
$_SESSION;
2422 foreach ( $cookies as $name => $value ) {
2423 if ( $value === false ) {
2424 $this->clearCookie( $name );
2426 $this->setCookie( $name, $value );
2432 * Log this user out.
2435 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2441 * Clear the user's cookies and session, and reset the instance cache.
2445 function doLogout() {
2446 $this->clearInstanceCache( 'defaults' );
2448 $_SESSION['wsUserID'] = 0;
2450 $this->clearCookie( 'UserID' );
2451 $this->clearCookie( 'Token' );
2453 # Remember when user logged out, to prevent seeing cached pages
2454 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2458 * Save this user's settings into the database.
2459 * @todo Only rarely do all these fields need to be set!
2461 function saveSettings() {
2463 if ( wfReadOnly() ) { return; }
2464 if ( 0 == $this->mId
) { return; }
2466 $this->mTouched
= self
::newTouchedTimestamp();
2468 $dbw = wfGetDB( DB_MASTER
);
2469 $dbw->update( 'user',
2471 'user_name' => $this->mName
,
2472 'user_password' => $this->mPassword
,
2473 'user_newpassword' => $this->mNewpassword
,
2474 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2475 'user_real_name' => $this->mRealName
,
2476 'user_email' => $this->mEmail
,
2477 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2478 'user_options' => '',
2479 'user_touched' => $dbw->timestamp( $this->mTouched
),
2480 'user_token' => $this->mToken
,
2481 'user_email_token' => $this->mEmailToken
,
2482 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2483 ), array( /* WHERE */
2484 'user_id' => $this->mId
2488 $this->saveOptions();
2490 wfRunHooks( 'UserSaveSettings', array( $this ) );
2491 $this->clearSharedCache();
2492 $this->getUserPage()->invalidateCache();
2496 * If only this user's username is known, and it exists, return the user ID.
2498 function idForName() {
2499 $s = trim( $this->getName() );
2500 if ( $s === '' ) return 0;
2502 $dbr = wfGetDB( DB_SLAVE
);
2503 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2504 if ( $id === false ) {
2511 * Add a user to the database, return the user object
2513 * @param $name \string Username to add
2514 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2515 * - password The user's password. Password logins will be disabled if this is omitted.
2516 * - newpassword A temporary password mailed to the user
2517 * - email The user's email address
2518 * - email_authenticated The email authentication timestamp
2519 * - real_name The user's real name
2520 * - options An associative array of non-default options
2521 * - token Random authentication token. Do not set.
2522 * - registration Registration timestamp. Do not set.
2524 * @return \type{User} A new User object, or null if the username already exists
2526 static function createNew( $name, $params = array() ) {
2529 if ( isset( $params['options'] ) ) {
2530 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2531 unset( $params['options'] );
2533 $dbw = wfGetDB( DB_MASTER
);
2534 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2536 'user_id' => $seqVal,
2537 'user_name' => $name,
2538 'user_password' => $user->mPassword
,
2539 'user_newpassword' => $user->mNewpassword
,
2540 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2541 'user_email' => $user->mEmail
,
2542 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2543 'user_real_name' => $user->mRealName
,
2544 'user_options' => '',
2545 'user_token' => $user->mToken
,
2546 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2547 'user_editcount' => 0,
2549 foreach ( $params as $name => $value ) {
2550 $fields["user_$name"] = $value;
2552 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2553 if ( $dbw->affectedRows() ) {
2554 $newUser = User
::newFromId( $dbw->insertId() );
2562 * Add this existing user object to the database
2564 function addToDatabase() {
2566 $dbw = wfGetDB( DB_MASTER
);
2567 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2568 $dbw->insert( 'user',
2570 'user_id' => $seqVal,
2571 'user_name' => $this->mName
,
2572 'user_password' => $this->mPassword
,
2573 'user_newpassword' => $this->mNewpassword
,
2574 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2575 'user_email' => $this->mEmail
,
2576 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2577 'user_real_name' => $this->mRealName
,
2578 'user_options' => '',
2579 'user_token' => $this->mToken
,
2580 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2581 'user_editcount' => 0,
2584 $this->mId
= $dbw->insertId();
2586 // Clear instance cache other than user table data, which is already accurate
2587 $this->clearInstanceCache();
2589 $this->saveOptions();
2593 * If this (non-anonymous) user is blocked, block any IP address
2594 * they've successfully logged in from.
2596 function spreadBlock() {
2597 wfDebug( __METHOD__
. "()\n" );
2599 if ( $this->mId
== 0 ) {
2603 $userblock = Block
::newFromDB( '', $this->mId
);
2604 if ( !$userblock ) {
2608 $userblock->doAutoblock( wfGetIP() );
2612 * Generate a string which will be different for any combination of
2613 * user options which would produce different parser output.
2614 * This will be used as part of the hash key for the parser cache,
2615 * so users will the same options can share the same cached data
2618 * Extensions which require it should install 'PageRenderingHash' hook,
2619 * which will give them a chance to modify this key based on their own
2622 * @return \string Page rendering hash
2624 function getPageRenderingHash() {
2625 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2627 return $this->mHash
;
2630 // stubthreshold is only included below for completeness,
2631 // it will always be 0 when this function is called by parsercache.
2633 $confstr = $this->getOption( 'math' );
2634 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2635 if ( $wgUseDynamicDates ) {
2636 $confstr .= '!' . $this->getDatePreference();
2638 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2639 $confstr .= '!' . $wgLang->getCode();
2640 $confstr .= '!' . $this->getOption( 'thumbsize' );
2641 // add in language specific options, if any
2642 $extra = $wgContLang->getExtraHashOptions();
2645 $confstr .= $wgRenderHashAppend;
2647 // Give a chance for extensions to modify the hash, if they have
2648 // extra options or other effects on the parser cache.
2649 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2651 // Make it a valid memcached key fragment
2652 $confstr = str_replace( ' ', '_', $confstr );
2653 $this->mHash
= $confstr;
2658 * Get whether the user is explicitly blocked from account creation.
2659 * @return \bool True if blocked
2661 function isBlockedFromCreateAccount() {
2662 $this->getBlockedStatus();
2663 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2667 * Get whether the user is blocked from using Special:Emailuser.
2668 * @return \bool True if blocked
2670 function isBlockedFromEmailuser() {
2671 $this->getBlockedStatus();
2672 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2676 * Get whether the user is allowed to create an account.
2677 * @return \bool True if allowed
2679 function isAllowedToCreateAccount() {
2680 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2686 function setLoaded( $loaded ) {
2687 wfDeprecated( __METHOD__
);
2691 * Get this user's personal page title.
2693 * @return \type{Title} User's personal page title
2695 function getUserPage() {
2696 return Title
::makeTitle( NS_USER
, $this->getName() );
2700 * Get this user's talk page title.
2702 * @return \type{Title} User's talk page title
2704 function getTalkPage() {
2705 $title = $this->getUserPage();
2706 return $title->getTalkPage();
2710 * Get the maximum valid user ID.
2711 * @return \int User ID
2714 function getMaxID() {
2715 static $res; // cache
2717 if ( isset( $res ) )
2720 $dbr = wfGetDB( DB_SLAVE
);
2721 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2726 * Determine whether the user is a newbie. Newbies are either
2727 * anonymous IPs, or the most recently created accounts.
2728 * @return \bool True if the user is a newbie
2730 function isNewbie() {
2731 return !$this->isAllowed( 'autoconfirmed' );
2735 * Check to see if the given clear-text password is one of the accepted passwords
2736 * @param $password \string user password.
2737 * @return \bool True if the given password is correct, otherwise False.
2739 function checkPassword( $password ) {
2743 // Even though we stop people from creating passwords that
2744 // are shorter than this, doesn't mean people wont be able
2745 // to. Certain authentication plugins do NOT want to save
2746 // domain passwords in a mysql database, so we should
2747 // check this (incase $wgAuth->strict() is false).
2748 if( !$this->isValidPassword( $password ) ) {
2752 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2754 } elseif( $wgAuth->strict() ) {
2755 /* Auth plugin doesn't allow local authentication */
2757 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2758 /* Auth plugin doesn't allow local authentication for this user name */
2761 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2763 } elseif ( function_exists( 'iconv' ) ) {
2764 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2765 # Check for this with iconv
2766 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2767 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2775 * Check if the given clear-text password matches the temporary password
2776 * sent by e-mail for password reset operations.
2777 * @return \bool True if matches, false otherwise
2779 function checkTemporaryPassword( $plaintext ) {
2780 global $wgNewPasswordExpiry;
2781 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2783 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2784 return ( time() < $expiry );
2791 * Initialize (if necessary) and return a session token value
2792 * which can be used in edit forms to show that the user's
2793 * login credentials aren't being hijacked with a foreign form
2796 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2797 * @return \string The new edit token
2799 function editToken( $salt = '' ) {
2800 if ( $this->isAnon() ) {
2801 return EDIT_TOKEN_SUFFIX
;
2803 if( !isset( $_SESSION['wsEditToken'] ) ) {
2804 $token = $this->generateToken();
2805 $_SESSION['wsEditToken'] = $token;
2807 $token = $_SESSION['wsEditToken'];
2809 if( is_array( $salt ) ) {
2810 $salt = implode( '|', $salt );
2812 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2817 * Generate a looking random token for various uses.
2819 * @param $salt \string Optional salt value
2820 * @return \string The new random token
2822 function generateToken( $salt = '' ) {
2823 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2824 return md5( $token . $salt );
2828 * Check given value against the token value stored in the session.
2829 * A match should confirm that the form was submitted from the
2830 * user's own login session, not a form submission from a third-party
2833 * @param $val \string Input value to compare
2834 * @param $salt \string Optional function-specific data for hashing
2835 * @return \bool Whether the token matches
2837 function matchEditToken( $val, $salt = '' ) {
2838 $sessionToken = $this->editToken( $salt );
2839 if ( $val != $sessionToken ) {
2840 wfDebug( "User::matchEditToken: broken session data\n" );
2842 return $val == $sessionToken;
2846 * Check given value against the token value stored in the session,
2847 * ignoring the suffix.
2849 * @param $val \string Input value to compare
2850 * @param $salt \string Optional function-specific data for hashing
2851 * @return \bool Whether the token matches
2853 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2854 $sessionToken = $this->editToken( $salt );
2855 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2859 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2860 * mail to the user's given address.
2862 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2864 function sendConfirmationMail() {
2866 $expiration = null; // gets passed-by-ref and defined in next line.
2867 $token = $this->confirmationToken( $expiration );
2868 $url = $this->confirmationTokenUrl( $token );
2869 $invalidateURL = $this->invalidationTokenUrl( $token );
2870 $this->saveSettings();
2872 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2873 wfMsg( 'confirmemail_body',
2877 $wgLang->timeanddate( $expiration, false ),
2879 $wgLang->date( $expiration, false ),
2880 $wgLang->time( $expiration, false ) ) );
2884 * Send an e-mail to this user's account. Does not check for
2885 * confirmed status or validity.
2887 * @param $subject \string Message subject
2888 * @param $body \string Message body
2889 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2890 * @param $replyto \string Reply-To address
2891 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2893 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2894 if( is_null( $from ) ) {
2895 global $wgPasswordSender;
2896 $from = $wgPasswordSender;
2899 $to = new MailAddress( $this );
2900 $sender = new MailAddress( $from );
2901 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2905 * Generate, store, and return a new e-mail confirmation code.
2906 * A hash (unsalted, since it's used as a key) is stored.
2908 * @note Call saveSettings() after calling this function to commit
2909 * this change to the database.
2911 * @param[out] &$expiration \mixed Accepts the expiration time
2912 * @return \string New token
2915 function confirmationToken( &$expiration ) {
2917 $expires = $now +
7 * 24 * 60 * 60;
2918 $expiration = wfTimestamp( TS_MW
, $expires );
2919 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2920 $hash = md5( $token );
2922 $this->mEmailToken
= $hash;
2923 $this->mEmailTokenExpires
= $expiration;
2928 * Return a URL the user can use to confirm their email address.
2929 * @param $token \string Accepts the email confirmation token
2930 * @return \string New token URL
2933 function confirmationTokenUrl( $token ) {
2934 return $this->getTokenUrl( 'ConfirmEmail', $token );
2938 * Return a URL the user can use to invalidate their email address.
2939 * @param $token \string Accepts the email confirmation token
2940 * @return \string New token URL
2943 function invalidationTokenUrl( $token ) {
2944 return $this->getTokenUrl( 'Invalidateemail', $token );
2948 * Internal function to format the e-mail validation/invalidation URLs.
2949 * This uses $wgArticlePath directly as a quickie hack to use the
2950 * hardcoded English names of the Special: pages, for ASCII safety.
2952 * @note Since these URLs get dropped directly into emails, using the
2953 * short English names avoids insanely long URL-encoded links, which
2954 * also sometimes can get corrupted in some browsers/mailers
2955 * (bug 6957 with Gmail and Internet Explorer).
2957 * @param $page \string Special page
2958 * @param $token \string Token
2959 * @return \string Formatted URL
2961 protected function getTokenUrl( $page, $token ) {
2962 global $wgArticlePath;
2966 "Special:$page/$token",
2971 * Mark the e-mail address confirmed.
2973 * @note Call saveSettings() after calling this function to commit the change.
2975 function confirmEmail() {
2976 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2977 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
2982 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2983 * address if it was already confirmed.
2985 * @note Call saveSettings() after calling this function to commit the change.
2987 function invalidateEmail() {
2989 $this->mEmailToken
= null;
2990 $this->mEmailTokenExpires
= null;
2991 $this->setEmailAuthenticationTimestamp( null );
2992 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
2997 * Set the e-mail authentication timestamp.
2998 * @param $timestamp \string TS_MW timestamp
3000 function setEmailAuthenticationTimestamp( $timestamp ) {
3002 $this->mEmailAuthenticated
= $timestamp;
3003 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3007 * Is this user allowed to send e-mails within limits of current
3008 * site configuration?
3009 * @return \bool True if allowed
3011 function canSendEmail() {
3012 global $wgEnableEmail, $wgEnableUserEmail, $wgUser;
3013 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$wgUser->isAllowed( 'sendemail' ) ) {
3016 $canSend = $this->isEmailConfirmed();
3017 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3022 * Is this user allowed to receive e-mails within limits of current
3023 * site configuration?
3024 * @return \bool True if allowed
3026 function canReceiveEmail() {
3027 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3031 * Is this user's e-mail address valid-looking and confirmed within
3032 * limits of the current site configuration?
3034 * @note If $wgEmailAuthentication is on, this may require the user to have
3035 * confirmed their address by returning a code or using a password
3036 * sent to the address from the wiki.
3038 * @return \bool True if confirmed
3040 function isEmailConfirmed() {
3041 global $wgEmailAuthentication;
3044 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3045 if( $this->isAnon() )
3047 if( !self
::isValidEmailAddr( $this->mEmail
) )
3049 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3058 * Check whether there is an outstanding request for e-mail confirmation.
3059 * @return \bool True if pending
3061 function isEmailConfirmationPending() {
3062 global $wgEmailAuthentication;
3063 return $wgEmailAuthentication &&
3064 !$this->isEmailConfirmed() &&
3065 $this->mEmailToken
&&
3066 $this->mEmailTokenExpires
> wfTimestamp();
3070 * Get the timestamp of account creation.
3072 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3073 * non-existent/anonymous user accounts.
3075 public function getRegistration() {
3076 return $this->getId() > 0
3077 ?
$this->mRegistration
3082 * Get the timestamp of the first edit
3084 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3085 * non-existent/anonymous user accounts.
3087 public function getFirstEditTimestamp() {
3088 if( $this->getId() == 0 ) return false; // anons
3089 $dbr = wfGetDB( DB_SLAVE
);
3090 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3091 array( 'rev_user' => $this->getId() ),
3093 array( 'ORDER BY' => 'rev_timestamp ASC' )
3095 if( !$time ) return false; // no edits
3096 return wfTimestamp( TS_MW
, $time );
3100 * Get the permissions associated with a given list of groups
3102 * @param $groups \type{\arrayof{\string}} List of internal group names
3103 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3105 static function getGroupPermissions( $groups ) {
3106 global $wgGroupPermissions, $wgRevokePermissions;
3108 // grant every granted permission first
3109 foreach( $groups as $group ) {
3110 if( isset( $wgGroupPermissions[$group] ) ) {
3111 $rights = array_merge( $rights,
3112 // array_filter removes empty items
3113 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3116 // now revoke the revoked permissions
3117 foreach( $groups as $group ) {
3118 if( isset( $wgRevokePermissions[$group] ) ) {
3119 $rights = array_diff( $rights,
3120 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3123 return array_unique( $rights );
3127 * Get all the groups who have a given permission
3129 * @param $role \string Role to check
3130 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3132 static function getGroupsWithPermission( $role ) {
3133 global $wgGroupPermissions;
3134 $allowedGroups = array();
3135 foreach ( $wgGroupPermissions as $group => $rights ) {
3136 if ( isset( $rights[$role] ) && $rights[$role] ) {
3137 $allowedGroups[] = $group;
3140 return $allowedGroups;
3144 * Get the localized descriptive name for a group, if it exists
3146 * @param $group \string Internal group name
3147 * @return \string Localized descriptive group name
3149 static function getGroupName( $group ) {
3150 global $wgMessageCache;
3151 $wgMessageCache->loadAllMessages();
3152 $key = "group-$group";
3153 $name = wfMsg( $key );
3154 return $name == '' ||
wfEmptyMsg( $key, $name )
3160 * Get the localized descriptive name for a member of a group, if it exists
3162 * @param $group \string Internal group name
3163 * @return \string Localized name for group member
3165 static function getGroupMember( $group ) {
3166 global $wgMessageCache;
3167 $wgMessageCache->loadAllMessages();
3168 $key = "group-$group-member";
3169 $name = wfMsg( $key );
3170 return $name == '' ||
wfEmptyMsg( $key, $name )
3176 * Return the set of defined explicit groups.
3177 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3178 * are not included, as they are defined automatically, not in the database.
3179 * @return \type{\arrayof{\string}} Array of internal group names
3181 static function getAllGroups() {
3182 global $wgGroupPermissions, $wgRevokePermissions;
3184 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3185 self
::getImplicitGroups()
3190 * Get a list of all available permissions.
3191 * @return \type{\arrayof{\string}} Array of permission names
3193 static function getAllRights() {
3194 if ( self
::$mAllRights === false ) {
3195 global $wgAvailableRights;
3196 if ( count( $wgAvailableRights ) ) {
3197 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3199 self
::$mAllRights = self
::$mCoreRights;
3201 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3203 return self
::$mAllRights;
3207 * Get a list of implicit groups
3208 * @return \type{\arrayof{\string}} Array of internal group names
3210 public static function getImplicitGroups() {
3211 global $wgImplicitGroups;
3212 $groups = $wgImplicitGroups;
3213 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3218 * Get the title of a page describing a particular group
3220 * @param $group \string Internal group name
3221 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3223 static function getGroupPage( $group ) {
3224 global $wgMessageCache;
3225 $wgMessageCache->loadAllMessages();
3226 $page = wfMsgForContent( 'grouppage-' . $group );
3227 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3228 $title = Title
::newFromText( $page );
3229 if( is_object( $title ) )
3236 * Create a link to the group in HTML, if available;
3237 * else return the group name.
3239 * @param $group \string Internal name of the group
3240 * @param $text \string The text of the link
3241 * @return \string HTML link to the group
3243 static function makeGroupLinkHTML( $group, $text = '' ) {
3245 $text = self
::getGroupName( $group );
3247 $title = self
::getGroupPage( $group );
3250 $sk = $wgUser->getSkin();
3251 return $sk->link( $title, htmlspecialchars( $text ) );
3258 * Create a link to the group in Wikitext, if available;
3259 * else return the group name.
3261 * @param $group \string Internal name of the group
3262 * @param $text \string The text of the link
3263 * @return \string Wikilink to the group
3265 static function makeGroupLinkWiki( $group, $text = '' ) {
3267 $text = self
::getGroupName( $group );
3269 $title = self
::getGroupPage( $group );
3271 $page = $title->getPrefixedText();
3272 return "[[$page|$text]]";
3279 * Returns an array of the groups that a particular group can add/remove.
3281 * @param $group String: the group to check for whether it can add/remove
3282 * @return Array array( 'add' => array( addablegroups ),
3283 * 'remove' => array( removablegroups ),
3284 * 'add-self' => array( addablegroups to self),
3285 * 'remove-self' => array( removable groups from self) )
3287 static function changeableByGroup( $group ) {
3288 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3290 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3291 if( empty( $wgAddGroups[$group] ) ) {
3292 // Don't add anything to $groups
3293 } elseif( $wgAddGroups[$group] === true ) {
3294 // You get everything
3295 $groups['add'] = self
::getAllGroups();
3296 } elseif( is_array( $wgAddGroups[$group] ) ) {
3297 $groups['add'] = $wgAddGroups[$group];
3300 // Same thing for remove
3301 if( empty( $wgRemoveGroups[$group] ) ) {
3302 } elseif( $wgRemoveGroups[$group] === true ) {
3303 $groups['remove'] = self
::getAllGroups();
3304 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3305 $groups['remove'] = $wgRemoveGroups[$group];
3308 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3309 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3310 foreach( $wgGroupsAddToSelf as $key => $value ) {
3311 if( is_int( $key ) ) {
3312 $wgGroupsAddToSelf['user'][] = $value;
3317 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3318 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3319 if( is_int( $key ) ) {
3320 $wgGroupsRemoveFromSelf['user'][] = $value;
3325 // Now figure out what groups the user can add to him/herself
3326 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3327 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3328 // No idea WHY this would be used, but it's there
3329 $groups['add-self'] = User
::getAllGroups();
3330 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3331 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3334 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3335 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3336 $groups['remove-self'] = User
::getAllGroups();
3337 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3338 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3345 * Returns an array of groups that this user can add and remove
3346 * @return Array array( 'add' => array( addablegroups ),
3347 * 'remove' => array( removablegroups ),
3348 * 'add-self' => array( addablegroups to self),
3349 * 'remove-self' => array( removable groups from self) )
3351 function changeableGroups() {
3352 if( $this->isAllowed( 'userrights' ) ) {
3353 // This group gives the right to modify everything (reverse-
3354 // compatibility with old "userrights lets you change
3356 // Using array_merge to make the groups reindexed
3357 $all = array_merge( User
::getAllGroups() );
3361 'add-self' => array(),
3362 'remove-self' => array()
3366 // Okay, it's not so simple, we will have to go through the arrays
3369 'remove' => array(),
3370 'add-self' => array(),
3371 'remove-self' => array()
3373 $addergroups = $this->getEffectiveGroups();
3375 foreach( $addergroups as $addergroup ) {
3376 $groups = array_merge_recursive(
3377 $groups, $this->changeableByGroup( $addergroup )
3379 $groups['add'] = array_unique( $groups['add'] );
3380 $groups['remove'] = array_unique( $groups['remove'] );
3381 $groups['add-self'] = array_unique( $groups['add-self'] );
3382 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3388 * Increment the user's edit-count field.
3389 * Will have no effect for anonymous users.
3391 function incEditCount() {
3392 if( !$this->isAnon() ) {
3393 $dbw = wfGetDB( DB_MASTER
);
3394 $dbw->update( 'user',
3395 array( 'user_editcount=user_editcount+1' ),
3396 array( 'user_id' => $this->getId() ),
3399 // Lazy initialization check...
3400 if( $dbw->affectedRows() == 0 ) {
3401 // Pull from a slave to be less cruel to servers
3402 // Accuracy isn't the point anyway here
3403 $dbr = wfGetDB( DB_SLAVE
);
3404 $count = $dbr->selectField( 'revision',
3406 array( 'rev_user' => $this->getId() ),
3409 // Now here's a goddamn hack...
3410 if( $dbr !== $dbw ) {
3411 // If we actually have a slave server, the count is
3412 // at least one behind because the current transaction
3413 // has not been committed and replicated.
3416 // But if DB_SLAVE is selecting the master, then the
3417 // count we just read includes the revision that was
3418 // just added in the working transaction.
3421 $dbw->update( 'user',
3422 array( 'user_editcount' => $count ),
3423 array( 'user_id' => $this->getId() ),
3427 // edit count in user cache too
3428 $this->invalidateCache();
3432 * Get the description of a given right
3434 * @param $right \string Right to query
3435 * @return \string Localized description of the right
3437 static function getRightDescription( $right ) {
3438 global $wgMessageCache;
3439 $wgMessageCache->loadAllMessages();
3440 $key = "right-$right";
3441 $name = wfMsg( $key );
3442 return $name == '' ||
wfEmptyMsg( $key, $name )
3448 * Make an old-style password hash
3450 * @param $password \string Plain-text password
3451 * @param $userId \string User ID
3452 * @return \string Password hash
3454 static function oldCrypt( $password, $userId ) {
3455 global $wgPasswordSalt;
3456 if ( $wgPasswordSalt ) {
3457 return md5( $userId . '-' . md5( $password ) );
3459 return md5( $password );
3464 * Make a new-style password hash
3466 * @param $password \string Plain-text password
3467 * @param $salt \string Optional salt, may be random or the user ID.
3468 * If unspecified or false, will generate one automatically
3469 * @return \string Password hash
3471 static function crypt( $password, $salt = false ) {
3472 global $wgPasswordSalt;
3475 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3479 if( $wgPasswordSalt ) {
3480 if ( $salt === false ) {
3481 $salt = substr( wfGenerateToken(), 0, 8 );
3483 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3485 return ':A:' . md5( $password );
3490 * Compare a password hash with a plain-text password. Requires the user
3491 * ID if there's a chance that the hash is an old-style hash.
3493 * @param $hash \string Password hash
3494 * @param $password \string Plain-text password to compare
3495 * @param $userId \string User ID for old-style password salt
3498 static function comparePasswords( $hash, $password, $userId = false ) {
3500 $type = substr( $hash, 0, 3 );
3503 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3507 if ( $type == ':A:' ) {
3509 return md5( $password ) === substr( $hash, 3 );
3510 } elseif ( $type == ':B:' ) {
3512 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3513 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3516 return self
::oldCrypt( $password, $userId ) === $hash;
3521 * Add a newuser log entry for this user
3522 * @param $byEmail Boolean: account made by email?
3524 public function addNewUserLogEntry( $byEmail = false ) {
3525 global $wgUser, $wgContLang, $wgNewUserLog;
3526 if( empty( $wgNewUserLog ) ) {
3527 return true; // disabled
3529 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3530 if( $this->getName() == $wgUser->getName() ) {
3534 $action = 'create2';
3536 ?
wfMsgForContent( 'newuserlog-byemail' )
3539 $log = new LogPage( 'newusers' );
3542 $this->getUserPage(),
3544 array( $this->getId() )
3550 * Add an autocreate newuser log entry for this user
3551 * Used by things like CentralAuth and perhaps other authplugins.
3553 public function addNewUserLogEntryAutoCreate() {
3554 global $wgNewUserLog;
3555 if( empty( $wgNewUserLog ) ) {
3556 return true; // disabled
3558 $log = new LogPage( 'newusers', false );
3559 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3563 protected function loadOptions() {
3565 if ( $this->mOptionsLoaded ||
!$this->getId() )
3568 $this->mOptions
= self
::getDefaultOptions();
3570 // Maybe load from the object
3571 if ( !is_null( $this->mOptionOverrides
) ) {
3572 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3573 foreach( $this->mOptionOverrides
as $key => $value ) {
3574 $this->mOptions
[$key] = $value;
3577 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3578 // Load from database
3579 $dbr = wfGetDB( DB_SLAVE
);
3581 $res = $dbr->select(
3584 array( 'up_user' => $this->getId() ),
3588 while( $row = $dbr->fetchObject( $res ) ) {
3589 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3590 $this->mOptions
[$row->up_property
] = $row->up_value
;
3594 $this->mOptionsLoaded
= true;
3596 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3599 protected function saveOptions() {
3600 global $wgAllowPrefChange;
3602 $extuser = ExternalUser
::newFromUser( $this );
3604 $this->loadOptions();
3605 $dbw = wfGetDB( DB_MASTER
);
3607 $insert_rows = array();
3609 $saveOptions = $this->mOptions
;
3611 // Allow hooks to abort, for instance to save to a global profile.
3612 // Reset options to default state before saving.
3613 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3616 foreach( $saveOptions as $key => $value ) {
3617 # Don't bother storing default values
3618 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3619 !( $value === false ||
is_null($value) ) ) ||
3620 $value != self
::getDefaultOption( $key ) ) {
3621 $insert_rows[] = array(
3622 'up_user' => $this->getId(),
3623 'up_property' => $key,
3624 'up_value' => $value,
3627 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3628 switch ( $wgAllowPrefChange[$key] ) {
3634 $extuser->setPref( $key, $value );
3640 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3641 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3646 * Provide an array of HTML 5 attributes to put on an input element
3647 * intended for the user to enter a new password. This may include
3648 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3650 * Do *not* use this when asking the user to enter his current password!
3651 * Regardless of configuration, users may have invalid passwords for whatever
3652 * reason (e.g., they were set before requirements were tightened up).
3653 * Only use it when asking for a new password, like on account creation or
3656 * Obviously, you still need to do server-side checking.
3658 * @return array Array of HTML attributes suitable for feeding to
3659 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3660 * That will potentially output invalid XHTML 1.0 Transitional, and will
3661 * get confused by the boolean attribute syntax used.)
3663 public static function passwordChangeInputAttribs() {
3664 global $wgMinimalPasswordLength;
3666 if ( $wgMinimalPasswordLength == 0 ) {
3670 # Note that the pattern requirement will always be satisfied if the
3671 # input is empty, so we need required in all cases.
3672 $ret = array( 'required' );
3674 # We can't actually do this right now, because Opera 9.6 will print out
3675 # the entered password visibly in its error message! When other
3676 # browsers add support for this attribute, or Opera fixes its support,
3677 # we can add support with a version check to avoid doing this on Opera
3678 # versions where it will be a problem. Reported to Opera as
3679 # DSK-262266, but they don't have a public bug tracker for us to follow.
3681 if ( $wgMinimalPasswordLength > 1 ) {
3682 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3683 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3684 $wgMinimalPasswordLength );