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 false if the username is invalid
349 * (e.g. if it contains illegal characters or is an IP address). If the
350 * username is not present in the database, the result will be a user object
351 * with a name, zero user ID and default settings.
353 static function newFromName( $name, $validate = 'valid' ) {
354 if ( $validate === true ) {
357 $name = self
::getCanonicalName( $name, $validate );
358 if ( $name === false ) {
361 # Create unloaded user object
370 * Static factory method for creation from a given user ID.
372 * @param $id \int Valid user ID
373 * @return \type{User} The corresponding User object
375 static function newFromId( $id ) {
383 * Factory method to fetch whichever user has a given email confirmation code.
384 * This code is generated when an account is created or its e-mail address
387 * If the code is invalid or has expired, returns NULL.
389 * @param $code \string Confirmation code
390 * @return \type{User}
392 static function newFromConfirmationCode( $code ) {
393 $dbr = wfGetDB( DB_SLAVE
);
394 $id = $dbr->selectField( 'user', 'user_id', array(
395 'user_email_token' => md5( $code ),
396 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
398 if( $id !== false ) {
399 return User
::newFromId( $id );
406 * Create a new user object using data from session or cookies. If the
407 * login credentials are invalid, the result is an anonymous user.
409 * @return \type{User}
411 static function newFromSession() {
413 $user->mFrom
= 'session';
418 * Create a new user object from a user row.
419 * The row should have all fields from the user table in it.
420 * @param $row array A row from the user table
421 * @return \type{User}
423 static function newFromRow( $row ) {
425 $user->loadFromRow( $row );
433 * Get the username corresponding to a given user ID
434 * @param $id \int User ID
435 * @return \string The corresponding username
437 static function whoIs( $id ) {
438 $dbr = wfGetDB( DB_SLAVE
);
439 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
443 * Get the real name of a user given their user ID
445 * @param $id \int User ID
446 * @return \string The corresponding user's real name
448 static function whoIsReal( $id ) {
449 $dbr = wfGetDB( DB_SLAVE
);
450 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
454 * Get database id given a user name
455 * @param $name \string Username
456 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
458 static function idFromName( $name ) {
459 $nt = Title
::makeTitleSafe( NS_USER
, $name );
460 if( is_null( $nt ) ) {
465 if ( isset( self
::$idCacheByName[$name] ) ) {
466 return self
::$idCacheByName[$name];
469 $dbr = wfGetDB( DB_SLAVE
);
470 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
472 if ( $s === false ) {
475 $result = $s->user_id
;
478 self
::$idCacheByName[$name] = $result;
480 if ( count( self
::$idCacheByName ) > 1000 ) {
481 self
::$idCacheByName = array();
488 * Does the string match an anonymous IPv4 address?
490 * This function exists for username validation, in order to reject
491 * usernames which are similar in form to IP addresses. Strings such
492 * as 300.300.300.300 will return true because it looks like an IP
493 * address, despite not being strictly valid.
495 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
496 * address because the usemod software would "cloak" anonymous IP
497 * addresses like this, if we allowed accounts like this to be created
498 * new users could get the old edits of these anonymous users.
500 * @param $name \string String to match
501 * @return \bool True or false
503 static function isIP( $name ) {
504 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
508 * Is the input a valid username?
510 * Checks if the input is a valid username, we don't want an empty string,
511 * an IP address, anything that containins slashes (would mess up subpages),
512 * is longer than the maximum allowed username size or doesn't begin with
515 * @param $name \string String to match
516 * @return \bool True or false
518 static function isValidUserName( $name ) {
519 global $wgContLang, $wgMaxNameChars;
522 || User
::isIP( $name )
523 ||
strpos( $name, '/' ) !== false
524 ||
strlen( $name ) > $wgMaxNameChars
525 ||
$name != $wgContLang->ucfirst( $name ) ) {
526 wfDebugLog( 'username', __METHOD__
.
527 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
531 // Ensure that the name can't be misresolved as a different title,
532 // such as with extra namespace keys at the start.
533 $parsed = Title
::newFromText( $name );
534 if( is_null( $parsed )
535 ||
$parsed->getNamespace()
536 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
537 wfDebugLog( 'username', __METHOD__
.
538 ": '$name' invalid due to ambiguous prefixes" );
542 // Check an additional blacklist of troublemaker characters.
543 // Should these be merged into the title char list?
544 $unicodeBlacklist = '/[' .
545 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
546 '\x{00a0}' . # non-breaking space
547 '\x{2000}-\x{200f}' . # various whitespace
548 '\x{2028}-\x{202f}' . # breaks and control chars
549 '\x{3000}' . # ideographic space
550 '\x{e000}-\x{f8ff}' . # private use
552 if( preg_match( $unicodeBlacklist, $name ) ) {
553 wfDebugLog( 'username', __METHOD__
.
554 ": '$name' invalid due to blacklisted characters" );
562 * Usernames which fail to pass this function will be blocked
563 * from user login and new account registrations, but may be used
564 * internally by batch processes.
566 * If an account already exists in this form, login will be blocked
567 * by a failure to pass this function.
569 * @param $name \string String to match
570 * @return \bool True or false
572 static function isUsableName( $name ) {
573 global $wgReservedUsernames;
574 // Must be a valid username, obviously ;)
575 if ( !self
::isValidUserName( $name ) ) {
579 static $reservedUsernames = false;
580 if ( !$reservedUsernames ) {
581 $reservedUsernames = $wgReservedUsernames;
582 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
585 // Certain names may be reserved for batch processes.
586 foreach ( $reservedUsernames as $reserved ) {
587 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
588 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
590 if ( $reserved == $name ) {
598 * Usernames which fail to pass this function will be blocked
599 * from new account registrations, but may be used internally
600 * either by batch processes or by user accounts which have
601 * already been created.
603 * Additional character blacklisting may be added here
604 * rather than in isValidUserName() to avoid disrupting
607 * @param $name \string String to match
608 * @return \bool True or false
610 static function isCreatableName( $name ) {
611 global $wgInvalidUsernameCharacters;
613 self
::isUsableName( $name ) &&
615 // Registration-time character blacklisting...
616 !preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name );
620 * Is the input a valid password for this user?
622 * @param $password String Desired password
623 * @return bool True or false
625 function isValidPassword( $password ) {
626 //simple boolean wrapper for getPasswordValidity
627 return $this->getPasswordValidity( $password ) === true;
631 * Given unvalidated password input, return error message on failure.
633 * @param $password String Desired password
634 * @return mixed: true on success, string of error message on failure
636 function getPasswordValidity( $password ) {
637 global $wgMinimalPasswordLength, $wgContLang;
639 $result = false; //init $result to false for the internal checks
641 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
644 if ( $result === false ) {
645 if( strlen( $password ) < $wgMinimalPasswordLength ) {
646 return 'passwordtooshort';
647 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
648 return 'password-name-match';
650 //it seems weird returning true here, but this is because of the
651 //initialization of $result to false above. If the hook is never run or it
652 //doesn't modify $result, then we will likely get down into this if with
656 } elseif( $result === true ) {
659 return $result; //the isValidPassword hook set a string $result and returned true
664 * Does a string look like an e-mail address?
666 * There used to be a regular expression here, it got removed because it
667 * rejected valid addresses. Actually just check if there is '@' somewhere
668 * in the given address.
670 * @todo Check for RFC 2822 compilance (bug 959)
672 * @param $addr \string E-mail address
673 * @return \bool True or false
675 public static function isValidEmailAddr( $addr ) {
677 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
681 return strpos( $addr, '@' ) !== false;
685 * Given unvalidated user input, return a canonical username, or false if
686 * the username is invalid.
687 * @param $name \string User input
688 * @param $validate \types{\string,\bool} Type of validation to use:
689 * - false No validation
690 * - 'valid' Valid for batch processes
691 * - 'usable' Valid for batch processes and login
692 * - 'creatable' Valid for batch processes, login and account creation
694 static function getCanonicalName( $name, $validate = 'valid' ) {
695 # Force usernames to capital
697 $name = $wgContLang->ucfirst( $name );
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 )
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, $wgExternalAuthType, $wgAutocreatePolicy;
855 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
856 if ( $result !== null ) {
860 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
861 $extUser = ExternalUser
::newFromCookie();
863 # TODO: Automatically create the user here (or probably a bit
864 # lower down, in fact)
868 if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
869 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
870 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
871 $this->loadDefaults(); // Possible collision!
872 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
873 cookie user ID ($sId) don't match!" );
876 $_SESSION['wsUserID'] = $sId;
877 } else if ( isset( $_SESSION['wsUserID'] ) ) {
878 if ( $_SESSION['wsUserID'] != 0 ) {
879 $sId = $_SESSION['wsUserID'];
881 $this->loadDefaults();
885 $this->loadDefaults();
889 if ( isset( $_SESSION['wsUserName'] ) ) {
890 $sName = $_SESSION['wsUserName'];
891 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
892 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
893 $_SESSION['wsUserName'] = $sName;
895 $this->loadDefaults();
899 $passwordCorrect = FALSE;
901 if ( !$this->loadFromId() ) {
902 # Not a valid ID, loadFromId has switched the object to anon for us
906 global $wgBlockDisablesLogin;
907 if( $wgBlockDisablesLogin && $this->isBlocked() ) {
908 # User blocked and we've disabled blocked user logins
909 $this->loadDefaults();
913 if ( isset( $_SESSION['wsToken'] ) ) {
914 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
916 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
917 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
920 # No session or persistent login cookie
921 $this->loadDefaults();
925 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
926 $_SESSION['wsToken'] = $this->mToken
;
927 wfDebug( "Logged in from $from\n" );
930 # Invalid credentials
931 wfDebug( "Can't log in from $from, invalid credentials\n" );
932 $this->loadDefaults();
938 * Load user and user_group data from the database.
939 * $this::mId must be set, this is how the user is identified.
941 * @return \bool True if the user exists, false if the user is anonymous
944 function loadFromDatabase() {
946 $this->mId
= intval( $this->mId
);
948 /** Anonymous user */
950 $this->loadDefaults();
954 $dbr = wfGetDB( DB_MASTER
);
955 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
957 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
959 if ( $s !== false ) {
960 # Initialise user table data
961 $this->loadFromRow( $s );
962 $this->mGroups
= null; // deferred
963 $this->getEditCount(); // revalidation for nulls
968 $this->loadDefaults();
974 * Initialize this object from a row from the user table.
976 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
978 function loadFromRow( $row ) {
979 $this->mDataLoaded
= true;
981 if ( isset( $row->user_id
) ) {
982 $this->mId
= intval( $row->user_id
);
984 $this->mName
= $row->user_name
;
985 $this->mRealName
= $row->user_real_name
;
986 $this->mPassword
= $row->user_password
;
987 $this->mNewpassword
= $row->user_newpassword
;
988 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
989 $this->mEmail
= $row->user_email
;
990 $this->decodeOptions( $row->user_options
);
991 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
992 $this->mToken
= $row->user_token
;
993 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
994 $this->mEmailToken
= $row->user_email_token
;
995 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
996 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
997 $this->mEditCount
= $row->user_editcount
;
1001 * Load the groups from the database if they aren't already loaded.
1004 function loadGroups() {
1005 if ( is_null( $this->mGroups
) ) {
1006 $dbr = wfGetDB( DB_MASTER
);
1007 $res = $dbr->select( 'user_groups',
1008 array( 'ug_group' ),
1009 array( 'ug_user' => $this->mId
),
1011 $this->mGroups
= array();
1012 while( $row = $dbr->fetchObject( $res ) ) {
1013 $this->mGroups
[] = $row->ug_group
;
1019 * Clear various cached data stored in this object.
1020 * @param $reloadFrom \string Reload user and user_groups table data from a
1021 * given source. May be "name", "id", "defaults", "session", or false for
1024 function clearInstanceCache( $reloadFrom = false ) {
1025 $this->mNewtalk
= -1;
1026 $this->mDatePreference
= null;
1027 $this->mBlockedby
= -1; # Unset
1028 $this->mHash
= false;
1029 $this->mSkin
= null;
1030 $this->mRights
= null;
1031 $this->mEffectiveGroups
= null;
1032 $this->mOptions
= null;
1034 if ( $reloadFrom ) {
1035 $this->mDataLoaded
= false;
1036 $this->mFrom
= $reloadFrom;
1041 * Combine the language default options with any site-specific options
1042 * and add the default language variants.
1044 * @return \type{\arrayof{\string}} Array of options
1046 static function getDefaultOptions() {
1047 global $wgNamespacesToBeSearchedDefault;
1049 * Site defaults will override the global/language defaults
1051 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1052 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1055 * default language setting
1057 $variant = $wgContLang->getPreferredVariant( false );
1058 $defOpt['variant'] = $variant;
1059 $defOpt['language'] = $variant;
1060 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1061 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1063 $defOpt['skin'] = $wgDefaultSkin;
1069 * Get a given default option value.
1071 * @param $opt \string Name of option to retrieve
1072 * @return \string Default option value
1074 public static function getDefaultOption( $opt ) {
1075 $defOpts = self
::getDefaultOptions();
1076 if( isset( $defOpts[$opt] ) ) {
1077 return $defOpts[$opt];
1084 * Get a list of user toggle names
1085 * @return \type{\arrayof{\string}} Array of user toggle names
1087 static function getToggles() {
1088 global $wgContLang, $wgUseRCPatrol;
1089 $extraToggles = array();
1090 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1091 if( $wgUseRCPatrol ) {
1092 $extraToggles[] = 'hidepatrolled';
1093 $extraToggles[] = 'newpageshidepatrolled';
1094 $extraToggles[] = 'watchlisthidepatrolled';
1096 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1101 * Get blocking information
1103 * @param $bFromSlave \bool Whether to check the slave database first. To
1104 * improve performance, non-critical checks are done
1105 * against slaves. Check when actually saving should be
1106 * done against master.
1108 function getBlockedStatus( $bFromSlave = true ) {
1109 global $wgProxyWhitelist, $wgUser;
1111 if ( -1 != $this->mBlockedby
) {
1112 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1116 wfProfileIn( __METHOD__
);
1117 wfDebug( __METHOD__
.": checking...\n" );
1119 // Initialize data...
1120 // Otherwise something ends up stomping on $this->mBlockedby when
1121 // things get lazy-loaded later, causing false positive block hits
1122 // due to -1 !== 0. Probably session-related... Nothing should be
1123 // overwriting mBlockedby, surely?
1126 $this->mBlockedby
= 0;
1127 $this->mHideName
= 0;
1128 $this->mAllowUsertalk
= 0;
1130 # Check if we are looking at an IP or a logged-in user
1131 if ( $this->isIP( $this->getName() ) ) {
1132 $ip = $this->getName();
1134 # Check if we are looking at the current user
1135 # If we don't, and the user is logged in, we don't know about
1136 # his IP / autoblock status, so ignore autoblock of current user's IP
1137 if ( $this->getID() != $wgUser->getID() ) {
1140 # Get IP of current user
1145 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1146 # Exempt from all types of IP-block
1151 $this->mBlock
= new Block();
1152 $this->mBlock
->fromMaster( !$bFromSlave );
1153 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1154 wfDebug( __METHOD__
. ": Found block.\n" );
1155 $this->mBlockedby
= $this->mBlock
->mBy
;
1156 if( $this->mBlockedby
== 0 )
1157 $this->mBlockedby
= $this->mBlock
->mByName
;
1158 $this->mBlockreason
= $this->mBlock
->mReason
;
1159 $this->mHideName
= $this->mBlock
->mHideName
;
1160 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1161 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1162 $this->spreadBlock();
1165 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1166 // apply to users. Note that the existence of $this->mBlock is not used to
1167 // check for edit blocks, $this->mBlockedby is instead.
1171 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1173 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1174 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1175 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1179 if ( !$this->mBlockedby
&& !$this->getID() ) {
1180 if ( $this->isDnsBlacklisted( $ip ) ) {
1181 $this->mBlockedby
= wfMsg( 'sorbs' );
1182 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1188 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1190 wfProfileOut( __METHOD__
);
1194 * Whether the given IP is in a DNS blacklist.
1196 * @param $ip \string IP to check
1197 * @param $checkWhitelist Boolean: whether to check the whitelist first
1198 * @return \bool True if blacklisted.
1200 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1201 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1202 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1204 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1207 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1210 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1211 return $this->inDnsBlacklist( $ip, $urls );
1215 * Whether the given IP is in a given DNS blacklist.
1217 * @param $ip \string IP to check
1218 * @param $bases \string or Array of Strings: URL of the DNS blacklist
1219 * @return \bool True if blacklisted.
1221 function inDnsBlacklist( $ip, $bases ) {
1222 wfProfileIn( __METHOD__
);
1226 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1227 if( IP
::isIPv4( $ip ) ) {
1228 # Reverse IP, bug 21255
1229 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1231 foreach( (array)$bases as $base ) {
1233 $host = "$ipReversed.$base";
1236 $ipList = gethostbynamel( $host );
1239 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1243 wfDebug( "Requested $host, not found in $base.\n" );
1248 wfProfileOut( __METHOD__
);
1253 * Is this user subject to rate limiting?
1255 * @return \bool True if rate limited
1257 public function isPingLimitable() {
1258 global $wgRateLimitsExcludedGroups;
1259 global $wgRateLimitsExcludedIPs;
1260 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1261 // Deprecated, but kept for backwards-compatibility config
1264 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1265 // No other good way currently to disable rate limits
1266 // for specific IPs. :P
1267 // But this is a crappy hack and should die.
1270 return !$this->isAllowed('noratelimit');
1274 * Primitive rate limits: enforce maximum actions per time period
1275 * to put a brake on flooding.
1277 * @note When using a shared cache like memcached, IP-address
1278 * last-hit counters will be shared across wikis.
1280 * @param $action \string Action to enforce; 'edit' if unspecified
1281 * @return \bool True if a rate limiter was tripped
1283 function pingLimiter( $action = 'edit' ) {
1284 # Call the 'PingLimiter' hook
1286 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1290 global $wgRateLimits;
1291 if( !isset( $wgRateLimits[$action] ) ) {
1295 # Some groups shouldn't trigger the ping limiter, ever
1296 if( !$this->isPingLimitable() )
1299 global $wgMemc, $wgRateLimitLog;
1300 wfProfileIn( __METHOD__
);
1302 $limits = $wgRateLimits[$action];
1304 $id = $this->getId();
1308 if( isset( $limits['anon'] ) && $id == 0 ) {
1309 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1312 if( isset( $limits['user'] ) && $id != 0 ) {
1313 $userLimit = $limits['user'];
1315 if( $this->isNewbie() ) {
1316 if( isset( $limits['newbie'] ) && $id != 0 ) {
1317 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1319 if( isset( $limits['ip'] ) ) {
1320 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1323 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1324 $subnet = $matches[1];
1325 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1328 // Check for group-specific permissions
1329 // If more than one group applies, use the group with the highest limit
1330 foreach ( $this->getGroups() as $group ) {
1331 if ( isset( $limits[$group] ) ) {
1332 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1333 $userLimit = $limits[$group];
1337 // Set the user limit key
1338 if ( $userLimit !== false ) {
1339 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1340 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1344 foreach( $keys as $key => $limit ) {
1345 list( $max, $period ) = $limit;
1346 $summary = "(limit $max in {$period}s)";
1347 $count = $wgMemc->get( $key );
1350 if( $count > $max ) {
1351 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1352 if( $wgRateLimitLog ) {
1353 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1357 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1360 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1361 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1363 $wgMemc->incr( $key );
1366 wfProfileOut( __METHOD__
);
1371 * Check if user is blocked
1373 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1374 * @return \bool True if blocked, false otherwise
1376 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1377 wfDebug( "User::isBlocked: enter\n" );
1378 $this->getBlockedStatus( $bFromSlave );
1379 return $this->mBlockedby
!== 0;
1383 * Check if user is blocked from editing a particular article
1385 * @param $title \string Title to check
1386 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1387 * @return \bool True if blocked, false otherwise
1389 function isBlockedFrom( $title, $bFromSlave = false ) {
1390 global $wgBlockAllowsUTEdit;
1391 wfProfileIn( __METHOD__
);
1392 wfDebug( __METHOD__
. ": enter\n" );
1394 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1395 $blocked = $this->isBlocked( $bFromSlave );
1396 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1397 # If a user's name is suppressed, they cannot make edits anywhere
1398 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1399 $title->getNamespace() == NS_USER_TALK
) {
1401 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1404 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1406 wfProfileOut( __METHOD__
);
1411 * If user is blocked, return the name of the user who placed the block
1412 * @return \string name of blocker
1414 function blockedBy() {
1415 $this->getBlockedStatus();
1416 return $this->mBlockedby
;
1420 * If user is blocked, return the specified reason for the block
1421 * @return \string Blocking reason
1423 function blockedFor() {
1424 $this->getBlockedStatus();
1425 return $this->mBlockreason
;
1429 * If user is blocked, return the ID for the block
1430 * @return \int Block ID
1432 function getBlockId() {
1433 $this->getBlockedStatus();
1434 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1438 * Check if user is blocked on all wikis.
1439 * Do not use for actual edit permission checks!
1440 * This is intented for quick UI checks.
1442 * @param $ip \type{\string} IP address, uses current client if none given
1443 * @return \type{\bool} True if blocked, false otherwise
1445 function isBlockedGlobally( $ip = '' ) {
1446 if( $this->mBlockedGlobally
!== null ) {
1447 return $this->mBlockedGlobally
;
1449 // User is already an IP?
1450 if( IP
::isIPAddress( $this->getName() ) ) {
1451 $ip = $this->getName();
1456 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1457 $this->mBlockedGlobally
= (bool)$blocked;
1458 return $this->mBlockedGlobally
;
1462 * Check if user account is locked
1464 * @return \type{\bool} True if locked, false otherwise
1466 function isLocked() {
1467 if( $this->mLocked
!== null ) {
1468 return $this->mLocked
;
1471 $authUser = $wgAuth->getUserInstance( $this );
1472 $this->mLocked
= (bool)$authUser->isLocked();
1473 return $this->mLocked
;
1477 * Check if user account is hidden
1479 * @return \type{\bool} True if hidden, false otherwise
1481 function isHidden() {
1482 if( $this->mHideName
!== null ) {
1483 return $this->mHideName
;
1485 $this->getBlockedStatus();
1486 if( !$this->mHideName
) {
1488 $authUser = $wgAuth->getUserInstance( $this );
1489 $this->mHideName
= (bool)$authUser->isHidden();
1491 return $this->mHideName
;
1495 * Get the user's ID.
1496 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1499 if( $this->mId
=== null and $this->mName
!== null
1500 and User
::isIP( $this->mName
) ) {
1501 // Special case, we know the user is anonymous
1503 } elseif( $this->mId
=== null ) {
1504 // Don't load if this was initialized from an ID
1511 * Set the user and reload all fields according to a given ID
1512 * @param $v \int User ID to reload
1514 function setId( $v ) {
1516 $this->clearInstanceCache( 'id' );
1520 * Get the user name, or the IP of an anonymous user
1521 * @return \string User's name or IP address
1523 function getName() {
1524 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1525 # Special case optimisation
1526 return $this->mName
;
1529 if ( $this->mName
=== false ) {
1531 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1533 return $this->mName
;
1538 * Set the user name.
1540 * This does not reload fields from the database according to the given
1541 * name. Rather, it is used to create a temporary "nonexistent user" for
1542 * later addition to the database. It can also be used to set the IP
1543 * address for an anonymous user to something other than the current
1546 * @note User::newFromName() has rougly the same function, when the named user
1548 * @param $str \string New user name to set
1550 function setName( $str ) {
1552 $this->mName
= $str;
1556 * Get the user's name escaped by underscores.
1557 * @return \string Username escaped by underscores.
1559 function getTitleKey() {
1560 return str_replace( ' ', '_', $this->getName() );
1564 * Check if the user has new messages.
1565 * @return \bool True if the user has new messages
1567 function getNewtalk() {
1570 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1571 if( $this->mNewtalk
=== -1 ) {
1572 $this->mNewtalk
= false; # reset talk page status
1574 # Check memcached separately for anons, who have no
1575 # entire User object stored in there.
1578 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1579 $newtalk = $wgMemc->get( $key );
1580 if( strval( $newtalk ) !== '' ) {
1581 $this->mNewtalk
= (bool)$newtalk;
1583 // Since we are caching this, make sure it is up to date by getting it
1585 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1586 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1589 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1593 return (bool)$this->mNewtalk
;
1597 * Return the talk page(s) this user has new messages on.
1598 * @return \type{\arrayof{\string}} Array of page URLs
1600 function getNewMessageLinks() {
1602 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1605 if( !$this->getNewtalk() )
1607 $up = $this->getUserPage();
1608 $utp = $up->getTalkPage();
1609 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1613 * Internal uncached check for new messages
1616 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1617 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1618 * @param $fromMaster \bool true to fetch from the master, false for a slave
1619 * @return \bool True if the user has new messages
1622 function checkNewtalk( $field, $id, $fromMaster = false ) {
1623 if ( $fromMaster ) {
1624 $db = wfGetDB( DB_MASTER
);
1626 $db = wfGetDB( DB_SLAVE
);
1628 $ok = $db->selectField( 'user_newtalk', $field,
1629 array( $field => $id ), __METHOD__
);
1630 return $ok !== false;
1634 * Add or update the new messages flag
1635 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1636 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1637 * @return \bool True if successful, false otherwise
1640 function updateNewtalk( $field, $id ) {
1641 $dbw = wfGetDB( DB_MASTER
);
1642 $dbw->insert( 'user_newtalk',
1643 array( $field => $id ),
1646 if ( $dbw->affectedRows() ) {
1647 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1650 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1656 * Clear the new messages flag for the given user
1657 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1658 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1659 * @return \bool True if successful, false otherwise
1662 function deleteNewtalk( $field, $id ) {
1663 $dbw = wfGetDB( DB_MASTER
);
1664 $dbw->delete( 'user_newtalk',
1665 array( $field => $id ),
1667 if ( $dbw->affectedRows() ) {
1668 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1671 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1677 * Update the 'You have new messages!' status.
1678 * @param $val \bool Whether the user has new messages
1680 function setNewtalk( $val ) {
1681 if( wfReadOnly() ) {
1686 $this->mNewtalk
= $val;
1688 if( $this->isAnon() ) {
1690 $id = $this->getName();
1693 $id = $this->getId();
1698 $changed = $this->updateNewtalk( $field, $id );
1700 $changed = $this->deleteNewtalk( $field, $id );
1703 if( $this->isAnon() ) {
1704 // Anons have a separate memcached space, since
1705 // user records aren't kept for them.
1706 $key = wfMemcKey( 'newtalk', 'ip', $id );
1707 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1710 $this->invalidateCache();
1715 * Generate a current or new-future timestamp to be stored in the
1716 * user_touched field when we update things.
1717 * @return \string Timestamp in TS_MW format
1719 private static function newTouchedTimestamp() {
1720 global $wgClockSkewFudge;
1721 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1725 * Clear user data from memcached.
1726 * Use after applying fun updates to the database; caller's
1727 * responsibility to update user_touched if appropriate.
1729 * Called implicitly from invalidateCache() and saveSettings().
1731 private function clearSharedCache() {
1735 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1740 * Immediately touch the user data cache for this account.
1741 * Updates user_touched field, and removes account data from memcached
1742 * for reload on the next hit.
1744 function invalidateCache() {
1745 if( wfReadOnly() ) {
1750 $this->mTouched
= self
::newTouchedTimestamp();
1752 $dbw = wfGetDB( DB_MASTER
);
1753 $dbw->update( 'user',
1754 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1755 array( 'user_id' => $this->mId
),
1758 $this->clearSharedCache();
1763 * Validate the cache for this account.
1764 * @param $timestamp \string A timestamp in TS_MW format
1766 function validateCache( $timestamp ) {
1768 return ( $timestamp >= $this->mTouched
);
1772 * Get the user touched timestamp
1774 function getTouched() {
1776 return $this->mTouched
;
1780 * Set the password and reset the random token.
1781 * Calls through to authentication plugin if necessary;
1782 * will have no effect if the auth plugin refuses to
1783 * pass the change through or if the legal password
1786 * As a special case, setting the password to null
1787 * wipes it, so the account cannot be logged in until
1788 * a new password is set, for instance via e-mail.
1790 * @param $str \string New password to set
1791 * @throws PasswordError on failure
1793 function setPassword( $str ) {
1796 if( $str !== null ) {
1797 if( !$wgAuth->allowPasswordChange() ) {
1798 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1801 if( !$this->isValidPassword( $str ) ) {
1802 global $wgMinimalPasswordLength;
1803 $valid = $this->getPasswordValidity( $str );
1804 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1805 $wgMinimalPasswordLength ) );
1809 if( !$wgAuth->setPassword( $this, $str ) ) {
1810 throw new PasswordError( wfMsg( 'externaldberror' ) );
1813 $this->setInternalPassword( $str );
1819 * Set the password and reset the random token unconditionally.
1821 * @param $str \string New password to set
1823 function setInternalPassword( $str ) {
1827 if( $str === null ) {
1828 // Save an invalid hash...
1829 $this->mPassword
= '';
1831 $this->mPassword
= self
::crypt( $str );
1833 $this->mNewpassword
= '';
1834 $this->mNewpassTime
= null;
1838 * Get the user's current token.
1839 * @return \string Token
1841 function getToken() {
1843 return $this->mToken
;
1847 * Set the random token (used for persistent authentication)
1848 * Called from loadDefaults() among other places.
1850 * @param $token \string If specified, set the token to this value
1853 function setToken( $token = false ) {
1854 global $wgSecretKey, $wgProxyKey;
1857 if ( $wgSecretKey ) {
1858 $key = $wgSecretKey;
1859 } elseif ( $wgProxyKey ) {
1864 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1866 $this->mToken
= $token;
1871 * Set the cookie password
1873 * @param $str \string New cookie password
1876 function setCookiePassword( $str ) {
1878 $this->mCookiePassword
= md5( $str );
1882 * Set the password for a password reminder or new account email
1884 * @param $str \string New password to set
1885 * @param $throttle \bool If true, reset the throttle timestamp to the present
1887 function setNewpassword( $str, $throttle = true ) {
1889 $this->mNewpassword
= self
::crypt( $str );
1891 $this->mNewpassTime
= wfTimestampNow();
1896 * Has password reminder email been sent within the last
1897 * $wgPasswordReminderResendTime hours?
1898 * @return \bool True or false
1900 function isPasswordReminderThrottled() {
1901 global $wgPasswordReminderResendTime;
1903 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1906 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1907 return time() < $expiry;
1911 * Get the user's e-mail address
1912 * @return \string User's email address
1914 function getEmail() {
1916 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1917 return $this->mEmail
;
1921 * Get the timestamp of the user's e-mail authentication
1922 * @return \string TS_MW timestamp
1924 function getEmailAuthenticationTimestamp() {
1926 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1927 return $this->mEmailAuthenticated
;
1931 * Set the user's e-mail address
1932 * @param $str \string New e-mail address
1934 function setEmail( $str ) {
1936 $this->mEmail
= $str;
1937 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1941 * Get the user's real name
1942 * @return \string User's real name
1944 function getRealName() {
1946 return $this->mRealName
;
1950 * Set the user's real name
1951 * @param $str \string New real name
1953 function setRealName( $str ) {
1955 $this->mRealName
= $str;
1959 * Get the user's current setting for a given option.
1961 * @param $oname \string The option to check
1962 * @param $defaultOverride \string A default value returned if the option does not exist
1963 * @return \string User's current value for the option
1964 * @see getBoolOption()
1965 * @see getIntOption()
1967 function getOption( $oname, $defaultOverride = null ) {
1968 $this->loadOptions();
1970 if ( is_null( $this->mOptions
) ) {
1971 if($defaultOverride != '') {
1972 return $defaultOverride;
1974 $this->mOptions
= User
::getDefaultOptions();
1977 if ( array_key_exists( $oname, $this->mOptions
) ) {
1978 return $this->mOptions
[$oname];
1980 return $defaultOverride;
1985 * Get all user's options
1989 public function getOptions() {
1990 $this->loadOptions();
1991 return $this->mOptions
;
1995 * Get the user's current setting for a given option, as a boolean value.
1997 * @param $oname \string The option to check
1998 * @return \bool User's current value for the option
2001 function getBoolOption( $oname ) {
2002 return (bool)$this->getOption( $oname );
2007 * Get the user's current setting for a given option, as a boolean value.
2009 * @param $oname \string The option to check
2010 * @param $defaultOverride \int A default value returned if the option does not exist
2011 * @return \int User's current value for the option
2014 function getIntOption( $oname, $defaultOverride=0 ) {
2015 $val = $this->getOption( $oname );
2017 $val = $defaultOverride;
2019 return intval( $val );
2023 * Set the given option for a user.
2025 * @param $oname \string The option to set
2026 * @param $val \mixed New value to set
2028 function setOption( $oname, $val ) {
2030 $this->loadOptions();
2032 if ( $oname == 'skin' ) {
2033 # Clear cached skin, so the new one displays immediately in Special:Preferences
2034 unset( $this->mSkin
);
2037 // Explicitly NULL values should refer to defaults
2038 global $wgDefaultUserOptions;
2039 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2040 $val = $wgDefaultUserOptions[$oname];
2043 $this->mOptions
[$oname] = $val;
2047 * Reset all options to the site defaults
2049 function resetOptions() {
2050 $this->mOptions
= User
::getDefaultOptions();
2054 * Get the user's preferred date format.
2055 * @return \string User's preferred date format
2057 function getDatePreference() {
2058 // Important migration for old data rows
2059 if ( is_null( $this->mDatePreference
) ) {
2061 $value = $this->getOption( 'date' );
2062 $map = $wgLang->getDatePreferenceMigrationMap();
2063 if ( isset( $map[$value] ) ) {
2064 $value = $map[$value];
2066 $this->mDatePreference
= $value;
2068 return $this->mDatePreference
;
2072 * Get the permissions this user has.
2073 * @return \type{\arrayof{\string}} Array of permission names
2075 function getRights() {
2076 if ( is_null( $this->mRights
) ) {
2077 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2078 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2079 // Force reindexation of rights when a hook has unset one of them
2080 $this->mRights
= array_values( $this->mRights
);
2082 return $this->mRights
;
2086 * Get the list of explicit group memberships this user has.
2087 * The implicit * and user groups are not included.
2088 * @return \type{\arrayof{\string}} Array of internal group names
2090 function getGroups() {
2092 return $this->mGroups
;
2096 * Get the list of implicit group memberships this user has.
2097 * This includes all explicit groups, plus 'user' if logged in,
2098 * '*' for all accounts and autopromoted groups
2099 * @param $recache \bool Whether to avoid the cache
2100 * @return \type{\arrayof{\string}} Array of internal group names
2102 function getEffectiveGroups( $recache = false ) {
2103 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2104 wfProfileIn( __METHOD__
);
2105 $this->mEffectiveGroups
= $this->getGroups();
2106 $this->mEffectiveGroups
[] = '*';
2107 if( $this->getId() ) {
2108 $this->mEffectiveGroups
[] = 'user';
2110 $this->mEffectiveGroups
= array_unique( array_merge(
2111 $this->mEffectiveGroups
,
2112 Autopromote
::getAutopromoteGroups( $this )
2115 # Hook for additional groups
2116 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2118 wfProfileOut( __METHOD__
);
2120 return $this->mEffectiveGroups
;
2124 * Get the user's edit count.
2125 * @return \int User'e edit count
2127 function getEditCount() {
2128 if( $this->getId() ) {
2129 if ( !isset( $this->mEditCount
) ) {
2130 /* Populate the count, if it has not been populated yet */
2131 $this->mEditCount
= User
::edits( $this->mId
);
2133 return $this->mEditCount
;
2141 * Add the user to the given group.
2142 * This takes immediate effect.
2143 * @param $group \string Name of the group to add
2145 function addGroup( $group ) {
2146 $dbw = wfGetDB( DB_MASTER
);
2147 if( $this->getId() ) {
2148 $dbw->insert( 'user_groups',
2150 'ug_user' => $this->getID(),
2151 'ug_group' => $group,
2154 array( 'IGNORE' ) );
2157 $this->loadGroups();
2158 $this->mGroups
[] = $group;
2159 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2161 $this->invalidateCache();
2165 * Remove the user from the given group.
2166 * This takes immediate effect.
2167 * @param $group \string Name of the group to remove
2169 function removeGroup( $group ) {
2171 $dbw = wfGetDB( DB_MASTER
);
2172 $dbw->delete( 'user_groups',
2174 'ug_user' => $this->getID(),
2175 'ug_group' => $group,
2177 'User::removeGroup' );
2179 $this->loadGroups();
2180 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2181 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2183 $this->invalidateCache();
2187 * Get whether the user is logged in
2188 * @return \bool True or false
2190 function isLoggedIn() {
2191 return $this->getID() != 0;
2195 * Get whether the user is anonymous
2196 * @return \bool True or false
2199 return !$this->isLoggedIn();
2203 * Get whether the user is a bot
2204 * @return \bool True or false
2208 wfDeprecated( __METHOD__
);
2209 return $this->isAllowed( 'bot' );
2213 * Check if user is allowed to access a feature / make an action
2214 * @param $action \string action to be checked
2215 * @return \bool True if action is allowed, else false
2217 function isAllowed( $action = '' ) {
2218 if ( $action === '' )
2219 return true; // In the spirit of DWIM
2220 # Patrolling may not be enabled
2221 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2222 global $wgUseRCPatrol, $wgUseNPPatrol;
2223 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2226 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2227 # by misconfiguration: 0 == 'foo'
2228 return in_array( $action, $this->getRights(), true );
2232 * Check whether to enable recent changes patrol features for this user
2233 * @return \bool True or false
2235 public function useRCPatrol() {
2236 global $wgUseRCPatrol;
2237 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2241 * Check whether to enable new pages patrol features for this user
2242 * @return \bool True or false
2244 public function useNPPatrol() {
2245 global $wgUseRCPatrol, $wgUseNPPatrol;
2246 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2250 * Get the current skin, loading it if required, and setting a title
2251 * @param $t Title: the title to use in the skin
2252 * @return Skin The current skin
2253 * @todo FIXME : need to check the old failback system [AV]
2255 function &getSkin( $t = null ) {
2256 if ( !isset( $this->mSkin
) ) {
2257 wfProfileIn( __METHOD__
);
2259 global $wgHiddenPrefs;
2260 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2263 $userSkin = $this->getOption( 'skin' );
2264 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2266 # if we're not allowing users to override, then use the default
2267 global $wgDefaultSkin;
2268 $userSkin = $wgDefaultSkin;
2271 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2272 wfProfileOut( __METHOD__
);
2274 if( $t ||
!$this->mSkin
->getTitle() ) {
2277 $t = $wgOut->getTitle();
2279 $this->mSkin
->setTitle( $t );
2281 return $this->mSkin
;
2285 * Check the watched status of an article.
2286 * @param $title \type{Title} Title of the article to look at
2287 * @return \bool True if article is watched
2289 function isWatched( $title ) {
2290 $wl = WatchedItem
::fromUserTitle( $this, $title );
2291 return $wl->isWatched();
2296 * @param $title \type{Title} Title of the article to look at
2298 function addWatch( $title ) {
2299 $wl = WatchedItem
::fromUserTitle( $this, $title );
2301 $this->invalidateCache();
2305 * Stop watching an article.
2306 * @param $title \type{Title} Title of the article to look at
2308 function removeWatch( $title ) {
2309 $wl = WatchedItem
::fromUserTitle( $this, $title );
2311 $this->invalidateCache();
2315 * Clear the user's notification timestamp for the given title.
2316 * If e-notif e-mails are on, they will receive notification mails on
2317 * the next change of the page if it's watched etc.
2318 * @param $title \type{Title} Title of the article to look at
2320 function clearNotification( &$title ) {
2321 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2323 # Do nothing if the database is locked to writes
2324 if( wfReadOnly() ) {
2328 if( $title->getNamespace() == NS_USER_TALK
&&
2329 $title->getText() == $this->getName() ) {
2330 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2332 $this->setNewtalk( false );
2335 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2339 if( $this->isAnon() ) {
2340 // Nothing else to do...
2344 // Only update the timestamp if the page is being watched.
2345 // The query to find out if it is watched is cached both in memcached and per-invocation,
2346 // and when it does have to be executed, it can be on a slave
2347 // If this is the user's newtalk page, we always update the timestamp
2348 if( $title->getNamespace() == NS_USER_TALK
&&
2349 $title->getText() == $wgUser->getName() )
2352 } elseif ( $this->getId() == $wgUser->getId() ) {
2353 $watched = $title->userIsWatching();
2358 // If the page is watched by the user (or may be watched), update the timestamp on any
2359 // any matching rows
2361 $dbw = wfGetDB( DB_MASTER
);
2362 $dbw->update( 'watchlist',
2364 'wl_notificationtimestamp' => null
2365 ), array( /* WHERE */
2366 'wl_title' => $title->getDBkey(),
2367 'wl_namespace' => $title->getNamespace(),
2368 'wl_user' => $this->getID()
2375 * Resets all of the given user's page-change notification timestamps.
2376 * If e-notif e-mails are on, they will receive notification mails on
2377 * the next change of any watched page.
2379 * @param $currentUser \int User ID
2381 function clearAllNotifications( $currentUser ) {
2382 global $wgUseEnotif, $wgShowUpdatedMarker;
2383 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2384 $this->setNewtalk( false );
2387 if( $currentUser != 0 ) {
2388 $dbw = wfGetDB( DB_MASTER
);
2389 $dbw->update( 'watchlist',
2391 'wl_notificationtimestamp' => null
2392 ), array( /* WHERE */
2393 'wl_user' => $currentUser
2396 # We also need to clear here the "you have new message" notification for the own user_talk page
2397 # This is cleared one page view later in Article::viewUpdates();
2402 * Set this user's options from an encoded string
2403 * @param $str \string Encoded options to import
2406 function decodeOptions( $str ) {
2410 $this->mOptionsLoaded
= true;
2411 $this->mOptionOverrides
= array();
2413 $this->mOptions
= array();
2414 $a = explode( "\n", $str );
2415 foreach ( $a as $s ) {
2417 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2418 $this->mOptions
[$m[1]] = $m[2];
2419 $this->mOptionOverrides
[$m[1]] = $m[2];
2425 * Set a cookie on the user's client. Wrapper for
2426 * WebResponse::setCookie
2427 * @param $name \string Name of the cookie to set
2428 * @param $value \string Value to set
2429 * @param $exp \int Expiration time, as a UNIX time value;
2430 * if 0 or not specified, use the default $wgCookieExpiration
2432 protected function setCookie( $name, $value, $exp = 0 ) {
2434 $wgRequest->response()->setcookie( $name, $value, $exp );
2438 * Clear a cookie on the user's client
2439 * @param $name \string Name of the cookie to clear
2441 protected function clearCookie( $name ) {
2442 $this->setCookie( $name, '', time() - 86400 );
2446 * Set the default cookies for this session on the user's client.
2448 function setCookies() {
2450 if ( 0 == $this->mId
) return;
2452 'wsUserID' => $this->mId
,
2453 'wsToken' => $this->mToken
,
2454 'wsUserName' => $this->getName()
2457 'UserID' => $this->mId
,
2458 'UserName' => $this->getName(),
2460 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2461 $cookies['Token'] = $this->mToken
;
2463 $cookies['Token'] = false;
2466 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2467 #check for null, since the hook could cause a null value
2468 if ( !is_null( $session ) && isset( $_SESSION ) ){
2469 $_SESSION = $session +
$_SESSION;
2471 foreach ( $cookies as $name => $value ) {
2472 if ( $value === false ) {
2473 $this->clearCookie( $name );
2475 $this->setCookie( $name, $value );
2481 * Log this user out.
2484 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2490 * Clear the user's cookies and session, and reset the instance cache.
2494 function doLogout() {
2495 $this->clearInstanceCache( 'defaults' );
2497 $_SESSION['wsUserID'] = 0;
2499 $this->clearCookie( 'UserID' );
2500 $this->clearCookie( 'Token' );
2502 # Remember when user logged out, to prevent seeing cached pages
2503 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2507 * Save this user's settings into the database.
2508 * @todo Only rarely do all these fields need to be set!
2510 function saveSettings() {
2512 if ( wfReadOnly() ) { return; }
2513 if ( 0 == $this->mId
) { return; }
2515 $this->mTouched
= self
::newTouchedTimestamp();
2517 $dbw = wfGetDB( DB_MASTER
);
2518 $dbw->update( 'user',
2520 'user_name' => $this->mName
,
2521 'user_password' => $this->mPassword
,
2522 'user_newpassword' => $this->mNewpassword
,
2523 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2524 'user_real_name' => $this->mRealName
,
2525 'user_email' => $this->mEmail
,
2526 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2527 'user_options' => '',
2528 'user_touched' => $dbw->timestamp( $this->mTouched
),
2529 'user_token' => $this->mToken
,
2530 'user_email_token' => $this->mEmailToken
,
2531 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2532 ), array( /* WHERE */
2533 'user_id' => $this->mId
2537 $this->saveOptions();
2539 wfRunHooks( 'UserSaveSettings', array( $this ) );
2540 $this->clearSharedCache();
2541 $this->getUserPage()->invalidateCache();
2545 * If only this user's username is known, and it exists, return the user ID.
2547 function idForName() {
2548 $s = trim( $this->getName() );
2549 if ( $s === '' ) return 0;
2551 $dbr = wfGetDB( DB_SLAVE
);
2552 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2553 if ( $id === false ) {
2560 * Add a user to the database, return the user object
2562 * @param $name \string Username to add
2563 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2564 * - password The user's password. Password logins will be disabled if this is omitted.
2565 * - newpassword A temporary password mailed to the user
2566 * - email The user's email address
2567 * - email_authenticated The email authentication timestamp
2568 * - real_name The user's real name
2569 * - options An associative array of non-default options
2570 * - token Random authentication token. Do not set.
2571 * - registration Registration timestamp. Do not set.
2573 * @return \type{User} A new User object, or null if the username already exists
2575 static function createNew( $name, $params = array() ) {
2578 if ( isset( $params['options'] ) ) {
2579 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2580 unset( $params['options'] );
2582 $dbw = wfGetDB( DB_MASTER
);
2583 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2585 'user_id' => $seqVal,
2586 'user_name' => $name,
2587 'user_password' => $user->mPassword
,
2588 'user_newpassword' => $user->mNewpassword
,
2589 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2590 'user_email' => $user->mEmail
,
2591 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2592 'user_real_name' => $user->mRealName
,
2593 'user_options' => '',
2594 'user_token' => $user->mToken
,
2595 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2596 'user_editcount' => 0,
2598 foreach ( $params as $name => $value ) {
2599 $fields["user_$name"] = $value;
2601 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2602 if ( $dbw->affectedRows() ) {
2603 $newUser = User
::newFromId( $dbw->insertId() );
2611 * Add this existing user object to the database
2613 function addToDatabase() {
2615 $dbw = wfGetDB( DB_MASTER
);
2616 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2617 $dbw->insert( 'user',
2619 'user_id' => $seqVal,
2620 'user_name' => $this->mName
,
2621 'user_password' => $this->mPassword
,
2622 'user_newpassword' => $this->mNewpassword
,
2623 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2624 'user_email' => $this->mEmail
,
2625 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2626 'user_real_name' => $this->mRealName
,
2627 'user_options' => '',
2628 'user_token' => $this->mToken
,
2629 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2630 'user_editcount' => 0,
2633 $this->mId
= $dbw->insertId();
2635 // Clear instance cache other than user table data, which is already accurate
2636 $this->clearInstanceCache();
2638 $this->saveOptions();
2642 * If this (non-anonymous) user is blocked, block any IP address
2643 * they've successfully logged in from.
2645 function spreadBlock() {
2646 wfDebug( __METHOD__
. "()\n" );
2648 if ( $this->mId
== 0 ) {
2652 $userblock = Block
::newFromDB( '', $this->mId
);
2653 if ( !$userblock ) {
2657 $userblock->doAutoblock( wfGetIP() );
2661 * Generate a string which will be different for any combination of
2662 * user options which would produce different parser output.
2663 * This will be used as part of the hash key for the parser cache,
2664 * so users with the same options can share the same cached data
2667 * Extensions which require it should install 'PageRenderingHash' hook,
2668 * which will give them a chance to modify this key based on their own
2671 * @return \string Page rendering hash
2673 function getPageRenderingHash() {
2674 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2676 return $this->mHash
;
2679 // stubthreshold is only included below for completeness,
2680 // it will always be 0 when this function is called by parsercache.
2682 $confstr = $this->getOption( 'math' );
2683 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2684 if ( $wgUseDynamicDates ) {
2685 $confstr .= '!' . $this->getDatePreference();
2687 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2688 $confstr .= '!' . $wgLang->getCode();
2689 $confstr .= '!' . $this->getOption( 'thumbsize' );
2690 // add in language specific options, if any
2691 $extra = $wgContLang->getExtraHashOptions();
2694 $confstr .= $wgRenderHashAppend;
2696 // Give a chance for extensions to modify the hash, if they have
2697 // extra options or other effects on the parser cache.
2698 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2700 // Make it a valid memcached key fragment
2701 $confstr = str_replace( ' ', '_', $confstr );
2702 $this->mHash
= $confstr;
2707 * Get whether the user is explicitly blocked from account creation.
2708 * @return \bool True if blocked
2710 function isBlockedFromCreateAccount() {
2711 $this->getBlockedStatus();
2712 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2716 * Get whether the user is blocked from using Special:Emailuser.
2717 * @return \bool True if blocked
2719 function isBlockedFromEmailuser() {
2720 $this->getBlockedStatus();
2721 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2725 * Get whether the user is allowed to create an account.
2726 * @return \bool True if allowed
2728 function isAllowedToCreateAccount() {
2729 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2735 function setLoaded( $loaded ) {
2736 wfDeprecated( __METHOD__
);
2740 * Get this user's personal page title.
2742 * @return \type{Title} User's personal page title
2744 function getUserPage() {
2745 return Title
::makeTitle( NS_USER
, $this->getName() );
2749 * Get this user's talk page title.
2751 * @return \type{Title} User's talk page title
2753 function getTalkPage() {
2754 $title = $this->getUserPage();
2755 return $title->getTalkPage();
2759 * Get the maximum valid user ID.
2760 * @return \int User ID
2763 function getMaxID() {
2764 static $res; // cache
2766 if ( isset( $res ) )
2769 $dbr = wfGetDB( DB_SLAVE
);
2770 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2775 * Determine whether the user is a newbie. Newbies are either
2776 * anonymous IPs, or the most recently created accounts.
2777 * @return \bool True if the user is a newbie
2779 function isNewbie() {
2780 return !$this->isAllowed( 'autoconfirmed' );
2784 * Check to see if the given clear-text password is one of the accepted passwords
2785 * @param $password \string user password.
2786 * @return \bool True if the given password is correct, otherwise False.
2788 function checkPassword( $password ) {
2792 // Even though we stop people from creating passwords that
2793 // are shorter than this, doesn't mean people wont be able
2794 // to. Certain authentication plugins do NOT want to save
2795 // domain passwords in a mysql database, so we should
2796 // check this (incase $wgAuth->strict() is false).
2797 if( !$this->isValidPassword( $password ) ) {
2801 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2803 } elseif( $wgAuth->strict() ) {
2804 /* Auth plugin doesn't allow local authentication */
2806 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2807 /* Auth plugin doesn't allow local authentication for this user name */
2810 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2812 } elseif ( function_exists( 'iconv' ) ) {
2813 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2814 # Check for this with iconv
2815 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2816 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2824 * Check if the given clear-text password matches the temporary password
2825 * sent by e-mail for password reset operations.
2826 * @return \bool True if matches, false otherwise
2828 function checkTemporaryPassword( $plaintext ) {
2829 global $wgNewPasswordExpiry;
2830 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2832 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2833 return ( time() < $expiry );
2840 * Initialize (if necessary) and return a session token value
2841 * which can be used in edit forms to show that the user's
2842 * login credentials aren't being hijacked with a foreign form
2845 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2846 * @return \string The new edit token
2848 function editToken( $salt = '' ) {
2849 if ( $this->isAnon() ) {
2850 return EDIT_TOKEN_SUFFIX
;
2852 if( !isset( $_SESSION['wsEditToken'] ) ) {
2853 $token = self
::generateToken();
2854 $_SESSION['wsEditToken'] = $token;
2856 $token = $_SESSION['wsEditToken'];
2858 if( is_array( $salt ) ) {
2859 $salt = implode( '|', $salt );
2861 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2866 * Generate a looking random token for various uses.
2868 * @param $salt \string Optional salt value
2869 * @return \string The new random token
2871 public static function generateToken( $salt = '' ) {
2872 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2873 return md5( $token . $salt );
2877 * Check given value against the token value stored in the session.
2878 * A match should confirm that the form was submitted from the
2879 * user's own login session, not a form submission from a third-party
2882 * @param $val \string Input value to compare
2883 * @param $salt \string Optional function-specific data for hashing
2884 * @return \bool Whether the token matches
2886 function matchEditToken( $val, $salt = '' ) {
2887 $sessionToken = $this->editToken( $salt );
2888 if ( $val != $sessionToken ) {
2889 wfDebug( "User::matchEditToken: broken session data\n" );
2891 return $val == $sessionToken;
2895 * Check given value against the token value stored in the session,
2896 * ignoring the suffix.
2898 * @param $val \string Input value to compare
2899 * @param $salt \string Optional function-specific data for hashing
2900 * @return \bool Whether the token matches
2902 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2903 $sessionToken = $this->editToken( $salt );
2904 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2908 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2909 * mail to the user's given address.
2911 * @param $changed Boolean: whether the adress changed
2912 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2914 function sendConfirmationMail( $changed = false ) {
2916 $expiration = null; // gets passed-by-ref and defined in next line.
2917 $token = $this->confirmationToken( $expiration );
2918 $url = $this->confirmationTokenUrl( $token );
2919 $invalidateURL = $this->invalidationTokenUrl( $token );
2920 $this->saveSettings();
2922 $message = $changed ?
'confirmemail_body_changed' : 'confirmemail_body';
2923 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2928 $wgLang->timeanddate( $expiration, false ),
2930 $wgLang->date( $expiration, false ),
2931 $wgLang->time( $expiration, false ) ) );
2935 * Send an e-mail to this user's account. Does not check for
2936 * confirmed status or validity.
2938 * @param $subject \string Message subject
2939 * @param $body \string Message body
2940 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2941 * @param $replyto \string Reply-To address
2942 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2944 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2945 if( is_null( $from ) ) {
2946 global $wgPasswordSender;
2947 $from = $wgPasswordSender;
2950 $to = new MailAddress( $this );
2951 $sender = new MailAddress( $from );
2952 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2956 * Generate, store, and return a new e-mail confirmation code.
2957 * A hash (unsalted, since it's used as a key) is stored.
2959 * @note Call saveSettings() after calling this function to commit
2960 * this change to the database.
2962 * @param[out] &$expiration \mixed Accepts the expiration time
2963 * @return \string New token
2966 function confirmationToken( &$expiration ) {
2968 $expires = $now +
7 * 24 * 60 * 60;
2969 $expiration = wfTimestamp( TS_MW
, $expires );
2970 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
2971 $hash = md5( $token );
2973 $this->mEmailToken
= $hash;
2974 $this->mEmailTokenExpires
= $expiration;
2979 * Return a URL the user can use to confirm their email address.
2980 * @param $token \string Accepts the email confirmation token
2981 * @return \string New token URL
2984 function confirmationTokenUrl( $token ) {
2985 return $this->getTokenUrl( 'ConfirmEmail', $token );
2989 * Return a URL the user can use to invalidate their email address.
2990 * @param $token \string Accepts the email confirmation token
2991 * @return \string New token URL
2994 function invalidationTokenUrl( $token ) {
2995 return $this->getTokenUrl( 'Invalidateemail', $token );
2999 * Internal function to format the e-mail validation/invalidation URLs.
3000 * This uses $wgArticlePath directly as a quickie hack to use the
3001 * hardcoded English names of the Special: pages, for ASCII safety.
3003 * @note Since these URLs get dropped directly into emails, using the
3004 * short English names avoids insanely long URL-encoded links, which
3005 * also sometimes can get corrupted in some browsers/mailers
3006 * (bug 6957 with Gmail and Internet Explorer).
3008 * @param $page \string Special page
3009 * @param $token \string Token
3010 * @return \string Formatted URL
3012 protected function getTokenUrl( $page, $token ) {
3013 global $wgArticlePath;
3017 "Special:$page/$token",
3022 * Mark the e-mail address confirmed.
3024 * @note Call saveSettings() after calling this function to commit the change.
3026 function confirmEmail() {
3027 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3028 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3033 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3034 * address if it was already confirmed.
3036 * @note Call saveSettings() after calling this function to commit the change.
3038 function invalidateEmail() {
3040 $this->mEmailToken
= null;
3041 $this->mEmailTokenExpires
= null;
3042 $this->setEmailAuthenticationTimestamp( null );
3043 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3048 * Set the e-mail authentication timestamp.
3049 * @param $timestamp \string TS_MW timestamp
3051 function setEmailAuthenticationTimestamp( $timestamp ) {
3053 $this->mEmailAuthenticated
= $timestamp;
3054 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3058 * Is this user allowed to send e-mails within limits of current
3059 * site configuration?
3060 * @return \bool True if allowed
3062 function canSendEmail() {
3063 global $wgEnableEmail, $wgEnableUserEmail;
3064 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3067 $canSend = $this->isEmailConfirmed();
3068 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3073 * Is this user allowed to receive e-mails within limits of current
3074 * site configuration?
3075 * @return \bool True if allowed
3077 function canReceiveEmail() {
3078 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3082 * Is this user's e-mail address valid-looking and confirmed within
3083 * limits of the current site configuration?
3085 * @note If $wgEmailAuthentication is on, this may require the user to have
3086 * confirmed their address by returning a code or using a password
3087 * sent to the address from the wiki.
3089 * @return \bool True if confirmed
3091 function isEmailConfirmed() {
3092 global $wgEmailAuthentication;
3095 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3096 if( $this->isAnon() )
3098 if( !self
::isValidEmailAddr( $this->mEmail
) )
3100 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3109 * Check whether there is an outstanding request for e-mail confirmation.
3110 * @return \bool True if pending
3112 function isEmailConfirmationPending() {
3113 global $wgEmailAuthentication;
3114 return $wgEmailAuthentication &&
3115 !$this->isEmailConfirmed() &&
3116 $this->mEmailToken
&&
3117 $this->mEmailTokenExpires
> wfTimestamp();
3121 * Get the timestamp of account creation.
3123 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3124 * non-existent/anonymous user accounts.
3126 public function getRegistration() {
3127 return $this->getId() > 0
3128 ?
$this->mRegistration
3133 * Get the timestamp of the first edit
3135 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3136 * non-existent/anonymous user accounts.
3138 public function getFirstEditTimestamp() {
3139 if( $this->getId() == 0 ) return false; // anons
3140 $dbr = wfGetDB( DB_SLAVE
);
3141 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3142 array( 'rev_user' => $this->getId() ),
3144 array( 'ORDER BY' => 'rev_timestamp ASC' )
3146 if( !$time ) return false; // no edits
3147 return wfTimestamp( TS_MW
, $time );
3151 * Get the permissions associated with a given list of groups
3153 * @param $groups \type{\arrayof{\string}} List of internal group names
3154 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3156 static function getGroupPermissions( $groups ) {
3157 global $wgGroupPermissions, $wgRevokePermissions;
3159 // grant every granted permission first
3160 foreach( $groups as $group ) {
3161 if( isset( $wgGroupPermissions[$group] ) ) {
3162 $rights = array_merge( $rights,
3163 // array_filter removes empty items
3164 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3167 // now revoke the revoked permissions
3168 foreach( $groups as $group ) {
3169 if( isset( $wgRevokePermissions[$group] ) ) {
3170 $rights = array_diff( $rights,
3171 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3174 return array_unique( $rights );
3178 * Get all the groups who have a given permission
3180 * @param $role \string Role to check
3181 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3183 static function getGroupsWithPermission( $role ) {
3184 global $wgGroupPermissions;
3185 $allowedGroups = array();
3186 foreach ( $wgGroupPermissions as $group => $rights ) {
3187 if ( isset( $rights[$role] ) && $rights[$role] ) {
3188 $allowedGroups[] = $group;
3191 return $allowedGroups;
3195 * Get the localized descriptive name for a group, if it exists
3197 * @param $group \string Internal group name
3198 * @return \string Localized descriptive group name
3200 static function getGroupName( $group ) {
3201 global $wgMessageCache;
3202 $wgMessageCache->loadAllMessages();
3203 $key = "group-$group";
3204 $name = wfMsg( $key );
3205 return $name == '' ||
wfEmptyMsg( $key, $name )
3211 * Get the localized descriptive name for a member of a group, if it exists
3213 * @param $group \string Internal group name
3214 * @return \string Localized name for group member
3216 static function getGroupMember( $group ) {
3217 global $wgMessageCache;
3218 $wgMessageCache->loadAllMessages();
3219 $key = "group-$group-member";
3220 $name = wfMsg( $key );
3221 return $name == '' ||
wfEmptyMsg( $key, $name )
3227 * Return the set of defined explicit groups.
3228 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3229 * are not included, as they are defined automatically, not in the database.
3230 * @return \type{\arrayof{\string}} Array of internal group names
3232 static function getAllGroups() {
3233 global $wgGroupPermissions, $wgRevokePermissions;
3235 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3236 self
::getImplicitGroups()
3241 * Get a list of all available permissions.
3242 * @return \type{\arrayof{\string}} Array of permission names
3244 static function getAllRights() {
3245 if ( self
::$mAllRights === false ) {
3246 global $wgAvailableRights;
3247 if ( count( $wgAvailableRights ) ) {
3248 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3250 self
::$mAllRights = self
::$mCoreRights;
3252 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3254 return self
::$mAllRights;
3258 * Get a list of implicit groups
3259 * @return \type{\arrayof{\string}} Array of internal group names
3261 public static function getImplicitGroups() {
3262 global $wgImplicitGroups;
3263 $groups = $wgImplicitGroups;
3264 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3269 * Get the title of a page describing a particular group
3271 * @param $group \string Internal group name
3272 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3274 static function getGroupPage( $group ) {
3275 global $wgMessageCache;
3276 $wgMessageCache->loadAllMessages();
3277 $page = wfMsgForContent( 'grouppage-' . $group );
3278 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3279 $title = Title
::newFromText( $page );
3280 if( is_object( $title ) )
3287 * Create a link to the group in HTML, if available;
3288 * else return the group name.
3290 * @param $group \string Internal name of the group
3291 * @param $text \string The text of the link
3292 * @return \string HTML link to the group
3294 static function makeGroupLinkHTML( $group, $text = '' ) {
3296 $text = self
::getGroupName( $group );
3298 $title = self
::getGroupPage( $group );
3301 $sk = $wgUser->getSkin();
3302 return $sk->link( $title, htmlspecialchars( $text ) );
3309 * Create a link to the group in Wikitext, if available;
3310 * else return the group name.
3312 * @param $group \string Internal name of the group
3313 * @param $text \string The text of the link
3314 * @return \string Wikilink to the group
3316 static function makeGroupLinkWiki( $group, $text = '' ) {
3318 $text = self
::getGroupName( $group );
3320 $title = self
::getGroupPage( $group );
3322 $page = $title->getPrefixedText();
3323 return "[[$page|$text]]";
3330 * Returns an array of the groups that a particular group can add/remove.
3332 * @param $group String: the group to check for whether it can add/remove
3333 * @return Array array( 'add' => array( addablegroups ),
3334 * 'remove' => array( removablegroups ),
3335 * 'add-self' => array( addablegroups to self),
3336 * 'remove-self' => array( removable groups from self) )
3338 static function changeableByGroup( $group ) {
3339 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3341 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3342 if( empty( $wgAddGroups[$group] ) ) {
3343 // Don't add anything to $groups
3344 } elseif( $wgAddGroups[$group] === true ) {
3345 // You get everything
3346 $groups['add'] = self
::getAllGroups();
3347 } elseif( is_array( $wgAddGroups[$group] ) ) {
3348 $groups['add'] = $wgAddGroups[$group];
3351 // Same thing for remove
3352 if( empty( $wgRemoveGroups[$group] ) ) {
3353 } elseif( $wgRemoveGroups[$group] === true ) {
3354 $groups['remove'] = self
::getAllGroups();
3355 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3356 $groups['remove'] = $wgRemoveGroups[$group];
3359 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3360 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3361 foreach( $wgGroupsAddToSelf as $key => $value ) {
3362 if( is_int( $key ) ) {
3363 $wgGroupsAddToSelf['user'][] = $value;
3368 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3369 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3370 if( is_int( $key ) ) {
3371 $wgGroupsRemoveFromSelf['user'][] = $value;
3376 // Now figure out what groups the user can add to him/herself
3377 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3378 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3379 // No idea WHY this would be used, but it's there
3380 $groups['add-self'] = User
::getAllGroups();
3381 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3382 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3385 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3386 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3387 $groups['remove-self'] = User
::getAllGroups();
3388 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3389 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3396 * Returns an array of groups that this user can add and remove
3397 * @return Array array( 'add' => array( addablegroups ),
3398 * 'remove' => array( removablegroups ),
3399 * 'add-self' => array( addablegroups to self),
3400 * 'remove-self' => array( removable groups from self) )
3402 function changeableGroups() {
3403 if( $this->isAllowed( 'userrights' ) ) {
3404 // This group gives the right to modify everything (reverse-
3405 // compatibility with old "userrights lets you change
3407 // Using array_merge to make the groups reindexed
3408 $all = array_merge( User
::getAllGroups() );
3412 'add-self' => array(),
3413 'remove-self' => array()
3417 // Okay, it's not so simple, we will have to go through the arrays
3420 'remove' => array(),
3421 'add-self' => array(),
3422 'remove-self' => array()
3424 $addergroups = $this->getEffectiveGroups();
3426 foreach( $addergroups as $addergroup ) {
3427 $groups = array_merge_recursive(
3428 $groups, $this->changeableByGroup( $addergroup )
3430 $groups['add'] = array_unique( $groups['add'] );
3431 $groups['remove'] = array_unique( $groups['remove'] );
3432 $groups['add-self'] = array_unique( $groups['add-self'] );
3433 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3439 * Increment the user's edit-count field.
3440 * Will have no effect for anonymous users.
3442 function incEditCount() {
3443 if( !$this->isAnon() ) {
3444 $dbw = wfGetDB( DB_MASTER
);
3445 $dbw->update( 'user',
3446 array( 'user_editcount=user_editcount+1' ),
3447 array( 'user_id' => $this->getId() ),
3450 // Lazy initialization check...
3451 if( $dbw->affectedRows() == 0 ) {
3452 // Pull from a slave to be less cruel to servers
3453 // Accuracy isn't the point anyway here
3454 $dbr = wfGetDB( DB_SLAVE
);
3455 $count = $dbr->selectField( 'revision',
3457 array( 'rev_user' => $this->getId() ),
3460 // Now here's a goddamn hack...
3461 if( $dbr !== $dbw ) {
3462 // If we actually have a slave server, the count is
3463 // at least one behind because the current transaction
3464 // has not been committed and replicated.
3467 // But if DB_SLAVE is selecting the master, then the
3468 // count we just read includes the revision that was
3469 // just added in the working transaction.
3472 $dbw->update( 'user',
3473 array( 'user_editcount' => $count ),
3474 array( 'user_id' => $this->getId() ),
3478 // edit count in user cache too
3479 $this->invalidateCache();
3483 * Get the description of a given right
3485 * @param $right \string Right to query
3486 * @return \string Localized description of the right
3488 static function getRightDescription( $right ) {
3489 global $wgMessageCache;
3490 $wgMessageCache->loadAllMessages();
3491 $key = "right-$right";
3492 $name = wfMsg( $key );
3493 return $name == '' ||
wfEmptyMsg( $key, $name )
3499 * Make an old-style password hash
3501 * @param $password \string Plain-text password
3502 * @param $userId \string User ID
3503 * @return \string Password hash
3505 static function oldCrypt( $password, $userId ) {
3506 global $wgPasswordSalt;
3507 if ( $wgPasswordSalt ) {
3508 return md5( $userId . '-' . md5( $password ) );
3510 return md5( $password );
3515 * Make a new-style password hash
3517 * @param $password \string Plain-text password
3518 * @param $salt \string Optional salt, may be random or the user ID.
3519 * If unspecified or false, will generate one automatically
3520 * @return \string Password hash
3522 static function crypt( $password, $salt = false ) {
3523 global $wgPasswordSalt;
3526 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3530 if( $wgPasswordSalt ) {
3531 if ( $salt === false ) {
3532 $salt = substr( wfGenerateToken(), 0, 8 );
3534 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3536 return ':A:' . md5( $password );
3541 * Compare a password hash with a plain-text password. Requires the user
3542 * ID if there's a chance that the hash is an old-style hash.
3544 * @param $hash \string Password hash
3545 * @param $password \string Plain-text password to compare
3546 * @param $userId \string User ID for old-style password salt
3549 static function comparePasswords( $hash, $password, $userId = false ) {
3551 $type = substr( $hash, 0, 3 );
3554 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3558 if ( $type == ':A:' ) {
3560 return md5( $password ) === substr( $hash, 3 );
3561 } elseif ( $type == ':B:' ) {
3563 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3564 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3567 return self
::oldCrypt( $password, $userId ) === $hash;
3572 * Add a newuser log entry for this user
3573 * @param $byEmail Boolean: account made by email?
3575 public function addNewUserLogEntry( $byEmail = false ) {
3576 global $wgUser, $wgNewUserLog;
3577 if( empty( $wgNewUserLog ) ) {
3578 return true; // disabled
3581 if( $this->getName() == $wgUser->getName() ) {
3585 $action = 'create2';
3587 ?
wfMsgForContent( 'newuserlog-byemail' )
3590 $log = new LogPage( 'newusers' );
3593 $this->getUserPage(),
3595 array( $this->getId() )
3601 * Add an autocreate newuser log entry for this user
3602 * Used by things like CentralAuth and perhaps other authplugins.
3604 public function addNewUserLogEntryAutoCreate() {
3605 global $wgNewUserLog;
3606 if( empty( $wgNewUserLog ) ) {
3607 return true; // disabled
3609 $log = new LogPage( 'newusers', false );
3610 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3614 protected function loadOptions() {
3616 if ( $this->mOptionsLoaded ||
!$this->getId() )
3619 $this->mOptions
= self
::getDefaultOptions();
3621 // Maybe load from the object
3622 if ( !is_null( $this->mOptionOverrides
) ) {
3623 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3624 foreach( $this->mOptionOverrides
as $key => $value ) {
3625 $this->mOptions
[$key] = $value;
3628 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3629 // Load from database
3630 $dbr = wfGetDB( DB_SLAVE
);
3632 $res = $dbr->select(
3635 array( 'up_user' => $this->getId() ),
3639 while( $row = $dbr->fetchObject( $res ) ) {
3640 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3641 $this->mOptions
[$row->up_property
] = $row->up_value
;
3645 $this->mOptionsLoaded
= true;
3647 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3650 protected function saveOptions() {
3651 global $wgAllowPrefChange;
3653 $extuser = ExternalUser
::newFromUser( $this );
3655 $this->loadOptions();
3656 $dbw = wfGetDB( DB_MASTER
);
3658 $insert_rows = array();
3660 $saveOptions = $this->mOptions
;
3662 // Allow hooks to abort, for instance to save to a global profile.
3663 // Reset options to default state before saving.
3664 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3667 foreach( $saveOptions as $key => $value ) {
3668 # Don't bother storing default values
3669 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3670 !( $value === false ||
is_null($value) ) ) ||
3671 $value != self
::getDefaultOption( $key ) ) {
3672 $insert_rows[] = array(
3673 'up_user' => $this->getId(),
3674 'up_property' => $key,
3675 'up_value' => $value,
3678 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3679 switch ( $wgAllowPrefChange[$key] ) {
3685 $extuser->setPref( $key, $value );
3691 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3692 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3697 * Provide an array of HTML5 attributes to put on an input element
3698 * intended for the user to enter a new password. This may include
3699 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3701 * Do *not* use this when asking the user to enter his current password!
3702 * Regardless of configuration, users may have invalid passwords for whatever
3703 * reason (e.g., they were set before requirements were tightened up).
3704 * Only use it when asking for a new password, like on account creation or
3707 * Obviously, you still need to do server-side checking.
3709 * @return array Array of HTML attributes suitable for feeding to
3710 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3711 * That will potentially output invalid XHTML 1.0 Transitional, and will
3712 * get confused by the boolean attribute syntax used.)
3714 public static function passwordChangeInputAttribs() {
3715 global $wgMinimalPasswordLength;
3717 if ( $wgMinimalPasswordLength == 0 ) {
3721 # Note that the pattern requirement will always be satisfied if the
3722 # input is empty, so we need required in all cases.
3723 $ret = array( 'required' );
3725 # We can't actually do this right now, because Opera 9.6 will print out
3726 # the entered password visibly in its error message! When other
3727 # browsers add support for this attribute, or Opera fixes its support,
3728 # we can add support with a version check to avoid doing this on Opera
3729 # versions where it will be a problem. Reported to Opera as
3730 # DSK-262266, but they don't have a public bug tracker for us to follow.
3732 if ( $wgMinimalPasswordLength > 1 ) {
3733 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3734 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3735 $wgMinimalPasswordLength );