84354142e97013c872d830976fea68559b629416
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 //simple boolean wrapper for getPasswordValidity
628 return $this->getPasswordValidity( $password ) === true;
632 * Given unvalidated password input, return error message on failure.
634 * @param $password String Desired password
635 * @return mixed: true on success, string of error message on failure
637 function getPasswordValidity( $password ) {
638 global $wgMinimalPasswordLength, $wgContLang;
640 $result = false; //init $result to false for the internal checks
642 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
645 if ( $result === false ) {
646 if( strlen( $password ) < $wgMinimalPasswordLength ) {
647 return 'passwordtooshort';
648 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
649 return 'password-name-match';
651 //it seems weird returning true here, but this is because of the
652 //initialization of $result to false above. If the hook is never run or it
653 //doesn't modify $result, then we will likely get down into this if with
657 } elseif( $result === true ) {
660 return $result; //the isValidPassword hook set a string $result and returned true
665 * Does a string look like an e-mail address?
667 * There used to be a regular expression here, it got removed because it
668 * rejected valid addresses. Actually just check if there is '@' somewhere
669 * in the given address.
671 * @todo Check for RFC 2822 compilance (bug 959)
673 * @param $addr \string E-mail address
674 * @return \bool True or false
676 public static function isValidEmailAddr( $addr ) {
678 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
682 return strpos( $addr, '@' ) !== false;
686 * Given unvalidated user input, return a canonical username, or false if
687 * the username is invalid.
688 * @param $name \string User input
689 * @param $validate \types{\string,\bool} Type of validation to use:
690 * - false No validation
691 * - 'valid' Valid for batch processes
692 * - 'usable' Valid for batch processes and login
693 * - 'creatable' Valid for batch processes, login and account creation
695 static function getCanonicalName( $name, $validate = 'valid' ) {
696 # Maybe force usernames to capital
697 $name = Title
::capitalize( $name, NS_USER
);
699 # Reject names containing '#'; these will be cleaned up
700 # with title normalisation, but then it's too late to
702 if( strpos( $name, '#' ) !== false )
703 return new WikiError( 'usernamehasherror' );
705 # Clean up name according to title rules
706 $t = ( $validate === 'valid' ) ?
707 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
708 # Check for invalid titles
709 if( is_null( $t ) ) {
713 # Reject various classes of invalid names
714 $name = $t->getText();
716 $name = $wgAuth->getCanonicalName( $t->getText() );
718 switch ( $validate ) {
722 if ( !User
::isValidUserName( $name ) ) {
727 if ( !User
::isUsableName( $name ) ) {
732 if ( !User
::isCreatableName( $name ) ) {
737 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
743 * Count the number of edits of a user
744 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
746 * @param $uid \int User ID to check
747 * @return \int The user's edit count
749 static function edits( $uid ) {
750 wfProfileIn( __METHOD__
);
751 $dbr = wfGetDB( DB_SLAVE
);
752 // check if the user_editcount field has been initialized
753 $field = $dbr->selectField(
754 'user', 'user_editcount',
755 array( 'user_id' => $uid ),
759 if( $field === null ) { // it has not been initialized. do so.
760 $dbw = wfGetDB( DB_MASTER
);
761 $count = $dbr->selectField(
762 'revision', 'count(*)',
763 array( 'rev_user' => $uid ),
768 array( 'user_editcount' => $count ),
769 array( 'user_id' => $uid ),
775 wfProfileOut( __METHOD__
);
780 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
781 * @todo hash random numbers to improve security, like generateToken()
783 * @return \string New random password
785 static function randomPassword() {
786 global $wgMinimalPasswordLength;
787 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
788 $l = strlen( $pwchars ) - 1;
790 $pwlength = max( 7, $wgMinimalPasswordLength );
791 $digit = mt_rand( 0, $pwlength - 1 );
793 for ( $i = 0; $i < $pwlength; $i++
) {
794 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
800 * Set cached properties to default.
802 * @note This no longer clears uncached lazy-initialised properties;
803 * the constructor does that instead.
806 function loadDefaults( $name = false ) {
807 wfProfileIn( __METHOD__
);
809 global $wgCookiePrefix;
812 $this->mName
= $name;
813 $this->mRealName
= '';
814 $this->mPassword
= $this->mNewpassword
= '';
815 $this->mNewpassTime
= null;
817 $this->mOptionOverrides
= null;
818 $this->mOptionsLoaded
= false;
820 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
821 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
823 $this->mTouched
= '0'; # Allow any pages to be cached
826 $this->setToken(); # Random
827 $this->mEmailAuthenticated
= null;
828 $this->mEmailToken
= '';
829 $this->mEmailTokenExpires
= null;
830 $this->mRegistration
= wfTimestamp( TS_MW
);
831 $this->mGroups
= array();
833 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
835 wfProfileOut( __METHOD__
);
839 * @deprecated Use wfSetupSession().
841 function SetupSession() {
842 wfDeprecated( __METHOD__
);
847 * Load user data from the session or login cookie. If there are no valid
848 * credentials, initialises the user as an anonymous user.
849 * @return \bool True if the user is logged in, false otherwise.
851 private function loadFromSession() {
852 global $wgMemc, $wgCookiePrefix;
855 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
856 if ( $result !== null ) {
860 if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
861 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
862 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
863 $this->loadDefaults(); // Possible collision!
864 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
865 cookie user ID ($sId) don't match!" );
868 $_SESSION['wsUserID'] = $sId;
869 } else if ( isset( $_SESSION['wsUserID'] ) ) {
870 if ( $_SESSION['wsUserID'] != 0 ) {
871 $sId = $_SESSION['wsUserID'];
873 $this->loadDefaults();
877 $this->loadDefaults();
881 if ( isset( $_SESSION['wsUserName'] ) ) {
882 $sName = $_SESSION['wsUserName'];
883 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
884 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
885 $_SESSION['wsUserName'] = $sName;
887 $this->loadDefaults();
891 $passwordCorrect = FALSE;
893 if ( !$this->loadFromId() ) {
894 # Not a valid ID, loadFromId has switched the object to anon for us
898 if ( isset( $_SESSION['wsToken'] ) ) {
899 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
901 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
902 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
905 # No session or persistent login cookie
906 $this->loadDefaults();
910 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
911 $_SESSION['wsToken'] = $this->mToken
;
912 wfDebug( "Logged in from $from\n" );
915 # Invalid credentials
916 wfDebug( "Can't log in from $from, invalid credentials\n" );
917 $this->loadDefaults();
923 * Load user and user_group data from the database.
924 * $this::mId must be set, this is how the user is identified.
926 * @return \bool True if the user exists, false if the user is anonymous
929 function loadFromDatabase() {
931 $this->mId
= intval( $this->mId
);
933 /** Anonymous user */
935 $this->loadDefaults();
939 $dbr = wfGetDB( DB_MASTER
);
940 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
942 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
944 if ( $s !== false ) {
945 # Initialise user table data
946 $this->loadFromRow( $s );
947 $this->mGroups
= null; // deferred
948 $this->getEditCount(); // revalidation for nulls
953 $this->loadDefaults();
959 * Initialize this object from a row from the user table.
961 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
963 function loadFromRow( $row ) {
964 $this->mDataLoaded
= true;
966 if ( isset( $row->user_id
) ) {
967 $this->mId
= intval( $row->user_id
);
969 $this->mName
= $row->user_name
;
970 $this->mRealName
= $row->user_real_name
;
971 $this->mPassword
= $row->user_password
;
972 $this->mNewpassword
= $row->user_newpassword
;
973 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
974 $this->mEmail
= $row->user_email
;
975 $this->decodeOptions( $row->user_options
);
976 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
977 $this->mToken
= $row->user_token
;
978 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
979 $this->mEmailToken
= $row->user_email_token
;
980 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
981 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
982 $this->mEditCount
= $row->user_editcount
;
986 * Load the groups from the database if they aren't already loaded.
989 function loadGroups() {
990 if ( is_null( $this->mGroups
) ) {
991 $dbr = wfGetDB( DB_MASTER
);
992 $res = $dbr->select( 'user_groups',
994 array( 'ug_user' => $this->mId
),
996 $this->mGroups
= array();
997 while( $row = $dbr->fetchObject( $res ) ) {
998 $this->mGroups
[] = $row->ug_group
;
1004 * Clear various cached data stored in this object.
1005 * @param $reloadFrom \string Reload user and user_groups table data from a
1006 * given source. May be "name", "id", "defaults", "session", or false for
1009 function clearInstanceCache( $reloadFrom = false ) {
1010 $this->mNewtalk
= -1;
1011 $this->mDatePreference
= null;
1012 $this->mBlockedby
= -1; # Unset
1013 $this->mHash
= false;
1014 $this->mSkin
= null;
1015 $this->mRights
= null;
1016 $this->mEffectiveGroups
= null;
1017 $this->mOptions
= null;
1019 if ( $reloadFrom ) {
1020 $this->mDataLoaded
= false;
1021 $this->mFrom
= $reloadFrom;
1026 * Combine the language default options with any site-specific options
1027 * and add the default language variants.
1029 * @return \type{\arrayof{\string}} Array of options
1031 static function getDefaultOptions() {
1032 global $wgNamespacesToBeSearchedDefault;
1034 * Site defaults will override the global/language defaults
1036 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1037 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1040 * default language setting
1042 $variant = $wgContLang->getPreferredVariant( false );
1043 $defOpt['variant'] = $variant;
1044 $defOpt['language'] = $variant;
1045 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1046 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1048 $defOpt['skin'] = $wgDefaultSkin;
1054 * Get a given default option value.
1056 * @param $opt \string Name of option to retrieve
1057 * @return \string Default option value
1059 public static function getDefaultOption( $opt ) {
1060 $defOpts = self
::getDefaultOptions();
1061 if( isset( $defOpts[$opt] ) ) {
1062 return $defOpts[$opt];
1069 * Get a list of user toggle names
1070 * @return \type{\arrayof{\string}} Array of user toggle names
1072 static function getToggles() {
1073 global $wgContLang, $wgUseRCPatrol;
1074 $extraToggles = array();
1075 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1076 if( $wgUseRCPatrol ) {
1077 $extraToggles[] = 'hidepatrolled';
1078 $extraToggles[] = 'newpageshidepatrolled';
1079 $extraToggles[] = 'watchlisthidepatrolled';
1081 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1086 * Get blocking information
1088 * @param $bFromSlave \bool Whether to check the slave database first. To
1089 * improve performance, non-critical checks are done
1090 * against slaves. Check when actually saving should be
1091 * done against master.
1093 function getBlockedStatus( $bFromSlave = true ) {
1094 global $wgEnableSorbs, $wgProxyWhitelist, $wgUser;
1096 if ( -1 != $this->mBlockedby
) {
1097 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1101 wfProfileIn( __METHOD__
);
1102 wfDebug( __METHOD__
.": checking...\n" );
1104 // Initialize data...
1105 // Otherwise something ends up stomping on $this->mBlockedby when
1106 // things get lazy-loaded later, causing false positive block hits
1107 // due to -1 !== 0. Probably session-related... Nothing should be
1108 // overwriting mBlockedby, surely?
1111 $this->mBlockedby
= 0;
1112 $this->mHideName
= 0;
1113 $this->mAllowUsertalk
= 0;
1115 # Check if we are looking at an IP or a logged-in user
1116 if ( $this->isIP( $this->getName() ) ) {
1117 $ip = $this->getName();
1119 # Check if we are looking at the current user
1120 # If we don't, and the user is logged in, we don't know about
1121 # his IP / autoblock status, so ignore autoblock of current user's IP
1122 if ( $this->getID() != $wgUser->getID() ) {
1125 # Get IP of current user
1130 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1131 # Exempt from all types of IP-block
1136 $this->mBlock
= new Block();
1137 $this->mBlock
->fromMaster( !$bFromSlave );
1138 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1139 wfDebug( __METHOD__
. ": Found block.\n" );
1140 $this->mBlockedby
= $this->mBlock
->mBy
;
1141 $this->mBlockreason
= $this->mBlock
->mReason
;
1142 $this->mHideName
= $this->mBlock
->mHideName
;
1143 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1144 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1145 $this->spreadBlock();
1148 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1149 // apply to users. Note that the existence of $this->mBlock is not used to
1150 // check for edit blocks, $this->mBlockedby is instead.
1154 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1156 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1157 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1158 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1162 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1163 if ( $this->inSorbsBlacklist( $ip ) ) {
1164 $this->mBlockedby
= wfMsg( 'sorbs' );
1165 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1171 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1173 wfProfileOut( __METHOD__
);
1177 * Whether the given IP is in the SORBS blacklist.
1179 * @param $ip \string IP to check
1180 * @return \bool True if blacklisted.
1182 function inSorbsBlacklist( $ip ) {
1183 global $wgEnableSorbs, $wgSorbsUrl;
1185 return $wgEnableSorbs &&
1186 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1190 * Whether the given IP is in a given DNS blacklist.
1192 * @param $ip \string IP to check
1193 * @param $bases \string or Array of Strings: URL of the DNS blacklist
1194 * @return \bool True if blacklisted.
1196 function inDnsBlacklist( $ip, $bases ) {
1197 wfProfileIn( __METHOD__
);
1201 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1202 if( IP
::isIPv4( $ip ) ) {
1203 # Reverse IP, bug 21255
1204 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1206 foreach( (array)$bases as $base ) {
1208 $host = "$ipReversed.$base";
1211 $ipList = gethostbynamel( $host );
1214 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1218 wfDebug( "Requested $host, not found in $base.\n" );
1223 wfProfileOut( __METHOD__
);
1228 * Is this user subject to rate limiting?
1230 * @return \bool True if rate limited
1232 public function isPingLimitable() {
1233 global $wgRateLimitsExcludedGroups;
1234 global $wgRateLimitsExcludedIPs;
1235 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1236 // Deprecated, but kept for backwards-compatibility config
1239 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1240 // No other good way currently to disable rate limits
1241 // for specific IPs. :P
1242 // But this is a crappy hack and should die.
1245 return !$this->isAllowed('noratelimit');
1249 * Primitive rate limits: enforce maximum actions per time period
1250 * to put a brake on flooding.
1252 * @note When using a shared cache like memcached, IP-address
1253 * last-hit counters will be shared across wikis.
1255 * @param $action \string Action to enforce; 'edit' if unspecified
1256 * @return \bool True if a rate limiter was tripped
1258 function pingLimiter( $action = 'edit' ) {
1259 # Call the 'PingLimiter' hook
1261 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1265 global $wgRateLimits;
1266 if( !isset( $wgRateLimits[$action] ) ) {
1270 # Some groups shouldn't trigger the ping limiter, ever
1271 if( !$this->isPingLimitable() )
1274 global $wgMemc, $wgRateLimitLog;
1275 wfProfileIn( __METHOD__
);
1277 $limits = $wgRateLimits[$action];
1279 $id = $this->getId();
1283 if( isset( $limits['anon'] ) && $id == 0 ) {
1284 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1287 if( isset( $limits['user'] ) && $id != 0 ) {
1288 $userLimit = $limits['user'];
1290 if( $this->isNewbie() ) {
1291 if( isset( $limits['newbie'] ) && $id != 0 ) {
1292 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1294 if( isset( $limits['ip'] ) ) {
1295 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1298 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1299 $subnet = $matches[1];
1300 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1303 // Check for group-specific permissions
1304 // If more than one group applies, use the group with the highest limit
1305 foreach ( $this->getGroups() as $group ) {
1306 if ( isset( $limits[$group] ) ) {
1307 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1308 $userLimit = $limits[$group];
1312 // Set the user limit key
1313 if ( $userLimit !== false ) {
1314 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1315 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1319 foreach( $keys as $key => $limit ) {
1320 list( $max, $period ) = $limit;
1321 $summary = "(limit $max in {$period}s)";
1322 $count = $wgMemc->get( $key );
1325 if( $count > $max ) {
1326 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1327 if( $wgRateLimitLog ) {
1328 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1332 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1334 $wgMemc->incr( $key );
1336 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1337 $wgMemc->set( $key, 1, intval( $period ) ); // first ping
1341 wfProfileOut( __METHOD__
);
1346 * Check if user is blocked
1348 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1349 * @return \bool True if blocked, false otherwise
1351 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1352 wfDebug( "User::isBlocked: enter\n" );
1353 $this->getBlockedStatus( $bFromSlave );
1354 return $this->mBlockedby
!== 0;
1358 * Check if user is blocked from editing a particular article
1360 * @param $title \string Title to check
1361 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1362 * @return \bool True if blocked, false otherwise
1364 function isBlockedFrom( $title, $bFromSlave = false ) {
1365 global $wgBlockAllowsUTEdit;
1366 wfProfileIn( __METHOD__
);
1367 wfDebug( __METHOD__
. ": enter\n" );
1369 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1370 $blocked = $this->isBlocked( $bFromSlave );
1371 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1372 # If a user's name is suppressed, they cannot make edits anywhere
1373 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1374 $title->getNamespace() == NS_USER_TALK
) {
1376 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1379 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1381 wfProfileOut( __METHOD__
);
1386 * If user is blocked, return the name of the user who placed the block
1387 * @return \string name of blocker
1389 function blockedBy() {
1390 $this->getBlockedStatus();
1391 return $this->mBlockedby
;
1395 * If user is blocked, return the specified reason for the block
1396 * @return \string Blocking reason
1398 function blockedFor() {
1399 $this->getBlockedStatus();
1400 return $this->mBlockreason
;
1404 * If user is blocked, return the ID for the block
1405 * @return \int Block ID
1407 function getBlockId() {
1408 $this->getBlockedStatus();
1409 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1413 * Check if user is blocked on all wikis.
1414 * Do not use for actual edit permission checks!
1415 * This is intented for quick UI checks.
1417 * @param $ip \type{\string} IP address, uses current client if none given
1418 * @return \type{\bool} True if blocked, false otherwise
1420 function isBlockedGlobally( $ip = '' ) {
1421 if( $this->mBlockedGlobally
!== null ) {
1422 return $this->mBlockedGlobally
;
1424 // User is already an IP?
1425 if( IP
::isIPAddress( $this->getName() ) ) {
1426 $ip = $this->getName();
1431 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1432 $this->mBlockedGlobally
= (bool)$blocked;
1433 return $this->mBlockedGlobally
;
1437 * Check if user account is locked
1439 * @return \type{\bool} True if locked, false otherwise
1441 function isLocked() {
1442 if( $this->mLocked
!== null ) {
1443 return $this->mLocked
;
1446 $authUser = $wgAuth->getUserInstance( $this );
1447 $this->mLocked
= (bool)$authUser->isLocked();
1448 return $this->mLocked
;
1452 * Check if user account is hidden
1454 * @return \type{\bool} True if hidden, false otherwise
1456 function isHidden() {
1457 if( $this->mHideName
!== null ) {
1458 return $this->mHideName
;
1460 $this->getBlockedStatus();
1461 if( !$this->mHideName
) {
1463 $authUser = $wgAuth->getUserInstance( $this );
1464 $this->mHideName
= (bool)$authUser->isHidden();
1466 return $this->mHideName
;
1470 * Get the user's ID.
1471 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1474 if( $this->mId
=== null and $this->mName
!== null
1475 and User
::isIP( $this->mName
) ) {
1476 // Special case, we know the user is anonymous
1478 } elseif( $this->mId
=== null ) {
1479 // Don't load if this was initialized from an ID
1486 * Set the user and reload all fields according to a given ID
1487 * @param $v \int User ID to reload
1489 function setId( $v ) {
1491 $this->clearInstanceCache( 'id' );
1495 * Get the user name, or the IP of an anonymous user
1496 * @return \string User's name or IP address
1498 function getName() {
1499 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1500 # Special case optimisation
1501 return $this->mName
;
1504 if ( $this->mName
=== false ) {
1506 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1508 return $this->mName
;
1513 * Set the user name.
1515 * This does not reload fields from the database according to the given
1516 * name. Rather, it is used to create a temporary "nonexistent user" for
1517 * later addition to the database. It can also be used to set the IP
1518 * address for an anonymous user to something other than the current
1521 * @note User::newFromName() has rougly the same function, when the named user
1523 * @param $str \string New user name to set
1525 function setName( $str ) {
1527 $this->mName
= $str;
1531 * Get the user's name escaped by underscores.
1532 * @return \string Username escaped by underscores.
1534 function getTitleKey() {
1535 return str_replace( ' ', '_', $this->getName() );
1539 * Check if the user has new messages.
1540 * @return \bool True if the user has new messages
1542 function getNewtalk() {
1545 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1546 if( $this->mNewtalk
=== -1 ) {
1547 $this->mNewtalk
= false; # reset talk page status
1549 # Check memcached separately for anons, who have no
1550 # entire User object stored in there.
1553 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1554 $newtalk = $wgMemc->get( $key );
1555 if( strval( $newtalk ) !== '' ) {
1556 $this->mNewtalk
= (bool)$newtalk;
1558 // Since we are caching this, make sure it is up to date by getting it
1560 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1561 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1564 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1568 return (bool)$this->mNewtalk
;
1572 * Return the talk page(s) this user has new messages on.
1573 * @return \type{\arrayof{\string}} Array of page URLs
1575 function getNewMessageLinks() {
1577 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1580 if( !$this->getNewtalk() )
1582 $up = $this->getUserPage();
1583 $utp = $up->getTalkPage();
1584 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1588 * Internal uncached check for new messages
1591 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1592 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1593 * @param $fromMaster \bool true to fetch from the master, false for a slave
1594 * @return \bool True if the user has new messages
1597 function checkNewtalk( $field, $id, $fromMaster = false ) {
1598 if ( $fromMaster ) {
1599 $db = wfGetDB( DB_MASTER
);
1601 $db = wfGetDB( DB_SLAVE
);
1603 $ok = $db->selectField( 'user_newtalk', $field,
1604 array( $field => $id ), __METHOD__
);
1605 return $ok !== false;
1609 * Add or update the new messages flag
1610 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1611 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1612 * @return \bool True if successful, false otherwise
1615 function updateNewtalk( $field, $id ) {
1616 $dbw = wfGetDB( DB_MASTER
);
1617 $dbw->insert( 'user_newtalk',
1618 array( $field => $id ),
1621 if ( $dbw->affectedRows() ) {
1622 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1625 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1631 * Clear the new messages flag for the given user
1632 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1633 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1634 * @return \bool True if successful, false otherwise
1637 function deleteNewtalk( $field, $id ) {
1638 $dbw = wfGetDB( DB_MASTER
);
1639 $dbw->delete( 'user_newtalk',
1640 array( $field => $id ),
1642 if ( $dbw->affectedRows() ) {
1643 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1646 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1652 * Update the 'You have new messages!' status.
1653 * @param $val \bool Whether the user has new messages
1655 function setNewtalk( $val ) {
1656 if( wfReadOnly() ) {
1661 $this->mNewtalk
= $val;
1663 if( $this->isAnon() ) {
1665 $id = $this->getName();
1668 $id = $this->getId();
1673 $changed = $this->updateNewtalk( $field, $id );
1675 $changed = $this->deleteNewtalk( $field, $id );
1678 if( $this->isAnon() ) {
1679 // Anons have a separate memcached space, since
1680 // user records aren't kept for them.
1681 $key = wfMemcKey( 'newtalk', 'ip', $id );
1682 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1685 $this->invalidateCache();
1690 * Generate a current or new-future timestamp to be stored in the
1691 * user_touched field when we update things.
1692 * @return \string Timestamp in TS_MW format
1694 private static function newTouchedTimestamp() {
1695 global $wgClockSkewFudge;
1696 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1700 * Clear user data from memcached.
1701 * Use after applying fun updates to the database; caller's
1702 * responsibility to update user_touched if appropriate.
1704 * Called implicitly from invalidateCache() and saveSettings().
1706 private function clearSharedCache() {
1710 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1715 * Immediately touch the user data cache for this account.
1716 * Updates user_touched field, and removes account data from memcached
1717 * for reload on the next hit.
1719 function invalidateCache() {
1720 if( wfReadOnly() ) {
1725 $this->mTouched
= self
::newTouchedTimestamp();
1727 $dbw = wfGetDB( DB_MASTER
);
1728 $dbw->update( 'user',
1729 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1730 array( 'user_id' => $this->mId
),
1733 $this->clearSharedCache();
1738 * Validate the cache for this account.
1739 * @param $timestamp \string A timestamp in TS_MW format
1741 function validateCache( $timestamp ) {
1743 return ( $timestamp >= $this->mTouched
);
1747 * Get the user touched timestamp
1749 function getTouched() {
1751 return $this->mTouched
;
1755 * Set the password and reset the random token.
1756 * Calls through to authentication plugin if necessary;
1757 * will have no effect if the auth plugin refuses to
1758 * pass the change through or if the legal password
1761 * As a special case, setting the password to null
1762 * wipes it, so the account cannot be logged in until
1763 * a new password is set, for instance via e-mail.
1765 * @param $str \string New password to set
1766 * @throws PasswordError on failure
1768 function setPassword( $str ) {
1771 if( $str !== null ) {
1772 if( !$wgAuth->allowPasswordChange() ) {
1773 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1776 if( !$this->isValidPassword( $str ) ) {
1777 global $wgMinimalPasswordLength;
1778 $valid = $this->getPasswordValidity( $str );
1779 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1780 $wgMinimalPasswordLength ) );
1784 if( !$wgAuth->setPassword( $this, $str ) ) {
1785 throw new PasswordError( wfMsg( 'externaldberror' ) );
1788 $this->setInternalPassword( $str );
1794 * Set the password and reset the random token unconditionally.
1796 * @param $str \string New password to set
1798 function setInternalPassword( $str ) {
1802 if( $str === null ) {
1803 // Save an invalid hash...
1804 $this->mPassword
= '';
1806 $this->mPassword
= self
::crypt( $str );
1808 $this->mNewpassword
= '';
1809 $this->mNewpassTime
= null;
1813 * Get the user's current token.
1814 * @return \string Token
1816 function getToken() {
1818 return $this->mToken
;
1822 * Set the random token (used for persistent authentication)
1823 * Called from loadDefaults() among other places.
1825 * @param $token \string If specified, set the token to this value
1828 function setToken( $token = false ) {
1829 global $wgSecretKey, $wgProxyKey;
1832 if ( $wgSecretKey ) {
1833 $key = $wgSecretKey;
1834 } elseif ( $wgProxyKey ) {
1839 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1841 $this->mToken
= $token;
1846 * Set the cookie password
1848 * @param $str \string New cookie password
1851 function setCookiePassword( $str ) {
1853 $this->mCookiePassword
= md5( $str );
1857 * Set the password for a password reminder or new account email
1859 * @param $str \string New password to set
1860 * @param $throttle \bool If true, reset the throttle timestamp to the present
1862 function setNewpassword( $str, $throttle = true ) {
1864 $this->mNewpassword
= self
::crypt( $str );
1866 $this->mNewpassTime
= wfTimestampNow();
1871 * Has password reminder email been sent within the last
1872 * $wgPasswordReminderResendTime hours?
1873 * @return \bool True or false
1875 function isPasswordReminderThrottled() {
1876 global $wgPasswordReminderResendTime;
1878 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1881 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1882 return time() < $expiry;
1886 * Get the user's e-mail address
1887 * @return \string User's email address
1889 function getEmail() {
1891 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1892 return $this->mEmail
;
1896 * Get the timestamp of the user's e-mail authentication
1897 * @return \string TS_MW timestamp
1899 function getEmailAuthenticationTimestamp() {
1901 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1902 return $this->mEmailAuthenticated
;
1906 * Set the user's e-mail address
1907 * @param $str \string New e-mail address
1909 function setEmail( $str ) {
1911 $this->mEmail
= $str;
1912 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1916 * Get the user's real name
1917 * @return \string User's real name
1919 function getRealName() {
1921 return $this->mRealName
;
1925 * Set the user's real name
1926 * @param $str \string New real name
1928 function setRealName( $str ) {
1930 $this->mRealName
= $str;
1934 * Get the user's current setting for a given option.
1936 * @param $oname \string The option to check
1937 * @param $defaultOverride \string A default value returned if the option does not exist
1938 * @return \string User's current value for the option
1939 * @see getBoolOption()
1940 * @see getIntOption()
1942 function getOption( $oname, $defaultOverride = null ) {
1943 $this->loadOptions();
1945 if ( is_null( $this->mOptions
) ) {
1946 if($defaultOverride != '') {
1947 return $defaultOverride;
1949 $this->mOptions
= User
::getDefaultOptions();
1952 if ( array_key_exists( $oname, $this->mOptions
) ) {
1953 return $this->mOptions
[$oname];
1955 return $defaultOverride;
1960 * Get the user's current setting for a given option, as a boolean value.
1962 * @param $oname \string The option to check
1963 * @return \bool User's current value for the option
1966 function getBoolOption( $oname ) {
1967 return (bool)$this->getOption( $oname );
1972 * Get the user's current setting for a given option, as a boolean value.
1974 * @param $oname \string The option to check
1975 * @param $defaultOverride \int A default value returned if the option does not exist
1976 * @return \int User's current value for the option
1979 function getIntOption( $oname, $defaultOverride=0 ) {
1980 $val = $this->getOption( $oname );
1982 $val = $defaultOverride;
1984 return intval( $val );
1988 * Set the given option for a user.
1990 * @param $oname \string The option to set
1991 * @param $val \mixed New value to set
1993 function setOption( $oname, $val ) {
1995 $this->loadOptions();
1997 if ( $oname == 'skin' ) {
1998 # Clear cached skin, so the new one displays immediately in Special:Preferences
1999 unset( $this->mSkin
);
2002 // Explicitly NULL values should refer to defaults
2003 global $wgDefaultUserOptions;
2004 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2005 $val = $wgDefaultUserOptions[$oname];
2008 $this->mOptions
[$oname] = $val;
2012 * Reset all options to the site defaults
2014 function resetOptions() {
2015 $this->mOptions
= User
::getDefaultOptions();
2019 * Get the user's preferred date format.
2020 * @return \string User's preferred date format
2022 function getDatePreference() {
2023 // Important migration for old data rows
2024 if ( is_null( $this->mDatePreference
) ) {
2026 $value = $this->getOption( 'date' );
2027 $map = $wgLang->getDatePreferenceMigrationMap();
2028 if ( isset( $map[$value] ) ) {
2029 $value = $map[$value];
2031 $this->mDatePreference
= $value;
2033 return $this->mDatePreference
;
2037 * Get the permissions this user has.
2038 * @return \type{\arrayof{\string}} Array of permission names
2040 function getRights() {
2041 if ( is_null( $this->mRights
) ) {
2042 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2043 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2044 // Force reindexation of rights when a hook has unset one of them
2045 $this->mRights
= array_values( $this->mRights
);
2047 return $this->mRights
;
2051 * Get the list of explicit group memberships this user has.
2052 * The implicit * and user groups are not included.
2053 * @return \type{\arrayof{\string}} Array of internal group names
2055 function getGroups() {
2057 return $this->mGroups
;
2061 * Get the list of implicit group memberships this user has.
2062 * This includes all explicit groups, plus 'user' if logged in,
2063 * '*' for all accounts and autopromoted groups
2064 * @param $recache \bool Whether to avoid the cache
2065 * @return \type{\arrayof{\string}} Array of internal group names
2067 function getEffectiveGroups( $recache = false ) {
2068 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2069 wfProfileIn( __METHOD__
);
2070 $this->mEffectiveGroups
= $this->getGroups();
2071 $this->mEffectiveGroups
[] = '*';
2072 if( $this->getId() ) {
2073 $this->mEffectiveGroups
[] = 'user';
2075 $this->mEffectiveGroups
= array_unique( array_merge(
2076 $this->mEffectiveGroups
,
2077 Autopromote
::getAutopromoteGroups( $this )
2080 # Hook for additional groups
2081 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2083 wfProfileOut( __METHOD__
);
2085 return $this->mEffectiveGroups
;
2089 * Get the user's edit count.
2090 * @return \int User'e edit count
2092 function getEditCount() {
2093 if( $this->getId() ) {
2094 if ( !isset( $this->mEditCount
) ) {
2095 /* Populate the count, if it has not been populated yet */
2096 $this->mEditCount
= User
::edits( $this->mId
);
2098 return $this->mEditCount
;
2106 * Add the user to the given group.
2107 * This takes immediate effect.
2108 * @param $group \string Name of the group to add
2110 function addGroup( $group ) {
2111 $dbw = wfGetDB( DB_MASTER
);
2112 if( $this->getId() ) {
2113 $dbw->insert( 'user_groups',
2115 'ug_user' => $this->getID(),
2116 'ug_group' => $group,
2119 array( 'IGNORE' ) );
2122 $this->loadGroups();
2123 $this->mGroups
[] = $group;
2124 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2126 $this->invalidateCache();
2130 * Remove the user from the given group.
2131 * This takes immediate effect.
2132 * @param $group \string Name of the group to remove
2134 function removeGroup( $group ) {
2136 $dbw = wfGetDB( DB_MASTER
);
2137 $dbw->delete( 'user_groups',
2139 'ug_user' => $this->getID(),
2140 'ug_group' => $group,
2142 'User::removeGroup' );
2144 $this->loadGroups();
2145 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2146 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2148 $this->invalidateCache();
2152 * Get whether the user is logged in
2153 * @return \bool True or false
2155 function isLoggedIn() {
2156 return $this->getID() != 0;
2160 * Get whether the user is anonymous
2161 * @return \bool True or false
2164 return !$this->isLoggedIn();
2168 * Get whether the user is a bot
2169 * @return \bool True or false
2173 wfDeprecated( __METHOD__
);
2174 return $this->isAllowed( 'bot' );
2178 * Check if user is allowed to access a feature / make an action
2179 * @param $action \string action to be checked
2180 * @return \bool True if action is allowed, else false
2182 function isAllowed( $action = '' ) {
2183 if ( $action === '' )
2184 return true; // In the spirit of DWIM
2185 # Patrolling may not be enabled
2186 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2187 global $wgUseRCPatrol, $wgUseNPPatrol;
2188 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2191 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2192 # by misconfiguration: 0 == 'foo'
2193 return in_array( $action, $this->getRights(), true );
2197 * Check whether to enable recent changes patrol features for this user
2198 * @return \bool True or false
2200 public function useRCPatrol() {
2201 global $wgUseRCPatrol;
2202 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2206 * Check whether to enable new pages patrol features for this user
2207 * @return \bool True or false
2209 public function useNPPatrol() {
2210 global $wgUseRCPatrol, $wgUseNPPatrol;
2211 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2215 * Get the current skin, loading it if required, and setting a title
2216 * @param $t Title: the title to use in the skin
2217 * @return Skin The current skin
2218 * @todo FIXME : need to check the old failback system [AV]
2220 function &getSkin( $t = null ) {
2221 if ( !isset( $this->mSkin
) ) {
2222 wfProfileIn( __METHOD__
);
2224 global $wgHiddenPrefs;
2225 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2228 $userSkin = $this->getOption( 'skin' );
2229 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2231 # if we're not allowing users to override, then use the default
2232 global $wgDefaultSkin;
2233 $userSkin = $wgDefaultSkin;
2236 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2237 wfProfileOut( __METHOD__
);
2239 if( $t ||
!$this->mSkin
->getTitle() ) {
2242 $t = $wgOut->getTitle();
2244 $this->mSkin
->setTitle( $t );
2246 return $this->mSkin
;
2250 * Check the watched status of an article.
2251 * @param $title \type{Title} Title of the article to look at
2252 * @return \bool True if article is watched
2254 function isWatched( $title ) {
2255 $wl = WatchedItem
::fromUserTitle( $this, $title );
2256 return $wl->isWatched();
2261 * @param $title \type{Title} Title of the article to look at
2263 function addWatch( $title ) {
2264 $wl = WatchedItem
::fromUserTitle( $this, $title );
2266 $this->invalidateCache();
2270 * Stop watching an article.
2271 * @param $title \type{Title} Title of the article to look at
2273 function removeWatch( $title ) {
2274 $wl = WatchedItem
::fromUserTitle( $this, $title );
2276 $this->invalidateCache();
2280 * Clear the user's notification timestamp for the given title.
2281 * If e-notif e-mails are on, they will receive notification mails on
2282 * the next change of the page if it's watched etc.
2283 * @param $title \type{Title} Title of the article to look at
2285 function clearNotification( &$title ) {
2286 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2288 # Do nothing if the database is locked to writes
2289 if( wfReadOnly() ) {
2293 if( $title->getNamespace() == NS_USER_TALK
&&
2294 $title->getText() == $this->getName() ) {
2295 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2297 $this->setNewtalk( false );
2300 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2304 if( $this->isAnon() ) {
2305 // Nothing else to do...
2309 // Only update the timestamp if the page is being watched.
2310 // The query to find out if it is watched is cached both in memcached and per-invocation,
2311 // and when it does have to be executed, it can be on a slave
2312 // If this is the user's newtalk page, we always update the timestamp
2313 if( $title->getNamespace() == NS_USER_TALK
&&
2314 $title->getText() == $wgUser->getName() )
2317 } elseif ( $this->getId() == $wgUser->getId() ) {
2318 $watched = $title->userIsWatching();
2323 // If the page is watched by the user (or may be watched), update the timestamp on any
2324 // any matching rows
2326 $dbw = wfGetDB( DB_MASTER
);
2327 $dbw->update( 'watchlist',
2329 'wl_notificationtimestamp' => NULL
2330 ), array( /* WHERE */
2331 'wl_title' => $title->getDBkey(),
2332 'wl_namespace' => $title->getNamespace(),
2333 'wl_user' => $this->getID()
2340 * Resets all of the given user's page-change notification timestamps.
2341 * If e-notif e-mails are on, they will receive notification mails on
2342 * the next change of any watched page.
2344 * @param $currentUser \int User ID
2346 function clearAllNotifications( $currentUser ) {
2347 global $wgUseEnotif, $wgShowUpdatedMarker;
2348 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2349 $this->setNewtalk( false );
2352 if( $currentUser != 0 ) {
2353 $dbw = wfGetDB( DB_MASTER
);
2354 $dbw->update( 'watchlist',
2356 'wl_notificationtimestamp' => NULL
2357 ), array( /* WHERE */
2358 'wl_user' => $currentUser
2361 # We also need to clear here the "you have new message" notification for the own user_talk page
2362 # This is cleared one page view later in Article::viewUpdates();
2367 * Set this user's options from an encoded string
2368 * @param $str \string Encoded options to import
2371 function decodeOptions( $str ) {
2375 $this->mOptionsLoaded
= true;
2376 $this->mOptionOverrides
= array();
2378 $this->mOptions
= array();
2379 $a = explode( "\n", $str );
2380 foreach ( $a as $s ) {
2382 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2383 $this->mOptions
[$m[1]] = $m[2];
2384 $this->mOptionOverrides
[$m[1]] = $m[2];
2390 * Set a cookie on the user's client. Wrapper for
2391 * WebResponse::setCookie
2392 * @param $name \string Name of the cookie to set
2393 * @param $value \string Value to set
2394 * @param $exp \int Expiration time, as a UNIX time value;
2395 * if 0 or not specified, use the default $wgCookieExpiration
2397 protected function setCookie( $name, $value, $exp = 0 ) {
2399 $wgRequest->response()->setcookie( $name, $value, $exp );
2403 * Clear a cookie on the user's client
2404 * @param $name \string Name of the cookie to clear
2406 protected function clearCookie( $name ) {
2407 $this->setCookie( $name, '', time() - 86400 );
2411 * Set the default cookies for this session on the user's client.
2413 function setCookies() {
2415 if ( 0 == $this->mId
) return;
2417 'wsUserID' => $this->mId
,
2418 'wsToken' => $this->mToken
,
2419 'wsUserName' => $this->getName()
2422 'UserID' => $this->mId
,
2423 'UserName' => $this->getName(),
2425 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2426 $cookies['Token'] = $this->mToken
;
2428 $cookies['Token'] = false;
2431 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2432 #check for null, since the hook could cause a null value
2433 if ( !is_null( $session ) && isset( $_SESSION ) ){
2434 $_SESSION = $session +
$_SESSION;
2436 foreach ( $cookies as $name => $value ) {
2437 if ( $value === false ) {
2438 $this->clearCookie( $name );
2440 $this->setCookie( $name, $value );
2446 * Log this user out.
2449 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2455 * Clear the user's cookies and session, and reset the instance cache.
2459 function doLogout() {
2460 $this->clearInstanceCache( 'defaults' );
2462 $_SESSION['wsUserID'] = 0;
2464 $this->clearCookie( 'UserID' );
2465 $this->clearCookie( 'Token' );
2467 # Remember when user logged out, to prevent seeing cached pages
2468 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2472 * Save this user's settings into the database.
2473 * @todo Only rarely do all these fields need to be set!
2475 function saveSettings() {
2477 if ( wfReadOnly() ) { return; }
2478 if ( 0 == $this->mId
) { return; }
2480 $this->mTouched
= self
::newTouchedTimestamp();
2482 $dbw = wfGetDB( DB_MASTER
);
2483 $dbw->update( 'user',
2485 'user_name' => $this->mName
,
2486 'user_password' => $this->mPassword
,
2487 'user_newpassword' => $this->mNewpassword
,
2488 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2489 'user_real_name' => $this->mRealName
,
2490 'user_email' => $this->mEmail
,
2491 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2492 'user_options' => '',
2493 'user_touched' => $dbw->timestamp( $this->mTouched
),
2494 'user_token' => $this->mToken
,
2495 'user_email_token' => $this->mEmailToken
,
2496 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2497 ), array( /* WHERE */
2498 'user_id' => $this->mId
2502 $this->saveOptions();
2504 wfRunHooks( 'UserSaveSettings', array( $this ) );
2505 $this->clearSharedCache();
2506 $this->getUserPage()->invalidateCache();
2510 * If only this user's username is known, and it exists, return the user ID.
2512 function idForName() {
2513 $s = trim( $this->getName() );
2514 if ( $s === '' ) return 0;
2516 $dbr = wfGetDB( DB_SLAVE
);
2517 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2518 if ( $id === false ) {
2525 * Add a user to the database, return the user object
2527 * @param $name \string Username to add
2528 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2529 * - password The user's password. Password logins will be disabled if this is omitted.
2530 * - newpassword A temporary password mailed to the user
2531 * - email The user's email address
2532 * - email_authenticated The email authentication timestamp
2533 * - real_name The user's real name
2534 * - options An associative array of non-default options
2535 * - token Random authentication token. Do not set.
2536 * - registration Registration timestamp. Do not set.
2538 * @return \type{User} A new User object, or null if the username already exists
2540 static function createNew( $name, $params = array() ) {
2543 if ( isset( $params['options'] ) ) {
2544 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2545 unset( $params['options'] );
2547 $dbw = wfGetDB( DB_MASTER
);
2548 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2550 'user_id' => $seqVal,
2551 'user_name' => $name,
2552 'user_password' => $user->mPassword
,
2553 'user_newpassword' => $user->mNewpassword
,
2554 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2555 'user_email' => $user->mEmail
,
2556 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2557 'user_real_name' => $user->mRealName
,
2558 'user_options' => '',
2559 'user_token' => $user->mToken
,
2560 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2561 'user_editcount' => 0,
2563 foreach ( $params as $name => $value ) {
2564 $fields["user_$name"] = $value;
2566 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2567 if ( $dbw->affectedRows() ) {
2568 $newUser = User
::newFromId( $dbw->insertId() );
2576 * Add this existing user object to the database
2578 function addToDatabase() {
2580 $dbw = wfGetDB( DB_MASTER
);
2581 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2582 $dbw->insert( 'user',
2584 'user_id' => $seqVal,
2585 'user_name' => $this->mName
,
2586 'user_password' => $this->mPassword
,
2587 'user_newpassword' => $this->mNewpassword
,
2588 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2589 'user_email' => $this->mEmail
,
2590 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2591 'user_real_name' => $this->mRealName
,
2592 'user_options' => '',
2593 'user_token' => $this->mToken
,
2594 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2595 'user_editcount' => 0,
2598 $this->mId
= $dbw->insertId();
2600 // Clear instance cache other than user table data, which is already accurate
2601 $this->clearInstanceCache();
2603 $this->saveOptions();
2607 * If this (non-anonymous) user is blocked, block any IP address
2608 * they've successfully logged in from.
2610 function spreadBlock() {
2611 wfDebug( __METHOD__
. "()\n" );
2613 if ( $this->mId
== 0 ) {
2617 $userblock = Block
::newFromDB( '', $this->mId
);
2618 if ( !$userblock ) {
2622 $userblock->doAutoblock( wfGetIP() );
2626 * Generate a string which will be different for any combination of
2627 * user options which would produce different parser output.
2628 * This will be used as part of the hash key for the parser cache,
2629 * so users with the same options can share the same cached data
2632 * Extensions which require it should install 'PageRenderingHash' hook,
2633 * which will give them a chance to modify this key based on their own
2636 * @return \string Page rendering hash
2638 function getPageRenderingHash() {
2639 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2641 return $this->mHash
;
2644 // stubthreshold is only included below for completeness,
2645 // it will always be 0 when this function is called by parsercache.
2647 $confstr = $this->getOption( 'math' );
2648 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2649 if ( $wgUseDynamicDates ) {
2650 $confstr .= '!' . $this->getDatePreference();
2652 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2653 $confstr .= '!' . $wgLang->getCode();
2654 $confstr .= '!' . $this->getOption( 'thumbsize' );
2655 // add in language specific options, if any
2656 $extra = $wgContLang->getExtraHashOptions();
2659 $confstr .= $wgRenderHashAppend;
2661 // Give a chance for extensions to modify the hash, if they have
2662 // extra options or other effects on the parser cache.
2663 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2665 // Make it a valid memcached key fragment
2666 $confstr = str_replace( ' ', '_', $confstr );
2667 $this->mHash
= $confstr;
2672 * Get whether the user is explicitly blocked from account creation.
2673 * @return \bool True if blocked
2675 function isBlockedFromCreateAccount() {
2676 $this->getBlockedStatus();
2677 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2681 * Get whether the user is blocked from using Special:Emailuser.
2682 * @return \bool True if blocked
2684 function isBlockedFromEmailuser() {
2685 $this->getBlockedStatus();
2686 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2690 * Get whether the user is allowed to create an account.
2691 * @return \bool True if allowed
2693 function isAllowedToCreateAccount() {
2694 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2700 function setLoaded( $loaded ) {
2701 wfDeprecated( __METHOD__
);
2705 * Get this user's personal page title.
2707 * @return \type{Title} User's personal page title
2709 function getUserPage() {
2710 return Title
::makeTitle( NS_USER
, $this->getName() );
2714 * Get this user's talk page title.
2716 * @return \type{Title} User's talk page title
2718 function getTalkPage() {
2719 $title = $this->getUserPage();
2720 return $title->getTalkPage();
2724 * Get the maximum valid user ID.
2725 * @return \int User ID
2728 function getMaxID() {
2729 static $res; // cache
2731 if ( isset( $res ) )
2734 $dbr = wfGetDB( DB_SLAVE
);
2735 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2740 * Determine whether the user is a newbie. Newbies are either
2741 * anonymous IPs, or the most recently created accounts.
2742 * @return \bool True if the user is a newbie
2744 function isNewbie() {
2745 return !$this->isAllowed( 'autoconfirmed' );
2749 * Check to see if the given clear-text password is one of the accepted passwords
2750 * @param $password \string user password.
2751 * @return \bool True if the given password is correct, otherwise False.
2753 function checkPassword( $password ) {
2757 // Even though we stop people from creating passwords that
2758 // are shorter than this, doesn't mean people wont be able
2759 // to. Certain authentication plugins do NOT want to save
2760 // domain passwords in a mysql database, so we should
2761 // check this (incase $wgAuth->strict() is false).
2762 if( !$this->isValidPassword( $password ) ) {
2766 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2768 } elseif( $wgAuth->strict() ) {
2769 /* Auth plugin doesn't allow local authentication */
2771 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2772 /* Auth plugin doesn't allow local authentication for this user name */
2775 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2777 } elseif ( function_exists( 'iconv' ) ) {
2778 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2779 # Check for this with iconv
2780 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2781 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2789 * Check if the given clear-text password matches the temporary password
2790 * sent by e-mail for password reset operations.
2791 * @return \bool True if matches, false otherwise
2793 function checkTemporaryPassword( $plaintext ) {
2794 global $wgNewPasswordExpiry;
2795 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2797 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2798 return ( time() < $expiry );
2805 * Initialize (if necessary) and return a session token value
2806 * which can be used in edit forms to show that the user's
2807 * login credentials aren't being hijacked with a foreign form
2810 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2811 * @return \string The new edit token
2813 function editToken( $salt = '' ) {
2814 if ( $this->isAnon() ) {
2815 return EDIT_TOKEN_SUFFIX
;
2817 if( !isset( $_SESSION['wsEditToken'] ) ) {
2818 $token = $this->generateToken();
2819 $_SESSION['wsEditToken'] = $token;
2821 $token = $_SESSION['wsEditToken'];
2823 if( is_array( $salt ) ) {
2824 $salt = implode( '|', $salt );
2826 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2831 * Generate a looking random token for various uses.
2833 * @param $salt \string Optional salt value
2834 * @return \string The new random token
2836 function generateToken( $salt = '' ) {
2837 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2838 return md5( $token . $salt );
2842 * Check given value against the token value stored in the session.
2843 * A match should confirm that the form was submitted from the
2844 * user's own login session, not a form submission from a third-party
2847 * @param $val \string Input value to compare
2848 * @param $salt \string Optional function-specific data for hashing
2849 * @return \bool Whether the token matches
2851 function matchEditToken( $val, $salt = '' ) {
2852 $sessionToken = $this->editToken( $salt );
2853 if ( $val != $sessionToken ) {
2854 wfDebug( "User::matchEditToken: broken session data\n" );
2856 return $val == $sessionToken;
2860 * Check given value against the token value stored in the session,
2861 * ignoring the suffix.
2863 * @param $val \string Input value to compare
2864 * @param $salt \string Optional function-specific data for hashing
2865 * @return \bool Whether the token matches
2867 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2868 $sessionToken = $this->editToken( $salt );
2869 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2873 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2874 * mail to the user's given address.
2876 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2878 function sendConfirmationMail() {
2880 $expiration = null; // gets passed-by-ref and defined in next line.
2881 $token = $this->confirmationToken( $expiration );
2882 $url = $this->confirmationTokenUrl( $token );
2883 $invalidateURL = $this->invalidationTokenUrl( $token );
2884 $this->saveSettings();
2886 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2887 wfMsg( 'confirmemail_body',
2891 $wgLang->timeanddate( $expiration, false ),
2893 $wgLang->date( $expiration, false ),
2894 $wgLang->time( $expiration, false ) ) );
2898 * Send an e-mail to this user's account. Does not check for
2899 * confirmed status or validity.
2901 * @param $subject \string Message subject
2902 * @param $body \string Message body
2903 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2904 * @param $replyto \string Reply-To address
2905 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2907 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2908 if( is_null( $from ) ) {
2909 global $wgPasswordSender;
2910 $from = $wgPasswordSender;
2913 $to = new MailAddress( $this );
2914 $sender = new MailAddress( $from );
2915 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2919 * Generate, store, and return a new e-mail confirmation code.
2920 * A hash (unsalted, since it's used as a key) is stored.
2922 * @note Call saveSettings() after calling this function to commit
2923 * this change to the database.
2925 * @param[out] &$expiration \mixed Accepts the expiration time
2926 * @return \string New token
2929 function confirmationToken( &$expiration ) {
2931 $expires = $now +
7 * 24 * 60 * 60;
2932 $expiration = wfTimestamp( TS_MW
, $expires );
2933 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2934 $hash = md5( $token );
2936 $this->mEmailToken
= $hash;
2937 $this->mEmailTokenExpires
= $expiration;
2942 * Return a URL the user can use to confirm their email address.
2943 * @param $token \string Accepts the email confirmation token
2944 * @return \string New token URL
2947 function confirmationTokenUrl( $token ) {
2948 return $this->getTokenUrl( 'ConfirmEmail', $token );
2952 * Return a URL the user can use to invalidate their email address.
2953 * @param $token \string Accepts the email confirmation token
2954 * @return \string New token URL
2957 function invalidationTokenUrl( $token ) {
2958 return $this->getTokenUrl( 'Invalidateemail', $token );
2962 * Internal function to format the e-mail validation/invalidation URLs.
2963 * This uses $wgArticlePath directly as a quickie hack to use the
2964 * hardcoded English names of the Special: pages, for ASCII safety.
2966 * @note Since these URLs get dropped directly into emails, using the
2967 * short English names avoids insanely long URL-encoded links, which
2968 * also sometimes can get corrupted in some browsers/mailers
2969 * (bug 6957 with Gmail and Internet Explorer).
2971 * @param $page \string Special page
2972 * @param $token \string Token
2973 * @return \string Formatted URL
2975 protected function getTokenUrl( $page, $token ) {
2976 global $wgArticlePath;
2980 "Special:$page/$token",
2985 * Mark the e-mail address confirmed.
2987 * @note Call saveSettings() after calling this function to commit the change.
2989 function confirmEmail() {
2990 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2991 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
2996 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2997 * address if it was already confirmed.
2999 * @note Call saveSettings() after calling this function to commit the change.
3001 function invalidateEmail() {
3003 $this->mEmailToken
= null;
3004 $this->mEmailTokenExpires
= null;
3005 $this->setEmailAuthenticationTimestamp( null );
3006 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3011 * Set the e-mail authentication timestamp.
3012 * @param $timestamp \string TS_MW timestamp
3014 function setEmailAuthenticationTimestamp( $timestamp ) {
3016 $this->mEmailAuthenticated
= $timestamp;
3017 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3021 * Is this user allowed to send e-mails within limits of current
3022 * site configuration?
3023 * @return \bool True if allowed
3025 function canSendEmail() {
3026 global $wgEnableEmail, $wgEnableUserEmail, $wgUser;
3027 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$wgUser->isAllowed( 'sendemail' ) ) {
3030 $canSend = $this->isEmailConfirmed();
3031 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3036 * Is this user allowed to receive e-mails within limits of current
3037 * site configuration?
3038 * @return \bool True if allowed
3040 function canReceiveEmail() {
3041 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3045 * Is this user's e-mail address valid-looking and confirmed within
3046 * limits of the current site configuration?
3048 * @note If $wgEmailAuthentication is on, this may require the user to have
3049 * confirmed their address by returning a code or using a password
3050 * sent to the address from the wiki.
3052 * @return \bool True if confirmed
3054 function isEmailConfirmed() {
3055 global $wgEmailAuthentication;
3058 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3059 if( $this->isAnon() )
3061 if( !self
::isValidEmailAddr( $this->mEmail
) )
3063 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3072 * Check whether there is an outstanding request for e-mail confirmation.
3073 * @return \bool True if pending
3075 function isEmailConfirmationPending() {
3076 global $wgEmailAuthentication;
3077 return $wgEmailAuthentication &&
3078 !$this->isEmailConfirmed() &&
3079 $this->mEmailToken
&&
3080 $this->mEmailTokenExpires
> wfTimestamp();
3084 * Get the timestamp of account creation.
3086 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3087 * non-existent/anonymous user accounts.
3089 public function getRegistration() {
3090 return $this->getId() > 0
3091 ?
$this->mRegistration
3096 * Get the timestamp of the first edit
3098 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3099 * non-existent/anonymous user accounts.
3101 public function getFirstEditTimestamp() {
3102 if( $this->getId() == 0 ) return false; // anons
3103 $dbr = wfGetDB( DB_SLAVE
);
3104 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3105 array( 'rev_user' => $this->getId() ),
3107 array( 'ORDER BY' => 'rev_timestamp ASC' )
3109 if( !$time ) return false; // no edits
3110 return wfTimestamp( TS_MW
, $time );
3114 * Get the permissions associated with a given list of groups
3116 * @param $groups \type{\arrayof{\string}} List of internal group names
3117 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3119 static function getGroupPermissions( $groups ) {
3120 global $wgGroupPermissions, $wgRevokePermissions;
3122 // grant every granted permission first
3123 foreach( $groups as $group ) {
3124 if( isset( $wgGroupPermissions[$group] ) ) {
3125 $rights = array_merge( $rights,
3126 // array_filter removes empty items
3127 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3130 // now revoke the revoked permissions
3131 foreach( $groups as $group ) {
3132 if( isset( $wgRevokePermissions[$group] ) ) {
3133 $rights = array_diff( $rights,
3134 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3137 return array_unique( $rights );
3141 * Get all the groups who have a given permission
3143 * @param $role \string Role to check
3144 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3146 static function getGroupsWithPermission( $role ) {
3147 global $wgGroupPermissions;
3148 $allowedGroups = array();
3149 foreach ( $wgGroupPermissions as $group => $rights ) {
3150 if ( isset( $rights[$role] ) && $rights[$role] ) {
3151 $allowedGroups[] = $group;
3154 return $allowedGroups;
3158 * Get the localized descriptive name for a group, if it exists
3160 * @param $group \string Internal group name
3161 * @return \string Localized descriptive group name
3163 static function getGroupName( $group ) {
3164 global $wgMessageCache;
3165 $wgMessageCache->loadAllMessages();
3166 $key = "group-$group";
3167 $name = wfMsg( $key );
3168 return $name == '' ||
wfEmptyMsg( $key, $name )
3174 * Get the localized descriptive name for a member of a group, if it exists
3176 * @param $group \string Internal group name
3177 * @return \string Localized name for group member
3179 static function getGroupMember( $group ) {
3180 global $wgMessageCache;
3181 $wgMessageCache->loadAllMessages();
3182 $key = "group-$group-member";
3183 $name = wfMsg( $key );
3184 return $name == '' ||
wfEmptyMsg( $key, $name )
3190 * Return the set of defined explicit groups.
3191 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3192 * are not included, as they are defined automatically, not in the database.
3193 * @return \type{\arrayof{\string}} Array of internal group names
3195 static function getAllGroups() {
3196 global $wgGroupPermissions, $wgRevokePermissions;
3198 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3199 self
::getImplicitGroups()
3204 * Get a list of all available permissions.
3205 * @return \type{\arrayof{\string}} Array of permission names
3207 static function getAllRights() {
3208 if ( self
::$mAllRights === false ) {
3209 global $wgAvailableRights;
3210 if ( count( $wgAvailableRights ) ) {
3211 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3213 self
::$mAllRights = self
::$mCoreRights;
3215 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3217 return self
::$mAllRights;
3221 * Get a list of implicit groups
3222 * @return \type{\arrayof{\string}} Array of internal group names
3224 public static function getImplicitGroups() {
3225 global $wgImplicitGroups;
3226 $groups = $wgImplicitGroups;
3227 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3232 * Get the title of a page describing a particular group
3234 * @param $group \string Internal group name
3235 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3237 static function getGroupPage( $group ) {
3238 global $wgMessageCache;
3239 $wgMessageCache->loadAllMessages();
3240 $page = wfMsgForContent( 'grouppage-' . $group );
3241 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3242 $title = Title
::newFromText( $page );
3243 if( is_object( $title ) )
3250 * Create a link to the group in HTML, if available;
3251 * else return the group name.
3253 * @param $group \string Internal name of the group
3254 * @param $text \string The text of the link
3255 * @return \string HTML link to the group
3257 static function makeGroupLinkHTML( $group, $text = '' ) {
3259 $text = self
::getGroupName( $group );
3261 $title = self
::getGroupPage( $group );
3264 $sk = $wgUser->getSkin();
3265 return $sk->link( $title, htmlspecialchars( $text ) );
3272 * Create a link to the group in Wikitext, if available;
3273 * else return the group name.
3275 * @param $group \string Internal name of the group
3276 * @param $text \string The text of the link
3277 * @return \string Wikilink to the group
3279 static function makeGroupLinkWiki( $group, $text = '' ) {
3281 $text = self
::getGroupName( $group );
3283 $title = self
::getGroupPage( $group );
3285 $page = $title->getPrefixedText();
3286 return "[[$page|$text]]";
3293 * Returns an array of the groups that a particular group can add/remove.
3295 * @param $group String: the group to check for whether it can add/remove
3296 * @return Array array( 'add' => array( addablegroups ),
3297 * 'remove' => array( removablegroups ),
3298 * 'add-self' => array( addablegroups to self),
3299 * 'remove-self' => array( removable groups from self) )
3301 static function changeableByGroup( $group ) {
3302 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3304 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3305 if( empty( $wgAddGroups[$group] ) ) {
3306 // Don't add anything to $groups
3307 } elseif( $wgAddGroups[$group] === true ) {
3308 // You get everything
3309 $groups['add'] = self
::getAllGroups();
3310 } elseif( is_array( $wgAddGroups[$group] ) ) {
3311 $groups['add'] = $wgAddGroups[$group];
3314 // Same thing for remove
3315 if( empty( $wgRemoveGroups[$group] ) ) {
3316 } elseif( $wgRemoveGroups[$group] === true ) {
3317 $groups['remove'] = self
::getAllGroups();
3318 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3319 $groups['remove'] = $wgRemoveGroups[$group];
3322 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3323 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3324 foreach( $wgGroupsAddToSelf as $key => $value ) {
3325 if( is_int( $key ) ) {
3326 $wgGroupsAddToSelf['user'][] = $value;
3331 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3332 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3333 if( is_int( $key ) ) {
3334 $wgGroupsRemoveFromSelf['user'][] = $value;
3339 // Now figure out what groups the user can add to him/herself
3340 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3341 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3342 // No idea WHY this would be used, but it's there
3343 $groups['add-self'] = User
::getAllGroups();
3344 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3345 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3348 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3349 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3350 $groups['remove-self'] = User
::getAllGroups();
3351 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3352 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3359 * Returns an array of groups that this user can add and remove
3360 * @return Array array( 'add' => array( addablegroups ),
3361 * 'remove' => array( removablegroups ),
3362 * 'add-self' => array( addablegroups to self),
3363 * 'remove-self' => array( removable groups from self) )
3365 function changeableGroups() {
3366 if( $this->isAllowed( 'userrights' ) ) {
3367 // This group gives the right to modify everything (reverse-
3368 // compatibility with old "userrights lets you change
3370 // Using array_merge to make the groups reindexed
3371 $all = array_merge( User
::getAllGroups() );
3375 'add-self' => array(),
3376 'remove-self' => array()
3380 // Okay, it's not so simple, we will have to go through the arrays
3383 'remove' => array(),
3384 'add-self' => array(),
3385 'remove-self' => array()
3387 $addergroups = $this->getEffectiveGroups();
3389 foreach( $addergroups as $addergroup ) {
3390 $groups = array_merge_recursive(
3391 $groups, $this->changeableByGroup( $addergroup )
3393 $groups['add'] = array_unique( $groups['add'] );
3394 $groups['remove'] = array_unique( $groups['remove'] );
3395 $groups['add-self'] = array_unique( $groups['add-self'] );
3396 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3402 * Increment the user's edit-count field.
3403 * Will have no effect for anonymous users.
3405 function incEditCount() {
3406 if( !$this->isAnon() ) {
3407 $dbw = wfGetDB( DB_MASTER
);
3408 $dbw->update( 'user',
3409 array( 'user_editcount=user_editcount+1' ),
3410 array( 'user_id' => $this->getId() ),
3413 // Lazy initialization check...
3414 if( $dbw->affectedRows() == 0 ) {
3415 // Pull from a slave to be less cruel to servers
3416 // Accuracy isn't the point anyway here
3417 $dbr = wfGetDB( DB_SLAVE
);
3418 $count = $dbr->selectField( 'revision',
3420 array( 'rev_user' => $this->getId() ),
3423 // Now here's a goddamn hack...
3424 if( $dbr !== $dbw ) {
3425 // If we actually have a slave server, the count is
3426 // at least one behind because the current transaction
3427 // has not been committed and replicated.
3430 // But if DB_SLAVE is selecting the master, then the
3431 // count we just read includes the revision that was
3432 // just added in the working transaction.
3435 $dbw->update( 'user',
3436 array( 'user_editcount' => $count ),
3437 array( 'user_id' => $this->getId() ),
3441 // edit count in user cache too
3442 $this->invalidateCache();
3446 * Get the description of a given right
3448 * @param $right \string Right to query
3449 * @return \string Localized description of the right
3451 static function getRightDescription( $right ) {
3452 global $wgMessageCache;
3453 $wgMessageCache->loadAllMessages();
3454 $key = "right-$right";
3455 $name = wfMsg( $key );
3456 return $name == '' ||
wfEmptyMsg( $key, $name )
3462 * Make an old-style password hash
3464 * @param $password \string Plain-text password
3465 * @param $userId \string User ID
3466 * @return \string Password hash
3468 static function oldCrypt( $password, $userId ) {
3469 global $wgPasswordSalt;
3470 if ( $wgPasswordSalt ) {
3471 return md5( $userId . '-' . md5( $password ) );
3473 return md5( $password );
3478 * Make a new-style password hash
3480 * @param $password \string Plain-text password
3481 * @param $salt \string Optional salt, may be random or the user ID.
3482 * If unspecified or false, will generate one automatically
3483 * @return \string Password hash
3485 static function crypt( $password, $salt = false ) {
3486 global $wgPasswordSalt;
3489 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3493 if( $wgPasswordSalt ) {
3494 if ( $salt === false ) {
3495 $salt = substr( wfGenerateToken(), 0, 8 );
3497 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3499 return ':A:' . md5( $password );
3504 * Compare a password hash with a plain-text password. Requires the user
3505 * ID if there's a chance that the hash is an old-style hash.
3507 * @param $hash \string Password hash
3508 * @param $password \string Plain-text password to compare
3509 * @param $userId \string User ID for old-style password salt
3512 static function comparePasswords( $hash, $password, $userId = false ) {
3514 $type = substr( $hash, 0, 3 );
3517 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3521 if ( $type == ':A:' ) {
3523 return md5( $password ) === substr( $hash, 3 );
3524 } elseif ( $type == ':B:' ) {
3526 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3527 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3530 return self
::oldCrypt( $password, $userId ) === $hash;
3535 * Add a newuser log entry for this user
3536 * @param $byEmail Boolean: account made by email?
3538 public function addNewUserLogEntry( $byEmail = false ) {
3539 global $wgUser, $wgContLang, $wgNewUserLog;
3540 if( empty( $wgNewUserLog ) ) {
3541 return true; // disabled
3543 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3544 if( $this->getName() == $wgUser->getName() ) {
3548 $action = 'create2';
3550 ?
wfMsgForContent( 'newuserlog-byemail' )
3553 $log = new LogPage( 'newusers' );
3556 $this->getUserPage(),
3558 array( $this->getId() )
3564 * Add an autocreate newuser log entry for this user
3565 * Used by things like CentralAuth and perhaps other authplugins.
3567 public function addNewUserLogEntryAutoCreate() {
3568 global $wgNewUserLog;
3569 if( empty( $wgNewUserLog ) ) {
3570 return true; // disabled
3572 $log = new LogPage( 'newusers', false );
3573 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3577 protected function loadOptions() {
3579 if ( $this->mOptionsLoaded ||
!$this->getId() )
3582 $this->mOptions
= self
::getDefaultOptions();
3584 // Maybe load from the object
3585 if ( !is_null( $this->mOptionOverrides
) ) {
3586 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3587 foreach( $this->mOptionOverrides
as $key => $value ) {
3588 $this->mOptions
[$key] = $value;
3591 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3592 // Load from database
3593 $dbr = wfGetDB( DB_SLAVE
);
3595 $res = $dbr->select(
3598 array( 'up_user' => $this->getId() ),
3602 while( $row = $dbr->fetchObject( $res ) ) {
3603 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3604 $this->mOptions
[$row->up_property
] = $row->up_value
;
3608 $this->mOptionsLoaded
= true;
3610 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3613 protected function saveOptions() {
3614 global $wgAllowPrefChange;
3616 $extuser = ExternalUser
::newFromUser( $this );
3618 $this->loadOptions();
3619 $dbw = wfGetDB( DB_MASTER
);
3621 $insert_rows = array();
3623 $saveOptions = $this->mOptions
;
3625 // Allow hooks to abort, for instance to save to a global profile.
3626 // Reset options to default state before saving.
3627 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3630 foreach( $saveOptions as $key => $value ) {
3631 # Don't bother storing default values
3632 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3633 !( $value === false ||
is_null($value) ) ) ||
3634 $value != self
::getDefaultOption( $key ) ) {
3635 $insert_rows[] = array(
3636 'up_user' => $this->getId(),
3637 'up_property' => $key,
3638 'up_value' => $value,
3641 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3642 switch ( $wgAllowPrefChange[$key] ) {
3648 $extuser->setPref( $key, $value );
3654 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3655 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3660 * Provide an array of HTML 5 attributes to put on an input element
3661 * intended for the user to enter a new password. This may include
3662 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3664 * Do *not* use this when asking the user to enter his current password!
3665 * Regardless of configuration, users may have invalid passwords for whatever
3666 * reason (e.g., they were set before requirements were tightened up).
3667 * Only use it when asking for a new password, like on account creation or
3670 * Obviously, you still need to do server-side checking.
3672 * @return array Array of HTML attributes suitable for feeding to
3673 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3674 * That will potentially output invalid XHTML 1.0 Transitional, and will
3675 * get confused by the boolean attribute syntax used.)
3677 public static function passwordChangeInputAttribs() {
3678 global $wgMinimalPasswordLength;
3680 if ( $wgMinimalPasswordLength == 0 ) {
3684 # Note that the pattern requirement will always be satisfied if the
3685 # input is empty, so we need required in all cases.
3686 $ret = array( 'required' );
3688 # We can't actually do this right now, because Opera 9.6 will print out
3689 # the entered password visibly in its error message! When other
3690 # browsers add support for this attribute, or Opera fixes its support,
3691 # we can add support with a version check to avoid doing this on Opera
3692 # versions where it will be a problem. Reported to Opera as
3693 # DSK-262266, but they don't have a public bug tracker for us to follow.
3695 if ( $wgMinimalPasswordLength > 1 ) {
3696 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3697 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3698 $wgMinimalPasswordLength );