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',
73 'enotifwatchlistpages',
74 'enotifusertalkpages',
77 'shownumberswatching',
97 * \type{\arrayof{\string}} List of member variables which are saved to the
98 * shared cache (memcached). Any operation which changes the
99 * corresponding database fields must call a cache-clearing function.
102 static $mCacheVars = array(
113 'mEmailAuthenticated',
115 'mEmailTokenExpires',
120 // user_properties table
125 * \type{\arrayof{\string}} Core rights.
126 * Each of these should have a corresponding message of the form
130 static $mCoreRights = array(
157 'move-rootuserpages',
161 '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 blacklisting may be added here rather than in
604 * isValidUserName() to avoid disrupting existing accounts.
606 * @param $name \string String to match
607 * @return \bool True or false
609 static function isCreatableName( $name ) {
610 global $wgInvalidUsernameCharacters;
612 // Ensure that the username isn't longer than 235 bytes, so that
613 // (at least for the builtin skins) user javascript and css files
614 // will work. (bug 23080)
615 if( strlen( $name ) > 235 ) {
616 wfDebugLog( 'username', __METHOD__
.
617 ": '$name' invalid due to length" );
621 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
622 wfDebugLog( 'username', __METHOD__
.
623 ": '$name' invalid due to wgInvalidUsernameCharacters" );
627 return self
::isUsableName( $name );
631 * Is the input a valid password for this user?
633 * @param $password String Desired password
634 * @return bool True or false
636 function isValidPassword( $password ) {
637 //simple boolean wrapper for getPasswordValidity
638 return $this->getPasswordValidity( $password ) === true;
642 * Given unvalidated password input, return error message on failure.
644 * @param $password String Desired password
645 * @return mixed: true on success, string of error message on failure
647 function getPasswordValidity( $password ) {
648 global $wgMinimalPasswordLength, $wgContLang;
650 $result = false; //init $result to false for the internal checks
652 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
655 if ( $result === false ) {
656 if( strlen( $password ) < $wgMinimalPasswordLength ) {
657 return 'passwordtooshort';
658 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
659 return 'password-name-match';
661 //it seems weird returning true here, but this is because of the
662 //initialization of $result to false above. If the hook is never run or it
663 //doesn't modify $result, then we will likely get down into this if with
667 } elseif( $result === true ) {
670 return $result; //the isValidPassword hook set a string $result and returned true
675 * Does a string look like an e-mail address?
677 * There used to be a regular expression here, it got removed because it
678 * rejected valid addresses. Actually just check if there is '@' somewhere
679 * in the given address.
681 * @todo Check for RFC 2822 compilance (bug 959)
683 * @param $addr \string E-mail address
684 * @return \bool True or false
686 public static function isValidEmailAddr( $addr ) {
688 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
692 return strpos( $addr, '@' ) !== false;
696 * Given unvalidated user input, return a canonical username, or false if
697 * the username is invalid.
698 * @param $name \string User input
699 * @param $validate \types{\string,\bool} Type of validation to use:
700 * - false No validation
701 * - 'valid' Valid for batch processes
702 * - 'usable' Valid for batch processes and login
703 * - 'creatable' Valid for batch processes, login and account creation
705 static function getCanonicalName( $name, $validate = 'valid' ) {
706 # Force usernames to capital
708 $name = $wgContLang->ucfirst( $name );
710 # Reject names containing '#'; these will be cleaned up
711 # with title normalisation, but then it's too late to
713 if( strpos( $name, '#' ) !== false )
716 # Clean up name according to title rules
717 $t = ( $validate === 'valid' ) ?
718 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
719 # Check for invalid titles
720 if( is_null( $t ) ) {
724 # Reject various classes of invalid names
725 $name = $t->getText();
727 $name = $wgAuth->getCanonicalName( $t->getText() );
729 switch ( $validate ) {
733 if ( !User
::isValidUserName( $name ) ) {
738 if ( !User
::isUsableName( $name ) ) {
743 if ( !User
::isCreatableName( $name ) ) {
748 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
754 * Count the number of edits of a user
755 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
757 * @param $uid \int User ID to check
758 * @return \int The user's edit count
760 static function edits( $uid ) {
761 wfProfileIn( __METHOD__
);
762 $dbr = wfGetDB( DB_SLAVE
);
763 // check if the user_editcount field has been initialized
764 $field = $dbr->selectField(
765 'user', 'user_editcount',
766 array( 'user_id' => $uid ),
770 if( $field === null ) { // it has not been initialized. do so.
771 $dbw = wfGetDB( DB_MASTER
);
772 $count = $dbr->selectField(
773 'revision', 'count(*)',
774 array( 'rev_user' => $uid ),
779 array( 'user_editcount' => $count ),
780 array( 'user_id' => $uid ),
786 wfProfileOut( __METHOD__
);
791 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
792 * @todo hash random numbers to improve security, like generateToken()
794 * @return \string New random password
796 static function randomPassword() {
797 global $wgMinimalPasswordLength;
798 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
799 $l = strlen( $pwchars ) - 1;
801 $pwlength = max( 7, $wgMinimalPasswordLength );
802 $digit = mt_rand( 0, $pwlength - 1 );
804 for ( $i = 0; $i < $pwlength; $i++
) {
805 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
811 * Set cached properties to default.
813 * @note This no longer clears uncached lazy-initialised properties;
814 * the constructor does that instead.
817 function loadDefaults( $name = false ) {
818 wfProfileIn( __METHOD__
);
820 global $wgCookiePrefix;
823 $this->mName
= $name;
824 $this->mRealName
= '';
825 $this->mPassword
= $this->mNewpassword
= '';
826 $this->mNewpassTime
= null;
828 $this->mOptionOverrides
= null;
829 $this->mOptionsLoaded
= false;
831 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
832 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
834 $this->mTouched
= '0'; # Allow any pages to be cached
837 $this->setToken(); # Random
838 $this->mEmailAuthenticated
= null;
839 $this->mEmailToken
= '';
840 $this->mEmailTokenExpires
= null;
841 $this->mRegistration
= wfTimestamp( TS_MW
);
842 $this->mGroups
= array();
844 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
846 wfProfileOut( __METHOD__
);
850 * @deprecated Use wfSetupSession().
852 function SetupSession() {
853 wfDeprecated( __METHOD__
);
858 * Load user data from the session or login cookie. If there are no valid
859 * credentials, initialises the user as an anonymous user.
860 * @return \bool True if the user is logged in, false otherwise.
862 private function loadFromSession() {
863 global $wgMemc, $wgCookiePrefix, $wgExternalAuthType, $wgAutocreatePolicy;
866 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
867 if ( $result !== null ) {
871 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
872 $extUser = ExternalUser
::newFromCookie();
874 # TODO: Automatically create the user here (or probably a bit
875 # lower down, in fact)
879 if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
880 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
881 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
882 $this->loadDefaults(); // Possible collision!
883 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
884 cookie user ID ($sId) don't match!" );
887 $_SESSION['wsUserID'] = $sId;
888 } else if ( isset( $_SESSION['wsUserID'] ) ) {
889 if ( $_SESSION['wsUserID'] != 0 ) {
890 $sId = $_SESSION['wsUserID'];
892 $this->loadDefaults();
896 $this->loadDefaults();
900 if ( isset( $_SESSION['wsUserName'] ) ) {
901 $sName = $_SESSION['wsUserName'];
902 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
903 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
904 $_SESSION['wsUserName'] = $sName;
906 $this->loadDefaults();
910 $passwordCorrect = FALSE;
912 if ( !$this->loadFromId() ) {
913 # Not a valid ID, loadFromId has switched the object to anon for us
917 global $wgBlockDisablesLogin;
918 if( $wgBlockDisablesLogin && $this->isBlocked() ) {
919 # User blocked and we've disabled blocked user logins
920 $this->loadDefaults();
924 if ( isset( $_SESSION['wsToken'] ) ) {
925 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
927 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
928 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
931 # No session or persistent login cookie
932 $this->loadDefaults();
936 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
937 $_SESSION['wsToken'] = $this->mToken
;
938 wfDebug( "Logged in from $from\n" );
941 # Invalid credentials
942 wfDebug( "Can't log in from $from, invalid credentials\n" );
943 $this->loadDefaults();
949 * Load user and user_group data from the database.
950 * $this::mId must be set, this is how the user is identified.
952 * @return \bool True if the user exists, false if the user is anonymous
955 function loadFromDatabase() {
957 $this->mId
= intval( $this->mId
);
959 /** Anonymous user */
961 $this->loadDefaults();
965 $dbr = wfGetDB( DB_MASTER
);
966 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
968 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
970 if ( $s !== false ) {
971 # Initialise user table data
972 $this->loadFromRow( $s );
973 $this->mGroups
= null; // deferred
974 $this->getEditCount(); // revalidation for nulls
979 $this->loadDefaults();
985 * Initialize this object from a row from the user table.
987 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
989 function loadFromRow( $row ) {
990 $this->mDataLoaded
= true;
992 if ( isset( $row->user_id
) ) {
993 $this->mId
= intval( $row->user_id
);
995 $this->mName
= $row->user_name
;
996 $this->mRealName
= $row->user_real_name
;
997 $this->mPassword
= $row->user_password
;
998 $this->mNewpassword
= $row->user_newpassword
;
999 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
1000 $this->mEmail
= $row->user_email
;
1001 $this->decodeOptions( $row->user_options
);
1002 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
1003 $this->mToken
= $row->user_token
;
1004 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
1005 $this->mEmailToken
= $row->user_email_token
;
1006 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
1007 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
1008 $this->mEditCount
= $row->user_editcount
;
1012 * Load the groups from the database if they aren't already loaded.
1015 function loadGroups() {
1016 if ( is_null( $this->mGroups
) ) {
1017 $dbr = wfGetDB( DB_MASTER
);
1018 $res = $dbr->select( 'user_groups',
1019 array( 'ug_group' ),
1020 array( 'ug_user' => $this->mId
),
1022 $this->mGroups
= array();
1023 while( $row = $dbr->fetchObject( $res ) ) {
1024 $this->mGroups
[] = $row->ug_group
;
1030 * Clear various cached data stored in this object.
1031 * @param $reloadFrom \string Reload user and user_groups table data from a
1032 * given source. May be "name", "id", "defaults", "session", or false for
1035 function clearInstanceCache( $reloadFrom = false ) {
1036 $this->mNewtalk
= -1;
1037 $this->mDatePreference
= null;
1038 $this->mBlockedby
= -1; # Unset
1039 $this->mHash
= false;
1040 $this->mSkin
= null;
1041 $this->mRights
= null;
1042 $this->mEffectiveGroups
= null;
1043 $this->mOptions
= null;
1045 if ( $reloadFrom ) {
1046 $this->mDataLoaded
= false;
1047 $this->mFrom
= $reloadFrom;
1052 * Combine the language default options with any site-specific options
1053 * and add the default language variants.
1055 * @return \type{\arrayof{\string}} Array of options
1057 static function getDefaultOptions() {
1058 global $wgNamespacesToBeSearchedDefault;
1060 * Site defaults will override the global/language defaults
1062 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1063 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1066 * default language setting
1068 $variant = $wgContLang->getPreferredVariant( false );
1069 $defOpt['variant'] = $variant;
1070 $defOpt['language'] = $variant;
1071 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1072 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1074 $defOpt['skin'] = $wgDefaultSkin;
1080 * Get a given default option value.
1082 * @param $opt \string Name of option to retrieve
1083 * @return \string Default option value
1085 public static function getDefaultOption( $opt ) {
1086 $defOpts = self
::getDefaultOptions();
1087 if( isset( $defOpts[$opt] ) ) {
1088 return $defOpts[$opt];
1095 * Get a list of user toggle names
1096 * @return \type{\arrayof{\string}} Array of user toggle names
1098 static function getToggles() {
1099 global $wgContLang, $wgUseRCPatrol;
1100 $extraToggles = array();
1101 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1102 if( $wgUseRCPatrol ) {
1103 $extraToggles[] = 'hidepatrolled';
1104 $extraToggles[] = 'newpageshidepatrolled';
1105 $extraToggles[] = 'watchlisthidepatrolled';
1107 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1112 * Get blocking information
1114 * @param $bFromSlave \bool Whether to check the slave database first. To
1115 * improve performance, non-critical checks are done
1116 * against slaves. Check when actually saving should be
1117 * done against master.
1119 function getBlockedStatus( $bFromSlave = true ) {
1120 global $wgProxyWhitelist, $wgUser;
1122 if ( -1 != $this->mBlockedby
) {
1123 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1127 wfProfileIn( __METHOD__
);
1128 wfDebug( __METHOD__
.": checking...\n" );
1130 // Initialize data...
1131 // Otherwise something ends up stomping on $this->mBlockedby when
1132 // things get lazy-loaded later, causing false positive block hits
1133 // due to -1 !== 0. Probably session-related... Nothing should be
1134 // overwriting mBlockedby, surely?
1137 $this->mBlockedby
= 0;
1138 $this->mHideName
= 0;
1139 $this->mAllowUsertalk
= 0;
1141 # Check if we are looking at an IP or a logged-in user
1142 if ( $this->isIP( $this->getName() ) ) {
1143 $ip = $this->getName();
1145 # Check if we are looking at the current user
1146 # If we don't, and the user is logged in, we don't know about
1147 # his IP / autoblock status, so ignore autoblock of current user's IP
1148 if ( $this->getID() != $wgUser->getID() ) {
1151 # Get IP of current user
1156 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1157 # Exempt from all types of IP-block
1162 $this->mBlock
= new Block();
1163 $this->mBlock
->fromMaster( !$bFromSlave );
1164 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1165 wfDebug( __METHOD__
. ": Found block.\n" );
1166 $this->mBlockedby
= $this->mBlock
->mBy
;
1167 if( $this->mBlockedby
== 0 )
1168 $this->mBlockedby
= $this->mBlock
->mByName
;
1169 $this->mBlockreason
= $this->mBlock
->mReason
;
1170 $this->mHideName
= $this->mBlock
->mHideName
;
1171 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1172 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1173 $this->spreadBlock();
1176 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1177 // apply to users. Note that the existence of $this->mBlock is not used to
1178 // check for edit blocks, $this->mBlockedby is instead.
1182 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1184 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1185 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1186 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1190 if ( !$this->mBlockedby
&& !$this->getID() ) {
1191 if ( $this->isDnsBlacklisted( $ip ) ) {
1192 $this->mBlockedby
= wfMsg( 'sorbs' );
1193 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1199 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1201 wfProfileOut( __METHOD__
);
1205 * Whether the given IP is in a DNS blacklist.
1207 * @param $ip \string IP to check
1208 * @param $checkWhitelist Boolean: whether to check the whitelist first
1209 * @return \bool True if blacklisted.
1211 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1212 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1213 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1215 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1218 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1221 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1222 return $this->inDnsBlacklist( $ip, $urls );
1226 * Whether the given IP is in a given DNS blacklist.
1228 * @param $ip \string IP to check
1229 * @param $bases \string or Array of Strings: URL of the DNS blacklist
1230 * @return \bool True if blacklisted.
1232 function inDnsBlacklist( $ip, $bases ) {
1233 wfProfileIn( __METHOD__
);
1237 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1238 if( IP
::isIPv4( $ip ) ) {
1239 # Reverse IP, bug 21255
1240 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1242 foreach( (array)$bases as $base ) {
1244 $host = "$ipReversed.$base";
1247 $ipList = gethostbynamel( $host );
1250 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1254 wfDebug( "Requested $host, not found in $base.\n" );
1259 wfProfileOut( __METHOD__
);
1264 * Is this user subject to rate limiting?
1266 * @return \bool True if rate limited
1268 public function isPingLimitable() {
1269 global $wgRateLimitsExcludedGroups;
1270 global $wgRateLimitsExcludedIPs;
1271 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1272 // Deprecated, but kept for backwards-compatibility config
1275 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1276 // No other good way currently to disable rate limits
1277 // for specific IPs. :P
1278 // But this is a crappy hack and should die.
1281 return !$this->isAllowed('noratelimit');
1285 * Primitive rate limits: enforce maximum actions per time period
1286 * to put a brake on flooding.
1288 * @note When using a shared cache like memcached, IP-address
1289 * last-hit counters will be shared across wikis.
1291 * @param $action \string Action to enforce; 'edit' if unspecified
1292 * @return \bool True if a rate limiter was tripped
1294 function pingLimiter( $action = 'edit' ) {
1295 # Call the 'PingLimiter' hook
1297 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1301 global $wgRateLimits;
1302 if( !isset( $wgRateLimits[$action] ) ) {
1306 # Some groups shouldn't trigger the ping limiter, ever
1307 if( !$this->isPingLimitable() )
1310 global $wgMemc, $wgRateLimitLog;
1311 wfProfileIn( __METHOD__
);
1313 $limits = $wgRateLimits[$action];
1315 $id = $this->getId();
1319 if( isset( $limits['anon'] ) && $id == 0 ) {
1320 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1323 if( isset( $limits['user'] ) && $id != 0 ) {
1324 $userLimit = $limits['user'];
1326 if( $this->isNewbie() ) {
1327 if( isset( $limits['newbie'] ) && $id != 0 ) {
1328 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1330 if( isset( $limits['ip'] ) ) {
1331 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1334 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1335 $subnet = $matches[1];
1336 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1339 // Check for group-specific permissions
1340 // If more than one group applies, use the group with the highest limit
1341 foreach ( $this->getGroups() as $group ) {
1342 if ( isset( $limits[$group] ) ) {
1343 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1344 $userLimit = $limits[$group];
1348 // Set the user limit key
1349 if ( $userLimit !== false ) {
1350 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1351 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1355 foreach( $keys as $key => $limit ) {
1356 list( $max, $period ) = $limit;
1357 $summary = "(limit $max in {$period}s)";
1358 $count = $wgMemc->get( $key );
1361 if( $count > $max ) {
1362 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1363 if( $wgRateLimitLog ) {
1364 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1368 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1371 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1372 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1374 $wgMemc->incr( $key );
1377 wfProfileOut( __METHOD__
);
1382 * Check if user is blocked
1384 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1385 * @return \bool True if blocked, false otherwise
1387 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1388 wfDebug( "User::isBlocked: enter\n" );
1389 $this->getBlockedStatus( $bFromSlave );
1390 return $this->mBlockedby
!== 0;
1394 * Check if user is blocked from editing a particular article
1396 * @param $title \string Title to check
1397 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1398 * @return \bool True if blocked, false otherwise
1400 function isBlockedFrom( $title, $bFromSlave = false ) {
1401 global $wgBlockAllowsUTEdit;
1402 wfProfileIn( __METHOD__
);
1403 wfDebug( __METHOD__
. ": enter\n" );
1405 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1406 $blocked = $this->isBlocked( $bFromSlave );
1407 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1408 # If a user's name is suppressed, they cannot make edits anywhere
1409 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1410 $title->getNamespace() == NS_USER_TALK
) {
1412 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1415 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1417 wfProfileOut( __METHOD__
);
1422 * If user is blocked, return the name of the user who placed the block
1423 * @return \string name of blocker
1425 function blockedBy() {
1426 $this->getBlockedStatus();
1427 return $this->mBlockedby
;
1431 * If user is blocked, return the specified reason for the block
1432 * @return \string Blocking reason
1434 function blockedFor() {
1435 $this->getBlockedStatus();
1436 return $this->mBlockreason
;
1440 * If user is blocked, return the ID for the block
1441 * @return \int Block ID
1443 function getBlockId() {
1444 $this->getBlockedStatus();
1445 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1449 * Check if user is blocked on all wikis.
1450 * Do not use for actual edit permission checks!
1451 * This is intented for quick UI checks.
1453 * @param $ip \type{\string} IP address, uses current client if none given
1454 * @return \type{\bool} True if blocked, false otherwise
1456 function isBlockedGlobally( $ip = '' ) {
1457 if( $this->mBlockedGlobally
!== null ) {
1458 return $this->mBlockedGlobally
;
1460 // User is already an IP?
1461 if( IP
::isIPAddress( $this->getName() ) ) {
1462 $ip = $this->getName();
1467 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1468 $this->mBlockedGlobally
= (bool)$blocked;
1469 return $this->mBlockedGlobally
;
1473 * Check if user account is locked
1475 * @return \type{\bool} True if locked, false otherwise
1477 function isLocked() {
1478 if( $this->mLocked
!== null ) {
1479 return $this->mLocked
;
1482 $authUser = $wgAuth->getUserInstance( $this );
1483 $this->mLocked
= (bool)$authUser->isLocked();
1484 return $this->mLocked
;
1488 * Check if user account is hidden
1490 * @return \type{\bool} True if hidden, false otherwise
1492 function isHidden() {
1493 if( $this->mHideName
!== null ) {
1494 return $this->mHideName
;
1496 $this->getBlockedStatus();
1497 if( !$this->mHideName
) {
1499 $authUser = $wgAuth->getUserInstance( $this );
1500 $this->mHideName
= (bool)$authUser->isHidden();
1502 return $this->mHideName
;
1506 * Get the user's ID.
1507 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1510 if( $this->mId
=== null and $this->mName
!== null
1511 and User
::isIP( $this->mName
) ) {
1512 // Special case, we know the user is anonymous
1514 } elseif( $this->mId
=== null ) {
1515 // Don't load if this was initialized from an ID
1522 * Set the user and reload all fields according to a given ID
1523 * @param $v \int User ID to reload
1525 function setId( $v ) {
1527 $this->clearInstanceCache( 'id' );
1531 * Get the user name, or the IP of an anonymous user
1532 * @return \string User's name or IP address
1534 function getName() {
1535 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1536 # Special case optimisation
1537 return $this->mName
;
1540 if ( $this->mName
=== false ) {
1542 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1544 return $this->mName
;
1549 * Set the user name.
1551 * This does not reload fields from the database according to the given
1552 * name. Rather, it is used to create a temporary "nonexistent user" for
1553 * later addition to the database. It can also be used to set the IP
1554 * address for an anonymous user to something other than the current
1557 * @note User::newFromName() has rougly the same function, when the named user
1559 * @param $str \string New user name to set
1561 function setName( $str ) {
1563 $this->mName
= $str;
1567 * Get the user's name escaped by underscores.
1568 * @return \string Username escaped by underscores.
1570 function getTitleKey() {
1571 return str_replace( ' ', '_', $this->getName() );
1575 * Check if the user has new messages.
1576 * @return \bool True if the user has new messages
1578 function getNewtalk() {
1581 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1582 if( $this->mNewtalk
=== -1 ) {
1583 $this->mNewtalk
= false; # reset talk page status
1585 # Check memcached separately for anons, who have no
1586 # entire User object stored in there.
1589 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1590 $newtalk = $wgMemc->get( $key );
1591 if( strval( $newtalk ) !== '' ) {
1592 $this->mNewtalk
= (bool)$newtalk;
1594 // Since we are caching this, make sure it is up to date by getting it
1596 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1597 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1600 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1604 return (bool)$this->mNewtalk
;
1608 * Return the talk page(s) this user has new messages on.
1609 * @return \type{\arrayof{\string}} Array of page URLs
1611 function getNewMessageLinks() {
1613 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1616 if( !$this->getNewtalk() )
1618 $up = $this->getUserPage();
1619 $utp = $up->getTalkPage();
1620 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1624 * Internal uncached check for new messages
1627 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1628 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1629 * @param $fromMaster \bool true to fetch from the master, false for a slave
1630 * @return \bool True if the user has new messages
1633 function checkNewtalk( $field, $id, $fromMaster = false ) {
1634 if ( $fromMaster ) {
1635 $db = wfGetDB( DB_MASTER
);
1637 $db = wfGetDB( DB_SLAVE
);
1639 $ok = $db->selectField( 'user_newtalk', $field,
1640 array( $field => $id ), __METHOD__
);
1641 return $ok !== false;
1645 * Add or update the new messages flag
1646 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1647 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1648 * @return \bool True if successful, false otherwise
1651 function updateNewtalk( $field, $id ) {
1652 $dbw = wfGetDB( DB_MASTER
);
1653 $dbw->insert( 'user_newtalk',
1654 array( $field => $id ),
1657 if ( $dbw->affectedRows() ) {
1658 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1661 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1667 * Clear the new messages flag for the given user
1668 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1669 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1670 * @return \bool True if successful, false otherwise
1673 function deleteNewtalk( $field, $id ) {
1674 $dbw = wfGetDB( DB_MASTER
);
1675 $dbw->delete( 'user_newtalk',
1676 array( $field => $id ),
1678 if ( $dbw->affectedRows() ) {
1679 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1682 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1688 * Update the 'You have new messages!' status.
1689 * @param $val \bool Whether the user has new messages
1691 function setNewtalk( $val ) {
1692 if( wfReadOnly() ) {
1697 $this->mNewtalk
= $val;
1699 if( $this->isAnon() ) {
1701 $id = $this->getName();
1704 $id = $this->getId();
1709 $changed = $this->updateNewtalk( $field, $id );
1711 $changed = $this->deleteNewtalk( $field, $id );
1714 if( $this->isAnon() ) {
1715 // Anons have a separate memcached space, since
1716 // user records aren't kept for them.
1717 $key = wfMemcKey( 'newtalk', 'ip', $id );
1718 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1721 $this->invalidateCache();
1726 * Generate a current or new-future timestamp to be stored in the
1727 * user_touched field when we update things.
1728 * @return \string Timestamp in TS_MW format
1730 private static function newTouchedTimestamp() {
1731 global $wgClockSkewFudge;
1732 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1736 * Clear user data from memcached.
1737 * Use after applying fun updates to the database; caller's
1738 * responsibility to update user_touched if appropriate.
1740 * Called implicitly from invalidateCache() and saveSettings().
1742 private function clearSharedCache() {
1746 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1751 * Immediately touch the user data cache for this account.
1752 * Updates user_touched field, and removes account data from memcached
1753 * for reload on the next hit.
1755 function invalidateCache() {
1756 if( wfReadOnly() ) {
1761 $this->mTouched
= self
::newTouchedTimestamp();
1763 $dbw = wfGetDB( DB_MASTER
);
1764 $dbw->update( 'user',
1765 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1766 array( 'user_id' => $this->mId
),
1769 $this->clearSharedCache();
1774 * Validate the cache for this account.
1775 * @param $timestamp \string A timestamp in TS_MW format
1777 function validateCache( $timestamp ) {
1779 return ( $timestamp >= $this->mTouched
);
1783 * Get the user touched timestamp
1785 function getTouched() {
1787 return $this->mTouched
;
1791 * Set the password and reset the random token.
1792 * Calls through to authentication plugin if necessary;
1793 * will have no effect if the auth plugin refuses to
1794 * pass the change through or if the legal password
1797 * As a special case, setting the password to null
1798 * wipes it, so the account cannot be logged in until
1799 * a new password is set, for instance via e-mail.
1801 * @param $str \string New password to set
1802 * @throws PasswordError on failure
1804 function setPassword( $str ) {
1807 if( $str !== null ) {
1808 if( !$wgAuth->allowPasswordChange() ) {
1809 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1812 if( !$this->isValidPassword( $str ) ) {
1813 global $wgMinimalPasswordLength;
1814 $valid = $this->getPasswordValidity( $str );
1815 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1816 $wgMinimalPasswordLength ) );
1820 if( !$wgAuth->setPassword( $this, $str ) ) {
1821 throw new PasswordError( wfMsg( 'externaldberror' ) );
1824 $this->setInternalPassword( $str );
1830 * Set the password and reset the random token unconditionally.
1832 * @param $str \string New password to set
1834 function setInternalPassword( $str ) {
1838 if( $str === null ) {
1839 // Save an invalid hash...
1840 $this->mPassword
= '';
1842 $this->mPassword
= self
::crypt( $str );
1844 $this->mNewpassword
= '';
1845 $this->mNewpassTime
= null;
1849 * Get the user's current token.
1850 * @return \string Token
1852 function getToken() {
1854 return $this->mToken
;
1858 * Set the random token (used for persistent authentication)
1859 * Called from loadDefaults() among other places.
1861 * @param $token \string If specified, set the token to this value
1864 function setToken( $token = false ) {
1865 global $wgSecretKey, $wgProxyKey;
1868 if ( $wgSecretKey ) {
1869 $key = $wgSecretKey;
1870 } elseif ( $wgProxyKey ) {
1875 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1877 $this->mToken
= $token;
1882 * Set the cookie password
1884 * @param $str \string New cookie password
1887 function setCookiePassword( $str ) {
1889 $this->mCookiePassword
= md5( $str );
1893 * Set the password for a password reminder or new account email
1895 * @param $str \string New password to set
1896 * @param $throttle \bool If true, reset the throttle timestamp to the present
1898 function setNewpassword( $str, $throttle = true ) {
1900 $this->mNewpassword
= self
::crypt( $str );
1902 $this->mNewpassTime
= wfTimestampNow();
1907 * Has password reminder email been sent within the last
1908 * $wgPasswordReminderResendTime hours?
1909 * @return \bool True or false
1911 function isPasswordReminderThrottled() {
1912 global $wgPasswordReminderResendTime;
1914 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1917 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1918 return time() < $expiry;
1922 * Get the user's e-mail address
1923 * @return \string User's email address
1925 function getEmail() {
1927 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1928 return $this->mEmail
;
1932 * Get the timestamp of the user's e-mail authentication
1933 * @return \string TS_MW timestamp
1935 function getEmailAuthenticationTimestamp() {
1937 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1938 return $this->mEmailAuthenticated
;
1942 * Set the user's e-mail address
1943 * @param $str \string New e-mail address
1945 function setEmail( $str ) {
1947 $this->mEmail
= $str;
1948 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1952 * Get the user's real name
1953 * @return \string User's real name
1955 function getRealName() {
1957 return $this->mRealName
;
1961 * Set the user's real name
1962 * @param $str \string New real name
1964 function setRealName( $str ) {
1966 $this->mRealName
= $str;
1970 * Get the user's current setting for a given option.
1972 * @param $oname \string The option to check
1973 * @param $defaultOverride \string A default value returned if the option does not exist
1974 * @return \string User's current value for the option
1975 * @see getBoolOption()
1976 * @see getIntOption()
1978 function getOption( $oname, $defaultOverride = null ) {
1979 $this->loadOptions();
1981 if ( is_null( $this->mOptions
) ) {
1982 if($defaultOverride != '') {
1983 return $defaultOverride;
1985 $this->mOptions
= User
::getDefaultOptions();
1988 if ( array_key_exists( $oname, $this->mOptions
) ) {
1989 return $this->mOptions
[$oname];
1991 return $defaultOverride;
1996 * Get all user's options
2000 public function getOptions() {
2001 $this->loadOptions();
2002 return $this->mOptions
;
2006 * Get the user's current setting for a given option, as a boolean value.
2008 * @param $oname \string The option to check
2009 * @return \bool User's current value for the option
2012 function getBoolOption( $oname ) {
2013 return (bool)$this->getOption( $oname );
2018 * Get the user's current setting for a given option, as a boolean value.
2020 * @param $oname \string The option to check
2021 * @param $defaultOverride \int A default value returned if the option does not exist
2022 * @return \int User's current value for the option
2025 function getIntOption( $oname, $defaultOverride=0 ) {
2026 $val = $this->getOption( $oname );
2028 $val = $defaultOverride;
2030 return intval( $val );
2034 * Set the given option for a user.
2036 * @param $oname \string The option to set
2037 * @param $val \mixed New value to set
2039 function setOption( $oname, $val ) {
2041 $this->loadOptions();
2043 if ( $oname == 'skin' ) {
2044 # Clear cached skin, so the new one displays immediately in Special:Preferences
2045 unset( $this->mSkin
);
2048 // Explicitly NULL values should refer to defaults
2049 global $wgDefaultUserOptions;
2050 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2051 $val = $wgDefaultUserOptions[$oname];
2054 $this->mOptions
[$oname] = $val;
2058 * Reset all options to the site defaults
2060 function resetOptions() {
2061 $this->mOptions
= User
::getDefaultOptions();
2065 * Get the user's preferred date format.
2066 * @return \string User's preferred date format
2068 function getDatePreference() {
2069 // Important migration for old data rows
2070 if ( is_null( $this->mDatePreference
) ) {
2072 $value = $this->getOption( 'date' );
2073 $map = $wgLang->getDatePreferenceMigrationMap();
2074 if ( isset( $map[$value] ) ) {
2075 $value = $map[$value];
2077 $this->mDatePreference
= $value;
2079 return $this->mDatePreference
;
2083 * Get the permissions this user has.
2084 * @return \type{\arrayof{\string}} Array of permission names
2086 function getRights() {
2087 if ( is_null( $this->mRights
) ) {
2088 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2089 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2090 // Force reindexation of rights when a hook has unset one of them
2091 $this->mRights
= array_values( $this->mRights
);
2093 return $this->mRights
;
2097 * Get the list of explicit group memberships this user has.
2098 * The implicit * and user groups are not included.
2099 * @return \type{\arrayof{\string}} Array of internal group names
2101 function getGroups() {
2103 return $this->mGroups
;
2107 * Get the list of implicit group memberships this user has.
2108 * This includes all explicit groups, plus 'user' if logged in,
2109 * '*' for all accounts and autopromoted groups
2110 * @param $recache \bool Whether to avoid the cache
2111 * @return \type{\arrayof{\string}} Array of internal group names
2113 function getEffectiveGroups( $recache = false ) {
2114 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2115 wfProfileIn( __METHOD__
);
2116 $this->mEffectiveGroups
= $this->getGroups();
2117 $this->mEffectiveGroups
[] = '*';
2118 if( $this->getId() ) {
2119 $this->mEffectiveGroups
[] = 'user';
2121 $this->mEffectiveGroups
= array_unique( array_merge(
2122 $this->mEffectiveGroups
,
2123 Autopromote
::getAutopromoteGroups( $this )
2126 # Hook for additional groups
2127 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2129 wfProfileOut( __METHOD__
);
2131 return $this->mEffectiveGroups
;
2135 * Get the user's edit count.
2136 * @return \int User'e edit count
2138 function getEditCount() {
2139 if( $this->getId() ) {
2140 if ( !isset( $this->mEditCount
) ) {
2141 /* Populate the count, if it has not been populated yet */
2142 $this->mEditCount
= User
::edits( $this->mId
);
2144 return $this->mEditCount
;
2152 * Add the user to the given group.
2153 * This takes immediate effect.
2154 * @param $group \string Name of the group to add
2156 function addGroup( $group ) {
2157 $dbw = wfGetDB( DB_MASTER
);
2158 if( $this->getId() ) {
2159 $dbw->insert( 'user_groups',
2161 'ug_user' => $this->getID(),
2162 'ug_group' => $group,
2165 array( 'IGNORE' ) );
2168 $this->loadGroups();
2169 $this->mGroups
[] = $group;
2170 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2172 $this->invalidateCache();
2176 * Remove the user from the given group.
2177 * This takes immediate effect.
2178 * @param $group \string Name of the group to remove
2180 function removeGroup( $group ) {
2182 $dbw = wfGetDB( DB_MASTER
);
2183 $dbw->delete( 'user_groups',
2185 'ug_user' => $this->getID(),
2186 'ug_group' => $group,
2189 $this->loadGroups();
2190 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2191 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2193 $this->invalidateCache();
2197 * Get whether the user is logged in
2198 * @return \bool True or false
2200 function isLoggedIn() {
2201 return $this->getID() != 0;
2205 * Get whether the user is anonymous
2206 * @return \bool True or false
2209 return !$this->isLoggedIn();
2213 * Get whether the user is a bot
2214 * @return \bool True or false
2218 wfDeprecated( __METHOD__
);
2219 return $this->isAllowed( 'bot' );
2223 * Check if user is allowed to access a feature / make an action
2224 * @param $action \string action to be checked
2225 * @return \bool True if action is allowed, else false
2227 function isAllowed( $action = '' ) {
2228 if ( $action === '' )
2229 return true; // In the spirit of DWIM
2230 # Patrolling may not be enabled
2231 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2232 global $wgUseRCPatrol, $wgUseNPPatrol;
2233 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2236 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2237 # by misconfiguration: 0 == 'foo'
2238 return in_array( $action, $this->getRights(), true );
2242 * Check whether to enable recent changes patrol features for this user
2243 * @return \bool True or false
2245 public function useRCPatrol() {
2246 global $wgUseRCPatrol;
2247 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2251 * Check whether to enable new pages patrol features for this user
2252 * @return \bool True or false
2254 public function useNPPatrol() {
2255 global $wgUseRCPatrol, $wgUseNPPatrol;
2256 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2260 * Get the current skin, loading it if required, and setting a title
2261 * @param $t Title: the title to use in the skin
2262 * @return Skin The current skin
2263 * @todo FIXME : need to check the old failback system [AV]
2265 function &getSkin( $t = null ) {
2266 if ( !isset( $this->mSkin
) ) {
2267 wfProfileIn( __METHOD__
);
2269 global $wgHiddenPrefs;
2270 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2273 $userSkin = $this->getOption( 'skin' );
2274 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2276 # if we're not allowing users to override, then use the default
2277 global $wgDefaultSkin;
2278 $userSkin = $wgDefaultSkin;
2281 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2282 wfProfileOut( __METHOD__
);
2284 if( $t ||
!$this->mSkin
->getTitle() ) {
2287 $t = $wgOut->getTitle();
2289 $this->mSkin
->setTitle( $t );
2291 return $this->mSkin
;
2295 * Check the watched status of an article.
2296 * @param $title \type{Title} Title of the article to look at
2297 * @return \bool True if article is watched
2299 function isWatched( $title ) {
2300 $wl = WatchedItem
::fromUserTitle( $this, $title );
2301 return $wl->isWatched();
2306 * @param $title \type{Title} Title of the article to look at
2308 function addWatch( $title ) {
2309 $wl = WatchedItem
::fromUserTitle( $this, $title );
2311 $this->invalidateCache();
2315 * Stop watching an article.
2316 * @param $title \type{Title} Title of the article to look at
2318 function removeWatch( $title ) {
2319 $wl = WatchedItem
::fromUserTitle( $this, $title );
2321 $this->invalidateCache();
2325 * Clear the user's notification timestamp for the given title.
2326 * If e-notif e-mails are on, they will receive notification mails on
2327 * the next change of the page if it's watched etc.
2328 * @param $title \type{Title} Title of the article to look at
2330 function clearNotification( &$title ) {
2331 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2333 # Do nothing if the database is locked to writes
2334 if( wfReadOnly() ) {
2338 if( $title->getNamespace() == NS_USER_TALK
&&
2339 $title->getText() == $this->getName() ) {
2340 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2342 $this->setNewtalk( false );
2345 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2349 if( $this->isAnon() ) {
2350 // Nothing else to do...
2354 // Only update the timestamp if the page is being watched.
2355 // The query to find out if it is watched is cached both in memcached and per-invocation,
2356 // and when it does have to be executed, it can be on a slave
2357 // If this is the user's newtalk page, we always update the timestamp
2358 if( $title->getNamespace() == NS_USER_TALK
&&
2359 $title->getText() == $wgUser->getName() )
2362 } elseif ( $this->getId() == $wgUser->getId() ) {
2363 $watched = $title->userIsWatching();
2368 // If the page is watched by the user (or may be watched), update the timestamp on any
2369 // any matching rows
2371 $dbw = wfGetDB( DB_MASTER
);
2372 $dbw->update( 'watchlist',
2374 'wl_notificationtimestamp' => null
2375 ), array( /* WHERE */
2376 'wl_title' => $title->getDBkey(),
2377 'wl_namespace' => $title->getNamespace(),
2378 'wl_user' => $this->getID()
2385 * Resets all of the given user's page-change notification timestamps.
2386 * If e-notif e-mails are on, they will receive notification mails on
2387 * the next change of any watched page.
2389 * @param $currentUser \int User ID
2391 function clearAllNotifications( $currentUser ) {
2392 global $wgUseEnotif, $wgShowUpdatedMarker;
2393 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2394 $this->setNewtalk( false );
2397 if( $currentUser != 0 ) {
2398 $dbw = wfGetDB( DB_MASTER
);
2399 $dbw->update( 'watchlist',
2401 'wl_notificationtimestamp' => null
2402 ), array( /* WHERE */
2403 'wl_user' => $currentUser
2406 # We also need to clear here the "you have new message" notification for the own user_talk page
2407 # This is cleared one page view later in Article::viewUpdates();
2412 * Set this user's options from an encoded string
2413 * @param $str \string Encoded options to import
2416 function decodeOptions( $str ) {
2420 $this->mOptionsLoaded
= true;
2421 $this->mOptionOverrides
= array();
2423 $this->mOptions
= array();
2424 $a = explode( "\n", $str );
2425 foreach ( $a as $s ) {
2427 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2428 $this->mOptions
[$m[1]] = $m[2];
2429 $this->mOptionOverrides
[$m[1]] = $m[2];
2435 * Set a cookie on the user's client. Wrapper for
2436 * WebResponse::setCookie
2437 * @param $name \string Name of the cookie to set
2438 * @param $value \string Value to set
2439 * @param $exp \int Expiration time, as a UNIX time value;
2440 * if 0 or not specified, use the default $wgCookieExpiration
2442 protected function setCookie( $name, $value, $exp = 0 ) {
2444 $wgRequest->response()->setcookie( $name, $value, $exp );
2448 * Clear a cookie on the user's client
2449 * @param $name \string Name of the cookie to clear
2451 protected function clearCookie( $name ) {
2452 $this->setCookie( $name, '', time() - 86400 );
2456 * Set the default cookies for this session on the user's client.
2458 function setCookies() {
2460 if ( 0 == $this->mId
) return;
2462 'wsUserID' => $this->mId
,
2463 'wsToken' => $this->mToken
,
2464 'wsUserName' => $this->getName()
2467 'UserID' => $this->mId
,
2468 'UserName' => $this->getName(),
2470 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2471 $cookies['Token'] = $this->mToken
;
2473 $cookies['Token'] = false;
2476 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2477 #check for null, since the hook could cause a null value
2478 if ( !is_null( $session ) && isset( $_SESSION ) ){
2479 $_SESSION = $session +
$_SESSION;
2481 foreach ( $cookies as $name => $value ) {
2482 if ( $value === false ) {
2483 $this->clearCookie( $name );
2485 $this->setCookie( $name, $value );
2491 * Log this user out.
2494 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2500 * Clear the user's cookies and session, and reset the instance cache.
2504 function doLogout() {
2505 $this->clearInstanceCache( 'defaults' );
2507 $_SESSION['wsUserID'] = 0;
2509 $this->clearCookie( 'UserID' );
2510 $this->clearCookie( 'Token' );
2512 # Remember when user logged out, to prevent seeing cached pages
2513 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2517 * Save this user's settings into the database.
2518 * @todo Only rarely do all these fields need to be set!
2520 function saveSettings() {
2522 if ( wfReadOnly() ) { return; }
2523 if ( 0 == $this->mId
) { return; }
2525 $this->mTouched
= self
::newTouchedTimestamp();
2527 $dbw = wfGetDB( DB_MASTER
);
2528 $dbw->update( 'user',
2530 'user_name' => $this->mName
,
2531 'user_password' => $this->mPassword
,
2532 'user_newpassword' => $this->mNewpassword
,
2533 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2534 'user_real_name' => $this->mRealName
,
2535 'user_email' => $this->mEmail
,
2536 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2537 'user_options' => '',
2538 'user_touched' => $dbw->timestamp( $this->mTouched
),
2539 'user_token' => $this->mToken
,
2540 'user_email_token' => $this->mEmailToken
,
2541 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2542 ), array( /* WHERE */
2543 'user_id' => $this->mId
2547 $this->saveOptions();
2549 wfRunHooks( 'UserSaveSettings', array( $this ) );
2550 $this->clearSharedCache();
2551 $this->getUserPage()->invalidateCache();
2555 * If only this user's username is known, and it exists, return the user ID.
2557 function idForName() {
2558 $s = trim( $this->getName() );
2559 if ( $s === '' ) return 0;
2561 $dbr = wfGetDB( DB_SLAVE
);
2562 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2563 if ( $id === false ) {
2570 * Add a user to the database, return the user object
2572 * @param $name \string Username to add
2573 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2574 * - password The user's password. Password logins will be disabled if this is omitted.
2575 * - newpassword A temporary password mailed to the user
2576 * - email The user's email address
2577 * - email_authenticated The email authentication timestamp
2578 * - real_name The user's real name
2579 * - options An associative array of non-default options
2580 * - token Random authentication token. Do not set.
2581 * - registration Registration timestamp. Do not set.
2583 * @return \type{User} A new User object, or null if the username already exists
2585 static function createNew( $name, $params = array() ) {
2588 if ( isset( $params['options'] ) ) {
2589 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2590 unset( $params['options'] );
2592 $dbw = wfGetDB( DB_MASTER
);
2593 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2595 'user_id' => $seqVal,
2596 'user_name' => $name,
2597 'user_password' => $user->mPassword
,
2598 'user_newpassword' => $user->mNewpassword
,
2599 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2600 'user_email' => $user->mEmail
,
2601 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2602 'user_real_name' => $user->mRealName
,
2603 'user_options' => '',
2604 'user_token' => $user->mToken
,
2605 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2606 'user_editcount' => 0,
2608 foreach ( $params as $name => $value ) {
2609 $fields["user_$name"] = $value;
2611 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2612 if ( $dbw->affectedRows() ) {
2613 $newUser = User
::newFromId( $dbw->insertId() );
2621 * Add this existing user object to the database
2623 function addToDatabase() {
2625 $dbw = wfGetDB( DB_MASTER
);
2626 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2627 $dbw->insert( 'user',
2629 'user_id' => $seqVal,
2630 'user_name' => $this->mName
,
2631 'user_password' => $this->mPassword
,
2632 'user_newpassword' => $this->mNewpassword
,
2633 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2634 'user_email' => $this->mEmail
,
2635 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2636 'user_real_name' => $this->mRealName
,
2637 'user_options' => '',
2638 'user_token' => $this->mToken
,
2639 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2640 'user_editcount' => 0,
2643 $this->mId
= $dbw->insertId();
2645 // Clear instance cache other than user table data, which is already accurate
2646 $this->clearInstanceCache();
2648 $this->saveOptions();
2652 * If this (non-anonymous) user is blocked, block any IP address
2653 * they've successfully logged in from.
2655 function spreadBlock() {
2656 wfDebug( __METHOD__
. "()\n" );
2658 if ( $this->mId
== 0 ) {
2662 $userblock = Block
::newFromDB( '', $this->mId
);
2663 if ( !$userblock ) {
2667 $userblock->doAutoblock( wfGetIP() );
2671 * Generate a string which will be different for any combination of
2672 * user options which would produce different parser output.
2673 * This will be used as part of the hash key for the parser cache,
2674 * so users with the same options can share the same cached data
2677 * Extensions which require it should install 'PageRenderingHash' hook,
2678 * which will give them a chance to modify this key based on their own
2681 * @return \string Page rendering hash
2683 function getPageRenderingHash() {
2684 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2686 return $this->mHash
;
2689 // stubthreshold is only included below for completeness,
2690 // it will always be 0 when this function is called by parsercache.
2692 $confstr = $this->getOption( 'math' );
2693 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2694 if ( $wgUseDynamicDates ) {
2695 $confstr .= '!' . $this->getDatePreference();
2697 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2698 $confstr .= '!' . $wgLang->getCode();
2699 $confstr .= '!' . $this->getOption( 'thumbsize' );
2700 // add in language specific options, if any
2701 $extra = $wgContLang->getExtraHashOptions();
2704 $confstr .= $wgRenderHashAppend;
2706 // Give a chance for extensions to modify the hash, if they have
2707 // extra options or other effects on the parser cache.
2708 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2710 // Make it a valid memcached key fragment
2711 $confstr = str_replace( ' ', '_', $confstr );
2712 $this->mHash
= $confstr;
2717 * Get whether the user is explicitly blocked from account creation.
2718 * @return \bool True if blocked
2720 function isBlockedFromCreateAccount() {
2721 $this->getBlockedStatus();
2722 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2726 * Get whether the user is blocked from using Special:Emailuser.
2727 * @return \bool True if blocked
2729 function isBlockedFromEmailuser() {
2730 $this->getBlockedStatus();
2731 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2735 * Get whether the user is allowed to create an account.
2736 * @return \bool True if allowed
2738 function isAllowedToCreateAccount() {
2739 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2745 function setLoaded( $loaded ) {
2746 wfDeprecated( __METHOD__
);
2750 * Get this user's personal page title.
2752 * @return \type{Title} User's personal page title
2754 function getUserPage() {
2755 return Title
::makeTitle( NS_USER
, $this->getName() );
2759 * Get this user's talk page title.
2761 * @return \type{Title} User's talk page title
2763 function getTalkPage() {
2764 $title = $this->getUserPage();
2765 return $title->getTalkPage();
2769 * Get the maximum valid user ID.
2770 * @return \int User ID
2773 function getMaxID() {
2774 static $res; // cache
2776 if ( isset( $res ) )
2779 $dbr = wfGetDB( DB_SLAVE
);
2780 return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__
);
2785 * Determine whether the user is a newbie. Newbies are either
2786 * anonymous IPs, or the most recently created accounts.
2787 * @return \bool True if the user is a newbie
2789 function isNewbie() {
2790 return !$this->isAllowed( 'autoconfirmed' );
2794 * Check to see if the given clear-text password is one of the accepted passwords
2795 * @param $password \string user password.
2796 * @return \bool True if the given password is correct, otherwise False.
2798 function checkPassword( $password ) {
2802 // Even though we stop people from creating passwords that
2803 // are shorter than this, doesn't mean people wont be able
2804 // to. Certain authentication plugins do NOT want to save
2805 // domain passwords in a mysql database, so we should
2806 // check this (incase $wgAuth->strict() is false).
2807 if( !$this->isValidPassword( $password ) ) {
2811 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2813 } elseif( $wgAuth->strict() ) {
2814 /* Auth plugin doesn't allow local authentication */
2816 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2817 /* Auth plugin doesn't allow local authentication for this user name */
2820 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2822 } elseif ( function_exists( 'iconv' ) ) {
2823 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2824 # Check for this with iconv
2825 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2826 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2834 * Check if the given clear-text password matches the temporary password
2835 * sent by e-mail for password reset operations.
2836 * @return \bool True if matches, false otherwise
2838 function checkTemporaryPassword( $plaintext ) {
2839 global $wgNewPasswordExpiry;
2840 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2842 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2843 return ( time() < $expiry );
2850 * Initialize (if necessary) and return a session token value
2851 * which can be used in edit forms to show that the user's
2852 * login credentials aren't being hijacked with a foreign form
2855 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2856 * @return \string The new edit token
2858 function editToken( $salt = '' ) {
2859 if ( $this->isAnon() ) {
2860 return EDIT_TOKEN_SUFFIX
;
2862 if( !isset( $_SESSION['wsEditToken'] ) ) {
2863 $token = self
::generateToken();
2864 $_SESSION['wsEditToken'] = $token;
2866 $token = $_SESSION['wsEditToken'];
2868 if( is_array( $salt ) ) {
2869 $salt = implode( '|', $salt );
2871 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2876 * Generate a looking random token for various uses.
2878 * @param $salt \string Optional salt value
2879 * @return \string The new random token
2881 public static function generateToken( $salt = '' ) {
2882 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2883 return md5( $token . $salt );
2887 * Check given value against the token value stored in the session.
2888 * A match should confirm that the form was submitted from the
2889 * user's own login session, not a form submission from a third-party
2892 * @param $val \string Input value to compare
2893 * @param $salt \string Optional function-specific data for hashing
2894 * @return \bool Whether the token matches
2896 function matchEditToken( $val, $salt = '' ) {
2897 $sessionToken = $this->editToken( $salt );
2898 if ( $val != $sessionToken ) {
2899 wfDebug( "User::matchEditToken: broken session data\n" );
2901 return $val == $sessionToken;
2905 * Check given value against the token value stored in the session,
2906 * ignoring the suffix.
2908 * @param $val \string Input value to compare
2909 * @param $salt \string Optional function-specific data for hashing
2910 * @return \bool Whether the token matches
2912 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2913 $sessionToken = $this->editToken( $salt );
2914 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2918 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2919 * mail to the user's given address.
2921 * @param $changed Boolean: whether the adress changed
2922 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2924 function sendConfirmationMail( $changed = false ) {
2926 $expiration = null; // gets passed-by-ref and defined in next line.
2927 $token = $this->confirmationToken( $expiration );
2928 $url = $this->confirmationTokenUrl( $token );
2929 $invalidateURL = $this->invalidationTokenUrl( $token );
2930 $this->saveSettings();
2932 $message = $changed ?
'confirmemail_body_changed' : 'confirmemail_body';
2933 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2938 $wgLang->timeanddate( $expiration, false ),
2940 $wgLang->date( $expiration, false ),
2941 $wgLang->time( $expiration, false ) ) );
2945 * Send an e-mail to this user's account. Does not check for
2946 * confirmed status or validity.
2948 * @param $subject \string Message subject
2949 * @param $body \string Message body
2950 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2951 * @param $replyto \string Reply-To address
2952 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2954 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2955 if( is_null( $from ) ) {
2956 global $wgPasswordSender;
2957 $from = $wgPasswordSender;
2960 $to = new MailAddress( $this );
2961 $sender = new MailAddress( $from );
2962 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2966 * Generate, store, and return a new e-mail confirmation code.
2967 * A hash (unsalted, since it's used as a key) is stored.
2969 * @note Call saveSettings() after calling this function to commit
2970 * this change to the database.
2972 * @param[out] &$expiration \mixed Accepts the expiration time
2973 * @return \string New token
2976 function confirmationToken( &$expiration ) {
2978 $expires = $now +
7 * 24 * 60 * 60;
2979 $expiration = wfTimestamp( TS_MW
, $expires );
2980 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
2981 $hash = md5( $token );
2983 $this->mEmailToken
= $hash;
2984 $this->mEmailTokenExpires
= $expiration;
2989 * Return a URL the user can use to confirm their email address.
2990 * @param $token \string Accepts the email confirmation token
2991 * @return \string New token URL
2994 function confirmationTokenUrl( $token ) {
2995 return $this->getTokenUrl( 'ConfirmEmail', $token );
2999 * Return a URL the user can use to invalidate their email address.
3000 * @param $token \string Accepts the email confirmation token
3001 * @return \string New token URL
3004 function invalidationTokenUrl( $token ) {
3005 return $this->getTokenUrl( 'Invalidateemail', $token );
3009 * Internal function to format the e-mail validation/invalidation URLs.
3010 * This uses $wgArticlePath directly as a quickie hack to use the
3011 * hardcoded English names of the Special: pages, for ASCII safety.
3013 * @note Since these URLs get dropped directly into emails, using the
3014 * short English names avoids insanely long URL-encoded links, which
3015 * also sometimes can get corrupted in some browsers/mailers
3016 * (bug 6957 with Gmail and Internet Explorer).
3018 * @param $page \string Special page
3019 * @param $token \string Token
3020 * @return \string Formatted URL
3022 protected function getTokenUrl( $page, $token ) {
3023 global $wgArticlePath;
3027 "Special:$page/$token",
3032 * Mark the e-mail address confirmed.
3034 * @note Call saveSettings() after calling this function to commit the change.
3036 function confirmEmail() {
3037 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3038 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3043 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3044 * address if it was already confirmed.
3046 * @note Call saveSettings() after calling this function to commit the change.
3048 function invalidateEmail() {
3050 $this->mEmailToken
= null;
3051 $this->mEmailTokenExpires
= null;
3052 $this->setEmailAuthenticationTimestamp( null );
3053 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3058 * Set the e-mail authentication timestamp.
3059 * @param $timestamp \string TS_MW timestamp
3061 function setEmailAuthenticationTimestamp( $timestamp ) {
3063 $this->mEmailAuthenticated
= $timestamp;
3064 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3068 * Is this user allowed to send e-mails within limits of current
3069 * site configuration?
3070 * @return \bool True if allowed
3072 function canSendEmail() {
3073 global $wgEnableEmail, $wgEnableUserEmail;
3074 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3077 $canSend = $this->isEmailConfirmed();
3078 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3083 * Is this user allowed to receive e-mails within limits of current
3084 * site configuration?
3085 * @return \bool True if allowed
3087 function canReceiveEmail() {
3088 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3092 * Is this user's e-mail address valid-looking and confirmed within
3093 * limits of the current site configuration?
3095 * @note If $wgEmailAuthentication is on, this may require the user to have
3096 * confirmed their address by returning a code or using a password
3097 * sent to the address from the wiki.
3099 * @return \bool True if confirmed
3101 function isEmailConfirmed() {
3102 global $wgEmailAuthentication;
3105 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3106 if( $this->isAnon() )
3108 if( !self
::isValidEmailAddr( $this->mEmail
) )
3110 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3119 * Check whether there is an outstanding request for e-mail confirmation.
3120 * @return \bool True if pending
3122 function isEmailConfirmationPending() {
3123 global $wgEmailAuthentication;
3124 return $wgEmailAuthentication &&
3125 !$this->isEmailConfirmed() &&
3126 $this->mEmailToken
&&
3127 $this->mEmailTokenExpires
> wfTimestamp();
3131 * Get the timestamp of account creation.
3133 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3134 * non-existent/anonymous user accounts.
3136 public function getRegistration() {
3137 return $this->getId() > 0
3138 ?
$this->mRegistration
3143 * Get the timestamp of the first edit
3145 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3146 * non-existent/anonymous user accounts.
3148 public function getFirstEditTimestamp() {
3149 if( $this->getId() == 0 ) return false; // anons
3150 $dbr = wfGetDB( DB_SLAVE
);
3151 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3152 array( 'rev_user' => $this->getId() ),
3154 array( 'ORDER BY' => 'rev_timestamp ASC' )
3156 if( !$time ) return false; // no edits
3157 return wfTimestamp( TS_MW
, $time );
3161 * Get the permissions associated with a given list of groups
3163 * @param $groups \type{\arrayof{\string}} List of internal group names
3164 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3166 static function getGroupPermissions( $groups ) {
3167 global $wgGroupPermissions, $wgRevokePermissions;
3169 // grant every granted permission first
3170 foreach( $groups as $group ) {
3171 if( isset( $wgGroupPermissions[$group] ) ) {
3172 $rights = array_merge( $rights,
3173 // array_filter removes empty items
3174 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3177 // now revoke the revoked permissions
3178 foreach( $groups as $group ) {
3179 if( isset( $wgRevokePermissions[$group] ) ) {
3180 $rights = array_diff( $rights,
3181 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3184 return array_unique( $rights );
3188 * Get all the groups who have a given permission
3190 * @param $role \string Role to check
3191 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3193 static function getGroupsWithPermission( $role ) {
3194 global $wgGroupPermissions;
3195 $allowedGroups = array();
3196 foreach ( $wgGroupPermissions as $group => $rights ) {
3197 if ( isset( $rights[$role] ) && $rights[$role] ) {
3198 $allowedGroups[] = $group;
3201 return $allowedGroups;
3205 * Get the localized descriptive name for a group, if it exists
3207 * @param $group \string Internal group name
3208 * @return \string Localized descriptive group name
3210 static function getGroupName( $group ) {
3211 global $wgMessageCache;
3212 $wgMessageCache->loadAllMessages();
3213 $key = "group-$group";
3214 $name = wfMsg( $key );
3215 return $name == '' ||
wfEmptyMsg( $key, $name )
3221 * Get the localized descriptive name for a member of a group, if it exists
3223 * @param $group \string Internal group name
3224 * @return \string Localized name for group member
3226 static function getGroupMember( $group ) {
3227 global $wgMessageCache;
3228 $wgMessageCache->loadAllMessages();
3229 $key = "group-$group-member";
3230 $name = wfMsg( $key );
3231 return $name == '' ||
wfEmptyMsg( $key, $name )
3237 * Return the set of defined explicit groups.
3238 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3239 * are not included, as they are defined automatically, not in the database.
3240 * @return \type{\arrayof{\string}} Array of internal group names
3242 static function getAllGroups() {
3243 global $wgGroupPermissions, $wgRevokePermissions;
3245 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3246 self
::getImplicitGroups()
3251 * Get a list of all available permissions.
3252 * @return \type{\arrayof{\string}} Array of permission names
3254 static function getAllRights() {
3255 if ( self
::$mAllRights === false ) {
3256 global $wgAvailableRights;
3257 if ( count( $wgAvailableRights ) ) {
3258 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3260 self
::$mAllRights = self
::$mCoreRights;
3262 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3264 return self
::$mAllRights;
3268 * Get a list of implicit groups
3269 * @return \type{\arrayof{\string}} Array of internal group names
3271 public static function getImplicitGroups() {
3272 global $wgImplicitGroups;
3273 $groups = $wgImplicitGroups;
3274 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3279 * Get the title of a page describing a particular group
3281 * @param $group \string Internal group name
3282 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3284 static function getGroupPage( $group ) {
3285 global $wgMessageCache;
3286 $wgMessageCache->loadAllMessages();
3287 $page = wfMsgForContent( 'grouppage-' . $group );
3288 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3289 $title = Title
::newFromText( $page );
3290 if( is_object( $title ) )
3297 * Create a link to the group in HTML, if available;
3298 * else return the group name.
3300 * @param $group \string Internal name of the group
3301 * @param $text \string The text of the link
3302 * @return \string HTML link to the group
3304 static function makeGroupLinkHTML( $group, $text = '' ) {
3306 $text = self
::getGroupName( $group );
3308 $title = self
::getGroupPage( $group );
3311 $sk = $wgUser->getSkin();
3312 return $sk->link( $title, htmlspecialchars( $text ) );
3319 * Create a link to the group in Wikitext, if available;
3320 * else return the group name.
3322 * @param $group \string Internal name of the group
3323 * @param $text \string The text of the link
3324 * @return \string Wikilink to the group
3326 static function makeGroupLinkWiki( $group, $text = '' ) {
3328 $text = self
::getGroupName( $group );
3330 $title = self
::getGroupPage( $group );
3332 $page = $title->getPrefixedText();
3333 return "[[$page|$text]]";
3340 * Returns an array of the groups that a particular group can add/remove.
3342 * @param $group String: the group to check for whether it can add/remove
3343 * @return Array array( 'add' => array( addablegroups ),
3344 * 'remove' => array( removablegroups ),
3345 * 'add-self' => array( addablegroups to self),
3346 * 'remove-self' => array( removable groups from self) )
3348 static function changeableByGroup( $group ) {
3349 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3351 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3352 if( empty( $wgAddGroups[$group] ) ) {
3353 // Don't add anything to $groups
3354 } elseif( $wgAddGroups[$group] === true ) {
3355 // You get everything
3356 $groups['add'] = self
::getAllGroups();
3357 } elseif( is_array( $wgAddGroups[$group] ) ) {
3358 $groups['add'] = $wgAddGroups[$group];
3361 // Same thing for remove
3362 if( empty( $wgRemoveGroups[$group] ) ) {
3363 } elseif( $wgRemoveGroups[$group] === true ) {
3364 $groups['remove'] = self
::getAllGroups();
3365 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3366 $groups['remove'] = $wgRemoveGroups[$group];
3369 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3370 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3371 foreach( $wgGroupsAddToSelf as $key => $value ) {
3372 if( is_int( $key ) ) {
3373 $wgGroupsAddToSelf['user'][] = $value;
3378 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3379 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3380 if( is_int( $key ) ) {
3381 $wgGroupsRemoveFromSelf['user'][] = $value;
3386 // Now figure out what groups the user can add to him/herself
3387 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3388 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3389 // No idea WHY this would be used, but it's there
3390 $groups['add-self'] = User
::getAllGroups();
3391 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3392 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3395 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3396 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3397 $groups['remove-self'] = User
::getAllGroups();
3398 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3399 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3406 * Returns an array of groups that this user can add and remove
3407 * @return Array array( 'add' => array( addablegroups ),
3408 * 'remove' => array( removablegroups ),
3409 * 'add-self' => array( addablegroups to self),
3410 * 'remove-self' => array( removable groups from self) )
3412 function changeableGroups() {
3413 if( $this->isAllowed( 'userrights' ) ) {
3414 // This group gives the right to modify everything (reverse-
3415 // compatibility with old "userrights lets you change
3417 // Using array_merge to make the groups reindexed
3418 $all = array_merge( User
::getAllGroups() );
3422 'add-self' => array(),
3423 'remove-self' => array()
3427 // Okay, it's not so simple, we will have to go through the arrays
3430 'remove' => array(),
3431 'add-self' => array(),
3432 'remove-self' => array()
3434 $addergroups = $this->getEffectiveGroups();
3436 foreach( $addergroups as $addergroup ) {
3437 $groups = array_merge_recursive(
3438 $groups, $this->changeableByGroup( $addergroup )
3440 $groups['add'] = array_unique( $groups['add'] );
3441 $groups['remove'] = array_unique( $groups['remove'] );
3442 $groups['add-self'] = array_unique( $groups['add-self'] );
3443 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3449 * Increment the user's edit-count field.
3450 * Will have no effect for anonymous users.
3452 function incEditCount() {
3453 if( !$this->isAnon() ) {
3454 $dbw = wfGetDB( DB_MASTER
);
3455 $dbw->update( 'user',
3456 array( 'user_editcount=user_editcount+1' ),
3457 array( 'user_id' => $this->getId() ),
3460 // Lazy initialization check...
3461 if( $dbw->affectedRows() == 0 ) {
3462 // Pull from a slave to be less cruel to servers
3463 // Accuracy isn't the point anyway here
3464 $dbr = wfGetDB( DB_SLAVE
);
3465 $count = $dbr->selectField( 'revision',
3467 array( 'rev_user' => $this->getId() ),
3470 // Now here's a goddamn hack...
3471 if( $dbr !== $dbw ) {
3472 // If we actually have a slave server, the count is
3473 // at least one behind because the current transaction
3474 // has not been committed and replicated.
3477 // But if DB_SLAVE is selecting the master, then the
3478 // count we just read includes the revision that was
3479 // just added in the working transaction.
3482 $dbw->update( 'user',
3483 array( 'user_editcount' => $count ),
3484 array( 'user_id' => $this->getId() ),
3488 // edit count in user cache too
3489 $this->invalidateCache();
3493 * Get the description of a given right
3495 * @param $right \string Right to query
3496 * @return \string Localized description of the right
3498 static function getRightDescription( $right ) {
3499 global $wgMessageCache;
3500 $wgMessageCache->loadAllMessages();
3501 $key = "right-$right";
3502 $name = wfMsg( $key );
3503 return $name == '' ||
wfEmptyMsg( $key, $name )
3509 * Make an old-style password hash
3511 * @param $password \string Plain-text password
3512 * @param $userId \string User ID
3513 * @return \string Password hash
3515 static function oldCrypt( $password, $userId ) {
3516 global $wgPasswordSalt;
3517 if ( $wgPasswordSalt ) {
3518 return md5( $userId . '-' . md5( $password ) );
3520 return md5( $password );
3525 * Make a new-style password hash
3527 * @param $password \string Plain-text password
3528 * @param $salt \string Optional salt, may be random or the user ID.
3529 * If unspecified or false, will generate one automatically
3530 * @return \string Password hash
3532 static function crypt( $password, $salt = false ) {
3533 global $wgPasswordSalt;
3536 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3540 if( $wgPasswordSalt ) {
3541 if ( $salt === false ) {
3542 $salt = substr( wfGenerateToken(), 0, 8 );
3544 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3546 return ':A:' . md5( $password );
3551 * Compare a password hash with a plain-text password. Requires the user
3552 * ID if there's a chance that the hash is an old-style hash.
3554 * @param $hash \string Password hash
3555 * @param $password \string Plain-text password to compare
3556 * @param $userId \string User ID for old-style password salt
3559 static function comparePasswords( $hash, $password, $userId = false ) {
3560 $type = substr( $hash, 0, 3 );
3563 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3567 if ( $type == ':A:' ) {
3569 return md5( $password ) === substr( $hash, 3 );
3570 } elseif ( $type == ':B:' ) {
3572 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3573 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3576 return self
::oldCrypt( $password, $userId ) === $hash;
3581 * Add a newuser log entry for this user
3582 * @param $byEmail Boolean: account made by email?
3584 public function addNewUserLogEntry( $byEmail = false ) {
3585 global $wgUser, $wgNewUserLog;
3586 if( empty( $wgNewUserLog ) ) {
3587 return true; // disabled
3590 if( $this->getName() == $wgUser->getName() ) {
3594 $action = 'create2';
3596 ?
wfMsgForContent( 'newuserlog-byemail' )
3599 $log = new LogPage( 'newusers' );
3602 $this->getUserPage(),
3604 array( $this->getId() )
3610 * Add an autocreate newuser log entry for this user
3611 * Used by things like CentralAuth and perhaps other authplugins.
3613 public function addNewUserLogEntryAutoCreate() {
3614 global $wgNewUserLog, $wgLogAutocreatedAccounts;
3615 if( !$wgNewUserLog ||
!$wgLogAutocreatedAccounts ) {
3616 return true; // disabled
3618 $log = new LogPage( 'newusers', false );
3619 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3623 protected function loadOptions() {
3625 if ( $this->mOptionsLoaded ||
!$this->getId() )
3628 $this->mOptions
= self
::getDefaultOptions();
3630 // Maybe load from the object
3631 if ( !is_null( $this->mOptionOverrides
) ) {
3632 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3633 foreach( $this->mOptionOverrides
as $key => $value ) {
3634 $this->mOptions
[$key] = $value;
3637 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3638 // Load from database
3639 $dbr = wfGetDB( DB_SLAVE
);
3641 $res = $dbr->select(
3644 array( 'up_user' => $this->getId() ),
3648 while( $row = $dbr->fetchObject( $res ) ) {
3649 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3650 $this->mOptions
[$row->up_property
] = $row->up_value
;
3654 $this->mOptionsLoaded
= true;
3656 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3659 protected function saveOptions() {
3660 global $wgAllowPrefChange;
3662 $extuser = ExternalUser
::newFromUser( $this );
3664 $this->loadOptions();
3665 $dbw = wfGetDB( DB_MASTER
);
3667 $insert_rows = array();
3669 $saveOptions = $this->mOptions
;
3671 // Allow hooks to abort, for instance to save to a global profile.
3672 // Reset options to default state before saving.
3673 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3676 foreach( $saveOptions as $key => $value ) {
3677 # Don't bother storing default values
3678 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3679 !( $value === false ||
is_null($value) ) ) ||
3680 $value != self
::getDefaultOption( $key ) ) {
3681 $insert_rows[] = array(
3682 'up_user' => $this->getId(),
3683 'up_property' => $key,
3684 'up_value' => $value,
3687 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3688 switch ( $wgAllowPrefChange[$key] ) {
3694 $extuser->setPref( $key, $value );
3700 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3701 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3706 * Provide an array of HTML5 attributes to put on an input element
3707 * intended for the user to enter a new password. This may include
3708 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3710 * Do *not* use this when asking the user to enter his current password!
3711 * Regardless of configuration, users may have invalid passwords for whatever
3712 * reason (e.g., they were set before requirements were tightened up).
3713 * Only use it when asking for a new password, like on account creation or
3716 * Obviously, you still need to do server-side checking.
3718 * NOTE: A combination of bugs in various browsers means that this function
3719 * actually just returns array() unconditionally at the moment. May as
3720 * well keep it around for when the browser bugs get fixed, though.
3722 * @return array Array of HTML attributes suitable for feeding to
3723 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3724 * That will potentially output invalid XHTML 1.0 Transitional, and will
3725 * get confused by the boolean attribute syntax used.)
3727 public static function passwordChangeInputAttribs() {
3728 global $wgMinimalPasswordLength;
3730 if ( $wgMinimalPasswordLength == 0 ) {
3734 # Note that the pattern requirement will always be satisfied if the
3735 # input is empty, so we need required in all cases.
3737 # FIXME (bug 23769): This needs to not claim the password is required
3738 # if e-mail confirmation is being used. Since HTML5 input validation
3739 # is b0rked anyway in some browsers, just return nothing. When it's
3740 # re-enabled, fix this code to not output required for e-mail
3742 #$ret = array( 'required' );
3745 # We can't actually do this right now, because Opera 9.6 will print out
3746 # the entered password visibly in its error message! When other
3747 # browsers add support for this attribute, or Opera fixes its support,
3748 # we can add support with a version check to avoid doing this on Opera
3749 # versions where it will be a problem. Reported to Opera as
3750 # DSK-262266, but they don't have a public bug tracker for us to follow.
3752 if ( $wgMinimalPasswordLength > 1 ) {
3753 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3754 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3755 $wgMinimalPasswordLength );
3763 * Format the user message using a hook, a template, or, failing these, a static format.
3764 * @param $subject String the subject of the message
3765 * @param $text String the content of the message
3766 * @param $signature String the signature, if provided.
3768 static protected function formatUserMessage( $subject, $text, $signature ) {
3769 if ( wfRunHooks( 'FormatUserMessage',
3770 array( $subject, &$text, $signature ) ) ) {
3772 $signature = empty($signature) ?
"~~~~~" : "{$signature} ~~~~~";
3774 $template = Title
::newFromText( wfMsgForContent( 'usermessage-template' ) );
3776 ||
$template->getNamespace() !== NS_TEMPLATE
3777 ||
!$template->exists() ) {
3778 $text = "== $subject ==\n\n$text\n\n-- $signature";
3780 $text = '{{'. $template->getText()
3781 . " | subject=$subject | body=$text | signature=$signature }}";
3789 * Leave a user a message
3790 * @param $subject String the subject of the message
3791 * @param $text String the message to leave
3792 * @param $signature String Text to leave in the signature
3793 * @param $summary String the summary for this change, defaults to
3794 * "Leave system message."
3795 * @param $article Article The article to update, defaults to the
3797 * @param $editor User The user leaving the message, defaults to
3798 * "{{MediaWiki:usermessage-editor}}"
3799 * @param $flags Int default edit flags
3801 * @return boolean true if it was successful
3803 public function leaveUserMessage( $subject, $text, $signature = "",
3804 $summary = null, $editor = null, $flags = 0 ) {
3805 if ( !isset( $summary ) ) {
3806 $summary = wfMsgForContent( 'usermessage-summary' );
3809 if ( !isset( $editor ) ) {
3810 $editor = User
::newFromName( wfMsgForContent( 'usermessage-editor' ) );
3811 if ( !$editor->isLoggedIn() ) {
3812 $editor->addToDatabase();
3816 $article = new Article( $this->getTalkPage() );
3817 wfRunHooks( 'SetupUserMessageArticle',
3818 array( $this, &$article, $subject, $text, $signature, $summary, $editor ) );
3821 $text = self
::formatUserMessage( $subject, $text, $signature );
3822 $flags = $article->checkFlags( $flags );
3824 if ( $flags & EDIT_UPDATE
) {
3825 $text .= $article->getContent();
3828 $dbw = wfGetDB( DB_MASTER
);
3832 $status = $article->doEdit( $text, $summary, $flags, false, $editor );
3833 } catch ( DBQueryError
$e ) {
3834 $status = Status
::newFatal("DB Error");
3837 if ( $status->isGood() ) {
3838 // Set newtalk with the right user ID
3839 $this->setNewtalk( true );
3840 wfRunHooks( 'AfterUserMessage',
3841 array( $this, $article, $summary, $text, $signature, $summary, $editor ) );
3844 // The article was concurrently created
3845 wfDebug( __METHOD__
. ": Error ".$status->getWikiText() );
3849 return $status->isGood();