3 * Implements the User class for the %MediaWiki software.
8 * \int Number of characters in user_token field.
11 define( 'USER_TOKEN_LENGTH', 32 );
14 * \int Serialized record version.
17 define( 'MW_USER_VERSION', 8 );
20 * \string Some punctuation to prevent editing from broken text-mangling proxies.
23 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
26 * Thrown by User::setPassword() on error.
29 class PasswordError
extends MWException
{
34 * The User object encapsulates all of the user-specific settings (user_id,
35 * name, rights, password, email address, options, last login time). Client
36 * classes use the getXXX() functions to access these fields. These functions
37 * do all the work of determining whether the user is logged in,
38 * whether the requested option can be satisfied from cookies or
39 * whether a database query is needed. Most of the settings needed
40 * for rendering normal pages are set in the cookie to minimize use
46 * \type{\arrayof{\string}} A list of default user toggles, i.e., boolean user
47 * preferences that are displayed by Special:Preferences as checkboxes.
48 * This list can be extended via the UserToggles hook or by
49 * $wgContLang::getExtraUserToggles().
52 public static $mToggles = array(
62 'editsectiononrightclick',
74 'enotifwatchlistpages',
75 'enotifusertalkpages',
78 'shownumberswatching',
98 * \type{\arrayof{\string}} List of member variables which are saved to the
99 * shared cache (memcached). Any operation which changes the
100 * corresponding database fields must call a cache-clearing function.
103 static $mCacheVars = array(
114 'mEmailAuthenticated',
116 'mEmailTokenExpires',
121 // user_properties table
126 * \type{\arrayof{\string}} Core rights.
127 * Each of these should have a corresponding message of the form
131 static $mCoreRights = array(
158 'move-rootuserpages',
162 'override-export-depth',
182 'userrights-interwiki',
186 * \string Cached results of getAllRights()
188 static $mAllRights = false;
190 /** @name Cache variables */
192 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
193 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
194 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
198 * \bool Whether the cache variables have been loaded.
200 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
203 * \string Initialization data source if mDataLoaded==false. May be one of:
204 * - 'defaults' anonymous user initialised from class defaults
205 * - 'name' initialise from mName
206 * - 'id' initialise from mId
207 * - 'session' log in from cookies or session if possible
209 * Use the User::newFrom*() family of functions to set this.
213 /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
215 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
216 $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
217 $mLocked, $mHideName, $mOptions;
220 static $idCacheByName = array();
223 * Lightweight constructor for an anonymous user.
224 * Use the User::newFrom* factory functions for other kinds of users.
228 * @see newFromConfirmationCode()
229 * @see newFromSession()
233 $this->clearInstanceCache( 'defaults' );
237 * Load the user table data for this object from the source given by mFrom.
240 if ( $this->mDataLoaded
) {
243 wfProfileIn( __METHOD__
);
245 # Set it now to avoid infinite recursion in accessors
246 $this->mDataLoaded
= true;
248 switch ( $this->mFrom
) {
250 $this->loadDefaults();
253 $this->mId
= self
::idFromName( $this->mName
);
255 # Nonexistent user placeholder object
256 $this->loadDefaults( $this->mName
);
265 $this->loadFromSession();
266 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
269 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
271 wfProfileOut( __METHOD__
);
275 * Load user table data, given mId has already been set.
276 * @return \bool false if the ID does not exist, true otherwise
279 function loadFromId() {
281 if ( $this->mId
== 0 ) {
282 $this->loadDefaults();
287 $key = wfMemcKey( 'user', 'id', $this->mId
);
288 $data = $wgMemc->get( $key );
289 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
290 # Object is expired, load from DB
295 wfDebug( "Cache miss for user {$this->mId}\n" );
297 if ( !$this->loadFromDatabase() ) {
298 # Can't load from ID, user is anonymous
301 $this->saveToCache();
303 wfDebug( "Got user {$this->mId} from cache\n" );
305 foreach ( self
::$mCacheVars as $name ) {
306 $this->$name = $data[$name];
313 * Save user data to the shared cache
315 function saveToCache() {
318 $this->loadOptions();
319 if ( $this->isAnon() ) {
320 // Anonymous users are uncached
324 foreach ( self
::$mCacheVars as $name ) {
325 $data[$name] = $this->$name;
327 $data['mVersion'] = MW_USER_VERSION
;
328 $key = wfMemcKey( 'user', 'id', $this->mId
);
330 $wgMemc->set( $key, $data );
334 /** @name newFrom*() static factory methods */
338 * Static factory method for creation from username.
340 * This is slightly less efficient than newFromId(), so use newFromId() if
341 * you have both an ID and a name handy.
343 * @param $name \string Username, validated by Title::newFromText()
344 * @param $validate \mixed Validate username. Takes the same parameters as
345 * User::getCanonicalName(), except that true is accepted as an alias
346 * for 'valid', for BC.
348 * @return \type{User} The User object, or null if the username is invalid. If the
349 * username is not present in the database, the result will be a user object
350 * with a name, zero user ID and default settings.
352 static function newFromName( $name, $validate = 'valid' ) {
353 if ( $validate === true ) {
356 $name = self
::getCanonicalName( $name, $validate );
357 if ( WikiError
::isError( $name ) ) {
359 } elseif ( $name === false ) {
362 # Create unloaded user object
371 * Static factory method for creation from a given user ID.
373 * @param $id \int Valid user ID
374 * @return \type{User} The corresponding User object
376 static function newFromId( $id ) {
384 * Factory method to fetch whichever user has a given email confirmation code.
385 * This code is generated when an account is created or its e-mail address
388 * If the code is invalid or has expired, returns NULL.
390 * @param $code \string Confirmation code
391 * @return \type{User}
393 static function newFromConfirmationCode( $code ) {
394 $dbr = wfGetDB( DB_SLAVE
);
395 $id = $dbr->selectField( 'user', 'user_id', array(
396 'user_email_token' => md5( $code ),
397 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
399 if( $id !== false ) {
400 return User
::newFromId( $id );
407 * Create a new user object using data from session or cookies. If the
408 * login credentials are invalid, the result is an anonymous user.
410 * @return \type{User}
412 static function newFromSession() {
414 $user->mFrom
= 'session';
419 * Create a new user object from a user row.
420 * The row should have all fields from the user table in it.
421 * @param $row array A row from the user table
422 * @return \type{User}
424 static function newFromRow( $row ) {
426 $user->loadFromRow( $row );
434 * Get the username corresponding to a given user ID
435 * @param $id \int User ID
436 * @return \string The corresponding username
438 static function whoIs( $id ) {
439 $dbr = wfGetDB( DB_SLAVE
);
440 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
444 * Get the real name of a user given their user ID
446 * @param $id \int User ID
447 * @return \string The corresponding user's real name
449 static function whoIsReal( $id ) {
450 $dbr = wfGetDB( DB_SLAVE
);
451 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
455 * Get database id given a user name
456 * @param $name \string Username
457 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
459 static function idFromName( $name ) {
460 $nt = Title
::makeTitleSafe( NS_USER
, $name );
461 if( is_null( $nt ) ) {
466 if ( isset( self
::$idCacheByName[$name] ) ) {
467 return self
::$idCacheByName[$name];
470 $dbr = wfGetDB( DB_SLAVE
);
471 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
473 if ( $s === false ) {
476 $result = $s->user_id
;
479 self
::$idCacheByName[$name] = $result;
481 if ( count( self
::$idCacheByName ) > 1000 ) {
482 self
::$idCacheByName = array();
489 * Does the string match an anonymous IPv4 address?
491 * This function exists for username validation, in order to reject
492 * usernames which are similar in form to IP addresses. Strings such
493 * as 300.300.300.300 will return true because it looks like an IP
494 * address, despite not being strictly valid.
496 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
497 * address because the usemod software would "cloak" anonymous IP
498 * addresses like this, if we allowed accounts like this to be created
499 * new users could get the old edits of these anonymous users.
501 * @param $name \string String to match
502 * @return \bool True or false
504 static function isIP( $name ) {
505 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
509 * Is the input a valid username?
511 * Checks if the input is a valid username, we don't want an empty string,
512 * an IP address, anything that containins slashes (would mess up subpages),
513 * is longer than the maximum allowed username size or doesn't begin with
516 * @param $name \string String to match
517 * @return \bool True or false
519 static function isValidUserName( $name ) {
520 global $wgContLang, $wgMaxNameChars;
523 || User
::isIP( $name )
524 ||
strpos( $name, '/' ) !== false
525 ||
strlen( $name ) > $wgMaxNameChars
526 ||
$name != $wgContLang->ucfirst( $name ) ) {
527 wfDebugLog( 'username', __METHOD__
.
528 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
532 // Ensure that the name can't be misresolved as a different title,
533 // such as with extra namespace keys at the start.
534 $parsed = Title
::newFromText( $name );
535 if( is_null( $parsed )
536 ||
$parsed->getNamespace()
537 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
538 wfDebugLog( 'username', __METHOD__
.
539 ": '$name' invalid due to ambiguous prefixes" );
543 // Check an additional blacklist of troublemaker characters.
544 // Should these be merged into the title char list?
545 $unicodeBlacklist = '/[' .
546 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
547 '\x{00a0}' . # non-breaking space
548 '\x{2000}-\x{200f}' . # various whitespace
549 '\x{2028}-\x{202f}' . # breaks and control chars
550 '\x{3000}' . # ideographic space
551 '\x{e000}-\x{f8ff}' . # private use
553 if( preg_match( $unicodeBlacklist, $name ) ) {
554 wfDebugLog( 'username', __METHOD__
.
555 ": '$name' invalid due to blacklisted characters" );
563 * Usernames which fail to pass this function will be blocked
564 * from user login and new account registrations, but may be used
565 * internally by batch processes.
567 * If an account already exists in this form, login will be blocked
568 * by a failure to pass this function.
570 * @param $name \string String to match
571 * @return \bool True or false
573 static function isUsableName( $name ) {
574 global $wgReservedUsernames;
575 // Must be a valid username, obviously ;)
576 if ( !self
::isValidUserName( $name ) ) {
580 static $reservedUsernames = false;
581 if ( !$reservedUsernames ) {
582 $reservedUsernames = $wgReservedUsernames;
583 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
586 // Certain names may be reserved for batch processes.
587 foreach ( $reservedUsernames as $reserved ) {
588 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
589 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
591 if ( $reserved == $name ) {
599 * Usernames which fail to pass this function will be blocked
600 * from new account registrations, but may be used internally
601 * either by batch processes or by user accounts which have
602 * already been created.
604 * Additional character blacklisting may be added here
605 * rather than in isValidUserName() to avoid disrupting
608 * @param $name \string String to match
609 * @return \bool True or false
611 static function isCreatableName( $name ) {
612 global $wgInvalidUsernameCharacters;
614 self
::isUsableName( $name ) &&
616 // Registration-time character blacklisting...
617 !preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name );
621 * Is the input a valid password for this user?
623 * @param $password String Desired password
624 * @return bool True or false
626 function isValidPassword( $password ) {
627 global $wgMinimalPasswordLength, $wgContLang;
629 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
631 if( $result === false )
634 // Password needs to be long enough, and can't be the same as the username
635 return strlen( $password ) >= $wgMinimalPasswordLength
636 && $wgContLang->lc( $password ) !== $wgContLang->lc( $this->mName
);
640 * Given unvalidated password input, return error message on failure.
642 * @param $password String Desired password
643 * @return mixed: true on success, string of error message on failure
645 function getPasswordValidity( $password ) {
646 global $wgMinimalPasswordLength, $wgContLang;
648 if ( !$this->isValidPassword( $password ) ) {
649 if( strlen( $password ) < $wgMinimalPasswordLength ) {
650 return 'passwordtooshort';
651 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
652 return 'password-name-match';
660 * Does a string look like an e-mail address?
662 * There used to be a regular expression here, it got removed because it
663 * rejected valid addresses. Actually just check if there is '@' somewhere
664 * in the given address.
666 * @todo Check for RFC 2822 compilance (bug 959)
668 * @param $addr \string E-mail address
669 * @return \bool True or false
671 public static function isValidEmailAddr( $addr ) {
673 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
677 return strpos( $addr, '@' ) !== false;
681 * Given unvalidated user input, return a canonical username, or false if
682 * the username is invalid.
683 * @param $name \string User input
684 * @param $validate \types{\string,\bool} Type of validation to use:
685 * - false No validation
686 * - 'valid' Valid for batch processes
687 * - 'usable' Valid for batch processes and login
688 * - 'creatable' Valid for batch processes, login and account creation
690 static function getCanonicalName( $name, $validate = 'valid' ) {
691 # Maybe force usernames to capital
692 $name = Title
::capitalize( $name, NS_USER
);
694 # Reject names containing '#'; these will be cleaned up
695 # with title normalisation, but then it's too late to
697 if( strpos( $name, '#' ) !== false )
698 return new WikiError( 'usernamehasherror' );
700 # Clean up name according to title rules
701 $t = ( $validate === 'valid' ) ?
702 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
703 # Check for invalid titles
704 if( is_null( $t ) ) {
708 # Reject various classes of invalid names
709 $name = $t->getText();
711 $name = $wgAuth->getCanonicalName( $t->getText() );
713 switch ( $validate ) {
717 if ( !User
::isValidUserName( $name ) ) {
722 if ( !User
::isUsableName( $name ) ) {
727 if ( !User
::isCreatableName( $name ) ) {
732 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
738 * Count the number of edits of a user
739 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
741 * @param $uid \int User ID to check
742 * @return \int The user's edit count
744 static function edits( $uid ) {
745 wfProfileIn( __METHOD__
);
746 $dbr = wfGetDB( DB_SLAVE
);
747 // check if the user_editcount field has been initialized
748 $field = $dbr->selectField(
749 'user', 'user_editcount',
750 array( 'user_id' => $uid ),
754 if( $field === null ) { // it has not been initialized. do so.
755 $dbw = wfGetDB( DB_MASTER
);
756 $count = $dbr->selectField(
757 'revision', 'count(*)',
758 array( 'rev_user' => $uid ),
763 array( 'user_editcount' => $count ),
764 array( 'user_id' => $uid ),
770 wfProfileOut( __METHOD__
);
775 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
776 * @todo hash random numbers to improve security, like generateToken()
778 * @return \string New random password
780 static function randomPassword() {
781 global $wgMinimalPasswordLength;
782 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
783 $l = strlen( $pwchars ) - 1;
785 $pwlength = max( 7, $wgMinimalPasswordLength );
786 $digit = mt_rand( 0, $pwlength - 1 );
788 for ( $i = 0; $i < $pwlength; $i++
) {
789 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
795 * Set cached properties to default.
797 * @note This no longer clears uncached lazy-initialised properties;
798 * the constructor does that instead.
801 function loadDefaults( $name = false ) {
802 wfProfileIn( __METHOD__
);
804 global $wgCookiePrefix;
807 $this->mName
= $name;
808 $this->mRealName
= '';
809 $this->mPassword
= $this->mNewpassword
= '';
810 $this->mNewpassTime
= null;
812 $this->mOptionOverrides
= null;
813 $this->mOptionsLoaded
= false;
815 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
816 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
818 $this->mTouched
= '0'; # Allow any pages to be cached
821 $this->setToken(); # Random
822 $this->mEmailAuthenticated
= null;
823 $this->mEmailToken
= '';
824 $this->mEmailTokenExpires
= null;
825 $this->mRegistration
= wfTimestamp( TS_MW
);
826 $this->mGroups
= array();
828 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
830 wfProfileOut( __METHOD__
);
834 * @deprecated Use wfSetupSession().
836 function SetupSession() {
837 wfDeprecated( __METHOD__
);
842 * Load user data from the session or login cookie. If there are no valid
843 * credentials, initialises the user as an anonymous user.
844 * @return \bool True if the user is logged in, false otherwise.
846 private function loadFromSession() {
847 global $wgMemc, $wgCookiePrefix;
850 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
851 if ( $result !== null ) {
855 if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
856 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
857 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
858 $this->loadDefaults(); // Possible collision!
859 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
860 cookie user ID ($sId) don't match!" );
863 $_SESSION['wsUserID'] = $sId;
864 } else if ( isset( $_SESSION['wsUserID'] ) ) {
865 if ( $_SESSION['wsUserID'] != 0 ) {
866 $sId = $_SESSION['wsUserID'];
868 $this->loadDefaults();
872 $this->loadDefaults();
876 if ( isset( $_SESSION['wsUserName'] ) ) {
877 $sName = $_SESSION['wsUserName'];
878 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
879 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
880 $_SESSION['wsUserName'] = $sName;
882 $this->loadDefaults();
886 $passwordCorrect = FALSE;
888 if ( !$this->loadFromId() ) {
889 # Not a valid ID, loadFromId has switched the object to anon for us
893 if ( isset( $_SESSION['wsToken'] ) ) {
894 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
896 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
897 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
900 # No session or persistent login cookie
901 $this->loadDefaults();
905 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
906 $_SESSION['wsToken'] = $this->mToken
;
907 wfDebug( "Logged in from $from\n" );
910 # Invalid credentials
911 wfDebug( "Can't log in from $from, invalid credentials\n" );
912 $this->loadDefaults();
918 * Load user and user_group data from the database.
919 * $this::mId must be set, this is how the user is identified.
921 * @return \bool True if the user exists, false if the user is anonymous
924 function loadFromDatabase() {
926 $this->mId
= intval( $this->mId
);
928 /** Anonymous user */
930 $this->loadDefaults();
934 $dbr = wfGetDB( DB_MASTER
);
935 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
937 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
939 if ( $s !== false ) {
940 # Initialise user table data
941 $this->loadFromRow( $s );
942 $this->mGroups
= null; // deferred
943 $this->getEditCount(); // revalidation for nulls
948 $this->loadDefaults();
954 * Initialize this object from a row from the user table.
956 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
958 function loadFromRow( $row ) {
959 $this->mDataLoaded
= true;
961 if ( isset( $row->user_id
) ) {
962 $this->mId
= intval( $row->user_id
);
964 $this->mName
= $row->user_name
;
965 $this->mRealName
= $row->user_real_name
;
966 $this->mPassword
= $row->user_password
;
967 $this->mNewpassword
= $row->user_newpassword
;
968 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
969 $this->mEmail
= $row->user_email
;
970 $this->decodeOptions( $row->user_options
);
971 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
972 $this->mToken
= $row->user_token
;
973 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
974 $this->mEmailToken
= $row->user_email_token
;
975 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
976 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
977 $this->mEditCount
= $row->user_editcount
;
981 * Load the groups from the database if they aren't already loaded.
984 function loadGroups() {
985 if ( is_null( $this->mGroups
) ) {
986 $dbr = wfGetDB( DB_MASTER
);
987 $res = $dbr->select( 'user_groups',
989 array( 'ug_user' => $this->mId
),
991 $this->mGroups
= array();
992 while( $row = $dbr->fetchObject( $res ) ) {
993 $this->mGroups
[] = $row->ug_group
;
999 * Clear various cached data stored in this object.
1000 * @param $reloadFrom \string Reload user and user_groups table data from a
1001 * given source. May be "name", "id", "defaults", "session", or false for
1004 function clearInstanceCache( $reloadFrom = false ) {
1005 $this->mNewtalk
= -1;
1006 $this->mDatePreference
= null;
1007 $this->mBlockedby
= -1; # Unset
1008 $this->mHash
= false;
1009 $this->mSkin
= null;
1010 $this->mRights
= null;
1011 $this->mEffectiveGroups
= null;
1012 $this->mOptions
= null;
1014 if ( $reloadFrom ) {
1015 $this->mDataLoaded
= false;
1016 $this->mFrom
= $reloadFrom;
1021 * Combine the language default options with any site-specific options
1022 * and add the default language variants.
1024 * @return \type{\arrayof{\string}} Array of options
1026 static function getDefaultOptions() {
1027 global $wgNamespacesToBeSearchedDefault;
1029 * Site defaults will override the global/language defaults
1031 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1032 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1035 * default language setting
1037 $variant = $wgContLang->getPreferredVariant( false );
1038 $defOpt['variant'] = $variant;
1039 $defOpt['language'] = $variant;
1040 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1041 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1043 $defOpt['skin'] = $wgDefaultSkin;
1049 * Get a given default option value.
1051 * @param $opt \string Name of option to retrieve
1052 * @return \string Default option value
1054 public static function getDefaultOption( $opt ) {
1055 $defOpts = self
::getDefaultOptions();
1056 if( isset( $defOpts[$opt] ) ) {
1057 return $defOpts[$opt];
1064 * Get a list of user toggle names
1065 * @return \type{\arrayof{\string}} Array of user toggle names
1067 static function getToggles() {
1068 global $wgContLang, $wgUseRCPatrol;
1069 $extraToggles = array();
1070 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1071 if( $wgUseRCPatrol ) {
1072 $extraToggles[] = 'hidepatrolled';
1073 $extraToggles[] = 'newpageshidepatrolled';
1074 $extraToggles[] = 'watchlisthidepatrolled';
1076 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1081 * Get blocking information
1083 * @param $bFromSlave \bool Whether to check the slave database first. To
1084 * improve performance, non-critical checks are done
1085 * against slaves. Check when actually saving should be
1086 * done against master.
1088 function getBlockedStatus( $bFromSlave = true ) {
1089 global $wgEnableSorbs, $wgProxyWhitelist, $wgUser;
1091 if ( -1 != $this->mBlockedby
) {
1092 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1096 wfProfileIn( __METHOD__
);
1097 wfDebug( __METHOD__
.": checking...\n" );
1099 // Initialize data...
1100 // Otherwise something ends up stomping on $this->mBlockedby when
1101 // things get lazy-loaded later, causing false positive block hits
1102 // due to -1 !== 0. Probably session-related... Nothing should be
1103 // overwriting mBlockedby, surely?
1106 $this->mBlockedby
= 0;
1107 $this->mHideName
= 0;
1108 $this->mAllowUsertalk
= 0;
1110 # Check if we are looking at an IP or a logged-in user
1111 if ( $this->isIP( $this->getName() ) ) {
1112 $ip = $this->getName();
1114 # Check if we are looking at the current user
1115 # If we don't, and the user is logged in, we don't know about
1116 # his IP / autoblock status, so ignore autoblock of current user's IP
1117 if ( $this->getID() != $wgUser->getID() ) {
1120 # Get IP of current user
1125 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1126 # Exempt from all types of IP-block
1131 $this->mBlock
= new Block();
1132 $this->mBlock
->fromMaster( !$bFromSlave );
1133 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1134 wfDebug( __METHOD__
. ": Found block.\n" );
1135 $this->mBlockedby
= $this->mBlock
->mBy
;
1136 $this->mBlockreason
= $this->mBlock
->mReason
;
1137 $this->mHideName
= $this->mBlock
->mHideName
;
1138 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1139 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1140 $this->spreadBlock();
1143 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1144 // apply to users. Note that the existence of $this->mBlock is not used to
1145 // check for edit blocks, $this->mBlockedby is instead.
1149 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1151 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1152 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1153 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1157 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1158 if ( $this->inSorbsBlacklist( $ip ) ) {
1159 $this->mBlockedby
= wfMsg( 'sorbs' );
1160 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1166 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1168 wfProfileOut( __METHOD__
);
1172 * Whether the given IP is in the SORBS blacklist.
1174 * @param $ip \string IP to check
1175 * @return \bool True if blacklisted.
1177 function inSorbsBlacklist( $ip ) {
1178 global $wgEnableSorbs, $wgSorbsUrl;
1180 return $wgEnableSorbs &&
1181 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1185 * Whether the given IP is in a given DNS blacklist.
1187 * @param $ip \string IP to check
1188 * @param $base \string URL of the DNS blacklist
1189 * @return \bool True if blacklisted.
1191 function inDnsBlacklist( $ip, $base ) {
1192 wfProfileIn( __METHOD__
);
1196 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1197 if( IP
::isIPv4( $ip ) ) {
1199 $host = "$ip.$base";
1202 $ipList = gethostbynamel( $host );
1205 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1208 wfDebug( "Requested $host, not found in $base.\n" );
1212 wfProfileOut( __METHOD__
);
1217 * Is this user subject to rate limiting?
1219 * @return \bool True if rate limited
1221 public function isPingLimitable() {
1222 global $wgRateLimitsExcludedGroups;
1223 global $wgRateLimitsExcludedIPs;
1224 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1225 // Deprecated, but kept for backwards-compatibility config
1228 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1229 // No other good way currently to disable rate limits
1230 // for specific IPs. :P
1231 // But this is a crappy hack and should die.
1234 return !$this->isAllowed('noratelimit');
1238 * Primitive rate limits: enforce maximum actions per time period
1239 * to put a brake on flooding.
1241 * @note When using a shared cache like memcached, IP-address
1242 * last-hit counters will be shared across wikis.
1244 * @param $action \string Action to enforce; 'edit' if unspecified
1245 * @return \bool True if a rate limiter was tripped
1247 function pingLimiter( $action = 'edit' ) {
1248 # Call the 'PingLimiter' hook
1250 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1254 global $wgRateLimits;
1255 if( !isset( $wgRateLimits[$action] ) ) {
1259 # Some groups shouldn't trigger the ping limiter, ever
1260 if( !$this->isPingLimitable() )
1263 global $wgMemc, $wgRateLimitLog;
1264 wfProfileIn( __METHOD__
);
1266 $limits = $wgRateLimits[$action];
1268 $id = $this->getId();
1272 if( isset( $limits['anon'] ) && $id == 0 ) {
1273 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1276 if( isset( $limits['user'] ) && $id != 0 ) {
1277 $userLimit = $limits['user'];
1279 if( $this->isNewbie() ) {
1280 if( isset( $limits['newbie'] ) && $id != 0 ) {
1281 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1283 if( isset( $limits['ip'] ) ) {
1284 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1287 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1288 $subnet = $matches[1];
1289 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1292 // Check for group-specific permissions
1293 // If more than one group applies, use the group with the highest limit
1294 foreach ( $this->getGroups() as $group ) {
1295 if ( isset( $limits[$group] ) ) {
1296 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1297 $userLimit = $limits[$group];
1301 // Set the user limit key
1302 if ( $userLimit !== false ) {
1303 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1304 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1308 foreach( $keys as $key => $limit ) {
1309 list( $max, $period ) = $limit;
1310 $summary = "(limit $max in {$period}s)";
1311 $count = $wgMemc->get( $key );
1314 if( $count > $max ) {
1315 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1316 if( $wgRateLimitLog ) {
1317 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1321 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1323 $wgMemc->incr( $key );
1325 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1326 $wgMemc->set( $key, 1, intval( $period ) ); // first ping
1330 wfProfileOut( __METHOD__
);
1335 * Check if user is blocked
1337 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1338 * @return \bool True if blocked, false otherwise
1340 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1341 wfDebug( "User::isBlocked: enter\n" );
1342 $this->getBlockedStatus( $bFromSlave );
1343 return $this->mBlockedby
!== 0;
1347 * Check if user is blocked from editing a particular article
1349 * @param $title \string Title to check
1350 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1351 * @return \bool True if blocked, false otherwise
1353 function isBlockedFrom( $title, $bFromSlave = false ) {
1354 global $wgBlockAllowsUTEdit;
1355 wfProfileIn( __METHOD__
);
1356 wfDebug( __METHOD__
. ": enter\n" );
1358 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1359 $blocked = $this->isBlocked( $bFromSlave );
1360 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1361 # If a user's name is suppressed, they cannot make edits anywhere
1362 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1363 $title->getNamespace() == NS_USER_TALK
) {
1365 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1368 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1370 wfProfileOut( __METHOD__
);
1375 * If user is blocked, return the name of the user who placed the block
1376 * @return \string name of blocker
1378 function blockedBy() {
1379 $this->getBlockedStatus();
1380 return $this->mBlockedby
;
1384 * If user is blocked, return the specified reason for the block
1385 * @return \string Blocking reason
1387 function blockedFor() {
1388 $this->getBlockedStatus();
1389 return $this->mBlockreason
;
1393 * If user is blocked, return the ID for the block
1394 * @return \int Block ID
1396 function getBlockId() {
1397 $this->getBlockedStatus();
1398 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1402 * Check if user is blocked on all wikis.
1403 * Do not use for actual edit permission checks!
1404 * This is intented for quick UI checks.
1406 * @param $ip \type{\string} IP address, uses current client if none given
1407 * @return \type{\bool} True if blocked, false otherwise
1409 function isBlockedGlobally( $ip = '' ) {
1410 if( $this->mBlockedGlobally
!== null ) {
1411 return $this->mBlockedGlobally
;
1413 // User is already an IP?
1414 if( IP
::isIPAddress( $this->getName() ) ) {
1415 $ip = $this->getName();
1420 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1421 $this->mBlockedGlobally
= (bool)$blocked;
1422 return $this->mBlockedGlobally
;
1426 * Check if user account is locked
1428 * @return \type{\bool} True if locked, false otherwise
1430 function isLocked() {
1431 if( $this->mLocked
!== null ) {
1432 return $this->mLocked
;
1435 $authUser = $wgAuth->getUserInstance( $this );
1436 $this->mLocked
= (bool)$authUser->isLocked();
1437 return $this->mLocked
;
1441 * Check if user account is hidden
1443 * @return \type{\bool} True if hidden, false otherwise
1445 function isHidden() {
1446 if( $this->mHideName
!== null ) {
1447 return $this->mHideName
;
1449 $this->getBlockedStatus();
1450 if( !$this->mHideName
) {
1452 $authUser = $wgAuth->getUserInstance( $this );
1453 $this->mHideName
= (bool)$authUser->isHidden();
1455 return $this->mHideName
;
1459 * Get the user's ID.
1460 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1463 if( $this->mId
=== null and $this->mName
!== null
1464 and User
::isIP( $this->mName
) ) {
1465 // Special case, we know the user is anonymous
1467 } elseif( $this->mId
=== null ) {
1468 // Don't load if this was initialized from an ID
1475 * Set the user and reload all fields according to a given ID
1476 * @param $v \int User ID to reload
1478 function setId( $v ) {
1480 $this->clearInstanceCache( 'id' );
1484 * Get the user name, or the IP of an anonymous user
1485 * @return \string User's name or IP address
1487 function getName() {
1488 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1489 # Special case optimisation
1490 return $this->mName
;
1493 if ( $this->mName
=== false ) {
1495 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1497 return $this->mName
;
1502 * Set the user name.
1504 * This does not reload fields from the database according to the given
1505 * name. Rather, it is used to create a temporary "nonexistent user" for
1506 * later addition to the database. It can also be used to set the IP
1507 * address for an anonymous user to something other than the current
1510 * @note User::newFromName() has rougly the same function, when the named user
1512 * @param $str \string New user name to set
1514 function setName( $str ) {
1516 $this->mName
= $str;
1520 * Get the user's name escaped by underscores.
1521 * @return \string Username escaped by underscores.
1523 function getTitleKey() {
1524 return str_replace( ' ', '_', $this->getName() );
1528 * Check if the user has new messages.
1529 * @return \bool True if the user has new messages
1531 function getNewtalk() {
1534 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1535 if( $this->mNewtalk
=== -1 ) {
1536 $this->mNewtalk
= false; # reset talk page status
1538 # Check memcached separately for anons, who have no
1539 # entire User object stored in there.
1542 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1543 $newtalk = $wgMemc->get( $key );
1544 if( strval( $newtalk ) !== '' ) {
1545 $this->mNewtalk
= (bool)$newtalk;
1547 // Since we are caching this, make sure it is up to date by getting it
1549 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1550 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1553 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1557 return (bool)$this->mNewtalk
;
1561 * Return the talk page(s) this user has new messages on.
1562 * @return \type{\arrayof{\string}} Array of page URLs
1564 function getNewMessageLinks() {
1566 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1569 if( !$this->getNewtalk() )
1571 $up = $this->getUserPage();
1572 $utp = $up->getTalkPage();
1573 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1577 * Internal uncached check for new messages
1580 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1581 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1582 * @param $fromMaster \bool true to fetch from the master, false for a slave
1583 * @return \bool True if the user has new messages
1586 function checkNewtalk( $field, $id, $fromMaster = false ) {
1587 if ( $fromMaster ) {
1588 $db = wfGetDB( DB_MASTER
);
1590 $db = wfGetDB( DB_SLAVE
);
1592 $ok = $db->selectField( 'user_newtalk', $field,
1593 array( $field => $id ), __METHOD__
);
1594 return $ok !== false;
1598 * Add or update the new messages flag
1599 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1600 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1601 * @return \bool True if successful, false otherwise
1604 function updateNewtalk( $field, $id ) {
1605 $dbw = wfGetDB( DB_MASTER
);
1606 $dbw->insert( 'user_newtalk',
1607 array( $field => $id ),
1610 if ( $dbw->affectedRows() ) {
1611 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1614 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1620 * Clear the new messages flag for the given user
1621 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1622 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1623 * @return \bool True if successful, false otherwise
1626 function deleteNewtalk( $field, $id ) {
1627 $dbw = wfGetDB( DB_MASTER
);
1628 $dbw->delete( 'user_newtalk',
1629 array( $field => $id ),
1631 if ( $dbw->affectedRows() ) {
1632 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1635 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1641 * Update the 'You have new messages!' status.
1642 * @param $val \bool Whether the user has new messages
1644 function setNewtalk( $val ) {
1645 if( wfReadOnly() ) {
1650 $this->mNewtalk
= $val;
1652 if( $this->isAnon() ) {
1654 $id = $this->getName();
1657 $id = $this->getId();
1662 $changed = $this->updateNewtalk( $field, $id );
1664 $changed = $this->deleteNewtalk( $field, $id );
1667 if( $this->isAnon() ) {
1668 // Anons have a separate memcached space, since
1669 // user records aren't kept for them.
1670 $key = wfMemcKey( 'newtalk', 'ip', $id );
1671 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1674 $this->invalidateCache();
1679 * Generate a current or new-future timestamp to be stored in the
1680 * user_touched field when we update things.
1681 * @return \string Timestamp in TS_MW format
1683 private static function newTouchedTimestamp() {
1684 global $wgClockSkewFudge;
1685 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1689 * Clear user data from memcached.
1690 * Use after applying fun updates to the database; caller's
1691 * responsibility to update user_touched if appropriate.
1693 * Called implicitly from invalidateCache() and saveSettings().
1695 private function clearSharedCache() {
1699 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1704 * Immediately touch the user data cache for this account.
1705 * Updates user_touched field, and removes account data from memcached
1706 * for reload on the next hit.
1708 function invalidateCache() {
1709 if( wfReadOnly() ) {
1714 $this->mTouched
= self
::newTouchedTimestamp();
1716 $dbw = wfGetDB( DB_MASTER
);
1717 $dbw->update( 'user',
1718 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1719 array( 'user_id' => $this->mId
),
1722 $this->clearSharedCache();
1727 * Validate the cache for this account.
1728 * @param $timestamp \string A timestamp in TS_MW format
1730 function validateCache( $timestamp ) {
1732 return ( $timestamp >= $this->mTouched
);
1736 * Get the user touched timestamp
1738 function getTouched() {
1740 return $this->mTouched
;
1744 * Set the password and reset the random token.
1745 * Calls through to authentication plugin if necessary;
1746 * will have no effect if the auth plugin refuses to
1747 * pass the change through or if the legal password
1750 * As a special case, setting the password to null
1751 * wipes it, so the account cannot be logged in until
1752 * a new password is set, for instance via e-mail.
1754 * @param $str \string New password to set
1755 * @throws PasswordError on failure
1757 function setPassword( $str ) {
1760 if( $str !== null ) {
1761 if( !$wgAuth->allowPasswordChange() ) {
1762 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1765 if( !$this->isValidPassword( $str ) ) {
1766 global $wgMinimalPasswordLength;
1767 $valid = $this->getPasswordValidity( $str );
1768 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1769 $wgMinimalPasswordLength ) );
1773 if( !$wgAuth->setPassword( $this, $str ) ) {
1774 throw new PasswordError( wfMsg( 'externaldberror' ) );
1777 $this->setInternalPassword( $str );
1783 * Set the password and reset the random token unconditionally.
1785 * @param $str \string New password to set
1787 function setInternalPassword( $str ) {
1791 if( $str === null ) {
1792 // Save an invalid hash...
1793 $this->mPassword
= '';
1795 $this->mPassword
= self
::crypt( $str );
1797 $this->mNewpassword
= '';
1798 $this->mNewpassTime
= null;
1802 * Get the user's current token.
1803 * @return \string Token
1805 function getToken() {
1807 return $this->mToken
;
1811 * Set the random token (used for persistent authentication)
1812 * Called from loadDefaults() among other places.
1814 * @param $token \string If specified, set the token to this value
1817 function setToken( $token = false ) {
1818 global $wgSecretKey, $wgProxyKey;
1821 if ( $wgSecretKey ) {
1822 $key = $wgSecretKey;
1823 } elseif ( $wgProxyKey ) {
1828 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1830 $this->mToken
= $token;
1835 * Set the cookie password
1837 * @param $str \string New cookie password
1840 function setCookiePassword( $str ) {
1842 $this->mCookiePassword
= md5( $str );
1846 * Set the password for a password reminder or new account email
1848 * @param $str \string New password to set
1849 * @param $throttle \bool If true, reset the throttle timestamp to the present
1851 function setNewpassword( $str, $throttle = true ) {
1853 $this->mNewpassword
= self
::crypt( $str );
1855 $this->mNewpassTime
= wfTimestampNow();
1860 * Has password reminder email been sent within the last
1861 * $wgPasswordReminderResendTime hours?
1862 * @return \bool True or false
1864 function isPasswordReminderThrottled() {
1865 global $wgPasswordReminderResendTime;
1867 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1870 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1871 return time() < $expiry;
1875 * Get the user's e-mail address
1876 * @return \string User's email address
1878 function getEmail() {
1880 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1881 return $this->mEmail
;
1885 * Get the timestamp of the user's e-mail authentication
1886 * @return \string TS_MW timestamp
1888 function getEmailAuthenticationTimestamp() {
1890 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1891 return $this->mEmailAuthenticated
;
1895 * Set the user's e-mail address
1896 * @param $str \string New e-mail address
1898 function setEmail( $str ) {
1900 $this->mEmail
= $str;
1901 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1905 * Get the user's real name
1906 * @return \string User's real name
1908 function getRealName() {
1910 return $this->mRealName
;
1914 * Set the user's real name
1915 * @param $str \string New real name
1917 function setRealName( $str ) {
1919 $this->mRealName
= $str;
1923 * Get the user's current setting for a given option.
1925 * @param $oname \string The option to check
1926 * @param $defaultOverride \string A default value returned if the option does not exist
1927 * @return \string User's current value for the option
1928 * @see getBoolOption()
1929 * @see getIntOption()
1931 function getOption( $oname, $defaultOverride = null ) {
1932 $this->loadOptions();
1934 if ( is_null( $this->mOptions
) ) {
1935 if($defaultOverride != '') {
1936 return $defaultOverride;
1938 $this->mOptions
= User
::getDefaultOptions();
1941 if ( array_key_exists( $oname, $this->mOptions
) ) {
1942 return $this->mOptions
[$oname];
1944 return $defaultOverride;
1949 * Get the user's current setting for a given option, as a boolean value.
1951 * @param $oname \string The option to check
1952 * @return \bool User's current value for the option
1955 function getBoolOption( $oname ) {
1956 return (bool)$this->getOption( $oname );
1961 * Get the user's current setting for a given option, as a boolean value.
1963 * @param $oname \string The option to check
1964 * @param $defaultOverride \int A default value returned if the option does not exist
1965 * @return \int User's current value for the option
1968 function getIntOption( $oname, $defaultOverride=0 ) {
1969 $val = $this->getOption( $oname );
1971 $val = $defaultOverride;
1973 return intval( $val );
1977 * Set the given option for a user.
1979 * @param $oname \string The option to set
1980 * @param $val \mixed New value to set
1982 function setOption( $oname, $val ) {
1984 $this->loadOptions();
1986 if ( $oname == 'skin' ) {
1987 # Clear cached skin, so the new one displays immediately in Special:Preferences
1988 unset( $this->mSkin
);
1991 // Explicitly NULL values should refer to defaults
1992 global $wgDefaultUserOptions;
1993 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
1994 $val = $wgDefaultUserOptions[$oname];
1997 $this->mOptions
[$oname] = $val;
2001 * Reset all options to the site defaults
2003 function resetOptions() {
2004 $this->mOptions
= User
::getDefaultOptions();
2008 * Get the user's preferred date format.
2009 * @return \string User's preferred date format
2011 function getDatePreference() {
2012 // Important migration for old data rows
2013 if ( is_null( $this->mDatePreference
) ) {
2015 $value = $this->getOption( 'date' );
2016 $map = $wgLang->getDatePreferenceMigrationMap();
2017 if ( isset( $map[$value] ) ) {
2018 $value = $map[$value];
2020 $this->mDatePreference
= $value;
2022 return $this->mDatePreference
;
2026 * Get the permissions this user has.
2027 * @return \type{\arrayof{\string}} Array of permission names
2029 function getRights() {
2030 if ( is_null( $this->mRights
) ) {
2031 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2032 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2033 // Force reindexation of rights when a hook has unset one of them
2034 $this->mRights
= array_values( $this->mRights
);
2036 return $this->mRights
;
2040 * Get the list of explicit group memberships this user has.
2041 * The implicit * and user groups are not included.
2042 * @return \type{\arrayof{\string}} Array of internal group names
2044 function getGroups() {
2046 return $this->mGroups
;
2050 * Get the list of implicit group memberships this user has.
2051 * This includes all explicit groups, plus 'user' if logged in,
2052 * '*' for all accounts and autopromoted groups
2053 * @param $recache \bool Whether to avoid the cache
2054 * @return \type{\arrayof{\string}} Array of internal group names
2056 function getEffectiveGroups( $recache = false ) {
2057 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2058 wfProfileIn( __METHOD__
);
2059 $this->mEffectiveGroups
= $this->getGroups();
2060 $this->mEffectiveGroups
[] = '*';
2061 if( $this->getId() ) {
2062 $this->mEffectiveGroups
[] = 'user';
2064 $this->mEffectiveGroups
= array_unique( array_merge(
2065 $this->mEffectiveGroups
,
2066 Autopromote
::getAutopromoteGroups( $this )
2069 # Hook for additional groups
2070 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2072 wfProfileOut( __METHOD__
);
2074 return $this->mEffectiveGroups
;
2078 * Get the user's edit count.
2079 * @return \int User'e edit count
2081 function getEditCount() {
2082 if( $this->getId() ) {
2083 if ( !isset( $this->mEditCount
) ) {
2084 /* Populate the count, if it has not been populated yet */
2085 $this->mEditCount
= User
::edits( $this->mId
);
2087 return $this->mEditCount
;
2095 * Add the user to the given group.
2096 * This takes immediate effect.
2097 * @param $group \string Name of the group to add
2099 function addGroup( $group ) {
2100 $dbw = wfGetDB( DB_MASTER
);
2101 if( $this->getId() ) {
2102 $dbw->insert( 'user_groups',
2104 'ug_user' => $this->getID(),
2105 'ug_group' => $group,
2108 array( 'IGNORE' ) );
2111 $this->loadGroups();
2112 $this->mGroups
[] = $group;
2113 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2115 $this->invalidateCache();
2119 * Remove the user from the given group.
2120 * This takes immediate effect.
2121 * @param $group \string Name of the group to remove
2123 function removeGroup( $group ) {
2125 $dbw = wfGetDB( DB_MASTER
);
2126 $dbw->delete( 'user_groups',
2128 'ug_user' => $this->getID(),
2129 'ug_group' => $group,
2131 'User::removeGroup' );
2133 $this->loadGroups();
2134 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2135 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2137 $this->invalidateCache();
2141 * Get whether the user is logged in
2142 * @return \bool True or false
2144 function isLoggedIn() {
2145 return $this->getID() != 0;
2149 * Get whether the user is anonymous
2150 * @return \bool True or false
2153 return !$this->isLoggedIn();
2157 * Get whether the user is a bot
2158 * @return \bool True or false
2162 wfDeprecated( __METHOD__
);
2163 return $this->isAllowed( 'bot' );
2167 * Check if user is allowed to access a feature / make an action
2168 * @param $action \string action to be checked
2169 * @return \bool True if action is allowed, else false
2171 function isAllowed( $action = '' ) {
2172 if ( $action === '' )
2173 return true; // In the spirit of DWIM
2174 # Patrolling may not be enabled
2175 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2176 global $wgUseRCPatrol, $wgUseNPPatrol;
2177 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2180 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2181 # by misconfiguration: 0 == 'foo'
2182 return in_array( $action, $this->getRights(), true );
2186 * Check whether to enable recent changes patrol features for this user
2187 * @return \bool True or false
2189 public function useRCPatrol() {
2190 global $wgUseRCPatrol;
2191 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2195 * Check whether to enable new pages patrol features for this user
2196 * @return \bool True or false
2198 public function useNPPatrol() {
2199 global $wgUseRCPatrol, $wgUseNPPatrol;
2200 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2204 * Get the current skin, loading it if required, and setting a title
2205 * @param $t Title: the title to use in the skin
2206 * @return Skin The current skin
2207 * @todo FIXME : need to check the old failback system [AV]
2209 function &getSkin( $t = null ) {
2210 if ( !isset( $this->mSkin
) ) {
2211 wfProfileIn( __METHOD__
);
2213 global $wgHiddenPrefs;
2214 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2217 $userSkin = $this->getOption( 'skin' );
2218 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2220 # if we're not allowing users to override, then use the default
2221 global $wgDefaultSkin;
2222 $userSkin = $wgDefaultSkin;
2225 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2226 wfProfileOut( __METHOD__
);
2228 if( $t ||
!$this->mSkin
->getTitle() ) {
2231 $t = $wgOut->getTitle();
2233 $this->mSkin
->setTitle( $t );
2235 return $this->mSkin
;
2239 * Check the watched status of an article.
2240 * @param $title \type{Title} Title of the article to look at
2241 * @return \bool True if article is watched
2243 function isWatched( $title ) {
2244 $wl = WatchedItem
::fromUserTitle( $this, $title );
2245 return $wl->isWatched();
2250 * @param $title \type{Title} Title of the article to look at
2252 function addWatch( $title ) {
2253 $wl = WatchedItem
::fromUserTitle( $this, $title );
2255 $this->invalidateCache();
2259 * Stop watching an article.
2260 * @param $title \type{Title} Title of the article to look at
2262 function removeWatch( $title ) {
2263 $wl = WatchedItem
::fromUserTitle( $this, $title );
2265 $this->invalidateCache();
2269 * Clear the user's notification timestamp for the given title.
2270 * If e-notif e-mails are on, they will receive notification mails on
2271 * the next change of the page if it's watched etc.
2272 * @param $title \type{Title} Title of the article to look at
2274 function clearNotification( &$title ) {
2275 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2277 # Do nothing if the database is locked to writes
2278 if( wfReadOnly() ) {
2282 if( $title->getNamespace() == NS_USER_TALK
&&
2283 $title->getText() == $this->getName() ) {
2284 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2286 $this->setNewtalk( false );
2289 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2293 if( $this->isAnon() ) {
2294 // Nothing else to do...
2298 // Only update the timestamp if the page is being watched.
2299 // The query to find out if it is watched is cached both in memcached and per-invocation,
2300 // and when it does have to be executed, it can be on a slave
2301 // If this is the user's newtalk page, we always update the timestamp
2302 if( $title->getNamespace() == NS_USER_TALK
&&
2303 $title->getText() == $wgUser->getName() )
2306 } elseif ( $this->getId() == $wgUser->getId() ) {
2307 $watched = $title->userIsWatching();
2312 // If the page is watched by the user (or may be watched), update the timestamp on any
2313 // any matching rows
2315 $dbw = wfGetDB( DB_MASTER
);
2316 $dbw->update( 'watchlist',
2318 'wl_notificationtimestamp' => NULL
2319 ), array( /* WHERE */
2320 'wl_title' => $title->getDBkey(),
2321 'wl_namespace' => $title->getNamespace(),
2322 'wl_user' => $this->getID()
2329 * Resets all of the given user's page-change notification timestamps.
2330 * If e-notif e-mails are on, they will receive notification mails on
2331 * the next change of any watched page.
2333 * @param $currentUser \int User ID
2335 function clearAllNotifications( $currentUser ) {
2336 global $wgUseEnotif, $wgShowUpdatedMarker;
2337 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2338 $this->setNewtalk( false );
2341 if( $currentUser != 0 ) {
2342 $dbw = wfGetDB( DB_MASTER
);
2343 $dbw->update( 'watchlist',
2345 'wl_notificationtimestamp' => NULL
2346 ), array( /* WHERE */
2347 'wl_user' => $currentUser
2350 # We also need to clear here the "you have new message" notification for the own user_talk page
2351 # This is cleared one page view later in Article::viewUpdates();
2356 * Set this user's options from an encoded string
2357 * @param $str \string Encoded options to import
2360 function decodeOptions( $str ) {
2364 $this->mOptionsLoaded
= true;
2365 $this->mOptionOverrides
= array();
2367 $this->mOptions
= array();
2368 $a = explode( "\n", $str );
2369 foreach ( $a as $s ) {
2371 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2372 $this->mOptions
[$m[1]] = $m[2];
2373 $this->mOptionOverrides
[$m[1]] = $m[2];
2379 * Set a cookie on the user's client. Wrapper for
2380 * WebResponse::setCookie
2381 * @param $name \string Name of the cookie to set
2382 * @param $value \string Value to set
2383 * @param $exp \int Expiration time, as a UNIX time value;
2384 * if 0 or not specified, use the default $wgCookieExpiration
2386 protected function setCookie( $name, $value, $exp = 0 ) {
2388 $wgRequest->response()->setcookie( $name, $value, $exp );
2392 * Clear a cookie on the user's client
2393 * @param $name \string Name of the cookie to clear
2395 protected function clearCookie( $name ) {
2396 $this->setCookie( $name, '', time() - 86400 );
2400 * Set the default cookies for this session on the user's client.
2402 function setCookies() {
2404 if ( 0 == $this->mId
) return;
2406 'wsUserID' => $this->mId
,
2407 'wsToken' => $this->mToken
,
2408 'wsUserName' => $this->getName()
2411 'UserID' => $this->mId
,
2412 'UserName' => $this->getName(),
2414 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2415 $cookies['Token'] = $this->mToken
;
2417 $cookies['Token'] = false;
2420 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2421 #check for null, since the hook could cause a null value
2422 if ( !is_null( $session ) && isset( $_SESSION ) ){
2423 $_SESSION = $session +
$_SESSION;
2425 foreach ( $cookies as $name => $value ) {
2426 if ( $value === false ) {
2427 $this->clearCookie( $name );
2429 $this->setCookie( $name, $value );
2435 * Log this user out.
2438 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2444 * Clear the user's cookies and session, and reset the instance cache.
2448 function doLogout() {
2449 $this->clearInstanceCache( 'defaults' );
2451 $_SESSION['wsUserID'] = 0;
2453 $this->clearCookie( 'UserID' );
2454 $this->clearCookie( 'Token' );
2456 # Remember when user logged out, to prevent seeing cached pages
2457 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2461 * Save this user's settings into the database.
2462 * @todo Only rarely do all these fields need to be set!
2464 function saveSettings() {
2466 if ( wfReadOnly() ) { return; }
2467 if ( 0 == $this->mId
) { return; }
2469 $this->mTouched
= self
::newTouchedTimestamp();
2471 $dbw = wfGetDB( DB_MASTER
);
2472 $dbw->update( 'user',
2474 'user_name' => $this->mName
,
2475 'user_password' => $this->mPassword
,
2476 'user_newpassword' => $this->mNewpassword
,
2477 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2478 'user_real_name' => $this->mRealName
,
2479 'user_email' => $this->mEmail
,
2480 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2481 'user_options' => '',
2482 'user_touched' => $dbw->timestamp( $this->mTouched
),
2483 'user_token' => $this->mToken
,
2484 'user_email_token' => $this->mEmailToken
,
2485 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2486 ), array( /* WHERE */
2487 'user_id' => $this->mId
2491 $this->saveOptions();
2493 wfRunHooks( 'UserSaveSettings', array( $this ) );
2494 $this->clearSharedCache();
2495 $this->getUserPage()->invalidateCache();
2499 * If only this user's username is known, and it exists, return the user ID.
2501 function idForName() {
2502 $s = trim( $this->getName() );
2503 if ( $s === '' ) return 0;
2505 $dbr = wfGetDB( DB_SLAVE
);
2506 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2507 if ( $id === false ) {
2514 * Add a user to the database, return the user object
2516 * @param $name \string Username to add
2517 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2518 * - password The user's password. Password logins will be disabled if this is omitted.
2519 * - newpassword A temporary password mailed to the user
2520 * - email The user's email address
2521 * - email_authenticated The email authentication timestamp
2522 * - real_name The user's real name
2523 * - options An associative array of non-default options
2524 * - token Random authentication token. Do not set.
2525 * - registration Registration timestamp. Do not set.
2527 * @return \type{User} A new User object, or null if the username already exists
2529 static function createNew( $name, $params = array() ) {
2532 if ( isset( $params['options'] ) ) {
2533 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2534 unset( $params['options'] );
2536 $dbw = wfGetDB( DB_MASTER
);
2537 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2539 'user_id' => $seqVal,
2540 'user_name' => $name,
2541 'user_password' => $user->mPassword
,
2542 'user_newpassword' => $user->mNewpassword
,
2543 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2544 'user_email' => $user->mEmail
,
2545 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2546 'user_real_name' => $user->mRealName
,
2547 'user_options' => '',
2548 'user_token' => $user->mToken
,
2549 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2550 'user_editcount' => 0,
2552 foreach ( $params as $name => $value ) {
2553 $fields["user_$name"] = $value;
2555 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2556 if ( $dbw->affectedRows() ) {
2557 $newUser = User
::newFromId( $dbw->insertId() );
2565 * Add this existing user object to the database
2567 function addToDatabase() {
2569 $dbw = wfGetDB( DB_MASTER
);
2570 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2571 $dbw->insert( 'user',
2573 'user_id' => $seqVal,
2574 'user_name' => $this->mName
,
2575 'user_password' => $this->mPassword
,
2576 'user_newpassword' => $this->mNewpassword
,
2577 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2578 'user_email' => $this->mEmail
,
2579 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2580 'user_real_name' => $this->mRealName
,
2581 'user_options' => '',
2582 'user_token' => $this->mToken
,
2583 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2584 'user_editcount' => 0,
2587 $this->mId
= $dbw->insertId();
2589 // Clear instance cache other than user table data, which is already accurate
2590 $this->clearInstanceCache();
2592 $this->saveOptions();
2596 * If this (non-anonymous) user is blocked, block any IP address
2597 * they've successfully logged in from.
2599 function spreadBlock() {
2600 wfDebug( __METHOD__
. "()\n" );
2602 if ( $this->mId
== 0 ) {
2606 $userblock = Block
::newFromDB( '', $this->mId
);
2607 if ( !$userblock ) {
2611 $userblock->doAutoblock( wfGetIP() );
2615 * Generate a string which will be different for any combination of
2616 * user options which would produce different parser output.
2617 * This will be used as part of the hash key for the parser cache,
2618 * so users will the same options can share the same cached data
2621 * Extensions which require it should install 'PageRenderingHash' hook,
2622 * which will give them a chance to modify this key based on their own
2625 * @return \string Page rendering hash
2627 function getPageRenderingHash() {
2628 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2630 return $this->mHash
;
2633 // stubthreshold is only included below for completeness,
2634 // it will always be 0 when this function is called by parsercache.
2636 $confstr = $this->getOption( 'math' );
2637 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2638 if ( $wgUseDynamicDates ) {
2639 $confstr .= '!' . $this->getDatePreference();
2641 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2642 $confstr .= '!' . $wgLang->getCode();
2643 $confstr .= '!' . $this->getOption( 'thumbsize' );
2644 // add in language specific options, if any
2645 $extra = $wgContLang->getExtraHashOptions();
2648 $confstr .= $wgRenderHashAppend;
2650 // Give a chance for extensions to modify the hash, if they have
2651 // extra options or other effects on the parser cache.
2652 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2654 // Make it a valid memcached key fragment
2655 $confstr = str_replace( ' ', '_', $confstr );
2656 $this->mHash
= $confstr;
2661 * Get whether the user is explicitly blocked from account creation.
2662 * @return \bool True if blocked
2664 function isBlockedFromCreateAccount() {
2665 $this->getBlockedStatus();
2666 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2670 * Get whether the user is blocked from using Special:Emailuser.
2671 * @return \bool True if blocked
2673 function isBlockedFromEmailuser() {
2674 $this->getBlockedStatus();
2675 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2679 * Get whether the user is allowed to create an account.
2680 * @return \bool True if allowed
2682 function isAllowedToCreateAccount() {
2683 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2689 function setLoaded( $loaded ) {
2690 wfDeprecated( __METHOD__
);
2694 * Get this user's personal page title.
2696 * @return \type{Title} User's personal page title
2698 function getUserPage() {
2699 return Title
::makeTitle( NS_USER
, $this->getName() );
2703 * Get this user's talk page title.
2705 * @return \type{Title} User's talk page title
2707 function getTalkPage() {
2708 $title = $this->getUserPage();
2709 return $title->getTalkPage();
2713 * Get the maximum valid user ID.
2714 * @return \int User ID
2717 function getMaxID() {
2718 static $res; // cache
2720 if ( isset( $res ) )
2723 $dbr = wfGetDB( DB_SLAVE
);
2724 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2729 * Determine whether the user is a newbie. Newbies are either
2730 * anonymous IPs, or the most recently created accounts.
2731 * @return \bool True if the user is a newbie
2733 function isNewbie() {
2734 return !$this->isAllowed( 'autoconfirmed' );
2738 * Check to see if the given clear-text password is one of the accepted passwords
2739 * @param $password \string user password.
2740 * @return \bool True if the given password is correct, otherwise False.
2742 function checkPassword( $password ) {
2746 // Even though we stop people from creating passwords that
2747 // are shorter than this, doesn't mean people wont be able
2748 // to. Certain authentication plugins do NOT want to save
2749 // domain passwords in a mysql database, so we should
2750 // check this (incase $wgAuth->strict() is false).
2751 if( !$this->isValidPassword( $password ) ) {
2755 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2757 } elseif( $wgAuth->strict() ) {
2758 /* Auth plugin doesn't allow local authentication */
2760 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2761 /* Auth plugin doesn't allow local authentication for this user name */
2764 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2766 } elseif ( function_exists( 'iconv' ) ) {
2767 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2768 # Check for this with iconv
2769 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2770 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2778 * Check if the given clear-text password matches the temporary password
2779 * sent by e-mail for password reset operations.
2780 * @return \bool True if matches, false otherwise
2782 function checkTemporaryPassword( $plaintext ) {
2783 global $wgNewPasswordExpiry;
2784 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2786 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2787 return ( time() < $expiry );
2794 * Initialize (if necessary) and return a session token value
2795 * which can be used in edit forms to show that the user's
2796 * login credentials aren't being hijacked with a foreign form
2799 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2800 * @return \string The new edit token
2802 function editToken( $salt = '' ) {
2803 if ( $this->isAnon() ) {
2804 return EDIT_TOKEN_SUFFIX
;
2806 if( !isset( $_SESSION['wsEditToken'] ) ) {
2807 $token = $this->generateToken();
2808 $_SESSION['wsEditToken'] = $token;
2810 $token = $_SESSION['wsEditToken'];
2812 if( is_array( $salt ) ) {
2813 $salt = implode( '|', $salt );
2815 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2820 * Generate a looking random token for various uses.
2822 * @param $salt \string Optional salt value
2823 * @return \string The new random token
2825 function generateToken( $salt = '' ) {
2826 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2827 return md5( $token . $salt );
2831 * Check given value against the token value stored in the session.
2832 * A match should confirm that the form was submitted from the
2833 * user's own login session, not a form submission from a third-party
2836 * @param $val \string Input value to compare
2837 * @param $salt \string Optional function-specific data for hashing
2838 * @return \bool Whether the token matches
2840 function matchEditToken( $val, $salt = '' ) {
2841 $sessionToken = $this->editToken( $salt );
2842 if ( $val != $sessionToken ) {
2843 wfDebug( "User::matchEditToken: broken session data\n" );
2845 return $val == $sessionToken;
2849 * Check given value against the token value stored in the session,
2850 * ignoring the suffix.
2852 * @param $val \string Input value to compare
2853 * @param $salt \string Optional function-specific data for hashing
2854 * @return \bool Whether the token matches
2856 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2857 $sessionToken = $this->editToken( $salt );
2858 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2862 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2863 * mail to the user's given address.
2865 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2867 function sendConfirmationMail() {
2869 $expiration = null; // gets passed-by-ref and defined in next line.
2870 $token = $this->confirmationToken( $expiration );
2871 $url = $this->confirmationTokenUrl( $token );
2872 $invalidateURL = $this->invalidationTokenUrl( $token );
2873 $this->saveSettings();
2875 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2876 wfMsg( 'confirmemail_body',
2880 $wgLang->timeanddate( $expiration, false ),
2882 $wgLang->date( $expiration, false ),
2883 $wgLang->time( $expiration, false ) ) );
2887 * Send an e-mail to this user's account. Does not check for
2888 * confirmed status or validity.
2890 * @param $subject \string Message subject
2891 * @param $body \string Message body
2892 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2893 * @param $replyto \string Reply-To address
2894 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2896 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2897 if( is_null( $from ) ) {
2898 global $wgPasswordSender;
2899 $from = $wgPasswordSender;
2902 $to = new MailAddress( $this );
2903 $sender = new MailAddress( $from );
2904 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2908 * Generate, store, and return a new e-mail confirmation code.
2909 * A hash (unsalted, since it's used as a key) is stored.
2911 * @note Call saveSettings() after calling this function to commit
2912 * this change to the database.
2914 * @param[out] &$expiration \mixed Accepts the expiration time
2915 * @return \string New token
2918 function confirmationToken( &$expiration ) {
2920 $expires = $now +
7 * 24 * 60 * 60;
2921 $expiration = wfTimestamp( TS_MW
, $expires );
2922 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2923 $hash = md5( $token );
2925 $this->mEmailToken
= $hash;
2926 $this->mEmailTokenExpires
= $expiration;
2931 * Return a URL the user can use to confirm their email address.
2932 * @param $token \string Accepts the email confirmation token
2933 * @return \string New token URL
2936 function confirmationTokenUrl( $token ) {
2937 return $this->getTokenUrl( 'ConfirmEmail', $token );
2941 * Return a URL the user can use to invalidate their email address.
2942 * @param $token \string Accepts the email confirmation token
2943 * @return \string New token URL
2946 function invalidationTokenUrl( $token ) {
2947 return $this->getTokenUrl( 'Invalidateemail', $token );
2951 * Internal function to format the e-mail validation/invalidation URLs.
2952 * This uses $wgArticlePath directly as a quickie hack to use the
2953 * hardcoded English names of the Special: pages, for ASCII safety.
2955 * @note Since these URLs get dropped directly into emails, using the
2956 * short English names avoids insanely long URL-encoded links, which
2957 * also sometimes can get corrupted in some browsers/mailers
2958 * (bug 6957 with Gmail and Internet Explorer).
2960 * @param $page \string Special page
2961 * @param $token \string Token
2962 * @return \string Formatted URL
2964 protected function getTokenUrl( $page, $token ) {
2965 global $wgArticlePath;
2969 "Special:$page/$token",
2974 * Mark the e-mail address confirmed.
2976 * @note Call saveSettings() after calling this function to commit the change.
2978 function confirmEmail() {
2979 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2980 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
2985 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2986 * address if it was already confirmed.
2988 * @note Call saveSettings() after calling this function to commit the change.
2990 function invalidateEmail() {
2992 $this->mEmailToken
= null;
2993 $this->mEmailTokenExpires
= null;
2994 $this->setEmailAuthenticationTimestamp( null );
2995 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3000 * Set the e-mail authentication timestamp.
3001 * @param $timestamp \string TS_MW timestamp
3003 function setEmailAuthenticationTimestamp( $timestamp ) {
3005 $this->mEmailAuthenticated
= $timestamp;
3006 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3010 * Is this user allowed to send e-mails within limits of current
3011 * site configuration?
3012 * @return \bool True if allowed
3014 function canSendEmail() {
3015 global $wgEnableEmail, $wgEnableUserEmail, $wgUser;
3016 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$wgUser->isAllowed( 'sendemail' ) ) {
3019 $canSend = $this->isEmailConfirmed();
3020 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3025 * Is this user allowed to receive e-mails within limits of current
3026 * site configuration?
3027 * @return \bool True if allowed
3029 function canReceiveEmail() {
3030 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3034 * Is this user's e-mail address valid-looking and confirmed within
3035 * limits of the current site configuration?
3037 * @note If $wgEmailAuthentication is on, this may require the user to have
3038 * confirmed their address by returning a code or using a password
3039 * sent to the address from the wiki.
3041 * @return \bool True if confirmed
3043 function isEmailConfirmed() {
3044 global $wgEmailAuthentication;
3047 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3048 if( $this->isAnon() )
3050 if( !self
::isValidEmailAddr( $this->mEmail
) )
3052 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3061 * Check whether there is an outstanding request for e-mail confirmation.
3062 * @return \bool True if pending
3064 function isEmailConfirmationPending() {
3065 global $wgEmailAuthentication;
3066 return $wgEmailAuthentication &&
3067 !$this->isEmailConfirmed() &&
3068 $this->mEmailToken
&&
3069 $this->mEmailTokenExpires
> wfTimestamp();
3073 * Get the timestamp of account creation.
3075 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3076 * non-existent/anonymous user accounts.
3078 public function getRegistration() {
3079 return $this->getId() > 0
3080 ?
$this->mRegistration
3085 * Get the timestamp of the first edit
3087 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3088 * non-existent/anonymous user accounts.
3090 public function getFirstEditTimestamp() {
3091 if( $this->getId() == 0 ) return false; // anons
3092 $dbr = wfGetDB( DB_SLAVE
);
3093 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3094 array( 'rev_user' => $this->getId() ),
3096 array( 'ORDER BY' => 'rev_timestamp ASC' )
3098 if( !$time ) return false; // no edits
3099 return wfTimestamp( TS_MW
, $time );
3103 * Get the permissions associated with a given list of groups
3105 * @param $groups \type{\arrayof{\string}} List of internal group names
3106 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3108 static function getGroupPermissions( $groups ) {
3109 global $wgGroupPermissions, $wgRevokePermissions;
3111 // grant every granted permission first
3112 foreach( $groups as $group ) {
3113 if( isset( $wgGroupPermissions[$group] ) ) {
3114 $rights = array_merge( $rights,
3115 // array_filter removes empty items
3116 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3119 // now revoke the revoked permissions
3120 foreach( $groups as $group ) {
3121 if( isset( $wgRevokePermissions[$group] ) ) {
3122 $rights = array_diff( $rights,
3123 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3126 return array_unique( $rights );
3130 * Get all the groups who have a given permission
3132 * @param $role \string Role to check
3133 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3135 static function getGroupsWithPermission( $role ) {
3136 global $wgGroupPermissions;
3137 $allowedGroups = array();
3138 foreach ( $wgGroupPermissions as $group => $rights ) {
3139 if ( isset( $rights[$role] ) && $rights[$role] ) {
3140 $allowedGroups[] = $group;
3143 return $allowedGroups;
3147 * Get the localized descriptive name for a group, if it exists
3149 * @param $group \string Internal group name
3150 * @return \string Localized descriptive group name
3152 static function getGroupName( $group ) {
3153 global $wgMessageCache;
3154 $wgMessageCache->loadAllMessages();
3155 $key = "group-$group";
3156 $name = wfMsg( $key );
3157 return $name == '' ||
wfEmptyMsg( $key, $name )
3163 * Get the localized descriptive name for a member of a group, if it exists
3165 * @param $group \string Internal group name
3166 * @return \string Localized name for group member
3168 static function getGroupMember( $group ) {
3169 global $wgMessageCache;
3170 $wgMessageCache->loadAllMessages();
3171 $key = "group-$group-member";
3172 $name = wfMsg( $key );
3173 return $name == '' ||
wfEmptyMsg( $key, $name )
3179 * Return the set of defined explicit groups.
3180 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3181 * are not included, as they are defined automatically, not in the database.
3182 * @return \type{\arrayof{\string}} Array of internal group names
3184 static function getAllGroups() {
3185 global $wgGroupPermissions, $wgRevokePermissions;
3187 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3188 self
::getImplicitGroups()
3193 * Get a list of all available permissions.
3194 * @return \type{\arrayof{\string}} Array of permission names
3196 static function getAllRights() {
3197 if ( self
::$mAllRights === false ) {
3198 global $wgAvailableRights;
3199 if ( count( $wgAvailableRights ) ) {
3200 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3202 self
::$mAllRights = self
::$mCoreRights;
3204 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3206 return self
::$mAllRights;
3210 * Get a list of implicit groups
3211 * @return \type{\arrayof{\string}} Array of internal group names
3213 public static function getImplicitGroups() {
3214 global $wgImplicitGroups;
3215 $groups = $wgImplicitGroups;
3216 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3221 * Get the title of a page describing a particular group
3223 * @param $group \string Internal group name
3224 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3226 static function getGroupPage( $group ) {
3227 global $wgMessageCache;
3228 $wgMessageCache->loadAllMessages();
3229 $page = wfMsgForContent( 'grouppage-' . $group );
3230 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3231 $title = Title
::newFromText( $page );
3232 if( is_object( $title ) )
3239 * Create a link to the group in HTML, if available;
3240 * else return the group name.
3242 * @param $group \string Internal name of the group
3243 * @param $text \string The text of the link
3244 * @return \string HTML link to the group
3246 static function makeGroupLinkHTML( $group, $text = '' ) {
3248 $text = self
::getGroupName( $group );
3250 $title = self
::getGroupPage( $group );
3253 $sk = $wgUser->getSkin();
3254 return $sk->link( $title, htmlspecialchars( $text ) );
3261 * Create a link to the group in Wikitext, if available;
3262 * else return the group name.
3264 * @param $group \string Internal name of the group
3265 * @param $text \string The text of the link
3266 * @return \string Wikilink to the group
3268 static function makeGroupLinkWiki( $group, $text = '' ) {
3270 $text = self
::getGroupName( $group );
3272 $title = self
::getGroupPage( $group );
3274 $page = $title->getPrefixedText();
3275 return "[[$page|$text]]";
3282 * Returns an array of the groups that a particular group can add/remove.
3284 * @param $group String: the group to check for whether it can add/remove
3285 * @return Array array( 'add' => array( addablegroups ),
3286 * 'remove' => array( removablegroups ),
3287 * 'add-self' => array( addablegroups to self),
3288 * 'remove-self' => array( removable groups from self) )
3290 static function changeableByGroup( $group ) {
3291 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3293 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3294 if( empty( $wgAddGroups[$group] ) ) {
3295 // Don't add anything to $groups
3296 } elseif( $wgAddGroups[$group] === true ) {
3297 // You get everything
3298 $groups['add'] = self
::getAllGroups();
3299 } elseif( is_array( $wgAddGroups[$group] ) ) {
3300 $groups['add'] = $wgAddGroups[$group];
3303 // Same thing for remove
3304 if( empty( $wgRemoveGroups[$group] ) ) {
3305 } elseif( $wgRemoveGroups[$group] === true ) {
3306 $groups['remove'] = self
::getAllGroups();
3307 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3308 $groups['remove'] = $wgRemoveGroups[$group];
3311 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3312 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3313 foreach( $wgGroupsAddToSelf as $key => $value ) {
3314 if( is_int( $key ) ) {
3315 $wgGroupsAddToSelf['user'][] = $value;
3320 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3321 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3322 if( is_int( $key ) ) {
3323 $wgGroupsRemoveFromSelf['user'][] = $value;
3328 // Now figure out what groups the user can add to him/herself
3329 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3330 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3331 // No idea WHY this would be used, but it's there
3332 $groups['add-self'] = User
::getAllGroups();
3333 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3334 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3337 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3338 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3339 $groups['remove-self'] = User
::getAllGroups();
3340 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3341 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3348 * Returns an array of groups that this user can add and remove
3349 * @return Array array( 'add' => array( addablegroups ),
3350 * 'remove' => array( removablegroups ),
3351 * 'add-self' => array( addablegroups to self),
3352 * 'remove-self' => array( removable groups from self) )
3354 function changeableGroups() {
3355 if( $this->isAllowed( 'userrights' ) ) {
3356 // This group gives the right to modify everything (reverse-
3357 // compatibility with old "userrights lets you change
3359 // Using array_merge to make the groups reindexed
3360 $all = array_merge( User
::getAllGroups() );
3364 'add-self' => array(),
3365 'remove-self' => array()
3369 // Okay, it's not so simple, we will have to go through the arrays
3372 'remove' => array(),
3373 'add-self' => array(),
3374 'remove-self' => array()
3376 $addergroups = $this->getEffectiveGroups();
3378 foreach( $addergroups as $addergroup ) {
3379 $groups = array_merge_recursive(
3380 $groups, $this->changeableByGroup( $addergroup )
3382 $groups['add'] = array_unique( $groups['add'] );
3383 $groups['remove'] = array_unique( $groups['remove'] );
3384 $groups['add-self'] = array_unique( $groups['add-self'] );
3385 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3391 * Increment the user's edit-count field.
3392 * Will have no effect for anonymous users.
3394 function incEditCount() {
3395 if( !$this->isAnon() ) {
3396 $dbw = wfGetDB( DB_MASTER
);
3397 $dbw->update( 'user',
3398 array( 'user_editcount=user_editcount+1' ),
3399 array( 'user_id' => $this->getId() ),
3402 // Lazy initialization check...
3403 if( $dbw->affectedRows() == 0 ) {
3404 // Pull from a slave to be less cruel to servers
3405 // Accuracy isn't the point anyway here
3406 $dbr = wfGetDB( DB_SLAVE
);
3407 $count = $dbr->selectField( 'revision',
3409 array( 'rev_user' => $this->getId() ),
3412 // Now here's a goddamn hack...
3413 if( $dbr !== $dbw ) {
3414 // If we actually have a slave server, the count is
3415 // at least one behind because the current transaction
3416 // has not been committed and replicated.
3419 // But if DB_SLAVE is selecting the master, then the
3420 // count we just read includes the revision that was
3421 // just added in the working transaction.
3424 $dbw->update( 'user',
3425 array( 'user_editcount' => $count ),
3426 array( 'user_id' => $this->getId() ),
3430 // edit count in user cache too
3431 $this->invalidateCache();
3435 * Get the description of a given right
3437 * @param $right \string Right to query
3438 * @return \string Localized description of the right
3440 static function getRightDescription( $right ) {
3441 global $wgMessageCache;
3442 $wgMessageCache->loadAllMessages();
3443 $key = "right-$right";
3444 $name = wfMsg( $key );
3445 return $name == '' ||
wfEmptyMsg( $key, $name )
3451 * Make an old-style password hash
3453 * @param $password \string Plain-text password
3454 * @param $userId \string User ID
3455 * @return \string Password hash
3457 static function oldCrypt( $password, $userId ) {
3458 global $wgPasswordSalt;
3459 if ( $wgPasswordSalt ) {
3460 return md5( $userId . '-' . md5( $password ) );
3462 return md5( $password );
3467 * Make a new-style password hash
3469 * @param $password \string Plain-text password
3470 * @param $salt \string Optional salt, may be random or the user ID.
3471 * If unspecified or false, will generate one automatically
3472 * @return \string Password hash
3474 static function crypt( $password, $salt = false ) {
3475 global $wgPasswordSalt;
3478 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3482 if( $wgPasswordSalt ) {
3483 if ( $salt === false ) {
3484 $salt = substr( wfGenerateToken(), 0, 8 );
3486 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3488 return ':A:' . md5( $password );
3493 * Compare a password hash with a plain-text password. Requires the user
3494 * ID if there's a chance that the hash is an old-style hash.
3496 * @param $hash \string Password hash
3497 * @param $password \string Plain-text password to compare
3498 * @param $userId \string User ID for old-style password salt
3501 static function comparePasswords( $hash, $password, $userId = false ) {
3503 $type = substr( $hash, 0, 3 );
3506 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3510 if ( $type == ':A:' ) {
3512 return md5( $password ) === substr( $hash, 3 );
3513 } elseif ( $type == ':B:' ) {
3515 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3516 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3519 return self
::oldCrypt( $password, $userId ) === $hash;
3524 * Add a newuser log entry for this user
3525 * @param $byEmail Boolean: account made by email?
3527 public function addNewUserLogEntry( $byEmail = false ) {
3528 global $wgUser, $wgContLang, $wgNewUserLog;
3529 if( empty( $wgNewUserLog ) ) {
3530 return true; // disabled
3532 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3533 if( $this->getName() == $wgUser->getName() ) {
3537 $action = 'create2';
3539 ?
wfMsgForContent( 'newuserlog-byemail' )
3542 $log = new LogPage( 'newusers' );
3545 $this->getUserPage(),
3547 array( $this->getId() )
3553 * Add an autocreate newuser log entry for this user
3554 * Used by things like CentralAuth and perhaps other authplugins.
3556 public function addNewUserLogEntryAutoCreate() {
3557 global $wgNewUserLog;
3558 if( empty( $wgNewUserLog ) ) {
3559 return true; // disabled
3561 $log = new LogPage( 'newusers', false );
3562 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3566 protected function loadOptions() {
3568 if ( $this->mOptionsLoaded ||
!$this->getId() )
3571 $this->mOptions
= self
::getDefaultOptions();
3573 // Maybe load from the object
3574 if ( !is_null( $this->mOptionOverrides
) ) {
3575 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3576 foreach( $this->mOptionOverrides
as $key => $value ) {
3577 $this->mOptions
[$key] = $value;
3580 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3581 // Load from database
3582 $dbr = wfGetDB( DB_SLAVE
);
3584 $res = $dbr->select(
3587 array( 'up_user' => $this->getId() ),
3591 while( $row = $dbr->fetchObject( $res ) ) {
3592 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3593 $this->mOptions
[$row->up_property
] = $row->up_value
;
3597 $this->mOptionsLoaded
= true;
3599 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3602 protected function saveOptions() {
3603 global $wgAllowPrefChange;
3605 $extuser = ExternalUser
::newFromUser( $this );
3607 $this->loadOptions();
3608 $dbw = wfGetDB( DB_MASTER
);
3610 $insert_rows = array();
3612 $saveOptions = $this->mOptions
;
3614 // Allow hooks to abort, for instance to save to a global profile.
3615 // Reset options to default state before saving.
3616 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3619 foreach( $saveOptions as $key => $value ) {
3620 # Don't bother storing default values
3621 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3622 !( $value === false ||
is_null($value) ) ) ||
3623 $value != self
::getDefaultOption( $key ) ) {
3624 $insert_rows[] = array(
3625 'up_user' => $this->getId(),
3626 'up_property' => $key,
3627 'up_value' => $value,
3630 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3631 switch ( $wgAllowPrefChange[$key] ) {
3637 $extuser->setPref( $key, $value );
3643 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3644 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3649 * Provide an array of HTML 5 attributes to put on an input element
3650 * intended for the user to enter a new password. This may include
3651 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3653 * Do *not* use this when asking the user to enter his current password!
3654 * Regardless of configuration, users may have invalid passwords for whatever
3655 * reason (e.g., they were set before requirements were tightened up).
3656 * Only use it when asking for a new password, like on account creation or
3659 * Obviously, you still need to do server-side checking.
3661 * @return array Array of HTML attributes suitable for feeding to
3662 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3663 * That will potentially output invalid XHTML 1.0 Transitional, and will
3664 * get confused by the boolean attribute syntax used.)
3666 public static function passwordChangeInputAttribs() {
3667 global $wgMinimalPasswordLength;
3669 if ( $wgMinimalPasswordLength == 0 ) {
3673 # Note that the pattern requirement will always be satisfied if the
3674 # input is empty, so we need required in all cases.
3675 $ret = array( 'required' );
3677 # We can't actually do this right now, because Opera 9.6 will print out
3678 # the entered password visibly in its error message! When other
3679 # browsers add support for this attribute, or Opera fixes its support,
3680 # we can add support with a version check to avoid doing this on Opera
3681 # versions where it will be a problem. Reported to Opera as
3682 # DSK-262266, but they don't have a public bug tracker for us to follow.
3684 if ( $wgMinimalPasswordLength > 1 ) {
3685 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3686 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3687 $wgMinimalPasswordLength );