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 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1223 // Deprecated, but kept for backwards-compatibility config
1226 return !$this->isAllowed( 'noratelimit' );
1230 * Primitive rate limits: enforce maximum actions per time period
1231 * to put a brake on flooding.
1233 * @note When using a shared cache like memcached, IP-address
1234 * last-hit counters will be shared across wikis.
1236 * @param $action \string Action to enforce; 'edit' if unspecified
1237 * @return \bool True if a rate limiter was tripped
1239 function pingLimiter( $action = 'edit' ) {
1240 # Call the 'PingLimiter' hook
1242 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1246 global $wgRateLimits;
1247 if( !isset( $wgRateLimits[$action] ) ) {
1251 # Some groups shouldn't trigger the ping limiter, ever
1252 if( !$this->isPingLimitable() )
1255 global $wgMemc, $wgRateLimitLog;
1256 wfProfileIn( __METHOD__
);
1258 $limits = $wgRateLimits[$action];
1260 $id = $this->getId();
1264 if( isset( $limits['anon'] ) && $id == 0 ) {
1265 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1268 if( isset( $limits['user'] ) && $id != 0 ) {
1269 $userLimit = $limits['user'];
1271 if( $this->isNewbie() ) {
1272 if( isset( $limits['newbie'] ) && $id != 0 ) {
1273 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1275 if( isset( $limits['ip'] ) ) {
1276 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1279 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1280 $subnet = $matches[1];
1281 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1284 // Check for group-specific permissions
1285 // If more than one group applies, use the group with the highest limit
1286 foreach ( $this->getGroups() as $group ) {
1287 if ( isset( $limits[$group] ) ) {
1288 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1289 $userLimit = $limits[$group];
1293 // Set the user limit key
1294 if ( $userLimit !== false ) {
1295 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1296 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1300 foreach( $keys as $key => $limit ) {
1301 list( $max, $period ) = $limit;
1302 $summary = "(limit $max in {$period}s)";
1303 $count = $wgMemc->get( $key );
1306 if( $count > $max ) {
1307 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1308 if( $wgRateLimitLog ) {
1309 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1313 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1315 $wgMemc->incr( $key );
1317 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1318 $wgMemc->set( $key, 1, intval( $period ) ); // first ping
1322 wfProfileOut( __METHOD__
);
1327 * Check if user is blocked
1329 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1330 * @return \bool True if blocked, false otherwise
1332 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1333 wfDebug( "User::isBlocked: enter\n" );
1334 $this->getBlockedStatus( $bFromSlave );
1335 return $this->mBlockedby
!== 0;
1339 * Check if user is blocked from editing a particular article
1341 * @param $title \string Title to check
1342 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1343 * @return \bool True if blocked, false otherwise
1345 function isBlockedFrom( $title, $bFromSlave = false ) {
1346 global $wgBlockAllowsUTEdit;
1347 wfProfileIn( __METHOD__
);
1348 wfDebug( __METHOD__
. ": enter\n" );
1350 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1351 $blocked = $this->isBlocked( $bFromSlave );
1352 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1353 # If a user's name is suppressed, they cannot make edits anywhere
1354 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1355 $title->getNamespace() == NS_USER_TALK
) {
1357 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1360 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1362 wfProfileOut( __METHOD__
);
1367 * If user is blocked, return the name of the user who placed the block
1368 * @return \string name of blocker
1370 function blockedBy() {
1371 $this->getBlockedStatus();
1372 return $this->mBlockedby
;
1376 * If user is blocked, return the specified reason for the block
1377 * @return \string Blocking reason
1379 function blockedFor() {
1380 $this->getBlockedStatus();
1381 return $this->mBlockreason
;
1385 * If user is blocked, return the ID for the block
1386 * @return \int Block ID
1388 function getBlockId() {
1389 $this->getBlockedStatus();
1390 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1394 * Check if user is blocked on all wikis.
1395 * Do not use for actual edit permission checks!
1396 * This is intented for quick UI checks.
1398 * @param $ip \type{\string} IP address, uses current client if none given
1399 * @return \type{\bool} True if blocked, false otherwise
1401 function isBlockedGlobally( $ip = '' ) {
1402 if( $this->mBlockedGlobally
!== null ) {
1403 return $this->mBlockedGlobally
;
1405 // User is already an IP?
1406 if( IP
::isIPAddress( $this->getName() ) ) {
1407 $ip = $this->getName();
1412 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1413 $this->mBlockedGlobally
= (bool)$blocked;
1414 return $this->mBlockedGlobally
;
1418 * Check if user account is locked
1420 * @return \type{\bool} True if locked, false otherwise
1422 function isLocked() {
1423 if( $this->mLocked
!== null ) {
1424 return $this->mLocked
;
1427 $authUser = $wgAuth->getUserInstance( $this );
1428 $this->mLocked
= (bool)$authUser->isLocked();
1429 return $this->mLocked
;
1433 * Check if user account is hidden
1435 * @return \type{\bool} True if hidden, false otherwise
1437 function isHidden() {
1438 if( $this->mHideName
!== null ) {
1439 return $this->mHideName
;
1441 $this->getBlockedStatus();
1442 if( !$this->mHideName
) {
1444 $authUser = $wgAuth->getUserInstance( $this );
1445 $this->mHideName
= (bool)$authUser->isHidden();
1447 return $this->mHideName
;
1451 * Get the user's ID.
1452 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1455 if( $this->mId
=== null and $this->mName
!== null
1456 and User
::isIP( $this->mName
) ) {
1457 // Special case, we know the user is anonymous
1459 } elseif( $this->mId
=== null ) {
1460 // Don't load if this was initialized from an ID
1467 * Set the user and reload all fields according to a given ID
1468 * @param $v \int User ID to reload
1470 function setId( $v ) {
1472 $this->clearInstanceCache( 'id' );
1476 * Get the user name, or the IP of an anonymous user
1477 * @return \string User's name or IP address
1479 function getName() {
1480 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1481 # Special case optimisation
1482 return $this->mName
;
1485 if ( $this->mName
=== false ) {
1487 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1489 return $this->mName
;
1494 * Set the user name.
1496 * This does not reload fields from the database according to the given
1497 * name. Rather, it is used to create a temporary "nonexistent user" for
1498 * later addition to the database. It can also be used to set the IP
1499 * address for an anonymous user to something other than the current
1502 * @note User::newFromName() has rougly the same function, when the named user
1504 * @param $str \string New user name to set
1506 function setName( $str ) {
1508 $this->mName
= $str;
1512 * Get the user's name escaped by underscores.
1513 * @return \string Username escaped by underscores.
1515 function getTitleKey() {
1516 return str_replace( ' ', '_', $this->getName() );
1520 * Check if the user has new messages.
1521 * @return \bool True if the user has new messages
1523 function getNewtalk() {
1526 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1527 if( $this->mNewtalk
=== -1 ) {
1528 $this->mNewtalk
= false; # reset talk page status
1530 # Check memcached separately for anons, who have no
1531 # entire User object stored in there.
1534 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1535 $newtalk = $wgMemc->get( $key );
1536 if( strval( $newtalk ) !== '' ) {
1537 $this->mNewtalk
= (bool)$newtalk;
1539 // Since we are caching this, make sure it is up to date by getting it
1541 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1542 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1545 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1549 return (bool)$this->mNewtalk
;
1553 * Return the talk page(s) this user has new messages on.
1554 * @return \type{\arrayof{\string}} Array of page URLs
1556 function getNewMessageLinks() {
1558 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1561 if( !$this->getNewtalk() )
1563 $up = $this->getUserPage();
1564 $utp = $up->getTalkPage();
1565 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1569 * Internal uncached check for new messages
1572 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1573 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1574 * @param $fromMaster \bool true to fetch from the master, false for a slave
1575 * @return \bool True if the user has new messages
1578 function checkNewtalk( $field, $id, $fromMaster = false ) {
1579 if ( $fromMaster ) {
1580 $db = wfGetDB( DB_MASTER
);
1582 $db = wfGetDB( DB_SLAVE
);
1584 $ok = $db->selectField( 'user_newtalk', $field,
1585 array( $field => $id ), __METHOD__
);
1586 return $ok !== false;
1590 * Add or update the new messages flag
1591 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1592 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1593 * @return \bool True if successful, false otherwise
1596 function updateNewtalk( $field, $id ) {
1597 $dbw = wfGetDB( DB_MASTER
);
1598 $dbw->insert( 'user_newtalk',
1599 array( $field => $id ),
1602 if ( $dbw->affectedRows() ) {
1603 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1606 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1612 * Clear the new messages flag for the given user
1613 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1614 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1615 * @return \bool True if successful, false otherwise
1618 function deleteNewtalk( $field, $id ) {
1619 $dbw = wfGetDB( DB_MASTER
);
1620 $dbw->delete( 'user_newtalk',
1621 array( $field => $id ),
1623 if ( $dbw->affectedRows() ) {
1624 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1627 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1633 * Update the 'You have new messages!' status.
1634 * @param $val \bool Whether the user has new messages
1636 function setNewtalk( $val ) {
1637 if( wfReadOnly() ) {
1642 $this->mNewtalk
= $val;
1644 if( $this->isAnon() ) {
1646 $id = $this->getName();
1649 $id = $this->getId();
1654 $changed = $this->updateNewtalk( $field, $id );
1656 $changed = $this->deleteNewtalk( $field, $id );
1659 if( $this->isAnon() ) {
1660 // Anons have a separate memcached space, since
1661 // user records aren't kept for them.
1662 $key = wfMemcKey( 'newtalk', 'ip', $id );
1663 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1666 $this->invalidateCache();
1671 * Generate a current or new-future timestamp to be stored in the
1672 * user_touched field when we update things.
1673 * @return \string Timestamp in TS_MW format
1675 private static function newTouchedTimestamp() {
1676 global $wgClockSkewFudge;
1677 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1681 * Clear user data from memcached.
1682 * Use after applying fun updates to the database; caller's
1683 * responsibility to update user_touched if appropriate.
1685 * Called implicitly from invalidateCache() and saveSettings().
1687 private function clearSharedCache() {
1691 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1696 * Immediately touch the user data cache for this account.
1697 * Updates user_touched field, and removes account data from memcached
1698 * for reload on the next hit.
1700 function invalidateCache() {
1701 if( wfReadOnly() ) {
1706 $this->mTouched
= self
::newTouchedTimestamp();
1708 $dbw = wfGetDB( DB_MASTER
);
1709 $dbw->update( 'user',
1710 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1711 array( 'user_id' => $this->mId
),
1714 $this->clearSharedCache();
1719 * Validate the cache for this account.
1720 * @param $timestamp \string A timestamp in TS_MW format
1722 function validateCache( $timestamp ) {
1724 return ( $timestamp >= $this->mTouched
);
1728 * Get the user touched timestamp
1730 function getTouched() {
1732 return $this->mTouched
;
1736 * Set the password and reset the random token.
1737 * Calls through to authentication plugin if necessary;
1738 * will have no effect if the auth plugin refuses to
1739 * pass the change through or if the legal password
1742 * As a special case, setting the password to null
1743 * wipes it, so the account cannot be logged in until
1744 * a new password is set, for instance via e-mail.
1746 * @param $str \string New password to set
1747 * @throws PasswordError on failure
1749 function setPassword( $str ) {
1752 if( $str !== null ) {
1753 if( !$wgAuth->allowPasswordChange() ) {
1754 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1757 if( !$this->isValidPassword( $str ) ) {
1758 global $wgMinimalPasswordLength;
1759 $valid = $this->getPasswordValidity( $str );
1760 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1761 $wgMinimalPasswordLength ) );
1765 if( !$wgAuth->setPassword( $this, $str ) ) {
1766 throw new PasswordError( wfMsg( 'externaldberror' ) );
1769 $this->setInternalPassword( $str );
1775 * Set the password and reset the random token unconditionally.
1777 * @param $str \string New password to set
1779 function setInternalPassword( $str ) {
1783 if( $str === null ) {
1784 // Save an invalid hash...
1785 $this->mPassword
= '';
1787 $this->mPassword
= self
::crypt( $str );
1789 $this->mNewpassword
= '';
1790 $this->mNewpassTime
= null;
1794 * Get the user's current token.
1795 * @return \string Token
1797 function getToken() {
1799 return $this->mToken
;
1803 * Set the random token (used for persistent authentication)
1804 * Called from loadDefaults() among other places.
1806 * @param $token \string If specified, set the token to this value
1809 function setToken( $token = false ) {
1810 global $wgSecretKey, $wgProxyKey;
1813 if ( $wgSecretKey ) {
1814 $key = $wgSecretKey;
1815 } elseif ( $wgProxyKey ) {
1820 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1822 $this->mToken
= $token;
1827 * Set the cookie password
1829 * @param $str \string New cookie password
1832 function setCookiePassword( $str ) {
1834 $this->mCookiePassword
= md5( $str );
1838 * Set the password for a password reminder or new account email
1840 * @param $str \string New password to set
1841 * @param $throttle \bool If true, reset the throttle timestamp to the present
1843 function setNewpassword( $str, $throttle = true ) {
1845 $this->mNewpassword
= self
::crypt( $str );
1847 $this->mNewpassTime
= wfTimestampNow();
1852 * Has password reminder email been sent within the last
1853 * $wgPasswordReminderResendTime hours?
1854 * @return \bool True or false
1856 function isPasswordReminderThrottled() {
1857 global $wgPasswordReminderResendTime;
1859 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1862 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1863 return time() < $expiry;
1867 * Get the user's e-mail address
1868 * @return \string User's email address
1870 function getEmail() {
1872 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1873 return $this->mEmail
;
1877 * Get the timestamp of the user's e-mail authentication
1878 * @return \string TS_MW timestamp
1880 function getEmailAuthenticationTimestamp() {
1882 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1883 return $this->mEmailAuthenticated
;
1887 * Set the user's e-mail address
1888 * @param $str \string New e-mail address
1890 function setEmail( $str ) {
1892 $this->mEmail
= $str;
1893 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1897 * Get the user's real name
1898 * @return \string User's real name
1900 function getRealName() {
1902 return $this->mRealName
;
1906 * Set the user's real name
1907 * @param $str \string New real name
1909 function setRealName( $str ) {
1911 $this->mRealName
= $str;
1915 * Get the user's current setting for a given option.
1917 * @param $oname \string The option to check
1918 * @param $defaultOverride \string A default value returned if the option does not exist
1919 * @return \string User's current value for the option
1920 * @see getBoolOption()
1921 * @see getIntOption()
1923 function getOption( $oname, $defaultOverride = null ) {
1924 $this->loadOptions();
1926 if ( is_null( $this->mOptions
) ) {
1927 if($defaultOverride != '') {
1928 return $defaultOverride;
1930 $this->mOptions
= User
::getDefaultOptions();
1933 if ( array_key_exists( $oname, $this->mOptions
) ) {
1934 return $this->mOptions
[$oname];
1936 return $defaultOverride;
1941 * Get the user's current setting for a given option, as a boolean value.
1943 * @param $oname \string The option to check
1944 * @return \bool User's current value for the option
1947 function getBoolOption( $oname ) {
1948 return (bool)$this->getOption( $oname );
1953 * Get the user's current setting for a given option, as a boolean value.
1955 * @param $oname \string The option to check
1956 * @param $defaultOverride \int A default value returned if the option does not exist
1957 * @return \int User's current value for the option
1960 function getIntOption( $oname, $defaultOverride=0 ) {
1961 $val = $this->getOption( $oname );
1963 $val = $defaultOverride;
1965 return intval( $val );
1969 * Set the given option for a user.
1971 * @param $oname \string The option to set
1972 * @param $val \mixed New value to set
1974 function setOption( $oname, $val ) {
1976 $this->loadOptions();
1978 if ( $oname == 'skin' ) {
1979 # Clear cached skin, so the new one displays immediately in Special:Preferences
1980 unset( $this->mSkin
);
1983 // Explicitly NULL values should refer to defaults
1984 global $wgDefaultUserOptions;
1985 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
1986 $val = $wgDefaultUserOptions[$oname];
1989 $this->mOptions
[$oname] = $val;
1993 * Reset all options to the site defaults
1995 function resetOptions() {
1996 $this->mOptions
= User
::getDefaultOptions();
2000 * Get the user's preferred date format.
2001 * @return \string User's preferred date format
2003 function getDatePreference() {
2004 // Important migration for old data rows
2005 if ( is_null( $this->mDatePreference
) ) {
2007 $value = $this->getOption( 'date' );
2008 $map = $wgLang->getDatePreferenceMigrationMap();
2009 if ( isset( $map[$value] ) ) {
2010 $value = $map[$value];
2012 $this->mDatePreference
= $value;
2014 return $this->mDatePreference
;
2018 * Get the permissions this user has.
2019 * @return \type{\arrayof{\string}} Array of permission names
2021 function getRights() {
2022 if ( is_null( $this->mRights
) ) {
2023 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2024 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2025 // Force reindexation of rights when a hook has unset one of them
2026 $this->mRights
= array_values( $this->mRights
);
2028 return $this->mRights
;
2032 * Get the list of explicit group memberships this user has.
2033 * The implicit * and user groups are not included.
2034 * @return \type{\arrayof{\string}} Array of internal group names
2036 function getGroups() {
2038 return $this->mGroups
;
2042 * Get the list of implicit group memberships this user has.
2043 * This includes all explicit groups, plus 'user' if logged in,
2044 * '*' for all accounts and autopromoted groups
2045 * @param $recache \bool Whether to avoid the cache
2046 * @return \type{\arrayof{\string}} Array of internal group names
2048 function getEffectiveGroups( $recache = false ) {
2049 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2050 $this->mEffectiveGroups
= $this->getGroups();
2051 $this->mEffectiveGroups
[] = '*';
2052 if( $this->getId() ) {
2053 $this->mEffectiveGroups
[] = 'user';
2055 $this->mEffectiveGroups
= array_unique( array_merge(
2056 $this->mEffectiveGroups
,
2057 Autopromote
::getAutopromoteGroups( $this )
2060 # Hook for additional groups
2061 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2064 return $this->mEffectiveGroups
;
2068 * Get the user's edit count.
2069 * @return \int User'e edit count
2071 function getEditCount() {
2072 if( $this->getId() ) {
2073 if ( !isset( $this->mEditCount
) ) {
2074 /* Populate the count, if it has not been populated yet */
2075 $this->mEditCount
= User
::edits( $this->mId
);
2077 return $this->mEditCount
;
2085 * Add the user to the given group.
2086 * This takes immediate effect.
2087 * @param $group \string Name of the group to add
2089 function addGroup( $group ) {
2090 $dbw = wfGetDB( DB_MASTER
);
2091 if( $this->getId() ) {
2092 $dbw->insert( 'user_groups',
2094 'ug_user' => $this->getID(),
2095 'ug_group' => $group,
2098 array( 'IGNORE' ) );
2101 $this->loadGroups();
2102 $this->mGroups
[] = $group;
2103 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2105 $this->invalidateCache();
2109 * Remove the user from the given group.
2110 * This takes immediate effect.
2111 * @param $group \string Name of the group to remove
2113 function removeGroup( $group ) {
2115 $dbw = wfGetDB( DB_MASTER
);
2116 $dbw->delete( 'user_groups',
2118 'ug_user' => $this->getID(),
2119 'ug_group' => $group,
2121 'User::removeGroup' );
2123 $this->loadGroups();
2124 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2125 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2127 $this->invalidateCache();
2131 * Get whether the user is logged in
2132 * @return \bool True or false
2134 function isLoggedIn() {
2135 return $this->getID() != 0;
2139 * Get whether the user is anonymous
2140 * @return \bool True or false
2143 return !$this->isLoggedIn();
2147 * Get whether the user is a bot
2148 * @return \bool True or false
2152 wfDeprecated( __METHOD__
);
2153 return $this->isAllowed( 'bot' );
2157 * Check if user is allowed to access a feature / make an action
2158 * @param $action \string action to be checked
2159 * @return \bool True if action is allowed, else false
2161 function isAllowed( $action = '' ) {
2162 if ( $action === '' )
2163 return true; // In the spirit of DWIM
2164 # Patrolling may not be enabled
2165 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2166 global $wgUseRCPatrol, $wgUseNPPatrol;
2167 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2170 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2171 # by misconfiguration: 0 == 'foo'
2172 return in_array( $action, $this->getRights(), true );
2176 * Check whether to enable recent changes patrol features for this user
2177 * @return \bool True or false
2179 public function useRCPatrol() {
2180 global $wgUseRCPatrol;
2181 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2185 * Check whether to enable new pages patrol features for this user
2186 * @return \bool True or false
2188 public function useNPPatrol() {
2189 global $wgUseRCPatrol, $wgUseNPPatrol;
2190 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2194 * Get the current skin, loading it if required, and setting a title
2195 * @param $t Title: the title to use in the skin
2196 * @return Skin The current skin
2197 * @todo FIXME : need to check the old failback system [AV]
2199 function &getSkin( $t = null ) {
2200 if ( !isset( $this->mSkin
) ) {
2201 wfProfileIn( __METHOD__
);
2203 global $wgHiddenPrefs;
2204 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2207 $userSkin = $this->getOption( 'skin' );
2208 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2210 # if we're not allowing users to override, then use the default
2211 global $wgDefaultSkin;
2212 $userSkin = $wgDefaultSkin;
2215 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2216 wfProfileOut( __METHOD__
);
2218 if( $t ||
!$this->mSkin
->getTitle() ) {
2221 $t = $wgOut->getTitle();
2223 $this->mSkin
->setTitle( $t );
2225 return $this->mSkin
;
2229 * Check the watched status of an article.
2230 * @param $title \type{Title} Title of the article to look at
2231 * @return \bool True if article is watched
2233 function isWatched( $title ) {
2234 $wl = WatchedItem
::fromUserTitle( $this, $title );
2235 return $wl->isWatched();
2240 * @param $title \type{Title} Title of the article to look at
2242 function addWatch( $title ) {
2243 $wl = WatchedItem
::fromUserTitle( $this, $title );
2245 $this->invalidateCache();
2249 * Stop watching an article.
2250 * @param $title \type{Title} Title of the article to look at
2252 function removeWatch( $title ) {
2253 $wl = WatchedItem
::fromUserTitle( $this, $title );
2255 $this->invalidateCache();
2259 * Clear the user's notification timestamp for the given title.
2260 * If e-notif e-mails are on, they will receive notification mails on
2261 * the next change of the page if it's watched etc.
2262 * @param $title \type{Title} Title of the article to look at
2264 function clearNotification( &$title ) {
2265 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2267 # Do nothing if the database is locked to writes
2268 if( wfReadOnly() ) {
2272 if( $title->getNamespace() == NS_USER_TALK
&&
2273 $title->getText() == $this->getName() ) {
2274 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2276 $this->setNewtalk( false );
2279 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2283 if( $this->isAnon() ) {
2284 // Nothing else to do...
2288 // Only update the timestamp if the page is being watched.
2289 // The query to find out if it is watched is cached both in memcached and per-invocation,
2290 // and when it does have to be executed, it can be on a slave
2291 // If this is the user's newtalk page, we always update the timestamp
2292 if( $title->getNamespace() == NS_USER_TALK
&&
2293 $title->getText() == $wgUser->getName() )
2296 } elseif ( $this->getId() == $wgUser->getId() ) {
2297 $watched = $title->userIsWatching();
2302 // If the page is watched by the user (or may be watched), update the timestamp on any
2303 // any matching rows
2305 $dbw = wfGetDB( DB_MASTER
);
2306 $dbw->update( 'watchlist',
2308 'wl_notificationtimestamp' => NULL
2309 ), array( /* WHERE */
2310 'wl_title' => $title->getDBkey(),
2311 'wl_namespace' => $title->getNamespace(),
2312 'wl_user' => $this->getID()
2319 * Resets all of the given user's page-change notification timestamps.
2320 * If e-notif e-mails are on, they will receive notification mails on
2321 * the next change of any watched page.
2323 * @param $currentUser \int User ID
2325 function clearAllNotifications( $currentUser ) {
2326 global $wgUseEnotif, $wgShowUpdatedMarker;
2327 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2328 $this->setNewtalk( false );
2331 if( $currentUser != 0 ) {
2332 $dbw = wfGetDB( DB_MASTER
);
2333 $dbw->update( 'watchlist',
2335 'wl_notificationtimestamp' => NULL
2336 ), array( /* WHERE */
2337 'wl_user' => $currentUser
2340 # We also need to clear here the "you have new message" notification for the own user_talk page
2341 # This is cleared one page view later in Article::viewUpdates();
2346 * Set this user's options from an encoded string
2347 * @param $str \string Encoded options to import
2350 function decodeOptions( $str ) {
2354 $this->mOptionsLoaded
= true;
2355 $this->mOptionOverrides
= array();
2357 $this->mOptions
= array();
2358 $a = explode( "\n", $str );
2359 foreach ( $a as $s ) {
2361 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2362 $this->mOptions
[$m[1]] = $m[2];
2363 $this->mOptionOverrides
[$m[1]] = $m[2];
2369 * Set a cookie on the user's client. Wrapper for
2370 * WebResponse::setCookie
2371 * @param $name \string Name of the cookie to set
2372 * @param $value \string Value to set
2373 * @param $exp \int Expiration time, as a UNIX time value;
2374 * if 0 or not specified, use the default $wgCookieExpiration
2376 protected function setCookie( $name, $value, $exp = 0 ) {
2378 $wgRequest->response()->setcookie( $name, $value, $exp );
2382 * Clear a cookie on the user's client
2383 * @param $name \string Name of the cookie to clear
2385 protected function clearCookie( $name ) {
2386 $this->setCookie( $name, '', time() - 86400 );
2390 * Set the default cookies for this session on the user's client.
2392 function setCookies() {
2394 if ( 0 == $this->mId
) return;
2396 'wsUserID' => $this->mId
,
2397 'wsToken' => $this->mToken
,
2398 'wsUserName' => $this->getName()
2401 'UserID' => $this->mId
,
2402 'UserName' => $this->getName(),
2404 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2405 $cookies['Token'] = $this->mToken
;
2407 $cookies['Token'] = false;
2410 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2411 #check for null, since the hook could cause a null value
2412 if ( !is_null( $session ) && isset( $_SESSION ) ){
2413 $_SESSION = $session +
$_SESSION;
2415 foreach ( $cookies as $name => $value ) {
2416 if ( $value === false ) {
2417 $this->clearCookie( $name );
2419 $this->setCookie( $name, $value );
2425 * Log this user out.
2428 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2434 * Clear the user's cookies and session, and reset the instance cache.
2438 function doLogout() {
2439 $this->clearInstanceCache( 'defaults' );
2441 $_SESSION['wsUserID'] = 0;
2443 $this->clearCookie( 'UserID' );
2444 $this->clearCookie( 'Token' );
2446 # Remember when user logged out, to prevent seeing cached pages
2447 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2451 * Save this user's settings into the database.
2452 * @todo Only rarely do all these fields need to be set!
2454 function saveSettings() {
2456 if ( wfReadOnly() ) { return; }
2457 if ( 0 == $this->mId
) { return; }
2459 $this->mTouched
= self
::newTouchedTimestamp();
2461 $dbw = wfGetDB( DB_MASTER
);
2462 $dbw->update( 'user',
2464 'user_name' => $this->mName
,
2465 'user_password' => $this->mPassword
,
2466 'user_newpassword' => $this->mNewpassword
,
2467 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2468 'user_real_name' => $this->mRealName
,
2469 'user_email' => $this->mEmail
,
2470 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2471 'user_options' => '',
2472 'user_touched' => $dbw->timestamp( $this->mTouched
),
2473 'user_token' => $this->mToken
,
2474 'user_email_token' => $this->mEmailToken
,
2475 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2476 ), array( /* WHERE */
2477 'user_id' => $this->mId
2481 $this->saveOptions();
2483 wfRunHooks( 'UserSaveSettings', array( $this ) );
2484 $this->clearSharedCache();
2485 $this->getUserPage()->invalidateCache();
2489 * If only this user's username is known, and it exists, return the user ID.
2491 function idForName() {
2492 $s = trim( $this->getName() );
2493 if ( $s === '' ) return 0;
2495 $dbr = wfGetDB( DB_SLAVE
);
2496 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2497 if ( $id === false ) {
2504 * Add a user to the database, return the user object
2506 * @param $name \string Username to add
2507 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2508 * - password The user's password. Password logins will be disabled if this is omitted.
2509 * - newpassword A temporary password mailed to the user
2510 * - email The user's email address
2511 * - email_authenticated The email authentication timestamp
2512 * - real_name The user's real name
2513 * - options An associative array of non-default options
2514 * - token Random authentication token. Do not set.
2515 * - registration Registration timestamp. Do not set.
2517 * @return \type{User} A new User object, or null if the username already exists
2519 static function createNew( $name, $params = array() ) {
2522 if ( isset( $params['options'] ) ) {
2523 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2524 unset( $params['options'] );
2526 $dbw = wfGetDB( DB_MASTER
);
2527 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2529 'user_id' => $seqVal,
2530 'user_name' => $name,
2531 'user_password' => $user->mPassword
,
2532 'user_newpassword' => $user->mNewpassword
,
2533 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2534 'user_email' => $user->mEmail
,
2535 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2536 'user_real_name' => $user->mRealName
,
2537 'user_options' => '',
2538 'user_token' => $user->mToken
,
2539 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2540 'user_editcount' => 0,
2542 foreach ( $params as $name => $value ) {
2543 $fields["user_$name"] = $value;
2545 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2546 if ( $dbw->affectedRows() ) {
2547 $newUser = User
::newFromId( $dbw->insertId() );
2555 * Add this existing user object to the database
2557 function addToDatabase() {
2559 $dbw = wfGetDB( DB_MASTER
);
2560 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2561 $dbw->insert( 'user',
2563 'user_id' => $seqVal,
2564 'user_name' => $this->mName
,
2565 'user_password' => $this->mPassword
,
2566 'user_newpassword' => $this->mNewpassword
,
2567 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2568 'user_email' => $this->mEmail
,
2569 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2570 'user_real_name' => $this->mRealName
,
2571 'user_options' => '',
2572 'user_token' => $this->mToken
,
2573 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2574 'user_editcount' => 0,
2577 $this->mId
= $dbw->insertId();
2579 // Clear instance cache other than user table data, which is already accurate
2580 $this->clearInstanceCache();
2582 $this->saveOptions();
2586 * If this (non-anonymous) user is blocked, block any IP address
2587 * they've successfully logged in from.
2589 function spreadBlock() {
2590 wfDebug( __METHOD__
. "()\n" );
2592 if ( $this->mId
== 0 ) {
2596 $userblock = Block
::newFromDB( '', $this->mId
);
2597 if ( !$userblock ) {
2601 $userblock->doAutoblock( wfGetIP() );
2605 * Generate a string which will be different for any combination of
2606 * user options which would produce different parser output.
2607 * This will be used as part of the hash key for the parser cache,
2608 * so users will the same options can share the same cached data
2611 * Extensions which require it should install 'PageRenderingHash' hook,
2612 * which will give them a chance to modify this key based on their own
2615 * @return \string Page rendering hash
2617 function getPageRenderingHash() {
2618 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2620 return $this->mHash
;
2623 // stubthreshold is only included below for completeness,
2624 // it will always be 0 when this function is called by parsercache.
2626 $confstr = $this->getOption( 'math' );
2627 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2628 if ( $wgUseDynamicDates ) {
2629 $confstr .= '!' . $this->getDatePreference();
2631 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2632 $confstr .= '!' . $wgLang->getCode();
2633 $confstr .= '!' . $this->getOption( 'thumbsize' );
2634 // add in language specific options, if any
2635 $extra = $wgContLang->getExtraHashOptions();
2638 $confstr .= $wgRenderHashAppend;
2640 // Give a chance for extensions to modify the hash, if they have
2641 // extra options or other effects on the parser cache.
2642 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2644 // Make it a valid memcached key fragment
2645 $confstr = str_replace( ' ', '_', $confstr );
2646 $this->mHash
= $confstr;
2651 * Get whether the user is explicitly blocked from account creation.
2652 * @return \bool True if blocked
2654 function isBlockedFromCreateAccount() {
2655 $this->getBlockedStatus();
2656 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2660 * Get whether the user is blocked from using Special:Emailuser.
2661 * @return \bool True if blocked
2663 function isBlockedFromEmailuser() {
2664 $this->getBlockedStatus();
2665 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2669 * Get whether the user is allowed to create an account.
2670 * @return \bool True if allowed
2672 function isAllowedToCreateAccount() {
2673 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2679 function setLoaded( $loaded ) {
2680 wfDeprecated( __METHOD__
);
2684 * Get this user's personal page title.
2686 * @return \type{Title} User's personal page title
2688 function getUserPage() {
2689 return Title
::makeTitle( NS_USER
, $this->getName() );
2693 * Get this user's talk page title.
2695 * @return \type{Title} User's talk page title
2697 function getTalkPage() {
2698 $title = $this->getUserPage();
2699 return $title->getTalkPage();
2703 * Get the maximum valid user ID.
2704 * @return \int User ID
2707 function getMaxID() {
2708 static $res; // cache
2710 if ( isset( $res ) )
2713 $dbr = wfGetDB( DB_SLAVE
);
2714 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2719 * Determine whether the user is a newbie. Newbies are either
2720 * anonymous IPs, or the most recently created accounts.
2721 * @return \bool True if the user is a newbie
2723 function isNewbie() {
2724 return !$this->isAllowed( 'autoconfirmed' );
2728 * Check to see if the given clear-text password is one of the accepted passwords
2729 * @param $password \string user password.
2730 * @return \bool True if the given password is correct, otherwise False.
2732 function checkPassword( $password ) {
2736 // Even though we stop people from creating passwords that
2737 // are shorter than this, doesn't mean people wont be able
2738 // to. Certain authentication plugins do NOT want to save
2739 // domain passwords in a mysql database, so we should
2740 // check this (incase $wgAuth->strict() is false).
2741 if( !$this->isValidPassword( $password ) ) {
2745 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2747 } elseif( $wgAuth->strict() ) {
2748 /* Auth plugin doesn't allow local authentication */
2750 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2751 /* Auth plugin doesn't allow local authentication for this user name */
2754 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2756 } elseif ( function_exists( 'iconv' ) ) {
2757 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2758 # Check for this with iconv
2759 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2760 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2768 * Check if the given clear-text password matches the temporary password
2769 * sent by e-mail for password reset operations.
2770 * @return \bool True if matches, false otherwise
2772 function checkTemporaryPassword( $plaintext ) {
2773 global $wgNewPasswordExpiry;
2774 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2776 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2777 return ( time() < $expiry );
2784 * Initialize (if necessary) and return a session token value
2785 * which can be used in edit forms to show that the user's
2786 * login credentials aren't being hijacked with a foreign form
2789 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2790 * @return \string The new edit token
2792 function editToken( $salt = '' ) {
2793 if ( $this->isAnon() ) {
2794 return EDIT_TOKEN_SUFFIX
;
2796 if( !isset( $_SESSION['wsEditToken'] ) ) {
2797 $token = $this->generateToken();
2798 $_SESSION['wsEditToken'] = $token;
2800 $token = $_SESSION['wsEditToken'];
2802 if( is_array( $salt ) ) {
2803 $salt = implode( '|', $salt );
2805 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2810 * Generate a looking random token for various uses.
2812 * @param $salt \string Optional salt value
2813 * @return \string The new random token
2815 function generateToken( $salt = '' ) {
2816 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2817 return md5( $token . $salt );
2821 * Check given value against the token value stored in the session.
2822 * A match should confirm that the form was submitted from the
2823 * user's own login session, not a form submission from a third-party
2826 * @param $val \string Input value to compare
2827 * @param $salt \string Optional function-specific data for hashing
2828 * @return \bool Whether the token matches
2830 function matchEditToken( $val, $salt = '' ) {
2831 $sessionToken = $this->editToken( $salt );
2832 if ( $val != $sessionToken ) {
2833 wfDebug( "User::matchEditToken: broken session data\n" );
2835 return $val == $sessionToken;
2839 * Check given value against the token value stored in the session,
2840 * ignoring the suffix.
2842 * @param $val \string Input value to compare
2843 * @param $salt \string Optional function-specific data for hashing
2844 * @return \bool Whether the token matches
2846 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2847 $sessionToken = $this->editToken( $salt );
2848 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2852 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2853 * mail to the user's given address.
2855 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2857 function sendConfirmationMail() {
2859 $expiration = null; // gets passed-by-ref and defined in next line.
2860 $token = $this->confirmationToken( $expiration );
2861 $url = $this->confirmationTokenUrl( $token );
2862 $invalidateURL = $this->invalidationTokenUrl( $token );
2863 $this->saveSettings();
2865 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2866 wfMsg( 'confirmemail_body',
2870 $wgLang->timeanddate( $expiration, false ),
2872 $wgLang->date( $expiration, false ),
2873 $wgLang->time( $expiration, false ) ) );
2877 * Send an e-mail to this user's account. Does not check for
2878 * confirmed status or validity.
2880 * @param $subject \string Message subject
2881 * @param $body \string Message body
2882 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2883 * @param $replyto \string Reply-To address
2884 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2886 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2887 if( is_null( $from ) ) {
2888 global $wgPasswordSender;
2889 $from = $wgPasswordSender;
2892 $to = new MailAddress( $this );
2893 $sender = new MailAddress( $from );
2894 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2898 * Generate, store, and return a new e-mail confirmation code.
2899 * A hash (unsalted, since it's used as a key) is stored.
2901 * @note Call saveSettings() after calling this function to commit
2902 * this change to the database.
2904 * @param[out] &$expiration \mixed Accepts the expiration time
2905 * @return \string New token
2908 function confirmationToken( &$expiration ) {
2910 $expires = $now +
7 * 24 * 60 * 60;
2911 $expiration = wfTimestamp( TS_MW
, $expires );
2912 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2913 $hash = md5( $token );
2915 $this->mEmailToken
= $hash;
2916 $this->mEmailTokenExpires
= $expiration;
2921 * Return a URL the user can use to confirm their email address.
2922 * @param $token \string Accepts the email confirmation token
2923 * @return \string New token URL
2926 function confirmationTokenUrl( $token ) {
2927 return $this->getTokenUrl( 'ConfirmEmail', $token );
2931 * Return a URL the user can use to invalidate their email address.
2932 * @param $token \string Accepts the email confirmation token
2933 * @return \string New token URL
2936 function invalidationTokenUrl( $token ) {
2937 return $this->getTokenUrl( 'Invalidateemail', $token );
2941 * Internal function to format the e-mail validation/invalidation URLs.
2942 * This uses $wgArticlePath directly as a quickie hack to use the
2943 * hardcoded English names of the Special: pages, for ASCII safety.
2945 * @note Since these URLs get dropped directly into emails, using the
2946 * short English names avoids insanely long URL-encoded links, which
2947 * also sometimes can get corrupted in some browsers/mailers
2948 * (bug 6957 with Gmail and Internet Explorer).
2950 * @param $page \string Special page
2951 * @param $token \string Token
2952 * @return \string Formatted URL
2954 protected function getTokenUrl( $page, $token ) {
2955 global $wgArticlePath;
2959 "Special:$page/$token",
2964 * Mark the e-mail address confirmed.
2966 * @note Call saveSettings() after calling this function to commit the change.
2968 function confirmEmail() {
2969 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2970 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
2975 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2976 * address if it was already confirmed.
2978 * @note Call saveSettings() after calling this function to commit the change.
2980 function invalidateEmail() {
2982 $this->mEmailToken
= null;
2983 $this->mEmailTokenExpires
= null;
2984 $this->setEmailAuthenticationTimestamp( null );
2985 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
2990 * Set the e-mail authentication timestamp.
2991 * @param $timestamp \string TS_MW timestamp
2993 function setEmailAuthenticationTimestamp( $timestamp ) {
2995 $this->mEmailAuthenticated
= $timestamp;
2996 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3000 * Is this user allowed to send e-mails within limits of current
3001 * site configuration?
3002 * @return \bool True if allowed
3004 function canSendEmail() {
3005 global $wgEnableEmail, $wgEnableUserEmail, $wgUser;
3006 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$wgUser->isAllowed( 'sendemail' ) ) {
3009 $canSend = $this->isEmailConfirmed();
3010 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3015 * Is this user allowed to receive e-mails within limits of current
3016 * site configuration?
3017 * @return \bool True if allowed
3019 function canReceiveEmail() {
3020 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3024 * Is this user's e-mail address valid-looking and confirmed within
3025 * limits of the current site configuration?
3027 * @note If $wgEmailAuthentication is on, this may require the user to have
3028 * confirmed their address by returning a code or using a password
3029 * sent to the address from the wiki.
3031 * @return \bool True if confirmed
3033 function isEmailConfirmed() {
3034 global $wgEmailAuthentication;
3037 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3038 if( $this->isAnon() )
3040 if( !self
::isValidEmailAddr( $this->mEmail
) )
3042 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3051 * Check whether there is an outstanding request for e-mail confirmation.
3052 * @return \bool True if pending
3054 function isEmailConfirmationPending() {
3055 global $wgEmailAuthentication;
3056 return $wgEmailAuthentication &&
3057 !$this->isEmailConfirmed() &&
3058 $this->mEmailToken
&&
3059 $this->mEmailTokenExpires
> wfTimestamp();
3063 * Get the timestamp of account creation.
3065 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3066 * non-existent/anonymous user accounts.
3068 public function getRegistration() {
3069 return $this->getId() > 0
3070 ?
$this->mRegistration
3075 * Get the timestamp of the first edit
3077 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3078 * non-existent/anonymous user accounts.
3080 public function getFirstEditTimestamp() {
3081 if( $this->getId() == 0 ) return false; // anons
3082 $dbr = wfGetDB( DB_SLAVE
);
3083 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3084 array( 'rev_user' => $this->getId() ),
3086 array( 'ORDER BY' => 'rev_timestamp ASC' )
3088 if( !$time ) return false; // no edits
3089 return wfTimestamp( TS_MW
, $time );
3093 * Get the permissions associated with a given list of groups
3095 * @param $groups \type{\arrayof{\string}} List of internal group names
3096 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3098 static function getGroupPermissions( $groups ) {
3099 global $wgGroupPermissions, $wgRevokePermissions;
3101 // grant every granted permission first
3102 foreach( $groups as $group ) {
3103 if( isset( $wgGroupPermissions[$group] ) ) {
3104 $rights = array_merge( $rights,
3105 // array_filter removes empty items
3106 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3109 // now revoke the revoked permissions
3110 foreach( $groups as $group ) {
3111 if( isset( $wgRevokePermissions[$group] ) ) {
3112 $rights = array_diff( $rights,
3113 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3116 return array_unique( $rights );
3120 * Get all the groups who have a given permission
3122 * @param $role \string Role to check
3123 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3125 static function getGroupsWithPermission( $role ) {
3126 global $wgGroupPermissions;
3127 $allowedGroups = array();
3128 foreach ( $wgGroupPermissions as $group => $rights ) {
3129 if ( isset( $rights[$role] ) && $rights[$role] ) {
3130 $allowedGroups[] = $group;
3133 return $allowedGroups;
3137 * Get the localized descriptive name for a group, if it exists
3139 * @param $group \string Internal group name
3140 * @return \string Localized descriptive group name
3142 static function getGroupName( $group ) {
3143 global $wgMessageCache;
3144 $wgMessageCache->loadAllMessages();
3145 $key = "group-$group";
3146 $name = wfMsg( $key );
3147 return $name == '' ||
wfEmptyMsg( $key, $name )
3153 * Get the localized descriptive name for a member of a group, if it exists
3155 * @param $group \string Internal group name
3156 * @return \string Localized name for group member
3158 static function getGroupMember( $group ) {
3159 global $wgMessageCache;
3160 $wgMessageCache->loadAllMessages();
3161 $key = "group-$group-member";
3162 $name = wfMsg( $key );
3163 return $name == '' ||
wfEmptyMsg( $key, $name )
3169 * Return the set of defined explicit groups.
3170 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3171 * are not included, as they are defined automatically, not in the database.
3172 * @return \type{\arrayof{\string}} Array of internal group names
3174 static function getAllGroups() {
3175 global $wgGroupPermissions, $wgRevokePermissions;
3177 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3178 self
::getImplicitGroups()
3183 * Get a list of all available permissions.
3184 * @return \type{\arrayof{\string}} Array of permission names
3186 static function getAllRights() {
3187 if ( self
::$mAllRights === false ) {
3188 global $wgAvailableRights;
3189 if ( count( $wgAvailableRights ) ) {
3190 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3192 self
::$mAllRights = self
::$mCoreRights;
3194 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3196 return self
::$mAllRights;
3200 * Get a list of implicit groups
3201 * @return \type{\arrayof{\string}} Array of internal group names
3203 public static function getImplicitGroups() {
3204 global $wgImplicitGroups;
3205 $groups = $wgImplicitGroups;
3206 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3211 * Get the title of a page describing a particular group
3213 * @param $group \string Internal group name
3214 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3216 static function getGroupPage( $group ) {
3217 global $wgMessageCache;
3218 $wgMessageCache->loadAllMessages();
3219 $page = wfMsgForContent( 'grouppage-' . $group );
3220 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3221 $title = Title
::newFromText( $page );
3222 if( is_object( $title ) )
3229 * Create a link to the group in HTML, if available;
3230 * else return the group name.
3232 * @param $group \string Internal name of the group
3233 * @param $text \string The text of the link
3234 * @return \string HTML link to the group
3236 static function makeGroupLinkHTML( $group, $text = '' ) {
3238 $text = self
::getGroupName( $group );
3240 $title = self
::getGroupPage( $group );
3243 $sk = $wgUser->getSkin();
3244 return $sk->link( $title, htmlspecialchars( $text ) );
3251 * Create a link to the group in Wikitext, if available;
3252 * else return the group name.
3254 * @param $group \string Internal name of the group
3255 * @param $text \string The text of the link
3256 * @return \string Wikilink to the group
3258 static function makeGroupLinkWiki( $group, $text = '' ) {
3260 $text = self
::getGroupName( $group );
3262 $title = self
::getGroupPage( $group );
3264 $page = $title->getPrefixedText();
3265 return "[[$page|$text]]";
3272 * Returns an array of the groups that a particular group can add/remove.
3274 * @param $group String: the group to check for whether it can add/remove
3275 * @return Array array( 'add' => array( addablegroups ),
3276 * 'remove' => array( removablegroups ),
3277 * 'add-self' => array( addablegroups to self),
3278 * 'remove-self' => array( removable groups from self) )
3280 static function changeableByGroup( $group ) {
3281 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3283 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3284 if( empty( $wgAddGroups[$group] ) ) {
3285 // Don't add anything to $groups
3286 } elseif( $wgAddGroups[$group] === true ) {
3287 // You get everything
3288 $groups['add'] = self
::getAllGroups();
3289 } elseif( is_array( $wgAddGroups[$group] ) ) {
3290 $groups['add'] = $wgAddGroups[$group];
3293 // Same thing for remove
3294 if( empty( $wgRemoveGroups[$group] ) ) {
3295 } elseif( $wgRemoveGroups[$group] === true ) {
3296 $groups['remove'] = self
::getAllGroups();
3297 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3298 $groups['remove'] = $wgRemoveGroups[$group];
3301 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3302 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3303 foreach( $wgGroupsAddToSelf as $key => $value ) {
3304 if( is_int( $key ) ) {
3305 $wgGroupsAddToSelf['user'][] = $value;
3310 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3311 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3312 if( is_int( $key ) ) {
3313 $wgGroupsRemoveFromSelf['user'][] = $value;
3318 // Now figure out what groups the user can add to him/herself
3319 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3320 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3321 // No idea WHY this would be used, but it's there
3322 $groups['add-self'] = User
::getAllGroups();
3323 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3324 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3327 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3328 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3329 $groups['remove-self'] = User
::getAllGroups();
3330 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3331 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3338 * Returns an array of groups that this user can add and remove
3339 * @return Array array( 'add' => array( addablegroups ),
3340 * 'remove' => array( removablegroups ),
3341 * 'add-self' => array( addablegroups to self),
3342 * 'remove-self' => array( removable groups from self) )
3344 function changeableGroups() {
3345 if( $this->isAllowed( 'userrights' ) ) {
3346 // This group gives the right to modify everything (reverse-
3347 // compatibility with old "userrights lets you change
3349 // Using array_merge to make the groups reindexed
3350 $all = array_merge( User
::getAllGroups() );
3354 'add-self' => array(),
3355 'remove-self' => array()
3359 // Okay, it's not so simple, we will have to go through the arrays
3362 'remove' => array(),
3363 'add-self' => array(),
3364 'remove-self' => array()
3366 $addergroups = $this->getEffectiveGroups();
3368 foreach( $addergroups as $addergroup ) {
3369 $groups = array_merge_recursive(
3370 $groups, $this->changeableByGroup( $addergroup )
3372 $groups['add'] = array_unique( $groups['add'] );
3373 $groups['remove'] = array_unique( $groups['remove'] );
3374 $groups['add-self'] = array_unique( $groups['add-self'] );
3375 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3381 * Increment the user's edit-count field.
3382 * Will have no effect for anonymous users.
3384 function incEditCount() {
3385 if( !$this->isAnon() ) {
3386 $dbw = wfGetDB( DB_MASTER
);
3387 $dbw->update( 'user',
3388 array( 'user_editcount=user_editcount+1' ),
3389 array( 'user_id' => $this->getId() ),
3392 // Lazy initialization check...
3393 if( $dbw->affectedRows() == 0 ) {
3394 // Pull from a slave to be less cruel to servers
3395 // Accuracy isn't the point anyway here
3396 $dbr = wfGetDB( DB_SLAVE
);
3397 $count = $dbr->selectField( 'revision',
3399 array( 'rev_user' => $this->getId() ),
3402 // Now here's a goddamn hack...
3403 if( $dbr !== $dbw ) {
3404 // If we actually have a slave server, the count is
3405 // at least one behind because the current transaction
3406 // has not been committed and replicated.
3409 // But if DB_SLAVE is selecting the master, then the
3410 // count we just read includes the revision that was
3411 // just added in the working transaction.
3414 $dbw->update( 'user',
3415 array( 'user_editcount' => $count ),
3416 array( 'user_id' => $this->getId() ),
3420 // edit count in user cache too
3421 $this->invalidateCache();
3425 * Get the description of a given right
3427 * @param $right \string Right to query
3428 * @return \string Localized description of the right
3430 static function getRightDescription( $right ) {
3431 global $wgMessageCache;
3432 $wgMessageCache->loadAllMessages();
3433 $key = "right-$right";
3434 $name = wfMsg( $key );
3435 return $name == '' ||
wfEmptyMsg( $key, $name )
3441 * Make an old-style password hash
3443 * @param $password \string Plain-text password
3444 * @param $userId \string User ID
3445 * @return \string Password hash
3447 static function oldCrypt( $password, $userId ) {
3448 global $wgPasswordSalt;
3449 if ( $wgPasswordSalt ) {
3450 return md5( $userId . '-' . md5( $password ) );
3452 return md5( $password );
3457 * Make a new-style password hash
3459 * @param $password \string Plain-text password
3460 * @param $salt \string Optional salt, may be random or the user ID.
3461 * If unspecified or false, will generate one automatically
3462 * @return \string Password hash
3464 static function crypt( $password, $salt = false ) {
3465 global $wgPasswordSalt;
3468 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3472 if( $wgPasswordSalt ) {
3473 if ( $salt === false ) {
3474 $salt = substr( wfGenerateToken(), 0, 8 );
3476 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3478 return ':A:' . md5( $password );
3483 * Compare a password hash with a plain-text password. Requires the user
3484 * ID if there's a chance that the hash is an old-style hash.
3486 * @param $hash \string Password hash
3487 * @param $password \string Plain-text password to compare
3488 * @param $userId \string User ID for old-style password salt
3491 static function comparePasswords( $hash, $password, $userId = false ) {
3493 $type = substr( $hash, 0, 3 );
3496 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3500 if ( $type == ':A:' ) {
3502 return md5( $password ) === substr( $hash, 3 );
3503 } elseif ( $type == ':B:' ) {
3505 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3506 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3509 return self
::oldCrypt( $password, $userId ) === $hash;
3514 * Add a newuser log entry for this user
3515 * @param $byEmail Boolean: account made by email?
3517 public function addNewUserLogEntry( $byEmail = false ) {
3518 global $wgUser, $wgContLang, $wgNewUserLog;
3519 if( empty( $wgNewUserLog ) ) {
3520 return true; // disabled
3522 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3523 if( $this->getName() == $wgUser->getName() ) {
3527 $action = 'create2';
3529 ?
wfMsgForContent( 'newuserlog-byemail' )
3532 $log = new LogPage( 'newusers' );
3535 $this->getUserPage(),
3537 array( $this->getId() )
3543 * Add an autocreate newuser log entry for this user
3544 * Used by things like CentralAuth and perhaps other authplugins.
3546 public function addNewUserLogEntryAutoCreate() {
3547 global $wgNewUserLog;
3548 if( empty( $wgNewUserLog ) ) {
3549 return true; // disabled
3551 $log = new LogPage( 'newusers', false );
3552 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3556 protected function loadOptions() {
3558 if ( $this->mOptionsLoaded ||
!$this->getId() )
3561 $this->mOptions
= self
::getDefaultOptions();
3563 // Maybe load from the object
3564 if ( !is_null( $this->mOptionOverrides
) ) {
3565 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3566 foreach( $this->mOptionOverrides
as $key => $value ) {
3567 $this->mOptions
[$key] = $value;
3570 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3571 // Load from database
3572 $dbr = wfGetDB( DB_SLAVE
);
3574 $res = $dbr->select(
3577 array( 'up_user' => $this->getId() ),
3581 while( $row = $dbr->fetchObject( $res ) ) {
3582 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3583 $this->mOptions
[$row->up_property
] = $row->up_value
;
3587 $this->mOptionsLoaded
= true;
3589 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3592 protected function saveOptions() {
3593 global $wgAllowPrefChange;
3595 $extuser = ExternalUser
::newFromUser( $this );
3597 $this->loadOptions();
3598 $dbw = wfGetDB( DB_MASTER
);
3600 $insert_rows = array();
3602 $saveOptions = $this->mOptions
;
3604 // Allow hooks to abort, for instance to save to a global profile.
3605 // Reset options to default state before saving.
3606 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3609 foreach( $saveOptions as $key => $value ) {
3610 # Don't bother storing default values
3611 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3612 !( $value === false ||
is_null($value) ) ) ||
3613 $value != self
::getDefaultOption( $key ) ) {
3614 $insert_rows[] = array(
3615 'up_user' => $this->getId(),
3616 'up_property' => $key,
3617 'up_value' => $value,
3620 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3621 switch ( $wgAllowPrefChange[$key] ) {
3627 $extuser->setPref( $key, $value );
3633 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3634 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3639 * Provide an array of HTML 5 attributes to put on an input element
3640 * intended for the user to enter a new password. This may include
3641 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3643 * Do *not* use this when asking the user to enter his current password!
3644 * Regardless of configuration, users may have invalid passwords for whatever
3645 * reason (e.g., they were set before requirements were tightened up).
3646 * Only use it when asking for a new password, like on account creation or
3649 * Obviously, you still need to do server-side checking.
3651 * @return array Array of HTML attributes suitable for feeding to
3652 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3653 * That will potentially output invalid XHTML 1.0 Transitional, and will
3654 * get confused by the boolean attribute syntax used.)
3656 public static function passwordChangeInputAttribs() {
3657 global $wgMinimalPasswordLength;
3659 if ( $wgMinimalPasswordLength == 0 ) {
3663 # Note that the pattern requirement will always be satisfied if the
3664 # input is empty, so we need required in all cases.
3665 $ret = array( 'required' );
3667 # We can't actually do this right now, because Opera 9.6 will print out
3668 # the entered password visibly in its error message! When other
3669 # browsers add support for this attribute, or Opera fixes its support,
3670 # we can add support with a version check to avoid doing this on Opera
3671 # versions where it will be a problem. Reported to Opera as
3672 # DSK-262266, but they don't have a public bug tracker for us to follow.
3674 if ( $wgMinimalPasswordLength > 1 ) {
3675 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3676 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3677 $wgMinimalPasswordLength );