3 * Implements the User class for the %MediaWiki software.
8 * \int Number of characters in user_token field.
11 define( 'USER_TOKEN_LENGTH', 32 );
14 * \int Serialized record version.
17 define( 'MW_USER_VERSION', 8 );
20 * \string Some punctuation to prevent editing from broken text-mangling proxies.
23 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
26 * Thrown by User::setPassword() on error.
29 class PasswordError
extends MWException
{
34 * The User object encapsulates all of the user-specific settings (user_id,
35 * name, rights, password, email address, options, last login time). Client
36 * classes use the getXXX() functions to access these fields. These functions
37 * do all the work of determining whether the user is logged in,
38 * whether the requested option can be satisfied from cookies or
39 * whether a database query is needed. Most of the settings needed
40 * for rendering normal pages are set in the cookie to minimize use
46 * \type{\arrayof{\string}} A list of default user toggles, i.e., boolean user
47 * preferences that are displayed by Special:Preferences as checkboxes.
48 * This list can be extended via the UserToggles hook or by
49 * $wgContLang::getExtraUserToggles().
52 public static $mToggles = array(
62 'editsectiononrightclick',
74 'enotifwatchlistpages',
75 'enotifusertalkpages',
78 'shownumberswatching',
98 * \type{\arrayof{\string}} List of member variables which are saved to the
99 * shared cache (memcached). Any operation which changes the
100 * corresponding database fields must call a cache-clearing function.
103 static $mCacheVars = array(
114 'mEmailAuthenticated',
116 'mEmailTokenExpires',
121 // user_properties table
126 * \type{\arrayof{\string}} Core rights.
127 * Each of these should have a corresponding message of the form
131 static $mCoreRights = array(
157 'move-rootuserpages',
161 'override-export-depth',
180 'userrights-interwiki',
184 * \string Cached results of getAllRights()
186 static $mAllRights = false;
188 /** @name Cache variables */
190 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
191 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
192 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
196 * \bool Whether the cache variables have been loaded.
198 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
201 * \string Initialization data source if mDataLoaded==false. May be one of:
202 * - 'defaults' anonymous user initialised from class defaults
203 * - 'name' initialise from mName
204 * - 'id' initialise from mId
205 * - 'session' log in from cookies or session if possible
207 * Use the User::newFrom*() family of functions to set this.
211 /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
213 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
214 $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
215 $mLocked, $mHideName, $mOptions;
219 * Lightweight constructor for an anonymous user.
220 * Use the User::newFrom* factory functions for other kinds of users.
224 * @see newFromConfirmationCode()
225 * @see newFromSession()
229 $this->clearInstanceCache( 'defaults' );
233 * Load the user table data for this object from the source given by mFrom.
236 if ( $this->mDataLoaded
) {
239 wfProfileIn( __METHOD__
);
241 # Set it now to avoid infinite recursion in accessors
242 $this->mDataLoaded
= true;
244 switch ( $this->mFrom
) {
246 $this->loadDefaults();
249 $this->mId
= self
::idFromName( $this->mName
);
251 # Nonexistent user placeholder object
252 $this->loadDefaults( $this->mName
);
261 $this->loadFromSession();
262 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
265 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
267 wfProfileOut( __METHOD__
);
271 * Load user table data, given mId has already been set.
272 * @return \bool false if the ID does not exist, true otherwise
275 function loadFromId() {
277 if ( $this->mId
== 0 ) {
278 $this->loadDefaults();
283 $key = wfMemcKey( 'user', 'id', $this->mId
);
284 $data = $wgMemc->get( $key );
285 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
286 # Object is expired, load from DB
291 wfDebug( "Cache miss for user {$this->mId}\n" );
293 if ( !$this->loadFromDatabase() ) {
294 # Can't load from ID, user is anonymous
297 $this->saveToCache();
299 wfDebug( "Got user {$this->mId} from cache\n" );
301 foreach ( self
::$mCacheVars as $name ) {
302 $this->$name = $data[$name];
309 * Save user data to the shared cache
311 function saveToCache() {
314 $this->loadOptions();
315 if ( $this->isAnon() ) {
316 // Anonymous users are uncached
320 foreach ( self
::$mCacheVars as $name ) {
321 $data[$name] = $this->$name;
323 $data['mVersion'] = MW_USER_VERSION
;
324 $key = wfMemcKey( 'user', 'id', $this->mId
);
326 $wgMemc->set( $key, $data );
330 /** @name newFrom*() static factory methods */
334 * Static factory method for creation from username.
336 * This is slightly less efficient than newFromId(), so use newFromId() if
337 * you have both an ID and a name handy.
339 * @param $name \string Username, validated by Title::newFromText()
340 * @param $validate \mixed Validate username. Takes the same parameters as
341 * User::getCanonicalName(), except that true is accepted as an alias
342 * for 'valid', for BC.
344 * @return \type{User} The User object, or null if the username is invalid. If the
345 * username is not present in the database, the result will be a user object
346 * with a name, zero user ID and default settings.
348 static function newFromName( $name, $validate = 'valid' ) {
349 if ( $validate === true ) {
352 $name = self
::getCanonicalName( $name, $validate );
353 if ( $name === false ) {
356 # Create unloaded user object
365 * Static factory method for creation from a given user ID.
367 * @param $id \int Valid user ID
368 * @return \type{User} The corresponding User object
370 static function newFromId( $id ) {
378 * Factory method to fetch whichever user has a given email confirmation code.
379 * This code is generated when an account is created or its e-mail address
382 * If the code is invalid or has expired, returns NULL.
384 * @param $code \string Confirmation code
385 * @return \type{User}
387 static function newFromConfirmationCode( $code ) {
388 $dbr = wfGetDB( DB_SLAVE
);
389 $id = $dbr->selectField( 'user', 'user_id', array(
390 'user_email_token' => md5( $code ),
391 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
393 if( $id !== false ) {
394 return User
::newFromId( $id );
401 * Create a new user object using data from session or cookies. If the
402 * login credentials are invalid, the result is an anonymous user.
404 * @return \type{User}
406 static function newFromSession() {
408 $user->mFrom
= 'session';
413 * Create a new user object from a user row.
414 * The row should have all fields from the user table in it.
415 * @param $row array A row from the user table
416 * @return \type{User}
418 static function newFromRow( $row ) {
420 $user->loadFromRow( $row );
428 * Get the username corresponding to a given user ID
429 * @param $id \int User ID
430 * @return \string The corresponding username
432 static function whoIs( $id ) {
433 $dbr = wfGetDB( DB_SLAVE
);
434 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
438 * Get the real name of a user given their user ID
440 * @param $id \int User ID
441 * @return \string The corresponding user's real name
443 static function whoIsReal( $id ) {
444 $dbr = wfGetDB( DB_SLAVE
);
445 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
449 * Get database id given a user name
450 * @param $name \string Username
451 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
453 static function idFromName( $name ) {
454 $nt = Title
::makeTitleSafe( NS_USER
, $name );
455 if( is_null( $nt ) ) {
459 $dbr = wfGetDB( DB_SLAVE
);
460 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
462 if ( $s === false ) {
470 * Does the string match an anonymous IPv4 address?
472 * This function exists for username validation, in order to reject
473 * usernames which are similar in form to IP addresses. Strings such
474 * as 300.300.300.300 will return true because it looks like an IP
475 * address, despite not being strictly valid.
477 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
478 * address because the usemod software would "cloak" anonymous IP
479 * addresses like this, if we allowed accounts like this to be created
480 * new users could get the old edits of these anonymous users.
482 * @param $name \string String to match
483 * @return \bool True or false
485 static function isIP( $name ) {
486 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
490 * Is the input a valid username?
492 * Checks if the input is a valid username, we don't want an empty string,
493 * an IP address, anything that containins slashes (would mess up subpages),
494 * is longer than the maximum allowed username size or doesn't begin with
497 * @param $name \string String to match
498 * @return \bool True or false
500 static function isValidUserName( $name ) {
501 global $wgContLang, $wgMaxNameChars;
504 || User
::isIP( $name )
505 ||
strpos( $name, '/' ) !== false
506 ||
strlen( $name ) > $wgMaxNameChars
507 ||
$name != $wgContLang->ucfirst( $name ) ) {
508 wfDebugLog( 'username', __METHOD__
.
509 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
513 // Ensure that the name can't be misresolved as a different title,
514 // such as with extra namespace keys at the start.
515 $parsed = Title
::newFromText( $name );
516 if( is_null( $parsed )
517 ||
$parsed->getNamespace()
518 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
519 wfDebugLog( 'username', __METHOD__
.
520 ": '$name' invalid due to ambiguous prefixes" );
524 // Check an additional blacklist of troublemaker characters.
525 // Should these be merged into the title char list?
526 $unicodeBlacklist = '/[' .
527 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
528 '\x{00a0}' . # non-breaking space
529 '\x{2000}-\x{200f}' . # various whitespace
530 '\x{2028}-\x{202f}' . # breaks and control chars
531 '\x{3000}' . # ideographic space
532 '\x{e000}-\x{f8ff}' . # private use
534 if( preg_match( $unicodeBlacklist, $name ) ) {
535 wfDebugLog( 'username', __METHOD__
.
536 ": '$name' invalid due to blacklisted characters" );
544 * Usernames which fail to pass this function will be blocked
545 * from user login and new account registrations, but may be used
546 * internally by batch processes.
548 * If an account already exists in this form, login will be blocked
549 * by a failure to pass this function.
551 * @param $name \string String to match
552 * @return \bool True or false
554 static function isUsableName( $name ) {
555 global $wgReservedUsernames;
556 // Must be a valid username, obviously ;)
557 if ( !self
::isValidUserName( $name ) ) {
561 static $reservedUsernames = false;
562 if ( !$reservedUsernames ) {
563 $reservedUsernames = $wgReservedUsernames;
564 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
567 // Certain names may be reserved for batch processes.
568 foreach ( $reservedUsernames as $reserved ) {
569 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
570 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
572 if ( $reserved == $name ) {
580 * Usernames which fail to pass this function will be blocked
581 * from new account registrations, but may be used internally
582 * either by batch processes or by user accounts which have
583 * already been created.
585 * Additional character blacklisting may be added here
586 * rather than in isValidUserName() to avoid disrupting
589 * @param $name \string String to match
590 * @return \bool True or false
592 static function isCreatableName( $name ) {
593 global $wgInvalidUsernameCharacters;
595 self
::isUsableName( $name ) &&
597 // Registration-time character blacklisting...
598 !preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name );
602 * Is the input a valid password for this user?
604 * @param $password \string Desired password
605 * @return \bool True or false
607 function isValidPassword( $password ) {
608 global $wgMinimalPasswordLength, $wgContLang;
611 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
613 if( $result === false )
616 // Password needs to be long enough, and can't be the same as the username
617 return strlen( $password ) >= $wgMinimalPasswordLength
618 && $wgContLang->lc( $password ) !== $wgContLang->lc( $this->mName
);
622 * Does a string look like an e-mail address?
624 * There used to be a regular expression here, it got removed because it
625 * rejected valid addresses. Actually just check if there is '@' somewhere
626 * in the given address.
628 * @todo Check for RFC 2822 compilance (bug 959)
630 * @param $addr \string E-mail address
631 * @return \bool True or false
633 public static function isValidEmailAddr( $addr ) {
635 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
639 return strpos( $addr, '@' ) !== false;
643 * Given unvalidated user input, return a canonical username, or false if
644 * the username is invalid.
645 * @param $name \string User input
646 * @param $validate \types{\string,\bool} Type of validation to use:
647 * - false No validation
648 * - 'valid' Valid for batch processes
649 * - 'usable' Valid for batch processes and login
650 * - 'creatable' Valid for batch processes, login and account creation
652 static function getCanonicalName( $name, $validate = 'valid' ) {
653 # Force usernames to capital
655 $name = $wgContLang->ucfirst( $name );
657 # Reject names containing '#'; these will be cleaned up
658 # with title normalisation, but then it's too late to
660 if( strpos( $name, '#' ) !== false )
663 # Clean up name according to title rules
664 $t = ($validate === 'valid') ?
665 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
666 # Check for invalid titles
667 if( is_null( $t ) ) {
671 # Reject various classes of invalid names
672 $name = $t->getText();
674 $name = $wgAuth->getCanonicalName( $t->getText() );
676 switch ( $validate ) {
680 if ( !User
::isValidUserName( $name ) ) {
685 if ( !User
::isUsableName( $name ) ) {
690 if ( !User
::isCreatableName( $name ) ) {
695 throw new MWException( 'Invalid parameter value for $validate in '.__METHOD__
);
701 * Count the number of edits of a user
702 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
704 * @param $uid \int User ID to check
705 * @return \int The user's edit count
707 static function edits( $uid ) {
708 wfProfileIn( __METHOD__
);
709 $dbr = wfGetDB( DB_SLAVE
);
710 // check if the user_editcount field has been initialized
711 $field = $dbr->selectField(
712 'user', 'user_editcount',
713 array( 'user_id' => $uid ),
717 if( $field === null ) { // it has not been initialized. do so.
718 $dbw = wfGetDB( DB_MASTER
);
719 $count = $dbr->selectField(
720 'revision', 'count(*)',
721 array( 'rev_user' => $uid ),
726 array( 'user_editcount' => $count ),
727 array( 'user_id' => $uid ),
733 wfProfileOut( __METHOD__
);
738 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
739 * @todo hash random numbers to improve security, like generateToken()
741 * @return \string New random password
743 static function randomPassword() {
744 global $wgMinimalPasswordLength;
745 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
746 $l = strlen( $pwchars ) - 1;
748 $pwlength = max( 7, $wgMinimalPasswordLength );
749 $digit = mt_rand(0, $pwlength - 1);
751 for ( $i = 0; $i < $pwlength; $i++
) {
752 $np .= $i == $digit ?
chr( mt_rand(48, 57) ) : $pwchars{ mt_rand(0, $l)};
758 * Set cached properties to default.
760 * @note This no longer clears uncached lazy-initialised properties;
761 * the constructor does that instead.
764 function loadDefaults( $name = false ) {
765 wfProfileIn( __METHOD__
);
767 global $wgCookiePrefix;
770 $this->mName
= $name;
771 $this->mRealName
= '';
772 $this->mPassword
= $this->mNewpassword
= '';
773 $this->mNewpassTime
= null;
775 $this->mOptionOverrides
= null;
776 $this->mOptionsLoaded
= false;
778 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
779 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
781 $this->mTouched
= '0'; # Allow any pages to be cached
784 $this->setToken(); # Random
785 $this->mEmailAuthenticated
= null;
786 $this->mEmailToken
= '';
787 $this->mEmailTokenExpires
= null;
788 $this->mRegistration
= wfTimestamp( TS_MW
);
789 $this->mGroups
= array();
791 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
793 wfProfileOut( __METHOD__
);
797 * @deprecated Use wfSetupSession().
799 function SetupSession() {
800 wfDeprecated( __METHOD__
);
805 * Load user data from the session or login cookie. If there are no valid
806 * credentials, initialises the user as an anonymous user.
807 * @return \bool True if the user is logged in, false otherwise.
809 private function loadFromSession() {
810 global $wgMemc, $wgCookiePrefix;
813 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
814 if ( $result !== null ) {
818 if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
819 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
820 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
821 $this->loadDefaults(); // Possible collision!
822 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
823 cookie user ID ($sId) don't match!" );
826 $_SESSION['wsUserID'] = $sId;
827 } else if ( isset( $_SESSION['wsUserID'] ) ) {
828 if ( $_SESSION['wsUserID'] != 0 ) {
829 $sId = $_SESSION['wsUserID'];
831 $this->loadDefaults();
835 $this->loadDefaults();
839 if ( isset( $_SESSION['wsUserName'] ) ) {
840 $sName = $_SESSION['wsUserName'];
841 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
842 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
843 $_SESSION['wsUserName'] = $sName;
845 $this->loadDefaults();
849 $passwordCorrect = FALSE;
851 if ( !$this->loadFromId() ) {
852 # Not a valid ID, loadFromId has switched the object to anon for us
856 if ( isset( $_SESSION['wsToken'] ) ) {
857 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
859 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
860 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
863 # No session or persistent login cookie
864 $this->loadDefaults();
868 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
869 $_SESSION['wsToken'] = $this->mToken
;
870 wfDebug( "Logged in from $from\n" );
873 # Invalid credentials
874 wfDebug( "Can't log in from $from, invalid credentials\n" );
875 $this->loadDefaults();
881 * Load user and user_group data from the database.
882 * $this::mId must be set, this is how the user is identified.
884 * @return \bool True if the user exists, false if the user is anonymous
887 function loadFromDatabase() {
889 $this->mId
= intval( $this->mId
);
891 /** Anonymous user */
893 $this->loadDefaults();
897 $dbr = wfGetDB( DB_MASTER
);
898 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
900 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
902 if ( $s !== false ) {
903 # Initialise user table data
904 $this->loadFromRow( $s );
905 $this->mGroups
= null; // deferred
906 $this->getEditCount(); // revalidation for nulls
911 $this->loadDefaults();
917 * Initialize this object from a row from the user table.
919 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
921 function loadFromRow( $row ) {
922 $this->mDataLoaded
= true;
924 if ( isset( $row->user_id
) ) {
925 $this->mId
= intval( $row->user_id
);
927 $this->mName
= $row->user_name
;
928 $this->mRealName
= $row->user_real_name
;
929 $this->mPassword
= $row->user_password
;
930 $this->mNewpassword
= $row->user_newpassword
;
931 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
932 $this->mEmail
= $row->user_email
;
933 $this->decodeOptions( $row->user_options
);
934 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
935 $this->mToken
= $row->user_token
;
936 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
937 $this->mEmailToken
= $row->user_email_token
;
938 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
939 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
940 $this->mEditCount
= $row->user_editcount
;
944 * Load the groups from the database if they aren't already loaded.
947 function loadGroups() {
948 if ( is_null( $this->mGroups
) ) {
949 $dbr = wfGetDB( DB_MASTER
);
950 $res = $dbr->select( 'user_groups',
952 array( 'ug_user' => $this->mId
),
954 $this->mGroups
= array();
955 while( $row = $dbr->fetchObject( $res ) ) {
956 $this->mGroups
[] = $row->ug_group
;
962 * Clear various cached data stored in this object.
963 * @param $reloadFrom \string Reload user and user_groups table data from a
964 * given source. May be "name", "id", "defaults", "session", or false for
967 function clearInstanceCache( $reloadFrom = false ) {
968 $this->mNewtalk
= -1;
969 $this->mDatePreference
= null;
970 $this->mBlockedby
= -1; # Unset
971 $this->mHash
= false;
973 $this->mRights
= null;
974 $this->mEffectiveGroups
= null;
975 $this->mOptions
= null;
978 $this->mDataLoaded
= false;
979 $this->mFrom
= $reloadFrom;
984 * Combine the language default options with any site-specific options
985 * and add the default language variants.
987 * @return \type{\arrayof{\string}} Array of options
989 static function getDefaultOptions() {
990 global $wgNamespacesToBeSearchedDefault;
992 * Site defaults will override the global/language defaults
994 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
995 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
998 * default language setting
1000 $variant = $wgContLang->getPreferredVariant( false );
1001 $defOpt['variant'] = $variant;
1002 $defOpt['language'] = $variant;
1003 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1004 $defOpt['searchNs'.$nsnum] = !empty($wgNamespacesToBeSearchedDefault[$nsnum]);
1006 $defOpt['skin'] = $wgDefaultSkin;
1012 * Get a given default option value.
1014 * @param $opt \string Name of option to retrieve
1015 * @return \string Default option value
1017 public static function getDefaultOption( $opt ) {
1018 $defOpts = self
::getDefaultOptions();
1019 if( isset( $defOpts[$opt] ) ) {
1020 return $defOpts[$opt];
1027 * Get a list of user toggle names
1028 * @return \type{\arrayof{\string}} Array of user toggle names
1030 static function getToggles() {
1031 global $wgContLang, $wgUseRCPatrol;
1032 $extraToggles = array();
1033 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1034 if( $wgUseRCPatrol ) {
1035 $extraToggles[] = 'hidepatrolled';
1036 $extraToggles[] = 'newpageshidepatrolled';
1037 $extraToggles[] = 'watchlisthidepatrolled';
1039 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1044 * Get blocking information
1046 * @param $bFromSlave \bool Whether to check the slave database first. To
1047 * improve performance, non-critical checks are done
1048 * against slaves. Check when actually saving should be
1049 * done against master.
1051 function getBlockedStatus( $bFromSlave = true ) {
1052 global $wgEnableSorbs, $wgProxyWhitelist;
1054 if ( -1 != $this->mBlockedby
) {
1055 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1059 wfProfileIn( __METHOD__
);
1060 wfDebug( __METHOD__
.": checking...\n" );
1062 // Initialize data...
1063 // Otherwise something ends up stomping on $this->mBlockedby when
1064 // things get lazy-loaded later, causing false positive block hits
1065 // due to -1 !== 0. Probably session-related... Nothing should be
1066 // overwriting mBlockedby, surely?
1069 $this->mBlockedby
= 0;
1070 $this->mHideName
= 0;
1071 $this->mAllowUsertalk
= 0;
1074 if ($this->isAllowed( 'ipblock-exempt' ) ) {
1075 # Exempt from all types of IP-block
1080 $this->mBlock
= new Block();
1081 $this->mBlock
->fromMaster( !$bFromSlave );
1082 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1083 wfDebug( __METHOD__
.": Found block.\n" );
1084 $this->mBlockedby
= $this->mBlock
->mBy
;
1085 $this->mBlockreason
= $this->mBlock
->mReason
;
1086 $this->mHideName
= $this->mBlock
->mHideName
;
1087 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1088 if ( $this->isLoggedIn() ) {
1089 $this->spreadBlock();
1092 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1093 // apply to users. Note that the existence of $this->mBlock is not used to
1094 // check for edit blocks, $this->mBlockedby is instead.
1098 if ( !$this->isAllowed('proxyunbannable') && !in_array( $ip, $wgProxyWhitelist ) ) {
1100 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1101 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1102 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1106 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1107 if ( $this->inSorbsBlacklist( $ip ) ) {
1108 $this->mBlockedby
= wfMsg( 'sorbs' );
1109 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1115 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1117 wfProfileOut( __METHOD__
);
1121 * Whether the given IP is in the SORBS blacklist.
1123 * @param $ip \string IP to check
1124 * @return \bool True if blacklisted.
1126 function inSorbsBlacklist( $ip ) {
1127 global $wgEnableSorbs, $wgSorbsUrl;
1129 return $wgEnableSorbs &&
1130 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1134 * Whether the given IP is in a given DNS blacklist.
1136 * @param $ip \string IP to check
1137 * @param $base \string URL of the DNS blacklist
1138 * @return \bool True if blacklisted.
1140 function inDnsBlacklist( $ip, $base ) {
1141 wfProfileIn( __METHOD__
);
1145 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1146 if( IP
::isIPv4($ip) ) {
1148 $host = "$ip.$base";
1151 $ipList = gethostbynamel( $host );
1154 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1157 wfDebug( "Requested $host, not found in $base.\n" );
1161 wfProfileOut( __METHOD__
);
1166 * Is this user subject to rate limiting?
1168 * @return \bool True if rate limited
1170 public function isPingLimitable() {
1171 global $wgRateLimitsExcludedGroups;
1172 global $wgRateLimitsExcludedIPs;
1173 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1174 // Deprecated, but kept for backwards-compatibility config
1177 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1178 // No other good way currently to disable rate limits
1179 // for specific IPs. :P
1180 // But this is a crappy hack and should die.
1183 return !$this->isAllowed('noratelimit');
1187 * Primitive rate limits: enforce maximum actions per time period
1188 * to put a brake on flooding.
1190 * @note When using a shared cache like memcached, IP-address
1191 * last-hit counters will be shared across wikis.
1193 * @param $action \string Action to enforce; 'edit' if unspecified
1194 * @return \bool True if a rate limiter was tripped
1196 function pingLimiter( $action='edit' ) {
1198 # Call the 'PingLimiter' hook
1200 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1204 global $wgRateLimits;
1205 if( !isset( $wgRateLimits[$action] ) ) {
1209 # Some groups shouldn't trigger the ping limiter, ever
1210 if( !$this->isPingLimitable() )
1213 global $wgMemc, $wgRateLimitLog;
1214 wfProfileIn( __METHOD__
);
1216 $limits = $wgRateLimits[$action];
1218 $id = $this->getId();
1222 if( isset( $limits['anon'] ) && $id == 0 ) {
1223 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1226 if( isset( $limits['user'] ) && $id != 0 ) {
1227 $userLimit = $limits['user'];
1229 if( $this->isNewbie() ) {
1230 if( isset( $limits['newbie'] ) && $id != 0 ) {
1231 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1233 if( isset( $limits['ip'] ) ) {
1234 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1237 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1238 $subnet = $matches[1];
1239 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1242 // Check for group-specific permissions
1243 // If more than one group applies, use the group with the highest limit
1244 foreach ( $this->getGroups() as $group ) {
1245 if ( isset( $limits[$group] ) ) {
1246 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1247 $userLimit = $limits[$group];
1251 // Set the user limit key
1252 if ( $userLimit !== false ) {
1253 wfDebug( __METHOD__
.": effective user limit: $userLimit\n" );
1254 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1258 foreach( $keys as $key => $limit ) {
1259 list( $max, $period ) = $limit;
1260 $summary = "(limit $max in {$period}s)";
1261 $count = $wgMemc->get( $key );
1263 if( $count > $max ) {
1264 wfDebug( __METHOD__
.": tripped! $key at $count $summary\n" );
1265 if( $wgRateLimitLog ) {
1266 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1270 wfDebug( __METHOD__
.": ok. $key at $count $summary\n" );
1273 wfDebug( __METHOD__
.": adding record for $key $summary\n" );
1274 $wgMemc->add( $key, 1, intval( $period ) );
1276 $wgMemc->incr( $key );
1279 wfProfileOut( __METHOD__
);
1284 * Check if user is blocked
1286 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1287 * @return \bool True if blocked, false otherwise
1289 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1290 wfDebug( "User::isBlocked: enter\n" );
1291 $this->getBlockedStatus( $bFromSlave );
1292 return $this->mBlockedby
!== 0;
1296 * Check if user is blocked from editing a particular article
1298 * @param $title \string Title to check
1299 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1300 * @return \bool True if blocked, false otherwise
1302 function isBlockedFrom( $title, $bFromSlave = false ) {
1303 global $wgBlockAllowsUTEdit;
1304 wfProfileIn( __METHOD__
);
1305 wfDebug( __METHOD__
.": enter\n" );
1307 wfDebug( __METHOD__
.": asking isBlocked()\n" );
1308 $blocked = $this->isBlocked( $bFromSlave );
1309 $allowUsertalk = ($wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false);
1310 # If a user's name is suppressed, they cannot make edits anywhere
1311 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1312 $title->getNamespace() == NS_USER_TALK
) {
1314 wfDebug( __METHOD__
.": self-talk page, ignoring any blocks\n" );
1316 wfProfileOut( __METHOD__
);
1321 * If user is blocked, return the name of the user who placed the block
1322 * @return \string name of blocker
1324 function blockedBy() {
1325 $this->getBlockedStatus();
1326 return $this->mBlockedby
;
1330 * If user is blocked, return the specified reason for the block
1331 * @return \string Blocking reason
1333 function blockedFor() {
1334 $this->getBlockedStatus();
1335 return $this->mBlockreason
;
1339 * If user is blocked, return the ID for the block
1340 * @return \int Block ID
1342 function getBlockId() {
1343 $this->getBlockedStatus();
1344 return ($this->mBlock ?
$this->mBlock
->mId
: false);
1348 * Check if user is blocked on all wikis.
1349 * Do not use for actual edit permission checks!
1350 * This is intented for quick UI checks.
1352 * @param $ip \type{\string} IP address, uses current client if none given
1353 * @return \type{\bool} True if blocked, false otherwise
1355 function isBlockedGlobally( $ip = '' ) {
1356 if( $this->mBlockedGlobally
!== null ) {
1357 return $this->mBlockedGlobally
;
1359 // User is already an IP?
1360 if( IP
::isIPAddress( $this->getName() ) ) {
1361 $ip = $this->getName();
1366 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1367 $this->mBlockedGlobally
= (bool)$blocked;
1368 return $this->mBlockedGlobally
;
1372 * Check if user account is locked
1374 * @return \type{\bool} True if locked, false otherwise
1376 function isLocked() {
1377 if( $this->mLocked
!== null ) {
1378 return $this->mLocked
;
1381 $authUser = $wgAuth->getUserInstance( $this );
1382 $this->mLocked
= (bool)$authUser->isLocked();
1383 return $this->mLocked
;
1387 * Check if user account is hidden
1389 * @return \type{\bool} True if hidden, false otherwise
1391 function isHidden() {
1392 if( $this->mHideName
!== null ) {
1393 return $this->mHideName
;
1395 $this->getBlockedStatus();
1396 if( !$this->mHideName
) {
1398 $authUser = $wgAuth->getUserInstance( $this );
1399 $this->mHideName
= (bool)$authUser->isHidden();
1401 return $this->mHideName
;
1405 * Get the user's ID.
1406 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1409 if( $this->mId
=== null and $this->mName
!== null
1410 and User
::isIP( $this->mName
) ) {
1411 // Special case, we know the user is anonymous
1413 } elseif( $this->mId
=== null ) {
1414 // Don't load if this was initialized from an ID
1421 * Set the user and reload all fields according to a given ID
1422 * @param $v \int User ID to reload
1424 function setId( $v ) {
1426 $this->clearInstanceCache( 'id' );
1430 * Get the user name, or the IP of an anonymous user
1431 * @return \string User's name or IP address
1433 function getName() {
1434 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1435 # Special case optimisation
1436 return $this->mName
;
1439 if ( $this->mName
=== false ) {
1441 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1443 return $this->mName
;
1448 * Set the user name.
1450 * This does not reload fields from the database according to the given
1451 * name. Rather, it is used to create a temporary "nonexistent user" for
1452 * later addition to the database. It can also be used to set the IP
1453 * address for an anonymous user to something other than the current
1456 * @note User::newFromName() has rougly the same function, when the named user
1458 * @param $str \string New user name to set
1460 function setName( $str ) {
1462 $this->mName
= $str;
1466 * Get the user's name escaped by underscores.
1467 * @return \string Username escaped by underscores.
1469 function getTitleKey() {
1470 return str_replace( ' ', '_', $this->getName() );
1474 * Check if the user has new messages.
1475 * @return \bool True if the user has new messages
1477 function getNewtalk() {
1480 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1481 if( $this->mNewtalk
=== -1 ) {
1482 $this->mNewtalk
= false; # reset talk page status
1484 # Check memcached separately for anons, who have no
1485 # entire User object stored in there.
1488 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1489 $newtalk = $wgMemc->get( $key );
1490 if( strval( $newtalk ) !== '' ) {
1491 $this->mNewtalk
= (bool)$newtalk;
1493 // Since we are caching this, make sure it is up to date by getting it
1495 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1496 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1499 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1503 return (bool)$this->mNewtalk
;
1507 * Return the talk page(s) this user has new messages on.
1508 * @return \type{\arrayof{\string}} Array of page URLs
1510 function getNewMessageLinks() {
1512 if (!wfRunHooks('UserRetrieveNewTalks', array(&$this, &$talks)))
1515 if (!$this->getNewtalk())
1517 $up = $this->getUserPage();
1518 $utp = $up->getTalkPage();
1519 return array(array("wiki" => wfWikiID(), "link" => $utp->getLocalURL()));
1524 * Internal uncached check for new messages
1527 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1528 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1529 * @param $fromMaster \bool true to fetch from the master, false for a slave
1530 * @return \bool True if the user has new messages
1533 function checkNewtalk( $field, $id, $fromMaster = false ) {
1534 if ( $fromMaster ) {
1535 $db = wfGetDB( DB_MASTER
);
1537 $db = wfGetDB( DB_SLAVE
);
1539 $ok = $db->selectField( 'user_newtalk', $field,
1540 array( $field => $id ), __METHOD__
);
1541 return $ok !== false;
1545 * Add or update the new messages flag
1546 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1547 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1548 * @return \bool True if successful, false otherwise
1551 function updateNewtalk( $field, $id ) {
1552 $dbw = wfGetDB( DB_MASTER
);
1553 $dbw->insert( 'user_newtalk',
1554 array( $field => $id ),
1557 if ( $dbw->affectedRows() ) {
1558 wfDebug( __METHOD__
.": set on ($field, $id)\n" );
1561 wfDebug( __METHOD__
." already set ($field, $id)\n" );
1567 * Clear the new messages flag for the given user
1568 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1569 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1570 * @return \bool True if successful, false otherwise
1573 function deleteNewtalk( $field, $id ) {
1574 $dbw = wfGetDB( DB_MASTER
);
1575 $dbw->delete( 'user_newtalk',
1576 array( $field => $id ),
1578 if ( $dbw->affectedRows() ) {
1579 wfDebug( __METHOD__
.": killed on ($field, $id)\n" );
1582 wfDebug( __METHOD__
.": already gone ($field, $id)\n" );
1588 * Update the 'You have new messages!' status.
1589 * @param $val \bool Whether the user has new messages
1591 function setNewtalk( $val ) {
1592 if( wfReadOnly() ) {
1597 $this->mNewtalk
= $val;
1599 if( $this->isAnon() ) {
1601 $id = $this->getName();
1604 $id = $this->getId();
1609 $changed = $this->updateNewtalk( $field, $id );
1611 $changed = $this->deleteNewtalk( $field, $id );
1614 if( $this->isAnon() ) {
1615 // Anons have a separate memcached space, since
1616 // user records aren't kept for them.
1617 $key = wfMemcKey( 'newtalk', 'ip', $id );
1618 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1621 $this->invalidateCache();
1626 * Generate a current or new-future timestamp to be stored in the
1627 * user_touched field when we update things.
1628 * @return \string Timestamp in TS_MW format
1630 private static function newTouchedTimestamp() {
1631 global $wgClockSkewFudge;
1632 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1636 * Clear user data from memcached.
1637 * Use after applying fun updates to the database; caller's
1638 * responsibility to update user_touched if appropriate.
1640 * Called implicitly from invalidateCache() and saveSettings().
1642 private function clearSharedCache() {
1646 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1651 * Immediately touch the user data cache for this account.
1652 * Updates user_touched field, and removes account data from memcached
1653 * for reload on the next hit.
1655 function invalidateCache() {
1658 $this->mTouched
= self
::newTouchedTimestamp();
1660 $dbw = wfGetDB( DB_MASTER
);
1661 $dbw->update( 'user',
1662 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1663 array( 'user_id' => $this->mId
),
1666 $this->clearSharedCache();
1671 * Validate the cache for this account.
1672 * @param $timestamp \string A timestamp in TS_MW format
1674 function validateCache( $timestamp ) {
1676 return ($timestamp >= $this->mTouched
);
1680 * Get the user touched timestamp
1682 function getTouched() {
1684 return $this->mTouched
;
1688 * Set the password and reset the random token.
1689 * Calls through to authentication plugin if necessary;
1690 * will have no effect if the auth plugin refuses to
1691 * pass the change through or if the legal password
1694 * As a special case, setting the password to null
1695 * wipes it, so the account cannot be logged in until
1696 * a new password is set, for instance via e-mail.
1698 * @param $str \string New password to set
1699 * @throws PasswordError on failure
1701 function setPassword( $str ) {
1704 if( $str !== null ) {
1705 if( !$wgAuth->allowPasswordChange() ) {
1706 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1709 if( !$this->isValidPassword( $str ) ) {
1710 global $wgMinimalPasswordLength;
1711 throw new PasswordError( wfMsgExt( 'passwordtooshort', array( 'parsemag' ),
1712 $wgMinimalPasswordLength ) );
1716 if( !$wgAuth->setPassword( $this, $str ) ) {
1717 throw new PasswordError( wfMsg( 'externaldberror' ) );
1720 $this->setInternalPassword( $str );
1726 * Set the password and reset the random token unconditionally.
1728 * @param $str \string New password to set
1730 function setInternalPassword( $str ) {
1734 if( $str === null ) {
1735 // Save an invalid hash...
1736 $this->mPassword
= '';
1738 $this->mPassword
= self
::crypt( $str );
1740 $this->mNewpassword
= '';
1741 $this->mNewpassTime
= null;
1745 * Get the user's current token.
1746 * @return \string Token
1748 function getToken() {
1750 return $this->mToken
;
1754 * Set the random token (used for persistent authentication)
1755 * Called from loadDefaults() among other places.
1757 * @param $token \string If specified, set the token to this value
1760 function setToken( $token = false ) {
1761 global $wgSecretKey, $wgProxyKey;
1764 if ( $wgSecretKey ) {
1765 $key = $wgSecretKey;
1766 } elseif ( $wgProxyKey ) {
1771 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1773 $this->mToken
= $token;
1778 * Set the cookie password
1780 * @param $str \string New cookie password
1783 function setCookiePassword( $str ) {
1785 $this->mCookiePassword
= md5( $str );
1789 * Set the password for a password reminder or new account email
1791 * @param $str \string New password to set
1792 * @param $throttle \bool If true, reset the throttle timestamp to the present
1794 function setNewpassword( $str, $throttle = true ) {
1796 $this->mNewpassword
= self
::crypt( $str );
1798 $this->mNewpassTime
= wfTimestampNow();
1803 * Has password reminder email been sent within the last
1804 * $wgPasswordReminderResendTime hours?
1805 * @return \bool True or false
1807 function isPasswordReminderThrottled() {
1808 global $wgPasswordReminderResendTime;
1810 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1813 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1814 return time() < $expiry;
1818 * Get the user's e-mail address
1819 * @return \string User's email address
1821 function getEmail() {
1823 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1824 return $this->mEmail
;
1828 * Get the timestamp of the user's e-mail authentication
1829 * @return \string TS_MW timestamp
1831 function getEmailAuthenticationTimestamp() {
1833 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1834 return $this->mEmailAuthenticated
;
1838 * Set the user's e-mail address
1839 * @param $str \string New e-mail address
1841 function setEmail( $str ) {
1843 $this->mEmail
= $str;
1844 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1848 * Get the user's real name
1849 * @return \string User's real name
1851 function getRealName() {
1853 return $this->mRealName
;
1857 * Set the user's real name
1858 * @param $str \string New real name
1860 function setRealName( $str ) {
1862 $this->mRealName
= $str;
1866 * Get the user's current setting for a given option.
1868 * @param $oname \string The option to check
1869 * @param $defaultOverride \string A default value returned if the option does not exist
1870 * @return \string User's current value for the option
1871 * @see getBoolOption()
1872 * @see getIntOption()
1874 function getOption( $oname, $defaultOverride = null ) {
1875 $this->loadOptions();
1877 if ( is_null( $this->mOptions
) ) {
1878 if($defaultOverride != '') {
1879 return $defaultOverride;
1881 $this->mOptions
= User
::getDefaultOptions();
1884 if ( array_key_exists( $oname, $this->mOptions
) ) {
1885 return $this->mOptions
[$oname];
1887 return $defaultOverride;
1892 * Get the user's current setting for a given option, as a boolean value.
1894 * @param $oname \string The option to check
1895 * @return \bool User's current value for the option
1898 function getBoolOption( $oname ) {
1899 return (bool)$this->getOption( $oname );
1904 * Get the user's current setting for a given option, as a boolean value.
1906 * @param $oname \string The option to check
1907 * @param $defaultOverride \int A default value returned if the option does not exist
1908 * @return \int User's current value for the option
1911 function getIntOption( $oname, $defaultOverride=0 ) {
1912 $val = $this->getOption( $oname );
1914 $val = $defaultOverride;
1916 return intval( $val );
1920 * Set the given option for a user.
1922 * @param $oname \string The option to set
1923 * @param $val \mixed New value to set
1925 function setOption( $oname, $val ) {
1927 $this->loadOptions();
1929 if ( $oname == 'skin' ) {
1930 # Clear cached skin, so the new one displays immediately in Special:Preferences
1931 unset( $this->mSkin
);
1934 // Explicitly NULL values should refer to defaults
1935 global $wgDefaultUserOptions;
1936 if( is_null($val) && isset($wgDefaultUserOptions[$oname]) ) {
1937 $val = $wgDefaultUserOptions[$oname];
1940 $this->mOptions
[$oname] = $val;
1944 * Reset all options to the site defaults
1946 function resetOptions() {
1947 $this->mOptions
= User
::getDefaultOptions();
1951 * Get the user's preferred date format.
1952 * @return \string User's preferred date format
1954 function getDatePreference() {
1955 // Important migration for old data rows
1956 if ( is_null( $this->mDatePreference
) ) {
1958 $value = $this->getOption( 'date' );
1959 $map = $wgLang->getDatePreferenceMigrationMap();
1960 if ( isset( $map[$value] ) ) {
1961 $value = $map[$value];
1963 $this->mDatePreference
= $value;
1965 return $this->mDatePreference
;
1969 * Get the permissions this user has.
1970 * @return \type{\arrayof{\string}} Array of permission names
1972 function getRights() {
1973 if ( is_null( $this->mRights
) ) {
1974 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
1975 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
1976 // Force reindexation of rights when a hook has unset one of them
1977 $this->mRights
= array_values( $this->mRights
);
1979 return $this->mRights
;
1983 * Get the list of explicit group memberships this user has.
1984 * The implicit * and user groups are not included.
1985 * @return \type{\arrayof{\string}} Array of internal group names
1987 function getGroups() {
1989 return $this->mGroups
;
1993 * Get the list of implicit group memberships this user has.
1994 * This includes all explicit groups, plus 'user' if logged in,
1995 * '*' for all accounts and autopromoted groups
1996 * @param $recache \bool Whether to avoid the cache
1997 * @return \type{\arrayof{\string}} Array of internal group names
1999 function getEffectiveGroups( $recache = false ) {
2000 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2001 $this->mEffectiveGroups
= $this->getGroups();
2002 $this->mEffectiveGroups
[] = '*';
2003 if( $this->getId() ) {
2004 $this->mEffectiveGroups
[] = 'user';
2006 $this->mEffectiveGroups
= array_unique( array_merge(
2007 $this->mEffectiveGroups
,
2008 Autopromote
::getAutopromoteGroups( $this )
2011 # Hook for additional groups
2012 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2015 return $this->mEffectiveGroups
;
2019 * Get the user's edit count.
2020 * @return \int User'e edit count
2022 function getEditCount() {
2023 if ($this->getId()) {
2024 if ( !isset( $this->mEditCount
) ) {
2025 /* Populate the count, if it has not been populated yet */
2026 $this->mEditCount
= User
::edits($this->mId
);
2028 return $this->mEditCount
;
2036 * Add the user to the given group.
2037 * This takes immediate effect.
2038 * @param $group \string Name of the group to add
2040 function addGroup( $group ) {
2041 $dbw = wfGetDB( DB_MASTER
);
2042 if( $this->getId() ) {
2043 $dbw->insert( 'user_groups',
2045 'ug_user' => $this->getID(),
2046 'ug_group' => $group,
2049 array( 'IGNORE' ) );
2052 $this->loadGroups();
2053 $this->mGroups
[] = $group;
2054 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2056 $this->invalidateCache();
2060 * Remove the user from the given group.
2061 * This takes immediate effect.
2062 * @param $group \string Name of the group to remove
2064 function removeGroup( $group ) {
2066 $dbw = wfGetDB( DB_MASTER
);
2067 $dbw->delete( 'user_groups',
2069 'ug_user' => $this->getID(),
2070 'ug_group' => $group,
2072 'User::removeGroup' );
2074 $this->loadGroups();
2075 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2076 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2078 $this->invalidateCache();
2083 * Get whether the user is logged in
2084 * @return \bool True or false
2086 function isLoggedIn() {
2087 return $this->getID() != 0;
2091 * Get whether the user is anonymous
2092 * @return \bool True or false
2095 return !$this->isLoggedIn();
2099 * Get whether the user is a bot
2100 * @return \bool True or false
2104 wfDeprecated( __METHOD__
);
2105 return $this->isAllowed( 'bot' );
2109 * Check if user is allowed to access a feature / make an action
2110 * @param $action \string action to be checked
2111 * @return \bool True if action is allowed, else false
2113 function isAllowed( $action = '' ) {
2114 if ( $action === '' )
2115 return true; // In the spirit of DWIM
2116 # Patrolling may not be enabled
2117 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2118 global $wgUseRCPatrol, $wgUseNPPatrol;
2119 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2122 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2123 # by misconfiguration: 0 == 'foo'
2124 return in_array( $action, $this->getRights(), true );
2128 * Check whether to enable recent changes patrol features for this user
2129 * @return \bool True or false
2131 public function useRCPatrol() {
2132 global $wgUseRCPatrol;
2133 return( $wgUseRCPatrol && ($this->isAllowed('patrol') ||
$this->isAllowed('patrolmarks')) );
2137 * Check whether to enable new pages patrol features for this user
2138 * @return \bool True or false
2140 public function useNPPatrol() {
2141 global $wgUseRCPatrol, $wgUseNPPatrol;
2142 return( ($wgUseRCPatrol ||
$wgUseNPPatrol) && ($this->isAllowed('patrol') ||
$this->isAllowed('patrolmarks')) );
2146 * Get the current skin, loading it if required, and setting a title
2147 * @param $t Title: the title to use in the skin
2148 * @return Skin The current skin
2149 * @todo FIXME : need to check the old failback system [AV]
2151 function &getSkin( $t = null ) {
2152 if ( ! isset( $this->mSkin
) ) {
2153 wfProfileIn( __METHOD__
);
2155 global $wgHiddenPrefs;
2156 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2159 $userSkin = $this->getOption( 'skin' );
2160 $userSkin = $wgRequest->getVal('useskin', $userSkin);
2162 # if we're not allowing users to override, then use the default
2163 global $wgDefaultSkin;
2164 $userSkin = $wgDefaultSkin;
2167 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2168 wfProfileOut( __METHOD__
);
2170 if( $t ||
!$this->mSkin
->getTitle() ) {
2173 $t = $wgOut->getTitle();
2175 $this->mSkin
->setTitle( $t );
2177 return $this->mSkin
;
2181 * Check the watched status of an article.
2182 * @param $title \type{Title} Title of the article to look at
2183 * @return \bool True if article is watched
2185 function isWatched( $title ) {
2186 $wl = WatchedItem
::fromUserTitle( $this, $title );
2187 return $wl->isWatched();
2192 * @param $title \type{Title} Title of the article to look at
2194 function addWatch( $title ) {
2195 $wl = WatchedItem
::fromUserTitle( $this, $title );
2197 $this->invalidateCache();
2201 * Stop watching an article.
2202 * @param $title \type{Title} Title of the article to look at
2204 function removeWatch( $title ) {
2205 $wl = WatchedItem
::fromUserTitle( $this, $title );
2207 $this->invalidateCache();
2211 * Clear the user's notification timestamp for the given title.
2212 * If e-notif e-mails are on, they will receive notification mails on
2213 * the next change of the page if it's watched etc.
2214 * @param $title \type{Title} Title of the article to look at
2216 function clearNotification( &$title ) {
2217 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2219 # Do nothing if the database is locked to writes
2220 if( wfReadOnly() ) {
2224 if ($title->getNamespace() == NS_USER_TALK
&&
2225 $title->getText() == $this->getName() ) {
2226 if (!wfRunHooks('UserClearNewTalkNotification', array(&$this)))
2228 $this->setNewtalk( false );
2231 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2235 if( $this->isAnon() ) {
2236 // Nothing else to do...
2240 // Only update the timestamp if the page is being watched.
2241 // The query to find out if it is watched is cached both in memcached and per-invocation,
2242 // and when it does have to be executed, it can be on a slave
2243 // If this is the user's newtalk page, we always update the timestamp
2244 if ($title->getNamespace() == NS_USER_TALK
&&
2245 $title->getText() == $wgUser->getName())
2248 } elseif ( $this->getId() == $wgUser->getId() ) {
2249 $watched = $title->userIsWatching();
2254 // If the page is watched by the user (or may be watched), update the timestamp on any
2255 // any matching rows
2257 $dbw = wfGetDB( DB_MASTER
);
2258 $dbw->update( 'watchlist',
2260 'wl_notificationtimestamp' => NULL
2261 ), array( /* WHERE */
2262 'wl_title' => $title->getDBkey(),
2263 'wl_namespace' => $title->getNamespace(),
2264 'wl_user' => $this->getID()
2271 * Resets all of the given user's page-change notification timestamps.
2272 * If e-notif e-mails are on, they will receive notification mails on
2273 * the next change of any watched page.
2275 * @param $currentUser \int User ID
2277 function clearAllNotifications( $currentUser ) {
2278 global $wgUseEnotif, $wgShowUpdatedMarker;
2279 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2280 $this->setNewtalk( false );
2283 if( $currentUser != 0 ) {
2284 $dbw = wfGetDB( DB_MASTER
);
2285 $dbw->update( 'watchlist',
2287 'wl_notificationtimestamp' => NULL
2288 ), array( /* WHERE */
2289 'wl_user' => $currentUser
2292 # We also need to clear here the "you have new message" notification for the own user_talk page
2293 # This is cleared one page view later in Article::viewUpdates();
2298 * Set this user's options from an encoded string
2299 * @param $str \string Encoded options to import
2302 function decodeOptions( $str ) {
2306 $this->mOptionsLoaded
= true;
2307 $this->mOptionOverrides
= array();
2309 $this->mOptions
= array();
2310 $a = explode( "\n", $str );
2311 foreach ( $a as $s ) {
2313 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2314 $this->mOptions
[$m[1]] = $m[2];
2315 $this->mOptionOverrides
[$m[1]] = $m[2];
2321 * Set a cookie on the user's client. Wrapper for
2322 * WebResponse::setCookie
2323 * @param $name \string Name of the cookie to set
2324 * @param $value \string Value to set
2325 * @param $exp \int Expiration time, as a UNIX time value;
2326 * if 0 or not specified, use the default $wgCookieExpiration
2328 protected function setCookie( $name, $value, $exp=0 ) {
2330 $wgRequest->response()->setcookie( $name, $value, $exp );
2334 * Clear a cookie on the user's client
2335 * @param $name \string Name of the cookie to clear
2337 protected function clearCookie( $name ) {
2338 $this->setCookie( $name, '', time() - 86400 );
2342 * Set the default cookies for this session on the user's client.
2344 function setCookies() {
2346 if ( 0 == $this->mId
) return;
2348 'wsUserID' => $this->mId
,
2349 'wsToken' => $this->mToken
,
2350 'wsUserName' => $this->getName()
2353 'UserID' => $this->mId
,
2354 'UserName' => $this->getName(),
2356 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2357 $cookies['Token'] = $this->mToken
;
2359 $cookies['Token'] = false;
2362 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2363 #check for null, since the hook could cause a null value
2364 if ( !is_null( $session ) && isset( $_SESSION ) ){
2365 $_SESSION = $session +
$_SESSION;
2367 foreach ( $cookies as $name => $value ) {
2368 if ( $value === false ) {
2369 $this->clearCookie( $name );
2371 $this->setCookie( $name, $value );
2377 * Log this user out.
2380 if( wfRunHooks( 'UserLogout', array(&$this) ) ) {
2386 * Clear the user's cookies and session, and reset the instance cache.
2390 function doLogout() {
2391 $this->clearInstanceCache( 'defaults' );
2393 $_SESSION['wsUserID'] = 0;
2395 $this->clearCookie( 'UserID' );
2396 $this->clearCookie( 'Token' );
2398 # Remember when user logged out, to prevent seeing cached pages
2399 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2403 * Save this user's settings into the database.
2404 * @todo Only rarely do all these fields need to be set!
2406 function saveSettings() {
2408 if ( wfReadOnly() ) { return; }
2409 if ( 0 == $this->mId
) { return; }
2411 $this->mTouched
= self
::newTouchedTimestamp();
2413 $dbw = wfGetDB( DB_MASTER
);
2414 $dbw->update( 'user',
2416 'user_name' => $this->mName
,
2417 'user_password' => $this->mPassword
,
2418 'user_newpassword' => $this->mNewpassword
,
2419 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2420 'user_real_name' => $this->mRealName
,
2421 'user_email' => $this->mEmail
,
2422 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2423 'user_options' => '',
2424 'user_touched' => $dbw->timestamp($this->mTouched
),
2425 'user_token' => $this->mToken
,
2426 'user_email_token' => $this->mEmailToken
,
2427 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2428 ), array( /* WHERE */
2429 'user_id' => $this->mId
2433 $this->saveOptions();
2435 wfRunHooks( 'UserSaveSettings', array( $this ) );
2436 $this->clearSharedCache();
2437 $this->getUserPage()->invalidateCache();
2441 * If only this user's username is known, and it exists, return the user ID.
2443 function idForName() {
2444 $s = trim( $this->getName() );
2445 if ( $s === '' ) return 0;
2447 $dbr = wfGetDB( DB_SLAVE
);
2448 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2449 if ( $id === false ) {
2456 * Add a user to the database, return the user object
2458 * @param $name \string Username to add
2459 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2460 * - password The user's password. Password logins will be disabled if this is omitted.
2461 * - newpassword A temporary password mailed to the user
2462 * - email The user's email address
2463 * - email_authenticated The email authentication timestamp
2464 * - real_name The user's real name
2465 * - options An associative array of non-default options
2466 * - token Random authentication token. Do not set.
2467 * - registration Registration timestamp. Do not set.
2469 * @return \type{User} A new User object, or null if the username already exists
2471 static function createNew( $name, $params = array() ) {
2474 if ( isset( $params['options'] ) ) {
2475 $user->mOptions
= $params['options'] +
$user->mOptions
;
2476 unset( $params['options'] );
2478 $dbw = wfGetDB( DB_MASTER
);
2479 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2481 'user_id' => $seqVal,
2482 'user_name' => $name,
2483 'user_password' => $user->mPassword
,
2484 'user_newpassword' => $user->mNewpassword
,
2485 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2486 'user_email' => $user->mEmail
,
2487 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2488 'user_real_name' => $user->mRealName
,
2489 'user_options' => $user->encodeOptions(),
2490 'user_token' => $user->mToken
,
2491 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2492 'user_editcount' => 0,
2494 foreach ( $params as $name => $value ) {
2495 $fields["user_$name"] = $value;
2497 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2498 if ( $dbw->affectedRows() ) {
2499 $newUser = User
::newFromId( $dbw->insertId() );
2507 * Add this existing user object to the database
2509 function addToDatabase() {
2511 $dbw = wfGetDB( DB_MASTER
);
2512 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2513 $dbw->insert( 'user',
2515 'user_id' => $seqVal,
2516 'user_name' => $this->mName
,
2517 'user_password' => $this->mPassword
,
2518 'user_newpassword' => $this->mNewpassword
,
2519 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2520 'user_email' => $this->mEmail
,
2521 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2522 'user_real_name' => $this->mRealName
,
2523 'user_options' => '',
2524 'user_token' => $this->mToken
,
2525 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2526 'user_editcount' => 0,
2529 $this->mId
= $dbw->insertId();
2531 // Clear instance cache other than user table data, which is already accurate
2532 $this->clearInstanceCache();
2534 $this->saveOptions();
2538 * If this (non-anonymous) user is blocked, block any IP address
2539 * they've successfully logged in from.
2541 function spreadBlock() {
2542 wfDebug( __METHOD__
."()\n" );
2544 if ( $this->mId
== 0 ) {
2548 $userblock = Block
::newFromDB( '', $this->mId
);
2549 if ( !$userblock ) {
2553 $userblock->doAutoblock( wfGetIp() );
2558 * Generate a string which will be different for any combination of
2559 * user options which would produce different parser output.
2560 * This will be used as part of the hash key for the parser cache,
2561 * so users will the same options can share the same cached data
2564 * Extensions which require it should install 'PageRenderingHash' hook,
2565 * which will give them a chance to modify this key based on their own
2568 * @return \string Page rendering hash
2570 function getPageRenderingHash() {
2571 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2573 return $this->mHash
;
2576 // stubthreshold is only included below for completeness,
2577 // it will always be 0 when this function is called by parsercache.
2579 $confstr = $this->getOption( 'math' );
2580 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2581 if ( $wgUseDynamicDates ) {
2582 $confstr .= '!' . $this->getDatePreference();
2584 $confstr .= '!' . ($this->getOption( 'numberheadings' ) ?
'1' : '');
2585 $confstr .= '!' . $wgLang->getCode();
2586 $confstr .= '!' . $this->getOption( 'thumbsize' );
2587 // add in language specific options, if any
2588 $extra = $wgContLang->getExtraHashOptions();
2591 $confstr .= $wgRenderHashAppend;
2593 // Give a chance for extensions to modify the hash, if they have
2594 // extra options or other effects on the parser cache.
2595 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2597 // Make it a valid memcached key fragment
2598 $confstr = str_replace( ' ', '_', $confstr );
2599 $this->mHash
= $confstr;
2604 * Get whether the user is explicitly blocked from account creation.
2605 * @return \bool True if blocked
2607 function isBlockedFromCreateAccount() {
2608 $this->getBlockedStatus();
2609 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2613 * Get whether the user is blocked from using Special:Emailuser.
2614 * @return \bool True if blocked
2616 function isBlockedFromEmailuser() {
2617 $this->getBlockedStatus();
2618 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2622 * Get whether the user is allowed to create an account.
2623 * @return \bool True if allowed
2625 function isAllowedToCreateAccount() {
2626 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2632 function setLoaded( $loaded ) {
2633 wfDeprecated( __METHOD__
);
2637 * Get this user's personal page title.
2639 * @return \type{Title} User's personal page title
2641 function getUserPage() {
2642 return Title
::makeTitle( NS_USER
, $this->getName() );
2646 * Get this user's talk page title.
2648 * @return \type{Title} User's talk page title
2650 function getTalkPage() {
2651 $title = $this->getUserPage();
2652 return $title->getTalkPage();
2656 * Get the maximum valid user ID.
2657 * @return \int User ID
2660 function getMaxID() {
2661 static $res; // cache
2663 if ( isset( $res ) )
2666 $dbr = wfGetDB( DB_SLAVE
);
2667 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2672 * Determine whether the user is a newbie. Newbies are either
2673 * anonymous IPs, or the most recently created accounts.
2674 * @return \bool True if the user is a newbie
2676 function isNewbie() {
2677 return !$this->isAllowed( 'autoconfirmed' );
2681 * Is the user active? We check to see if they've made at least
2682 * X number of edits in the last Y days.
2684 * @return \bool True if the user is active, false if not.
2686 public function isActiveEditor() {
2687 global $wgActiveUserEditCount, $wgActiveUserDays;
2688 $dbr = wfGetDB( DB_SLAVE
);
2690 // Stolen without shame from RC
2691 $cutoff_unixtime = time() - ( $wgActiveUserDays * 86400 );
2692 $cutoff_unixtime = $cutoff_unixtime - ( $cutoff_unixtime %
86400 );
2693 $oldTime = $dbr->addQuotes( $dbr->timestamp( $cutoff_unixtime ) );
2695 $res = $dbr->select( 'revision', '1',
2696 array( 'rev_user_text' => $this->getName(), "rev_timestamp > $oldTime"),
2698 array('LIMIT' => $wgActiveUserEditCount ) );
2700 $count = $dbr->numRows($res);
2701 $dbr->freeResult($res);
2703 return $count == $wgActiveUserEditCount;
2707 * Check to see if the given clear-text password is one of the accepted passwords
2708 * @param $password \string user password.
2709 * @return \bool True if the given password is correct, otherwise False.
2711 function checkPassword( $password ) {
2715 // Even though we stop people from creating passwords that
2716 // are shorter than this, doesn't mean people wont be able
2717 // to. Certain authentication plugins do NOT want to save
2718 // domain passwords in a mysql database, so we should
2719 // check this (incase $wgAuth->strict() is false).
2720 if( !$this->isValidPassword( $password ) ) {
2724 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2726 } elseif( $wgAuth->strict() ) {
2727 /* Auth plugin doesn't allow local authentication */
2729 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2730 /* Auth plugin doesn't allow local authentication for this user name */
2733 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2735 } elseif ( function_exists( 'iconv' ) ) {
2736 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2737 # Check for this with iconv
2738 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2739 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2747 * Check if the given clear-text password matches the temporary password
2748 * sent by e-mail for password reset operations.
2749 * @return \bool True if matches, false otherwise
2751 function checkTemporaryPassword( $plaintext ) {
2752 global $wgNewPasswordExpiry;
2753 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2755 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2756 return ( time() < $expiry );
2763 * Initialize (if necessary) and return a session token value
2764 * which can be used in edit forms to show that the user's
2765 * login credentials aren't being hijacked with a foreign form
2768 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2769 * @return \string The new edit token
2771 function editToken( $salt = '' ) {
2772 if ( $this->isAnon() ) {
2773 return EDIT_TOKEN_SUFFIX
;
2775 if( !isset( $_SESSION['wsEditToken'] ) ) {
2776 $token = $this->generateToken();
2777 $_SESSION['wsEditToken'] = $token;
2779 $token = $_SESSION['wsEditToken'];
2781 if( is_array( $salt ) ) {
2782 $salt = implode( '|', $salt );
2784 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2789 * Generate a looking random token for various uses.
2791 * @param $salt \string Optional salt value
2792 * @return \string The new random token
2794 function generateToken( $salt = '' ) {
2795 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2796 return md5( $token . $salt );
2800 * Check given value against the token value stored in the session.
2801 * A match should confirm that the form was submitted from the
2802 * user's own login session, not a form submission from a third-party
2805 * @param $val \string Input value to compare
2806 * @param $salt \string Optional function-specific data for hashing
2807 * @return \bool Whether the token matches
2809 function matchEditToken( $val, $salt = '' ) {
2810 $sessionToken = $this->editToken( $salt );
2811 if ( $val != $sessionToken ) {
2812 wfDebug( "User::matchEditToken: broken session data\n" );
2814 return $val == $sessionToken;
2818 * Check given value against the token value stored in the session,
2819 * ignoring the suffix.
2821 * @param $val \string Input value to compare
2822 * @param $salt \string Optional function-specific data for hashing
2823 * @return \bool Whether the token matches
2825 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2826 $sessionToken = $this->editToken( $salt );
2827 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2831 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2832 * mail to the user's given address.
2834 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2836 function sendConfirmationMail() {
2838 $expiration = null; // gets passed-by-ref and defined in next line.
2839 $token = $this->confirmationToken( $expiration );
2840 $url = $this->confirmationTokenUrl( $token );
2841 $invalidateURL = $this->invalidationTokenUrl( $token );
2842 $this->saveSettings();
2844 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2845 wfMsg( 'confirmemail_body',
2849 $wgLang->timeanddate( $expiration, false ),
2854 * Send an e-mail to this user's account. Does not check for
2855 * confirmed status or validity.
2857 * @param $subject \string Message subject
2858 * @param $body \string Message body
2859 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2860 * @param $replyto \string Reply-To address
2861 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2863 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2864 if( is_null( $from ) ) {
2865 global $wgPasswordSender;
2866 $from = $wgPasswordSender;
2869 $to = new MailAddress( $this );
2870 $sender = new MailAddress( $from );
2871 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2875 * Generate, store, and return a new e-mail confirmation code.
2876 * A hash (unsalted, since it's used as a key) is stored.
2878 * @note Call saveSettings() after calling this function to commit
2879 * this change to the database.
2881 * @param[out] &$expiration \mixed Accepts the expiration time
2882 * @return \string New token
2885 function confirmationToken( &$expiration ) {
2887 $expires = $now +
7 * 24 * 60 * 60;
2888 $expiration = wfTimestamp( TS_MW
, $expires );
2889 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2890 $hash = md5( $token );
2892 $this->mEmailToken
= $hash;
2893 $this->mEmailTokenExpires
= $expiration;
2898 * Return a URL the user can use to confirm their email address.
2899 * @param $token \string Accepts the email confirmation token
2900 * @return \string New token URL
2903 function confirmationTokenUrl( $token ) {
2904 return $this->getTokenUrl( 'ConfirmEmail', $token );
2907 * Return a URL the user can use to invalidate their email address.
2908 * @param $token \string Accepts the email confirmation token
2909 * @return \string New token URL
2912 function invalidationTokenUrl( $token ) {
2913 return $this->getTokenUrl( 'Invalidateemail', $token );
2917 * Internal function to format the e-mail validation/invalidation URLs.
2918 * This uses $wgArticlePath directly as a quickie hack to use the
2919 * hardcoded English names of the Special: pages, for ASCII safety.
2921 * @note Since these URLs get dropped directly into emails, using the
2922 * short English names avoids insanely long URL-encoded links, which
2923 * also sometimes can get corrupted in some browsers/mailers
2924 * (bug 6957 with Gmail and Internet Explorer).
2926 * @param $page \string Special page
2927 * @param $token \string Token
2928 * @return \string Formatted URL
2930 protected function getTokenUrl( $page, $token ) {
2931 global $wgArticlePath;
2935 "Special:$page/$token",
2940 * Mark the e-mail address confirmed.
2942 * @note Call saveSettings() after calling this function to commit the change.
2944 function confirmEmail() {
2945 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2950 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2951 * address if it was already confirmed.
2953 * @note Call saveSettings() after calling this function to commit the change.
2955 function invalidateEmail() {
2957 $this->mEmailToken
= null;
2958 $this->mEmailTokenExpires
= null;
2959 $this->setEmailAuthenticationTimestamp( null );
2964 * Set the e-mail authentication timestamp.
2965 * @param $timestamp \string TS_MW timestamp
2967 function setEmailAuthenticationTimestamp( $timestamp ) {
2969 $this->mEmailAuthenticated
= $timestamp;
2970 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2974 * Is this user allowed to send e-mails within limits of current
2975 * site configuration?
2976 * @return \bool True if allowed
2978 function canSendEmail() {
2979 global $wgEnableEmail, $wgEnableUserEmail;
2980 if( !$wgEnableEmail ||
!$wgEnableUserEmail ) {
2983 $canSend = $this->isEmailConfirmed();
2984 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
2989 * Is this user allowed to receive e-mails within limits of current
2990 * site configuration?
2991 * @return \bool True if allowed
2993 function canReceiveEmail() {
2994 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
2998 * Is this user's e-mail address valid-looking and confirmed within
2999 * limits of the current site configuration?
3001 * @note If $wgEmailAuthentication is on, this may require the user to have
3002 * confirmed their address by returning a code or using a password
3003 * sent to the address from the wiki.
3005 * @return \bool True if confirmed
3007 function isEmailConfirmed() {
3008 global $wgEmailAuthentication;
3011 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3012 if( $this->isAnon() )
3014 if( !self
::isValidEmailAddr( $this->mEmail
) )
3016 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3025 * Check whether there is an outstanding request for e-mail confirmation.
3026 * @return \bool True if pending
3028 function isEmailConfirmationPending() {
3029 global $wgEmailAuthentication;
3030 return $wgEmailAuthentication &&
3031 !$this->isEmailConfirmed() &&
3032 $this->mEmailToken
&&
3033 $this->mEmailTokenExpires
> wfTimestamp();
3037 * Get the timestamp of account creation.
3039 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3040 * non-existent/anonymous user accounts.
3042 public function getRegistration() {
3043 return $this->getId() > 0
3044 ?
$this->mRegistration
3049 * Get the timestamp of the first edit
3051 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3052 * non-existent/anonymous user accounts.
3054 public function getFirstEditTimestamp() {
3055 if( $this->getId() == 0 ) return false; // anons
3056 $dbr = wfGetDB( DB_SLAVE
);
3057 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3058 array( 'rev_user' => $this->getId() ),
3060 array( 'ORDER BY' => 'rev_timestamp ASC' )
3062 if( !$time ) return false; // no edits
3063 return wfTimestamp( TS_MW
, $time );
3067 * Get the permissions associated with a given list of groups
3069 * @param $groups \type{\arrayof{\string}} List of internal group names
3070 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3072 static function getGroupPermissions( $groups ) {
3073 global $wgGroupPermissions;
3075 foreach( $groups as $group ) {
3076 if( isset( $wgGroupPermissions[$group] ) ) {
3077 $rights = array_merge( $rights,
3078 // array_filter removes empty items
3079 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3082 return array_unique($rights);
3086 * Get all the groups who have a given permission
3088 * @param $role \string Role to check
3089 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3091 static function getGroupsWithPermission( $role ) {
3092 global $wgGroupPermissions;
3093 $allowedGroups = array();
3094 foreach ( $wgGroupPermissions as $group => $rights ) {
3095 if ( isset( $rights[$role] ) && $rights[$role] ) {
3096 $allowedGroups[] = $group;
3099 return $allowedGroups;
3103 * Get the localized descriptive name for a group, if it exists
3105 * @param $group \string Internal group name
3106 * @return \string Localized descriptive group name
3108 static function getGroupName( $group ) {
3109 global $wgMessageCache;
3110 $wgMessageCache->loadAllMessages();
3111 $key = "group-$group";
3112 $name = wfMsg( $key );
3113 return $name == '' ||
wfEmptyMsg( $key, $name )
3119 * Get the localized descriptive name for a member of a group, if it exists
3121 * @param $group \string Internal group name
3122 * @return \string Localized name for group member
3124 static function getGroupMember( $group ) {
3125 global $wgMessageCache;
3126 $wgMessageCache->loadAllMessages();
3127 $key = "group-$group-member";
3128 $name = wfMsg( $key );
3129 return $name == '' ||
wfEmptyMsg( $key, $name )
3135 * Return the set of defined explicit groups.
3136 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3137 * are not included, as they are defined automatically, not in the database.
3138 * @return \type{\arrayof{\string}} Array of internal group names
3140 static function getAllGroups() {
3141 global $wgGroupPermissions;
3143 array_keys( $wgGroupPermissions ),
3144 self
::getImplicitGroups()
3149 * Get a list of all available permissions.
3150 * @return \type{\arrayof{\string}} Array of permission names
3152 static function getAllRights() {
3153 if ( self
::$mAllRights === false ) {
3154 global $wgAvailableRights;
3155 if ( count( $wgAvailableRights ) ) {
3156 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3158 self
::$mAllRights = self
::$mCoreRights;
3160 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3162 return self
::$mAllRights;
3166 * Get a list of implicit groups
3167 * @return \type{\arrayof{\string}} Array of internal group names
3169 public static function getImplicitGroups() {
3170 global $wgImplicitGroups;
3171 $groups = $wgImplicitGroups;
3172 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3177 * Get the title of a page describing a particular group
3179 * @param $group \string Internal group name
3180 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3182 static function getGroupPage( $group ) {
3183 global $wgMessageCache;
3184 $wgMessageCache->loadAllMessages();
3185 $page = wfMsgForContent( 'grouppage-' . $group );
3186 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3187 $title = Title
::newFromText( $page );
3188 if( is_object( $title ) )
3195 * Create a link to the group in HTML, if available;
3196 * else return the group name.
3198 * @param $group \string Internal name of the group
3199 * @param $text \string The text of the link
3200 * @return \string HTML link to the group
3202 static function makeGroupLinkHTML( $group, $text = '' ) {
3204 $text = self
::getGroupName( $group );
3206 $title = self
::getGroupPage( $group );
3209 $sk = $wgUser->getSkin();
3210 return $sk->link( $title, htmlspecialchars( $text ) );
3217 * Create a link to the group in Wikitext, if available;
3218 * else return the group name.
3220 * @param $group \string Internal name of the group
3221 * @param $text \string The text of the link
3222 * @return \string Wikilink to the group
3224 static function makeGroupLinkWiki( $group, $text = '' ) {
3226 $text = self
::getGroupName( $group );
3228 $title = self
::getGroupPage( $group );
3230 $page = $title->getPrefixedText();
3231 return "[[$page|$text]]";
3238 * Returns an array of the groups that a particular group can add/remove.
3240 * @param $group String: the group to check for whether it can add/remove
3241 * @return Array array( 'add' => array( addablegroups ),
3242 * 'remove' => array( removablegroups ),
3243 * 'add-self' => array( addablegroups to self),
3244 * 'remove-self' => array( removable groups from self) )
3246 static function changeableByGroup( $group ) {
3247 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3249 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3250 if( empty($wgAddGroups[$group]) ) {
3251 // Don't add anything to $groups
3252 } elseif( $wgAddGroups[$group] === true ) {
3253 // You get everything
3254 $groups['add'] = self
::getAllGroups();
3255 } elseif( is_array($wgAddGroups[$group]) ) {
3256 $groups['add'] = $wgAddGroups[$group];
3259 // Same thing for remove
3260 if( empty($wgRemoveGroups[$group]) ) {
3261 } elseif($wgRemoveGroups[$group] === true ) {
3262 $groups['remove'] = self
::getAllGroups();
3263 } elseif( is_array($wgRemoveGroups[$group]) ) {
3264 $groups['remove'] = $wgRemoveGroups[$group];
3267 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3268 if( empty($wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3269 foreach($wgGroupsAddToSelf as $key => $value) {
3270 if( is_int($key) ) {
3271 $wgGroupsAddToSelf['user'][] = $value;
3276 if( empty($wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3277 foreach($wgGroupsRemoveFromSelf as $key => $value) {
3278 if( is_int($key) ) {
3279 $wgGroupsRemoveFromSelf['user'][] = $value;
3284 // Now figure out what groups the user can add to him/herself
3285 if( empty($wgGroupsAddToSelf[$group]) ) {
3286 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3287 // No idea WHY this would be used, but it's there
3288 $groups['add-self'] = User
::getAllGroups();
3289 } elseif( is_array($wgGroupsAddToSelf[$group]) ) {
3290 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3293 if( empty($wgGroupsRemoveFromSelf[$group]) ) {
3294 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3295 $groups['remove-self'] = User
::getAllGroups();
3296 } elseif( is_array($wgGroupsRemoveFromSelf[$group]) ) {
3297 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3304 * Returns an array of groups that this user can add and remove
3305 * @return Array array( 'add' => array( addablegroups ),
3306 * 'remove' => array( removablegroups ),
3307 * 'add-self' => array( addablegroups to self),
3308 * 'remove-self' => array( removable groups from self) )
3310 function changeableGroups() {
3311 if( $this->isAllowed( 'userrights' ) ) {
3312 // This group gives the right to modify everything (reverse-
3313 // compatibility with old "userrights lets you change
3315 // Using array_merge to make the groups reindexed
3316 $all = array_merge( User
::getAllGroups() );
3320 'add-self' => array(),
3321 'remove-self' => array()
3325 // Okay, it's not so simple, we will have to go through the arrays
3328 'remove' => array(),
3329 'add-self' => array(),
3330 'remove-self' => array() );
3331 $addergroups = $this->getEffectiveGroups();
3333 foreach ($addergroups as $addergroup) {
3334 $groups = array_merge_recursive(
3335 $groups, $this->changeableByGroup($addergroup)
3337 $groups['add'] = array_unique( $groups['add'] );
3338 $groups['remove'] = array_unique( $groups['remove'] );
3339 $groups['add-self'] = array_unique( $groups['add-self'] );
3340 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3346 * Increment the user's edit-count field.
3347 * Will have no effect for anonymous users.
3349 function incEditCount() {
3350 if( !$this->isAnon() ) {
3351 $dbw = wfGetDB( DB_MASTER
);
3352 $dbw->update( 'user',
3353 array( 'user_editcount=user_editcount+1' ),
3354 array( 'user_id' => $this->getId() ),
3357 // Lazy initialization check...
3358 if( $dbw->affectedRows() == 0 ) {
3359 // Pull from a slave to be less cruel to servers
3360 // Accuracy isn't the point anyway here
3361 $dbr = wfGetDB( DB_SLAVE
);
3362 $count = $dbr->selectField( 'revision',
3364 array( 'rev_user' => $this->getId() ),
3367 // Now here's a goddamn hack...
3368 if( $dbr !== $dbw ) {
3369 // If we actually have a slave server, the count is
3370 // at least one behind because the current transaction
3371 // has not been committed and replicated.
3374 // But if DB_SLAVE is selecting the master, then the
3375 // count we just read includes the revision that was
3376 // just added in the working transaction.
3379 $dbw->update( 'user',
3380 array( 'user_editcount' => $count ),
3381 array( 'user_id' => $this->getId() ),
3385 // edit count in user cache too
3386 $this->invalidateCache();
3390 * Get the description of a given right
3392 * @param $right \string Right to query
3393 * @return \string Localized description of the right
3395 static function getRightDescription( $right ) {
3396 global $wgMessageCache;
3397 $wgMessageCache->loadAllMessages();
3398 $key = "right-$right";
3399 $name = wfMsg( $key );
3400 return $name == '' ||
wfEmptyMsg( $key, $name )
3406 * Make an old-style password hash
3408 * @param $password \string Plain-text password
3409 * @param $userId \string User ID
3410 * @return \string Password hash
3412 static function oldCrypt( $password, $userId ) {
3413 global $wgPasswordSalt;
3414 if ( $wgPasswordSalt ) {
3415 return md5( $userId . '-' . md5( $password ) );
3417 return md5( $password );
3422 * Make a new-style password hash
3424 * @param $password \string Plain-text password
3425 * @param $salt \string Optional salt, may be random or the user ID.
3426 * If unspecified or false, will generate one automatically
3427 * @return \string Password hash
3429 static function crypt( $password, $salt = false ) {
3430 global $wgPasswordSalt;
3433 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3437 if( $wgPasswordSalt ) {
3438 if ( $salt === false ) {
3439 $salt = substr( wfGenerateToken(), 0, 8 );
3441 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3443 return ':A:' . md5( $password );
3448 * Compare a password hash with a plain-text password. Requires the user
3449 * ID if there's a chance that the hash is an old-style hash.
3451 * @param $hash \string Password hash
3452 * @param $password \string Plain-text password to compare
3453 * @param $userId \string User ID for old-style password salt
3456 static function comparePasswords( $hash, $password, $userId = false ) {
3458 $type = substr( $hash, 0, 3 );
3461 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3465 if ( $type == ':A:' ) {
3467 return md5( $password ) === substr( $hash, 3 );
3468 } elseif ( $type == ':B:' ) {
3470 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3471 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3474 return self
::oldCrypt( $password, $userId ) === $hash;
3479 * Add a newuser log entry for this user
3480 * @param $byEmail Boolean: account made by email?
3482 public function addNewUserLogEntry( $byEmail = false ) {
3483 global $wgUser, $wgContLang, $wgNewUserLog;
3484 if( empty($wgNewUserLog) ) {
3485 return true; // disabled
3487 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3488 if( $this->getName() == $wgUser->getName() ) {
3492 $action = 'create2';
3493 $message = $byEmail ?
wfMsgForContent( 'newuserlog-byemail' ) : '';
3495 $log = new LogPage( 'newusers' );
3496 $log->addEntry( $action, $this->getUserPage(), $message, array( $this->getId() ) );
3501 * Add an autocreate newuser log entry for this user
3502 * Used by things like CentralAuth and perhaps other authplugins.
3504 public function addNewUserLogEntryAutoCreate() {
3505 global $wgNewUserLog;
3506 if( empty($wgNewUserLog) ) {
3507 return true; // disabled
3509 $log = new LogPage( 'newusers', false );
3510 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3514 protected function loadOptions() {
3516 if ($this->mOptionsLoaded ||
!$this->getId() )
3519 $this->mOptions
= self
::getDefaultOptions();
3521 // Maybe load from the object
3523 if ( !is_null($this->mOptionOverrides
) ) {
3524 wfDebug( "Loading options for user ".$this->getId()." from override cache.\n" );
3525 foreach( $this->mOptionOverrides
as $key => $value ) {
3526 $this->mOptions
[$key] = $value;
3529 wfDebug( "Loading options for user ".$this->getId()." from database.\n" );
3530 // Load from database
3531 $dbr = wfGetDB( DB_SLAVE
);
3533 $res = $dbr->select( 'user_properties',
3535 array('up_user' => $this->getId()),
3539 while( $row = $dbr->fetchObject( $res ) ) {
3540 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3541 $this->mOptions
[$row->up_property
] = $row->up_value
;
3545 $this->mOptionsLoaded
= true;
3547 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3550 protected function saveOptions() {
3551 $this->loadOptions();
3552 $dbw = wfGetDB( DB_MASTER
);
3554 $insert_rows = array();
3556 $saveOptions = $this->mOptions
;
3558 // Allow hooks to abort, for instance to save to a global profile.
3559 // Reset options to default state before saving.
3560 if (!wfRunHooks( 'UserSaveOptions', array($this, &$saveOptions) ) )
3563 foreach( $saveOptions as $key => $value ) {
3564 if ( ( is_null(self
::getDefaultOption($key)) &&
3565 !( $value === false ||
is_null($value) ) ) ||
3566 $value != self
::getDefaultOption( $key ) ) {
3567 $insert_rows[] = array(
3568 'up_user' => $this->getId(),
3569 'up_property' => $key,
3570 'up_value' => $value,
3576 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3577 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);