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', 6 );
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
127 * \type{\arrayof{\string}} Core rights.
128 * Each of these should have a corresponding message of the form
132 static $mCoreRights = array(
158 'move-rootuserpages',
162 'override-export-depth',
181 'userrights-interwiki',
185 * \string Cached results of getAllRights()
187 static $mAllRights = false;
189 /** @name Cache variables */
191 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
192 $mEmail, $mOptions, $mTouched, $mToken, $mEmailAuthenticated,
193 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups;
197 * \bool Whether the cache variables have been loaded.
199 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
202 * \string Initialization data source if mDataLoaded==false. May be one of:
203 * - 'defaults' anonymous user initialised from class defaults
204 * - 'name' initialise from mName
205 * - 'id' initialise from mId
206 * - 'session' log in from cookies or session if possible
208 * Use the User::newFrom*() family of functions to set this.
212 /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
214 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
215 $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
216 $mLocked, $mHideName;
220 * Lightweight constructor for an anonymous user.
221 * Use the User::newFrom* factory functions for other kinds of users.
225 * @see newFromConfirmationCode()
226 * @see newFromSession()
230 $this->clearInstanceCache( 'defaults' );
234 * Load the user table data for this object from the source given by mFrom.
237 if ( $this->mDataLoaded
) {
240 wfProfileIn( __METHOD__
);
242 # Set it now to avoid infinite recursion in accessors
243 $this->mDataLoaded
= true;
245 switch ( $this->mFrom
) {
247 $this->loadDefaults();
250 $this->mId
= self
::idFromName( $this->mName
);
252 # Nonexistent user placeholder object
253 $this->loadDefaults( $this->mName
);
262 $this->loadFromSession();
263 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
266 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
268 wfProfileOut( __METHOD__
);
272 * Load user table data, given mId has already been set.
273 * @return \bool false if the ID does not exist, true otherwise
276 function loadFromId() {
278 if ( $this->mId
== 0 ) {
279 $this->loadDefaults();
284 $key = wfMemcKey( 'user', 'id', $this->mId
);
285 $data = $wgMemc->get( $key );
286 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
287 # Object is expired, load from DB
292 wfDebug( "Cache miss for user {$this->mId}\n" );
294 if ( !$this->loadFromDatabase() ) {
295 # Can't load from ID, user is anonymous
298 $this->saveToCache();
300 wfDebug( "Got user {$this->mId} from cache\n" );
302 foreach ( self
::$mCacheVars as $name ) {
303 $this->$name = $data[$name];
310 * Save user data to the shared cache
312 function saveToCache() {
315 $this->loadOptions();
316 if ( $this->isAnon() ) {
317 // Anonymous users are uncached
321 foreach ( self
::$mCacheVars as $name ) {
322 $data[$name] = $this->$name;
324 $data['mVersion'] = MW_USER_VERSION
;
325 $key = wfMemcKey( 'user', 'id', $this->mId
);
327 $wgMemc->set( $key, $data );
331 /** @name newFrom*() static factory methods */
335 * Static factory method for creation from username.
337 * This is slightly less efficient than newFromId(), so use newFromId() if
338 * you have both an ID and a name handy.
340 * @param $name \string Username, validated by Title::newFromText()
341 * @param $validate \mixed Validate username. Takes the same parameters as
342 * User::getCanonicalName(), except that true is accepted as an alias
343 * for 'valid', for BC.
345 * @return \type{User} The User object, or null if the username is invalid. If the
346 * username is not present in the database, the result will be a user object
347 * with a name, zero user ID and default settings.
349 static function newFromName( $name, $validate = 'valid' ) {
350 if ( $validate === true ) {
353 $name = self
::getCanonicalName( $name, $validate );
354 if ( $name === false ) {
357 # Create unloaded user object
366 * Static factory method for creation from a given user ID.
368 * @param $id \int Valid user ID
369 * @return \type{User} The corresponding User object
371 static function newFromId( $id ) {
379 * Factory method to fetch whichever user has a given email confirmation code.
380 * This code is generated when an account is created or its e-mail address
383 * If the code is invalid or has expired, returns NULL.
385 * @param $code \string Confirmation code
386 * @return \type{User}
388 static function newFromConfirmationCode( $code ) {
389 $dbr = wfGetDB( DB_SLAVE
);
390 $id = $dbr->selectField( 'user', 'user_id', array(
391 'user_email_token' => md5( $code ),
392 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
394 if( $id !== false ) {
395 return User
::newFromId( $id );
402 * Create a new user object using data from session or cookies. If the
403 * login credentials are invalid, the result is an anonymous user.
405 * @return \type{User}
407 static function newFromSession() {
409 $user->mFrom
= 'session';
414 * Create a new user object from a user row.
415 * The row should have all fields from the user table in it.
416 * @param $row array A row from the user table
417 * @return \type{User}
419 static function newFromRow( $row ) {
421 $user->loadFromRow( $row );
429 * Get the username corresponding to a given user ID
430 * @param $id \int User ID
431 * @return \string The corresponding username
433 static function whoIs( $id ) {
434 $dbr = wfGetDB( DB_SLAVE
);
435 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
439 * Get the real name of a user given their user ID
441 * @param $id \int User ID
442 * @return \string The corresponding user's real name
444 static function whoIsReal( $id ) {
445 $dbr = wfGetDB( DB_SLAVE
);
446 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
450 * Get database id given a user name
451 * @param $name \string Username
452 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
454 static function idFromName( $name ) {
455 $nt = Title
::makeTitleSafe( NS_USER
, $name );
456 if( is_null( $nt ) ) {
460 $dbr = wfGetDB( DB_SLAVE
);
461 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
463 if ( $s === false ) {
471 * Does the string match an anonymous IPv4 address?
473 * This function exists for username validation, in order to reject
474 * usernames which are similar in form to IP addresses. Strings such
475 * as 300.300.300.300 will return true because it looks like an IP
476 * address, despite not being strictly valid.
478 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
479 * address because the usemod software would "cloak" anonymous IP
480 * addresses like this, if we allowed accounts like this to be created
481 * new users could get the old edits of these anonymous users.
483 * @param $name \string String to match
484 * @return \bool True or false
486 static function isIP( $name ) {
487 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
491 * Is the input a valid username?
493 * Checks if the input is a valid username, we don't want an empty string,
494 * an IP address, anything that containins slashes (would mess up subpages),
495 * is longer than the maximum allowed username size or doesn't begin with
498 * @param $name \string String to match
499 * @return \bool True or false
501 static function isValidUserName( $name ) {
502 global $wgContLang, $wgMaxNameChars;
505 || User
::isIP( $name )
506 ||
strpos( $name, '/' ) !== false
507 ||
strlen( $name ) > $wgMaxNameChars
508 ||
$name != $wgContLang->ucfirst( $name ) ) {
509 wfDebugLog( 'username', __METHOD__
.
510 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
514 // Ensure that the name can't be misresolved as a different title,
515 // such as with extra namespace keys at the start.
516 $parsed = Title
::newFromText( $name );
517 if( is_null( $parsed )
518 ||
$parsed->getNamespace()
519 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
520 wfDebugLog( 'username', __METHOD__
.
521 ": '$name' invalid due to ambiguous prefixes" );
525 // Check an additional blacklist of troublemaker characters.
526 // Should these be merged into the title char list?
527 $unicodeBlacklist = '/[' .
528 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
529 '\x{00a0}' . # non-breaking space
530 '\x{2000}-\x{200f}' . # various whitespace
531 '\x{2028}-\x{202f}' . # breaks and control chars
532 '\x{3000}' . # ideographic space
533 '\x{e000}-\x{f8ff}' . # private use
535 if( preg_match( $unicodeBlacklist, $name ) ) {
536 wfDebugLog( 'username', __METHOD__
.
537 ": '$name' invalid due to blacklisted characters" );
545 * Usernames which fail to pass this function will be blocked
546 * from user login and new account registrations, but may be used
547 * internally by batch processes.
549 * If an account already exists in this form, login will be blocked
550 * by a failure to pass this function.
552 * @param $name \string String to match
553 * @return \bool True or false
555 static function isUsableName( $name ) {
556 global $wgReservedUsernames;
557 // Must be a valid username, obviously ;)
558 if ( !self
::isValidUserName( $name ) ) {
562 static $reservedUsernames = false;
563 if ( !$reservedUsernames ) {
564 $reservedUsernames = $wgReservedUsernames;
565 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
568 // Certain names may be reserved for batch processes.
569 foreach ( $reservedUsernames as $reserved ) {
570 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
571 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
573 if ( $reserved == $name ) {
581 * Usernames which fail to pass this function will be blocked
582 * from new account registrations, but may be used internally
583 * either by batch processes or by user accounts which have
584 * already been created.
586 * Additional character blacklisting may be added here
587 * rather than in isValidUserName() to avoid disrupting
590 * @param $name \string String to match
591 * @return \bool True or false
593 static function isCreatableName( $name ) {
594 global $wgInvalidUsernameCharacters;
596 self
::isUsableName( $name ) &&
598 // Registration-time character blacklisting...
599 !preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name );
603 * Is the input a valid password for this user?
605 * @param $password \string Desired password
606 * @return \bool True or false
608 function isValidPassword( $password ) {
609 global $wgMinimalPasswordLength, $wgContLang;
612 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
614 if( $result === false )
617 // Password needs to be long enough, and can't be the same as the username
618 return strlen( $password ) >= $wgMinimalPasswordLength
619 && $wgContLang->lc( $password ) !== $wgContLang->lc( $this->mName
);
623 * Does a string look like an e-mail address?
625 * There used to be a regular expression here, it got removed because it
626 * rejected valid addresses. Actually just check if there is '@' somewhere
627 * in the given address.
629 * @todo Check for RFC 2822 compilance (bug 959)
631 * @param $addr \string E-mail address
632 * @return \bool True or false
634 public static function isValidEmailAddr( $addr ) {
636 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
640 return strpos( $addr, '@' ) !== false;
644 * Given unvalidated user input, return a canonical username, or false if
645 * the username is invalid.
646 * @param $name \string User input
647 * @param $validate \types{\string,\bool} Type of validation to use:
648 * - false No validation
649 * - 'valid' Valid for batch processes
650 * - 'usable' Valid for batch processes and login
651 * - 'creatable' Valid for batch processes, login and account creation
653 static function getCanonicalName( $name, $validate = 'valid' ) {
654 # Force usernames to capital
656 $name = $wgContLang->ucfirst( $name );
658 # Reject names containing '#'; these will be cleaned up
659 # with title normalisation, but then it's too late to
661 if( strpos( $name, '#' ) !== false )
664 # Clean up name according to title rules
665 $t = ($validate === 'valid') ?
666 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
667 # Check for invalid titles
668 if( is_null( $t ) ) {
672 # Reject various classes of invalid names
673 $name = $t->getText();
675 $name = $wgAuth->getCanonicalName( $t->getText() );
677 switch ( $validate ) {
681 if ( !User
::isValidUserName( $name ) ) {
686 if ( !User
::isUsableName( $name ) ) {
691 if ( !User
::isCreatableName( $name ) ) {
696 throw new MWException( 'Invalid parameter value for $validate in '.__METHOD__
);
702 * Count the number of edits of a user
703 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
705 * @param $uid \int User ID to check
706 * @return \int The user's edit count
708 static function edits( $uid ) {
709 wfProfileIn( __METHOD__
);
710 $dbr = wfGetDB( DB_SLAVE
);
711 // check if the user_editcount field has been initialized
712 $field = $dbr->selectField(
713 'user', 'user_editcount',
714 array( 'user_id' => $uid ),
718 if( $field === null ) { // it has not been initialized. do so.
719 $dbw = wfGetDB( DB_MASTER
);
720 $count = $dbr->selectField(
721 'revision', 'count(*)',
722 array( 'rev_user' => $uid ),
727 array( 'user_editcount' => $count ),
728 array( 'user_id' => $uid ),
734 wfProfileOut( __METHOD__
);
739 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
740 * @todo hash random numbers to improve security, like generateToken()
742 * @return \string New random password
744 static function randomPassword() {
745 global $wgMinimalPasswordLength;
746 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
747 $l = strlen( $pwchars ) - 1;
749 $pwlength = max( 7, $wgMinimalPasswordLength );
750 $digit = mt_rand(0, $pwlength - 1);
752 for ( $i = 0; $i < $pwlength; $i++
) {
753 $np .= $i == $digit ?
chr( mt_rand(48, 57) ) : $pwchars{ mt_rand(0, $l)};
759 * Set cached properties to default.
761 * @note This no longer clears uncached lazy-initialised properties;
762 * the constructor does that instead.
765 function loadDefaults( $name = false ) {
766 wfProfileIn( __METHOD__
);
768 global $wgCookiePrefix;
771 $this->mName
= $name;
772 $this->mRealName
= '';
773 $this->mPassword
= $this->mNewpassword
= '';
774 $this->mNewpassTime
= null;
776 $this->mOptions
= null; # Defer init
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;
977 $this->mDataLoaded
= false;
978 $this->mFrom
= $reloadFrom;
983 * Combine the language default options with any site-specific options
984 * and add the default language variants.
986 * @return \type{\arrayof{\string}} Array of options
988 static function getDefaultOptions() {
989 global $wgNamespacesToBeSearchedDefault;
991 * Site defaults will override the global/language defaults
993 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
994 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
997 * default language setting
999 $variant = $wgContLang->getPreferredVariant( false );
1000 $defOpt['variant'] = $variant;
1001 $defOpt['language'] = $variant;
1002 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1003 $defOpt['searchNs'.$nsnum] = !empty($wgNamespacesToBeSearchedDefault[$nsnum]);
1005 $defOpt['skin'] = $wgDefaultSkin;
1011 * Get a given default option value.
1013 * @param $opt \string Name of option to retrieve
1014 * @return \string Default option value
1016 public static function getDefaultOption( $opt ) {
1017 $defOpts = self
::getDefaultOptions();
1018 if( isset( $defOpts[$opt] ) ) {
1019 return $defOpts[$opt];
1026 * Get a list of user toggle names
1027 * @return \type{\arrayof{\string}} Array of user toggle names
1029 static function getToggles() {
1030 global $wgContLang, $wgUseRCPatrol;
1031 $extraToggles = array();
1032 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1033 if( $wgUseRCPatrol ) {
1034 $extraToggles[] = 'hidepatrolled';
1035 $extraToggles[] = 'newpageshidepatrolled';
1036 $extraToggles[] = 'watchlisthidepatrolled';
1038 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1043 * Get blocking information
1045 * @param $bFromSlave \bool Whether to check the slave database first. To
1046 * improve performance, non-critical checks are done
1047 * against slaves. Check when actually saving should be
1048 * done against master.
1050 function getBlockedStatus( $bFromSlave = true ) {
1051 global $wgEnableSorbs, $wgProxyWhitelist;
1053 if ( -1 != $this->mBlockedby
) {
1054 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1058 wfProfileIn( __METHOD__
);
1059 wfDebug( __METHOD__
.": checking...\n" );
1061 // Initialize data...
1062 // Otherwise something ends up stomping on $this->mBlockedby when
1063 // things get lazy-loaded later, causing false positive block hits
1064 // due to -1 !== 0. Probably session-related... Nothing should be
1065 // overwriting mBlockedby, surely?
1068 $this->mBlockedby
= 0;
1069 $this->mHideName
= 0;
1070 $this->mAllowUsertalk
= 0;
1073 if ($this->isAllowed( 'ipblock-exempt' ) ) {
1074 # Exempt from all types of IP-block
1079 $this->mBlock
= new Block();
1080 $this->mBlock
->fromMaster( !$bFromSlave );
1081 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1082 wfDebug( __METHOD__
.": Found block.\n" );
1083 $this->mBlockedby
= $this->mBlock
->mBy
;
1084 $this->mBlockreason
= $this->mBlock
->mReason
;
1085 $this->mHideName
= $this->mBlock
->mHideName
;
1086 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1087 if ( $this->isLoggedIn() ) {
1088 $this->spreadBlock();
1091 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1092 // apply to users. Note that the existence of $this->mBlock is not used to
1093 // check for edit blocks, $this->mBlockedby is instead.
1097 if ( !$this->isAllowed('proxyunbannable') && !in_array( $ip, $wgProxyWhitelist ) ) {
1099 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1100 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1101 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1105 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1106 if ( $this->inSorbsBlacklist( $ip ) ) {
1107 $this->mBlockedby
= wfMsg( 'sorbs' );
1108 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1114 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1116 wfProfileOut( __METHOD__
);
1120 * Whether the given IP is in the SORBS blacklist.
1122 * @param $ip \string IP to check
1123 * @return \bool True if blacklisted.
1125 function inSorbsBlacklist( $ip ) {
1126 global $wgEnableSorbs, $wgSorbsUrl;
1128 return $wgEnableSorbs &&
1129 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1133 * Whether the given IP is in a given DNS blacklist.
1135 * @param $ip \string IP to check
1136 * @param $base \string URL of the DNS blacklist
1137 * @return \bool True if blacklisted.
1139 function inDnsBlacklist( $ip, $base ) {
1140 wfProfileIn( __METHOD__
);
1144 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1145 if( IP
::isIPv4($ip) ) {
1147 $host = "$ip.$base";
1150 $ipList = gethostbynamel( $host );
1153 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1156 wfDebug( "Requested $host, not found in $base.\n" );
1160 wfProfileOut( __METHOD__
);
1165 * Is this user subject to rate limiting?
1167 * @return \bool True if rate limited
1169 public function isPingLimitable() {
1170 global $wgRateLimitsExcludedGroups;
1171 global $wgRateLimitsExcludedIPs;
1172 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1173 // Deprecated, but kept for backwards-compatibility config
1176 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1177 // No other good way currently to disable rate limits
1178 // for specific IPs. :P
1179 // But this is a crappy hack and should die.
1182 return !$this->isAllowed('noratelimit');
1186 * Primitive rate limits: enforce maximum actions per time period
1187 * to put a brake on flooding.
1189 * @note When using a shared cache like memcached, IP-address
1190 * last-hit counters will be shared across wikis.
1192 * @param $action \string Action to enforce; 'edit' if unspecified
1193 * @return \bool True if a rate limiter was tripped
1195 function pingLimiter( $action='edit' ) {
1197 # Call the 'PingLimiter' hook
1199 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1203 global $wgRateLimits;
1204 if( !isset( $wgRateLimits[$action] ) ) {
1208 # Some groups shouldn't trigger the ping limiter, ever
1209 if( !$this->isPingLimitable() )
1212 global $wgMemc, $wgRateLimitLog;
1213 wfProfileIn( __METHOD__
);
1215 $limits = $wgRateLimits[$action];
1217 $id = $this->getId();
1221 if( isset( $limits['anon'] ) && $id == 0 ) {
1222 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1225 if( isset( $limits['user'] ) && $id != 0 ) {
1226 $userLimit = $limits['user'];
1228 if( $this->isNewbie() ) {
1229 if( isset( $limits['newbie'] ) && $id != 0 ) {
1230 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1232 if( isset( $limits['ip'] ) ) {
1233 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1236 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1237 $subnet = $matches[1];
1238 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1241 // Check for group-specific permissions
1242 // If more than one group applies, use the group with the highest limit
1243 foreach ( $this->getGroups() as $group ) {
1244 if ( isset( $limits[$group] ) ) {
1245 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1246 $userLimit = $limits[$group];
1250 // Set the user limit key
1251 if ( $userLimit !== false ) {
1252 wfDebug( __METHOD__
.": effective user limit: $userLimit\n" );
1253 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1257 foreach( $keys as $key => $limit ) {
1258 list( $max, $period ) = $limit;
1259 $summary = "(limit $max in {$period}s)";
1260 $count = $wgMemc->get( $key );
1262 if( $count > $max ) {
1263 wfDebug( __METHOD__
.": tripped! $key at $count $summary\n" );
1264 if( $wgRateLimitLog ) {
1265 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1269 wfDebug( __METHOD__
.": ok. $key at $count $summary\n" );
1272 wfDebug( __METHOD__
.": adding record for $key $summary\n" );
1273 $wgMemc->add( $key, 1, intval( $period ) );
1275 $wgMemc->incr( $key );
1278 wfProfileOut( __METHOD__
);
1283 * Check if user is blocked
1285 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1286 * @return \bool True if blocked, false otherwise
1288 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1289 wfDebug( "User::isBlocked: enter\n" );
1290 $this->getBlockedStatus( $bFromSlave );
1291 return $this->mBlockedby
!== 0;
1295 * Check if user is blocked from editing a particular article
1297 * @param $title \string Title to check
1298 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1299 * @return \bool True if blocked, false otherwise
1301 function isBlockedFrom( $title, $bFromSlave = false ) {
1302 global $wgBlockAllowsUTEdit;
1303 wfProfileIn( __METHOD__
);
1304 wfDebug( __METHOD__
.": enter\n" );
1306 wfDebug( __METHOD__
.": asking isBlocked()\n" );
1307 $blocked = $this->isBlocked( $bFromSlave );
1308 $allowUsertalk = ($wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false);
1309 # If a user's name is suppressed, they cannot make edits anywhere
1310 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1311 $title->getNamespace() == NS_USER_TALK
) {
1313 wfDebug( __METHOD__
.": self-talk page, ignoring any blocks\n" );
1315 wfProfileOut( __METHOD__
);
1320 * If user is blocked, return the name of the user who placed the block
1321 * @return \string name of blocker
1323 function blockedBy() {
1324 $this->getBlockedStatus();
1325 return $this->mBlockedby
;
1329 * If user is blocked, return the specified reason for the block
1330 * @return \string Blocking reason
1332 function blockedFor() {
1333 $this->getBlockedStatus();
1334 return $this->mBlockreason
;
1338 * If user is blocked, return the ID for the block
1339 * @return \int Block ID
1341 function getBlockId() {
1342 $this->getBlockedStatus();
1343 return ($this->mBlock ?
$this->mBlock
->mId
: false);
1347 * Check if user is blocked on all wikis.
1348 * Do not use for actual edit permission checks!
1349 * This is intented for quick UI checks.
1351 * @param $ip \type{\string} IP address, uses current client if none given
1352 * @return \type{\bool} True if blocked, false otherwise
1354 function isBlockedGlobally( $ip = '' ) {
1355 if( $this->mBlockedGlobally
!== null ) {
1356 return $this->mBlockedGlobally
;
1358 // User is already an IP?
1359 if( IP
::isIPAddress( $this->getName() ) ) {
1360 $ip = $this->getName();
1365 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1366 $this->mBlockedGlobally
= (bool)$blocked;
1367 return $this->mBlockedGlobally
;
1371 * Check if user account is locked
1373 * @return \type{\bool} True if locked, false otherwise
1375 function isLocked() {
1376 if( $this->mLocked
!== null ) {
1377 return $this->mLocked
;
1380 $authUser = $wgAuth->getUserInstance( $this );
1381 $this->mLocked
= (bool)$authUser->isLocked();
1382 return $this->mLocked
;
1386 * Check if user account is hidden
1388 * @return \type{\bool} True if hidden, false otherwise
1390 function isHidden() {
1391 if( $this->mHideName
!== null ) {
1392 return $this->mHideName
;
1394 $this->getBlockedStatus();
1395 if( !$this->mHideName
) {
1397 $authUser = $wgAuth->getUserInstance( $this );
1398 $this->mHideName
= (bool)$authUser->isHidden();
1400 return $this->mHideName
;
1404 * Get the user's ID.
1405 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1408 if( $this->mId
=== null and $this->mName
!== null
1409 and User
::isIP( $this->mName
) ) {
1410 // Special case, we know the user is anonymous
1412 } elseif( $this->mId
=== null ) {
1413 // Don't load if this was initialized from an ID
1420 * Set the user and reload all fields according to a given ID
1421 * @param $v \int User ID to reload
1423 function setId( $v ) {
1425 $this->clearInstanceCache( 'id' );
1429 * Get the user name, or the IP of an anonymous user
1430 * @return \string User's name or IP address
1432 function getName() {
1433 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1434 # Special case optimisation
1435 return $this->mName
;
1438 if ( $this->mName
=== false ) {
1440 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1442 return $this->mName
;
1447 * Set the user name.
1449 * This does not reload fields from the database according to the given
1450 * name. Rather, it is used to create a temporary "nonexistent user" for
1451 * later addition to the database. It can also be used to set the IP
1452 * address for an anonymous user to something other than the current
1455 * @note User::newFromName() has rougly the same function, when the named user
1457 * @param $str \string New user name to set
1459 function setName( $str ) {
1461 $this->mName
= $str;
1465 * Get the user's name escaped by underscores.
1466 * @return \string Username escaped by underscores.
1468 function getTitleKey() {
1469 return str_replace( ' ', '_', $this->getName() );
1473 * Check if the user has new messages.
1474 * @return \bool True if the user has new messages
1476 function getNewtalk() {
1479 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1480 if( $this->mNewtalk
=== -1 ) {
1481 $this->mNewtalk
= false; # reset talk page status
1483 # Check memcached separately for anons, who have no
1484 # entire User object stored in there.
1487 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1488 $newtalk = $wgMemc->get( $key );
1489 if( strval( $newtalk ) !== '' ) {
1490 $this->mNewtalk
= (bool)$newtalk;
1492 // Since we are caching this, make sure it is up to date by getting it
1494 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1495 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1498 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1502 return (bool)$this->mNewtalk
;
1506 * Return the talk page(s) this user has new messages on.
1507 * @return \type{\arrayof{\string}} Array of page URLs
1509 function getNewMessageLinks() {
1511 if (!wfRunHooks('UserRetrieveNewTalks', array(&$this, &$talks)))
1514 if (!$this->getNewtalk())
1516 $up = $this->getUserPage();
1517 $utp = $up->getTalkPage();
1518 return array(array("wiki" => wfWikiID(), "link" => $utp->getLocalURL()));
1523 * Internal uncached check for new messages
1526 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1527 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1528 * @param $fromMaster \bool true to fetch from the master, false for a slave
1529 * @return \bool True if the user has new messages
1532 function checkNewtalk( $field, $id, $fromMaster = false ) {
1533 if ( $fromMaster ) {
1534 $db = wfGetDB( DB_MASTER
);
1536 $db = wfGetDB( DB_SLAVE
);
1538 $ok = $db->selectField( 'user_newtalk', $field,
1539 array( $field => $id ), __METHOD__
);
1540 return $ok !== false;
1544 * Add or update the new messages flag
1545 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1546 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1547 * @return \bool True if successful, false otherwise
1550 function updateNewtalk( $field, $id ) {
1551 $dbw = wfGetDB( DB_MASTER
);
1552 $dbw->insert( 'user_newtalk',
1553 array( $field => $id ),
1556 if ( $dbw->affectedRows() ) {
1557 wfDebug( __METHOD__
.": set on ($field, $id)\n" );
1560 wfDebug( __METHOD__
." already set ($field, $id)\n" );
1566 * Clear the new messages flag for the given user
1567 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1568 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1569 * @return \bool True if successful, false otherwise
1572 function deleteNewtalk( $field, $id ) {
1573 $dbw = wfGetDB( DB_MASTER
);
1574 $dbw->delete( 'user_newtalk',
1575 array( $field => $id ),
1577 if ( $dbw->affectedRows() ) {
1578 wfDebug( __METHOD__
.": killed on ($field, $id)\n" );
1581 wfDebug( __METHOD__
.": already gone ($field, $id)\n" );
1587 * Update the 'You have new messages!' status.
1588 * @param $val \bool Whether the user has new messages
1590 function setNewtalk( $val ) {
1591 if( wfReadOnly() ) {
1596 $this->mNewtalk
= $val;
1598 if( $this->isAnon() ) {
1600 $id = $this->getName();
1603 $id = $this->getId();
1608 $changed = $this->updateNewtalk( $field, $id );
1610 $changed = $this->deleteNewtalk( $field, $id );
1613 if( $this->isAnon() ) {
1614 // Anons have a separate memcached space, since
1615 // user records aren't kept for them.
1616 $key = wfMemcKey( 'newtalk', 'ip', $id );
1617 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1620 $this->invalidateCache();
1625 * Generate a current or new-future timestamp to be stored in the
1626 * user_touched field when we update things.
1627 * @return \string Timestamp in TS_MW format
1629 private static function newTouchedTimestamp() {
1630 global $wgClockSkewFudge;
1631 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1635 * Clear user data from memcached.
1636 * Use after applying fun updates to the database; caller's
1637 * responsibility to update user_touched if appropriate.
1639 * Called implicitly from invalidateCache() and saveSettings().
1641 private function clearSharedCache() {
1645 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1650 * Immediately touch the user data cache for this account.
1651 * Updates user_touched field, and removes account data from memcached
1652 * for reload on the next hit.
1654 function invalidateCache() {
1657 $this->mTouched
= self
::newTouchedTimestamp();
1659 $dbw = wfGetDB( DB_MASTER
);
1660 $dbw->update( 'user',
1661 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1662 array( 'user_id' => $this->mId
),
1665 $this->clearSharedCache();
1670 * Validate the cache for this account.
1671 * @param $timestamp \string A timestamp in TS_MW format
1673 function validateCache( $timestamp ) {
1675 return ($timestamp >= $this->mTouched
);
1679 * Get the user touched timestamp
1681 function getTouched() {
1683 return $this->mTouched
;
1687 * Set the password and reset the random token.
1688 * Calls through to authentication plugin if necessary;
1689 * will have no effect if the auth plugin refuses to
1690 * pass the change through or if the legal password
1693 * As a special case, setting the password to null
1694 * wipes it, so the account cannot be logged in until
1695 * a new password is set, for instance via e-mail.
1697 * @param $str \string New password to set
1698 * @throws PasswordError on failure
1700 function setPassword( $str ) {
1703 if( $str !== null ) {
1704 if( !$wgAuth->allowPasswordChange() ) {
1705 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1708 if( !$this->isValidPassword( $str ) ) {
1709 global $wgMinimalPasswordLength;
1710 throw new PasswordError( wfMsgExt( 'passwordtooshort', array( 'parsemag' ),
1711 $wgMinimalPasswordLength ) );
1715 if( !$wgAuth->setPassword( $this, $str ) ) {
1716 throw new PasswordError( wfMsg( 'externaldberror' ) );
1719 $this->setInternalPassword( $str );
1725 * Set the password and reset the random token unconditionally.
1727 * @param $str \string New password to set
1729 function setInternalPassword( $str ) {
1733 if( $str === null ) {
1734 // Save an invalid hash...
1735 $this->mPassword
= '';
1737 $this->mPassword
= self
::crypt( $str );
1739 $this->mNewpassword
= '';
1740 $this->mNewpassTime
= null;
1744 * Get the user's current token.
1745 * @return \string Token
1747 function getToken() {
1749 return $this->mToken
;
1753 * Set the random token (used for persistent authentication)
1754 * Called from loadDefaults() among other places.
1756 * @param $token \string If specified, set the token to this value
1759 function setToken( $token = false ) {
1760 global $wgSecretKey, $wgProxyKey;
1763 if ( $wgSecretKey ) {
1764 $key = $wgSecretKey;
1765 } elseif ( $wgProxyKey ) {
1770 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1772 $this->mToken
= $token;
1777 * Set the cookie password
1779 * @param $str \string New cookie password
1782 function setCookiePassword( $str ) {
1784 $this->mCookiePassword
= md5( $str );
1788 * Set the password for a password reminder or new account email
1790 * @param $str \string New password to set
1791 * @param $throttle \bool If true, reset the throttle timestamp to the present
1793 function setNewpassword( $str, $throttle = true ) {
1795 $this->mNewpassword
= self
::crypt( $str );
1797 $this->mNewpassTime
= wfTimestampNow();
1802 * Has password reminder email been sent within the last
1803 * $wgPasswordReminderResendTime hours?
1804 * @return \bool True or false
1806 function isPasswordReminderThrottled() {
1807 global $wgPasswordReminderResendTime;
1809 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1812 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1813 return time() < $expiry;
1817 * Get the user's e-mail address
1818 * @return \string User's email address
1820 function getEmail() {
1822 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1823 return $this->mEmail
;
1827 * Get the timestamp of the user's e-mail authentication
1828 * @return \string TS_MW timestamp
1830 function getEmailAuthenticationTimestamp() {
1832 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1833 return $this->mEmailAuthenticated
;
1837 * Set the user's e-mail address
1838 * @param $str \string New e-mail address
1840 function setEmail( $str ) {
1842 $this->mEmail
= $str;
1843 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1847 * Get the user's real name
1848 * @return \string User's real name
1850 function getRealName() {
1852 return $this->mRealName
;
1856 * Set the user's real name
1857 * @param $str \string New real name
1859 function setRealName( $str ) {
1861 $this->mRealName
= $str;
1865 * Get the user's current setting for a given option.
1867 * @param $oname \string The option to check
1868 * @param $defaultOverride \string A default value returned if the option does not exist
1869 * @return \string User's current value for the option
1870 * @see getBoolOption()
1871 * @see getIntOption()
1873 function getOption( $oname, $defaultOverride = null ) {
1874 $this->loadOptions();
1876 if ( is_null( $this->mOptions
) ) {
1877 if($defaultOverride != '') {
1878 return $defaultOverride;
1880 $this->mOptions
= User
::getDefaultOptions();
1883 if ( array_key_exists( $oname, $this->mOptions
) ) {
1884 return $this->mOptions
[$oname];
1886 return $defaultOverride;
1891 * Get the user's current setting for a given option, as a boolean value.
1893 * @param $oname \string The option to check
1894 * @return \bool User's current value for the option
1897 function getBoolOption( $oname ) {
1898 return (bool)$this->getOption( $oname );
1903 * Get the user's current setting for a given option, as a boolean value.
1905 * @param $oname \string The option to check
1906 * @param $defaultOverride \int A default value returned if the option does not exist
1907 * @return \int User's current value for the option
1910 function getIntOption( $oname, $defaultOverride=0 ) {
1911 $val = $this->getOption( $oname );
1913 $val = $defaultOverride;
1915 return intval( $val );
1919 * Set the given option for a user.
1921 * @param $oname \string The option to set
1922 * @param $val \mixed New value to set
1924 function setOption( $oname, $val ) {
1926 $this->loadOptions();
1928 if ( $oname == 'skin' ) {
1929 # Clear cached skin, so the new one displays immediately in Special:Preferences
1930 unset( $this->mSkin
);
1933 // Explicitly NULL values should refer to defaults
1934 global $wgDefaultUserOptions;
1935 if( is_null($val) && isset($wgDefaultUserOptions[$oname]) ) {
1936 $val = $wgDefaultUserOptions[$oname];
1939 $this->mOptions
[$oname] = $val;
1943 * Reset all options to the site defaults
1945 function resetOptions() {
1946 $this->mOptions
= User
::getDefaultOptions();
1950 * Get the user's preferred date format.
1951 * @return \string User's preferred date format
1953 function getDatePreference() {
1954 // Important migration for old data rows
1955 if ( is_null( $this->mDatePreference
) ) {
1957 $value = $this->getOption( 'date' );
1958 $map = $wgLang->getDatePreferenceMigrationMap();
1959 if ( isset( $map[$value] ) ) {
1960 $value = $map[$value];
1962 $this->mDatePreference
= $value;
1964 return $this->mDatePreference
;
1968 * Get the permissions this user has.
1969 * @return \type{\arrayof{\string}} Array of permission names
1971 function getRights() {
1972 if ( is_null( $this->mRights
) ) {
1973 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
1974 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
1975 // Force reindexation of rights when a hook has unset one of them
1976 $this->mRights
= array_values( $this->mRights
);
1978 return $this->mRights
;
1982 * Get the list of explicit group memberships this user has.
1983 * The implicit * and user groups are not included.
1984 * @return \type{\arrayof{\string}} Array of internal group names
1986 function getGroups() {
1988 return $this->mGroups
;
1992 * Get the list of implicit group memberships this user has.
1993 * This includes all explicit groups, plus 'user' if logged in,
1994 * '*' for all accounts and autopromoted groups
1995 * @param $recache \bool Whether to avoid the cache
1996 * @return \type{\arrayof{\string}} Array of internal group names
1998 function getEffectiveGroups( $recache = false ) {
1999 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2000 $this->mEffectiveGroups
= $this->getGroups();
2001 $this->mEffectiveGroups
[] = '*';
2002 if( $this->getId() ) {
2003 $this->mEffectiveGroups
[] = 'user';
2005 $this->mEffectiveGroups
= array_unique( array_merge(
2006 $this->mEffectiveGroups
,
2007 Autopromote
::getAutopromoteGroups( $this )
2010 # Hook for additional groups
2011 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2014 return $this->mEffectiveGroups
;
2018 * Get the user's edit count.
2019 * @return \int User'e edit count
2021 function getEditCount() {
2022 if ($this->getId()) {
2023 if ( !isset( $this->mEditCount
) ) {
2024 /* Populate the count, if it has not been populated yet */
2025 $this->mEditCount
= User
::edits($this->mId
);
2027 return $this->mEditCount
;
2035 * Add the user to the given group.
2036 * This takes immediate effect.
2037 * @param $group \string Name of the group to add
2039 function addGroup( $group ) {
2040 $dbw = wfGetDB( DB_MASTER
);
2041 if( $this->getId() ) {
2042 $dbw->insert( 'user_groups',
2044 'ug_user' => $this->getID(),
2045 'ug_group' => $group,
2048 array( 'IGNORE' ) );
2051 $this->loadGroups();
2052 $this->mGroups
[] = $group;
2053 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2055 $this->invalidateCache();
2059 * Remove the user from the given group.
2060 * This takes immediate effect.
2061 * @param $group \string Name of the group to remove
2063 function removeGroup( $group ) {
2065 $dbw = wfGetDB( DB_MASTER
);
2066 $dbw->delete( 'user_groups',
2068 'ug_user' => $this->getID(),
2069 'ug_group' => $group,
2071 'User::removeGroup' );
2073 $this->loadGroups();
2074 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2075 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2077 $this->invalidateCache();
2082 * Get whether the user is logged in
2083 * @return \bool True or false
2085 function isLoggedIn() {
2086 return $this->getID() != 0;
2090 * Get whether the user is anonymous
2091 * @return \bool True or false
2094 return !$this->isLoggedIn();
2098 * Get whether the user is a bot
2099 * @return \bool True or false
2103 wfDeprecated( __METHOD__
);
2104 return $this->isAllowed( 'bot' );
2108 * Check if user is allowed to access a feature / make an action
2109 * @param $action \string action to be checked
2110 * @return \bool True if action is allowed, else false
2112 function isAllowed( $action = '' ) {
2113 if ( $action === '' )
2114 return true; // In the spirit of DWIM
2115 # Patrolling may not be enabled
2116 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2117 global $wgUseRCPatrol, $wgUseNPPatrol;
2118 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2121 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2122 # by misconfiguration: 0 == 'foo'
2123 return in_array( $action, $this->getRights(), true );
2127 * Check whether to enable recent changes patrol features for this user
2128 * @return \bool True or false
2130 public function useRCPatrol() {
2131 global $wgUseRCPatrol;
2132 return( $wgUseRCPatrol && ($this->isAllowed('patrol') ||
$this->isAllowed('patrolmarks')) );
2136 * Check whether to enable new pages patrol features for this user
2137 * @return \bool True or false
2139 public function useNPPatrol() {
2140 global $wgUseRCPatrol, $wgUseNPPatrol;
2141 return( ($wgUseRCPatrol ||
$wgUseNPPatrol) && ($this->isAllowed('patrol') ||
$this->isAllowed('patrolmarks')) );
2145 * Get the current skin, loading it if required, and setting a title
2146 * @param $t Title: the title to use in the skin
2147 * @return Skin The current skin
2148 * @todo FIXME : need to check the old failback system [AV]
2150 function &getSkin( $t = null ) {
2151 global $wgRequest, $wgAllowUserSkin, $wgDefaultSkin;
2152 if ( ! isset( $this->mSkin
) ) {
2153 wfProfileIn( __METHOD__
);
2155 if( $wgAllowUserSkin ) {
2157 $userSkin = $this->getOption( 'skin' );
2158 $userSkin = $wgRequest->getVal('useskin', $userSkin);
2160 # if we're not allowing users to override, then use the default
2161 $userSkin = $wgDefaultSkin;
2164 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2165 wfProfileOut( __METHOD__
);
2167 if( $t ||
!$this->mSkin
->getTitle() ) {
2170 $t = $wgOut->getTitle();
2172 $this->mSkin
->setTitle( $t );
2174 return $this->mSkin
;
2178 * Check the watched status of an article.
2179 * @param $title \type{Title} Title of the article to look at
2180 * @return \bool True if article is watched
2182 function isWatched( $title ) {
2183 $wl = WatchedItem
::fromUserTitle( $this, $title );
2184 return $wl->isWatched();
2189 * @param $title \type{Title} Title of the article to look at
2191 function addWatch( $title ) {
2192 $wl = WatchedItem
::fromUserTitle( $this, $title );
2194 $this->invalidateCache();
2198 * Stop watching an article.
2199 * @param $title \type{Title} Title of the article to look at
2201 function removeWatch( $title ) {
2202 $wl = WatchedItem
::fromUserTitle( $this, $title );
2204 $this->invalidateCache();
2208 * Clear the user's notification timestamp for the given title.
2209 * If e-notif e-mails are on, they will receive notification mails on
2210 * the next change of the page if it's watched etc.
2211 * @param $title \type{Title} Title of the article to look at
2213 function clearNotification( &$title ) {
2214 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2216 # Do nothing if the database is locked to writes
2217 if( wfReadOnly() ) {
2221 if ($title->getNamespace() == NS_USER_TALK
&&
2222 $title->getText() == $this->getName() ) {
2223 if (!wfRunHooks('UserClearNewTalkNotification', array(&$this)))
2225 $this->setNewtalk( false );
2228 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2232 if( $this->isAnon() ) {
2233 // Nothing else to do...
2237 // Only update the timestamp if the page is being watched.
2238 // The query to find out if it is watched is cached both in memcached and per-invocation,
2239 // and when it does have to be executed, it can be on a slave
2240 // If this is the user's newtalk page, we always update the timestamp
2241 if ($title->getNamespace() == NS_USER_TALK
&&
2242 $title->getText() == $wgUser->getName())
2245 } elseif ( $this->getId() == $wgUser->getId() ) {
2246 $watched = $title->userIsWatching();
2251 // If the page is watched by the user (or may be watched), update the timestamp on any
2252 // any matching rows
2254 $dbw = wfGetDB( DB_MASTER
);
2255 $dbw->update( 'watchlist',
2257 'wl_notificationtimestamp' => NULL
2258 ), array( /* WHERE */
2259 'wl_title' => $title->getDBkey(),
2260 'wl_namespace' => $title->getNamespace(),
2261 'wl_user' => $this->getID()
2268 * Resets all of the given user's page-change notification timestamps.
2269 * If e-notif e-mails are on, they will receive notification mails on
2270 * the next change of any watched page.
2272 * @param $currentUser \int User ID
2274 function clearAllNotifications( $currentUser ) {
2275 global $wgUseEnotif, $wgShowUpdatedMarker;
2276 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2277 $this->setNewtalk( false );
2280 if( $currentUser != 0 ) {
2281 $dbw = wfGetDB( DB_MASTER
);
2282 $dbw->update( 'watchlist',
2284 'wl_notificationtimestamp' => NULL
2285 ), array( /* WHERE */
2286 'wl_user' => $currentUser
2289 # We also need to clear here the "you have new message" notification for the own user_talk page
2290 # This is cleared one page view later in Article::viewUpdates();
2295 * Set this user's options from an encoded string
2296 * @param $str \string Encoded options to import
2299 function decodeOptions( $str ) {
2301 $this->mOptionsLoaded
= true;
2305 $this->mOptions
= array();
2306 $a = explode( "\n", $str );
2307 foreach ( $a as $s ) {
2309 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2310 $this->mOptions
[$m[1]] = $m[2];
2316 * Set a cookie on the user's client. Wrapper for
2317 * WebResponse::setCookie
2318 * @param $name \string Name of the cookie to set
2319 * @param $value \string Value to set
2320 * @param $exp \int Expiration time, as a UNIX time value;
2321 * if 0 or not specified, use the default $wgCookieExpiration
2323 protected function setCookie( $name, $value, $exp=0 ) {
2325 $wgRequest->response()->setcookie( $name, $value, $exp );
2329 * Clear a cookie on the user's client
2330 * @param $name \string Name of the cookie to clear
2332 protected function clearCookie( $name ) {
2333 $this->setCookie( $name, '', time() - 86400 );
2337 * Set the default cookies for this session on the user's client.
2339 function setCookies() {
2341 if ( 0 == $this->mId
) return;
2343 'wsUserID' => $this->mId
,
2344 'wsToken' => $this->mToken
,
2345 'wsUserName' => $this->getName()
2348 'UserID' => $this->mId
,
2349 'UserName' => $this->getName(),
2351 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2352 $cookies['Token'] = $this->mToken
;
2354 $cookies['Token'] = false;
2357 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2358 #check for null, since the hook could cause a null value
2359 if ( !is_null( $session ) && isset( $_SESSION ) ){
2360 $_SESSION = $session +
$_SESSION;
2362 foreach ( $cookies as $name => $value ) {
2363 if ( $value === false ) {
2364 $this->clearCookie( $name );
2366 $this->setCookie( $name, $value );
2372 * Log this user out.
2376 if( wfRunHooks( 'UserLogout', array(&$this) ) ) {
2382 * Clear the user's cookies and session, and reset the instance cache.
2386 function doLogout() {
2387 $this->clearInstanceCache( 'defaults' );
2389 $_SESSION['wsUserID'] = 0;
2391 $this->clearCookie( 'UserID' );
2392 $this->clearCookie( 'Token' );
2394 # Remember when user logged out, to prevent seeing cached pages
2395 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2399 * Save this user's settings into the database.
2400 * @todo Only rarely do all these fields need to be set!
2402 function saveSettings() {
2404 if ( wfReadOnly() ) { return; }
2405 if ( 0 == $this->mId
) { return; }
2407 $this->mTouched
= self
::newTouchedTimestamp();
2409 $dbw = wfGetDB( DB_MASTER
);
2410 $dbw->update( 'user',
2412 'user_name' => $this->mName
,
2413 'user_password' => $this->mPassword
,
2414 'user_newpassword' => $this->mNewpassword
,
2415 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2416 'user_real_name' => $this->mRealName
,
2417 'user_email' => $this->mEmail
,
2418 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2419 'user_options' => '',
2420 'user_touched' => $dbw->timestamp($this->mTouched
),
2421 'user_token' => $this->mToken
,
2422 'user_email_token' => $this->mEmailToken
,
2423 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2424 ), array( /* WHERE */
2425 'user_id' => $this->mId
2429 $this->saveOptions();
2431 wfRunHooks( 'UserSaveSettings', array( $this ) );
2432 $this->clearSharedCache();
2433 $this->getUserPage()->invalidateCache();
2437 * If only this user's username is known, and it exists, return the user ID.
2439 function idForName() {
2440 $s = trim( $this->getName() );
2441 if ( $s === '' ) return 0;
2443 $dbr = wfGetDB( DB_SLAVE
);
2444 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2445 if ( $id === false ) {
2452 * Add a user to the database, return the user object
2454 * @param $name \string Username to add
2455 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2456 * - password The user's password. Password logins will be disabled if this is omitted.
2457 * - newpassword A temporary password mailed to the user
2458 * - email The user's email address
2459 * - email_authenticated The email authentication timestamp
2460 * - real_name The user's real name
2461 * - options An associative array of non-default options
2462 * - token Random authentication token. Do not set.
2463 * - registration Registration timestamp. Do not set.
2465 * @return \type{User} A new User object, or null if the username already exists
2467 static function createNew( $name, $params = array() ) {
2470 if ( isset( $params['options'] ) ) {
2471 $user->mOptions
= $params['options'] +
$user->mOptions
;
2472 unset( $params['options'] );
2474 $dbw = wfGetDB( DB_MASTER
);
2475 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2477 'user_id' => $seqVal,
2478 'user_name' => $name,
2479 'user_password' => $user->mPassword
,
2480 'user_newpassword' => $user->mNewpassword
,
2481 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2482 'user_email' => $user->mEmail
,
2483 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2484 'user_real_name' => $user->mRealName
,
2485 'user_options' => $user->encodeOptions(),
2486 'user_token' => $user->mToken
,
2487 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2488 'user_editcount' => 0,
2490 foreach ( $params as $name => $value ) {
2491 $fields["user_$name"] = $value;
2493 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2494 if ( $dbw->affectedRows() ) {
2495 $newUser = User
::newFromId( $dbw->insertId() );
2503 * Add this existing user object to the database
2505 function addToDatabase() {
2507 $dbw = wfGetDB( DB_MASTER
);
2508 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2509 $dbw->insert( 'user',
2511 'user_id' => $seqVal,
2512 'user_name' => $this->mName
,
2513 'user_password' => $this->mPassword
,
2514 'user_newpassword' => $this->mNewpassword
,
2515 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2516 'user_email' => $this->mEmail
,
2517 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2518 'user_real_name' => $this->mRealName
,
2519 'user_options' => '',
2520 'user_token' => $this->mToken
,
2521 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2522 'user_editcount' => 0,
2525 $this->mId
= $dbw->insertId();
2527 // Clear instance cache other than user table data, which is already accurate
2528 $this->clearInstanceCache();
2530 $this->saveOptions();
2534 * If this (non-anonymous) user is blocked, block any IP address
2535 * they've successfully logged in from.
2537 function spreadBlock() {
2538 wfDebug( __METHOD__
."()\n" );
2540 if ( $this->mId
== 0 ) {
2544 $userblock = Block
::newFromDB( '', $this->mId
);
2545 if ( !$userblock ) {
2549 $userblock->doAutoblock( wfGetIp() );
2554 * Generate a string which will be different for any combination of
2555 * user options which would produce different parser output.
2556 * This will be used as part of the hash key for the parser cache,
2557 * so users will the same options can share the same cached data
2560 * Extensions which require it should install 'PageRenderingHash' hook,
2561 * which will give them a chance to modify this key based on their own
2564 * @return \string Page rendering hash
2566 function getPageRenderingHash() {
2567 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2569 return $this->mHash
;
2572 // stubthreshold is only included below for completeness,
2573 // it will always be 0 when this function is called by parsercache.
2575 $confstr = $this->getOption( 'math' );
2576 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2577 if ( $wgUseDynamicDates ) {
2578 $confstr .= '!' . $this->getDatePreference();
2580 $confstr .= '!' . ($this->getOption( 'numberheadings' ) ?
'1' : '');
2581 $confstr .= '!' . $wgLang->getCode();
2582 $confstr .= '!' . $this->getOption( 'thumbsize' );
2583 // add in language specific options, if any
2584 $extra = $wgContLang->getExtraHashOptions();
2587 $confstr .= $wgRenderHashAppend;
2589 // Give a chance for extensions to modify the hash, if they have
2590 // extra options or other effects on the parser cache.
2591 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2593 // Make it a valid memcached key fragment
2594 $confstr = str_replace( ' ', '_', $confstr );
2595 $this->mHash
= $confstr;
2600 * Get whether the user is explicitly blocked from account creation.
2601 * @return \bool True if blocked
2603 function isBlockedFromCreateAccount() {
2604 $this->getBlockedStatus();
2605 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2609 * Get whether the user is blocked from using Special:Emailuser.
2610 * @return \bool True if blocked
2612 function isBlockedFromEmailuser() {
2613 $this->getBlockedStatus();
2614 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2618 * Get whether the user is allowed to create an account.
2619 * @return \bool True if allowed
2621 function isAllowedToCreateAccount() {
2622 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2628 function setLoaded( $loaded ) {
2629 wfDeprecated( __METHOD__
);
2633 * Get this user's personal page title.
2635 * @return \type{Title} User's personal page title
2637 function getUserPage() {
2638 return Title
::makeTitle( NS_USER
, $this->getName() );
2642 * Get this user's talk page title.
2644 * @return \type{Title} User's talk page title
2646 function getTalkPage() {
2647 $title = $this->getUserPage();
2648 return $title->getTalkPage();
2652 * Get the maximum valid user ID.
2653 * @return \int User ID
2656 function getMaxID() {
2657 static $res; // cache
2659 if ( isset( $res ) )
2662 $dbr = wfGetDB( DB_SLAVE
);
2663 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2668 * Determine whether the user is a newbie. Newbies are either
2669 * anonymous IPs, or the most recently created accounts.
2670 * @return \bool True if the user is a newbie
2672 function isNewbie() {
2673 return !$this->isAllowed( 'autoconfirmed' );
2677 * Is the user active? We check to see if they've made at least
2678 * X number of edits in the last Y days.
2680 * @return \bool True if the user is active, false if not.
2682 public function isActiveEditor() {
2683 global $wgActiveUserEditCount, $wgActiveUserDays;
2684 $dbr = wfGetDB( DB_SLAVE
);
2686 // Stolen without shame from RC
2687 $cutoff_unixtime = time() - ( $wgActiveUserDays * 86400 );
2688 $cutoff_unixtime = $cutoff_unixtime - ( $cutoff_unixtime %
86400 );
2689 $oldTime = $dbr->addQuotes( $dbr->timestamp( $cutoff_unixtime ) );
2691 $res = $dbr->select( 'revision', '1',
2692 array( 'rev_user_text' => $this->getName(), "rev_timestamp > $oldTime"),
2694 array('LIMIT' => $wgActiveUserEditCount ) );
2696 $count = $dbr->numRows($res);
2697 $dbr->freeResult($res);
2699 return $count == $wgActiveUserEditCount;
2703 * Check to see if the given clear-text password is one of the accepted passwords
2704 * @param $password \string user password.
2705 * @return \bool True if the given password is correct, otherwise False.
2707 function checkPassword( $password ) {
2711 // Even though we stop people from creating passwords that
2712 // are shorter than this, doesn't mean people wont be able
2713 // to. Certain authentication plugins do NOT want to save
2714 // domain passwords in a mysql database, so we should
2715 // check this (incase $wgAuth->strict() is false).
2716 if( !$this->isValidPassword( $password ) ) {
2720 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2722 } elseif( $wgAuth->strict() ) {
2723 /* Auth plugin doesn't allow local authentication */
2725 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2726 /* Auth plugin doesn't allow local authentication for this user name */
2729 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2731 } elseif ( function_exists( 'iconv' ) ) {
2732 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2733 # Check for this with iconv
2734 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2735 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2743 * Check if the given clear-text password matches the temporary password
2744 * sent by e-mail for password reset operations.
2745 * @return \bool True if matches, false otherwise
2747 function checkTemporaryPassword( $plaintext ) {
2748 global $wgNewPasswordExpiry;
2749 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2751 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2752 return ( time() < $expiry );
2759 * Initialize (if necessary) and return a session token value
2760 * which can be used in edit forms to show that the user's
2761 * login credentials aren't being hijacked with a foreign form
2764 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2765 * @return \string The new edit token
2767 function editToken( $salt = '' ) {
2768 if ( $this->isAnon() ) {
2769 return EDIT_TOKEN_SUFFIX
;
2771 if( !isset( $_SESSION['wsEditToken'] ) ) {
2772 $token = $this->generateToken();
2773 $_SESSION['wsEditToken'] = $token;
2775 $token = $_SESSION['wsEditToken'];
2777 if( is_array( $salt ) ) {
2778 $salt = implode( '|', $salt );
2780 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2785 * Generate a looking random token for various uses.
2787 * @param $salt \string Optional salt value
2788 * @return \string The new random token
2790 function generateToken( $salt = '' ) {
2791 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2792 return md5( $token . $salt );
2796 * Check given value against the token value stored in the session.
2797 * A match should confirm that the form was submitted from the
2798 * user's own login session, not a form submission from a third-party
2801 * @param $val \string Input value to compare
2802 * @param $salt \string Optional function-specific data for hashing
2803 * @return \bool Whether the token matches
2805 function matchEditToken( $val, $salt = '' ) {
2806 $sessionToken = $this->editToken( $salt );
2807 if ( $val != $sessionToken ) {
2808 wfDebug( "User::matchEditToken: broken session data\n" );
2810 return $val == $sessionToken;
2814 * Check given value against the token value stored in the session,
2815 * ignoring the suffix.
2817 * @param $val \string Input value to compare
2818 * @param $salt \string Optional function-specific data for hashing
2819 * @return \bool Whether the token matches
2821 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2822 $sessionToken = $this->editToken( $salt );
2823 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2827 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2828 * mail to the user's given address.
2830 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2832 function sendConfirmationMail() {
2834 $expiration = null; // gets passed-by-ref and defined in next line.
2835 $token = $this->confirmationToken( $expiration );
2836 $url = $this->confirmationTokenUrl( $token );
2837 $invalidateURL = $this->invalidationTokenUrl( $token );
2838 $this->saveSettings();
2840 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2841 wfMsg( 'confirmemail_body',
2845 $wgLang->timeanddate( $expiration, false ),
2850 * Send an e-mail to this user's account. Does not check for
2851 * confirmed status or validity.
2853 * @param $subject \string Message subject
2854 * @param $body \string Message body
2855 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2856 * @param $replyto \string Reply-To address
2857 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2859 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2860 if( is_null( $from ) ) {
2861 global $wgPasswordSender;
2862 $from = $wgPasswordSender;
2865 $to = new MailAddress( $this );
2866 $sender = new MailAddress( $from );
2867 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2871 * Generate, store, and return a new e-mail confirmation code.
2872 * A hash (unsalted, since it's used as a key) is stored.
2874 * @note Call saveSettings() after calling this function to commit
2875 * this change to the database.
2877 * @param[out] &$expiration \mixed Accepts the expiration time
2878 * @return \string New token
2881 function confirmationToken( &$expiration ) {
2883 $expires = $now +
7 * 24 * 60 * 60;
2884 $expiration = wfTimestamp( TS_MW
, $expires );
2885 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2886 $hash = md5( $token );
2888 $this->mEmailToken
= $hash;
2889 $this->mEmailTokenExpires
= $expiration;
2894 * Return a URL the user can use to confirm their email address.
2895 * @param $token \string Accepts the email confirmation token
2896 * @return \string New token URL
2899 function confirmationTokenUrl( $token ) {
2900 return $this->getTokenUrl( 'ConfirmEmail', $token );
2903 * Return a URL the user can use to invalidate their email address.
2904 * @param $token \string Accepts the email confirmation token
2905 * @return \string New token URL
2908 function invalidationTokenUrl( $token ) {
2909 return $this->getTokenUrl( 'Invalidateemail', $token );
2913 * Internal function to format the e-mail validation/invalidation URLs.
2914 * This uses $wgArticlePath directly as a quickie hack to use the
2915 * hardcoded English names of the Special: pages, for ASCII safety.
2917 * @note Since these URLs get dropped directly into emails, using the
2918 * short English names avoids insanely long URL-encoded links, which
2919 * also sometimes can get corrupted in some browsers/mailers
2920 * (bug 6957 with Gmail and Internet Explorer).
2922 * @param $page \string Special page
2923 * @param $token \string Token
2924 * @return \string Formatted URL
2926 protected function getTokenUrl( $page, $token ) {
2927 global $wgArticlePath;
2931 "Special:$page/$token",
2936 * Mark the e-mail address confirmed.
2938 * @note Call saveSettings() after calling this function to commit the change.
2940 function confirmEmail() {
2941 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2946 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2947 * address if it was already confirmed.
2949 * @note Call saveSettings() after calling this function to commit the change.
2951 function invalidateEmail() {
2953 $this->mEmailToken
= null;
2954 $this->mEmailTokenExpires
= null;
2955 $this->setEmailAuthenticationTimestamp( null );
2960 * Set the e-mail authentication timestamp.
2961 * @param $timestamp \string TS_MW timestamp
2963 function setEmailAuthenticationTimestamp( $timestamp ) {
2965 $this->mEmailAuthenticated
= $timestamp;
2966 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2970 * Is this user allowed to send e-mails within limits of current
2971 * site configuration?
2972 * @return \bool True if allowed
2974 function canSendEmail() {
2975 global $wgEnableEmail, $wgEnableUserEmail;
2976 if( !$wgEnableEmail ||
!$wgEnableUserEmail ) {
2979 $canSend = $this->isEmailConfirmed();
2980 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
2985 * Is this user allowed to receive e-mails within limits of current
2986 * site configuration?
2987 * @return \bool True if allowed
2989 function canReceiveEmail() {
2990 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
2994 * Is this user's e-mail address valid-looking and confirmed within
2995 * limits of the current site configuration?
2997 * @note If $wgEmailAuthentication is on, this may require the user to have
2998 * confirmed their address by returning a code or using a password
2999 * sent to the address from the wiki.
3001 * @return \bool True if confirmed
3003 function isEmailConfirmed() {
3004 global $wgEmailAuthentication;
3007 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3008 if( $this->isAnon() )
3010 if( !self
::isValidEmailAddr( $this->mEmail
) )
3012 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3021 * Check whether there is an outstanding request for e-mail confirmation.
3022 * @return \bool True if pending
3024 function isEmailConfirmationPending() {
3025 global $wgEmailAuthentication;
3026 return $wgEmailAuthentication &&
3027 !$this->isEmailConfirmed() &&
3028 $this->mEmailToken
&&
3029 $this->mEmailTokenExpires
> wfTimestamp();
3033 * Get the timestamp of account creation.
3035 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3036 * non-existent/anonymous user accounts.
3038 public function getRegistration() {
3039 return $this->getId() > 0
3040 ?
$this->mRegistration
3045 * Get the timestamp of the first edit
3047 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3048 * non-existent/anonymous user accounts.
3050 public function getFirstEditTimestamp() {
3051 if( $this->getId() == 0 ) return false; // anons
3052 $dbr = wfGetDB( DB_SLAVE
);
3053 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3054 array( 'rev_user' => $this->getId() ),
3056 array( 'ORDER BY' => 'rev_timestamp ASC' )
3058 if( !$time ) return false; // no edits
3059 return wfTimestamp( TS_MW
, $time );
3063 * Get the permissions associated with a given list of groups
3065 * @param $groups \type{\arrayof{\string}} List of internal group names
3066 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3068 static function getGroupPermissions( $groups ) {
3069 global $wgGroupPermissions;
3071 foreach( $groups as $group ) {
3072 if( isset( $wgGroupPermissions[$group] ) ) {
3073 $rights = array_merge( $rights,
3074 // array_filter removes empty items
3075 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3078 return array_unique($rights);
3082 * Get all the groups who have a given permission
3084 * @param $role \string Role to check
3085 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3087 static function getGroupsWithPermission( $role ) {
3088 global $wgGroupPermissions;
3089 $allowedGroups = array();
3090 foreach ( $wgGroupPermissions as $group => $rights ) {
3091 if ( isset( $rights[$role] ) && $rights[$role] ) {
3092 $allowedGroups[] = $group;
3095 return $allowedGroups;
3099 * Get the localized descriptive name for a group, if it exists
3101 * @param $group \string Internal group name
3102 * @return \string Localized descriptive group name
3104 static function getGroupName( $group ) {
3105 global $wgMessageCache;
3106 $wgMessageCache->loadAllMessages();
3107 $key = "group-$group";
3108 $name = wfMsg( $key );
3109 return $name == '' ||
wfEmptyMsg( $key, $name )
3115 * Get the localized descriptive name for a member of a group, if it exists
3117 * @param $group \string Internal group name
3118 * @return \string Localized name for group member
3120 static function getGroupMember( $group ) {
3121 global $wgMessageCache;
3122 $wgMessageCache->loadAllMessages();
3123 $key = "group-$group-member";
3124 $name = wfMsg( $key );
3125 return $name == '' ||
wfEmptyMsg( $key, $name )
3131 * Return the set of defined explicit groups.
3132 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3133 * are not included, as they are defined automatically, not in the database.
3134 * @return \type{\arrayof{\string}} Array of internal group names
3136 static function getAllGroups() {
3137 global $wgGroupPermissions;
3139 array_keys( $wgGroupPermissions ),
3140 self
::getImplicitGroups()
3145 * Get a list of all available permissions.
3146 * @return \type{\arrayof{\string}} Array of permission names
3148 static function getAllRights() {
3149 if ( self
::$mAllRights === false ) {
3150 global $wgAvailableRights;
3151 if ( count( $wgAvailableRights ) ) {
3152 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3154 self
::$mAllRights = self
::$mCoreRights;
3156 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3158 return self
::$mAllRights;
3162 * Get a list of implicit groups
3163 * @return \type{\arrayof{\string}} Array of internal group names
3165 public static function getImplicitGroups() {
3166 global $wgImplicitGroups;
3167 $groups = $wgImplicitGroups;
3168 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3173 * Get the title of a page describing a particular group
3175 * @param $group \string Internal group name
3176 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3178 static function getGroupPage( $group ) {
3179 global $wgMessageCache;
3180 $wgMessageCache->loadAllMessages();
3181 $page = wfMsgForContent( 'grouppage-' . $group );
3182 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3183 $title = Title
::newFromText( $page );
3184 if( is_object( $title ) )
3191 * Create a link to the group in HTML, if available;
3192 * else return the group name.
3194 * @param $group \string Internal name of the group
3195 * @param $text \string The text of the link
3196 * @return \string HTML link to the group
3198 static function makeGroupLinkHTML( $group, $text = '' ) {
3200 $text = self
::getGroupName( $group );
3202 $title = self
::getGroupPage( $group );
3205 $sk = $wgUser->getSkin();
3206 return $sk->makeLinkObj( $title, htmlspecialchars( $text ) );
3213 * Create a link to the group in Wikitext, if available;
3214 * else return the group name.
3216 * @param $group \string Internal name of the group
3217 * @param $text \string The text of the link
3218 * @return \string Wikilink to the group
3220 static function makeGroupLinkWiki( $group, $text = '' ) {
3222 $text = self
::getGroupName( $group );
3224 $title = self
::getGroupPage( $group );
3226 $page = $title->getPrefixedText();
3227 return "[[$page|$text]]";
3234 * Returns an array of the groups that a particular group can add/remove.
3236 * @param $group String: the group to check for whether it can add/remove
3237 * @return Array array( 'add' => array( addablegroups ),
3238 * 'remove' => array( removablegroups ),
3239 * 'add-self' => array( addablegroups to self),
3240 * 'remove-self' => array( removable groups from self) )
3242 static function changeableByGroup( $group ) {
3243 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3245 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3246 if( empty($wgAddGroups[$group]) ) {
3247 // Don't add anything to $groups
3248 } elseif( $wgAddGroups[$group] === true ) {
3249 // You get everything
3250 $groups['add'] = self
::getAllGroups();
3251 } elseif( is_array($wgAddGroups[$group]) ) {
3252 $groups['add'] = $wgAddGroups[$group];
3255 // Same thing for remove
3256 if( empty($wgRemoveGroups[$group]) ) {
3257 } elseif($wgRemoveGroups[$group] === true ) {
3258 $groups['remove'] = self
::getAllGroups();
3259 } elseif( is_array($wgRemoveGroups[$group]) ) {
3260 $groups['remove'] = $wgRemoveGroups[$group];
3263 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3264 if( empty($wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3265 foreach($wgGroupsAddToSelf as $key => $value) {
3266 if( is_int($key) ) {
3267 $wgGroupsAddToSelf['user'][] = $value;
3272 if( empty($wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3273 foreach($wgGroupsRemoveFromSelf as $key => $value) {
3274 if( is_int($key) ) {
3275 $wgGroupsRemoveFromSelf['user'][] = $value;
3280 // Now figure out what groups the user can add to him/herself
3281 if( empty($wgGroupsAddToSelf[$group]) ) {
3282 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3283 // No idea WHY this would be used, but it's there
3284 $groups['add-self'] = User
::getAllGroups();
3285 } elseif( is_array($wgGroupsAddToSelf[$group]) ) {
3286 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3289 if( empty($wgGroupsRemoveFromSelf[$group]) ) {
3290 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3291 $groups['remove-self'] = User
::getAllGroups();
3292 } elseif( is_array($wgGroupsRemoveFromSelf[$group]) ) {
3293 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3300 * Returns an array of groups that this user can add and remove
3301 * @return Array array( 'add' => array( addablegroups ),
3302 * 'remove' => array( removablegroups ),
3303 * 'add-self' => array( addablegroups to self),
3304 * 'remove-self' => array( removable groups from self) )
3306 function changeableGroups() {
3307 if( $this->isAllowed( 'userrights' ) ) {
3308 // This group gives the right to modify everything (reverse-
3309 // compatibility with old "userrights lets you change
3311 // Using array_merge to make the groups reindexed
3312 $all = array_merge( User
::getAllGroups() );
3316 'add-self' => array(),
3317 'remove-self' => array()
3321 // Okay, it's not so simple, we will have to go through the arrays
3324 'remove' => array(),
3325 'add-self' => array(),
3326 'remove-self' => array() );
3327 $addergroups = $this->getEffectiveGroups();
3329 foreach ($addergroups as $addergroup) {
3330 $groups = array_merge_recursive(
3331 $groups, $this->changeableByGroup($addergroup)
3333 $groups['add'] = array_unique( $groups['add'] );
3334 $groups['remove'] = array_unique( $groups['remove'] );
3335 $groups['add-self'] = array_unique( $groups['add-self'] );
3336 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3342 * Increment the user's edit-count field.
3343 * Will have no effect for anonymous users.
3345 function incEditCount() {
3346 if( !$this->isAnon() ) {
3347 $dbw = wfGetDB( DB_MASTER
);
3348 $dbw->update( 'user',
3349 array( 'user_editcount=user_editcount+1' ),
3350 array( 'user_id' => $this->getId() ),
3353 // Lazy initialization check...
3354 if( $dbw->affectedRows() == 0 ) {
3355 // Pull from a slave to be less cruel to servers
3356 // Accuracy isn't the point anyway here
3357 $dbr = wfGetDB( DB_SLAVE
);
3358 $count = $dbr->selectField( 'revision',
3360 array( 'rev_user' => $this->getId() ),
3363 // Now here's a goddamn hack...
3364 if( $dbr !== $dbw ) {
3365 // If we actually have a slave server, the count is
3366 // at least one behind because the current transaction
3367 // has not been committed and replicated.
3370 // But if DB_SLAVE is selecting the master, then the
3371 // count we just read includes the revision that was
3372 // just added in the working transaction.
3375 $dbw->update( 'user',
3376 array( 'user_editcount' => $count ),
3377 array( 'user_id' => $this->getId() ),
3381 // edit count in user cache too
3382 $this->invalidateCache();
3386 * Get the description of a given right
3388 * @param $right \string Right to query
3389 * @return \string Localized description of the right
3391 static function getRightDescription( $right ) {
3392 global $wgMessageCache;
3393 $wgMessageCache->loadAllMessages();
3394 $key = "right-$right";
3395 $name = wfMsg( $key );
3396 return $name == '' ||
wfEmptyMsg( $key, $name )
3402 * Make an old-style password hash
3404 * @param $password \string Plain-text password
3405 * @param $userId \string User ID
3406 * @return \string Password hash
3408 static function oldCrypt( $password, $userId ) {
3409 global $wgPasswordSalt;
3410 if ( $wgPasswordSalt ) {
3411 return md5( $userId . '-' . md5( $password ) );
3413 return md5( $password );
3418 * Make a new-style password hash
3420 * @param $password \string Plain-text password
3421 * @param $salt \string Optional salt, may be random or the user ID.
3422 * If unspecified or false, will generate one automatically
3423 * @return \string Password hash
3425 static function crypt( $password, $salt = false ) {
3426 global $wgPasswordSalt;
3429 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3433 if( $wgPasswordSalt ) {
3434 if ( $salt === false ) {
3435 $salt = substr( wfGenerateToken(), 0, 8 );
3437 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3439 return ':A:' . md5( $password );
3444 * Compare a password hash with a plain-text password. Requires the user
3445 * ID if there's a chance that the hash is an old-style hash.
3447 * @param $hash \string Password hash
3448 * @param $password \string Plain-text password to compare
3449 * @param $userId \string User ID for old-style password salt
3452 static function comparePasswords( $hash, $password, $userId = false ) {
3454 $type = substr( $hash, 0, 3 );
3457 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3461 if ( $type == ':A:' ) {
3463 return md5( $password ) === substr( $hash, 3 );
3464 } elseif ( $type == ':B:' ) {
3466 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3467 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3470 return self
::oldCrypt( $password, $userId ) === $hash;
3475 * Add a newuser log entry for this user
3476 * @param $byEmail Boolean: account made by email?
3478 public function addNewUserLogEntry( $byEmail = false ) {
3479 global $wgUser, $wgContLang, $wgNewUserLog;
3480 if( empty($wgNewUserLog) ) {
3481 return true; // disabled
3483 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3484 if( $this->getName() == $wgUser->getName() ) {
3488 $action = 'create2';
3489 $message = $byEmail ?
wfMsgForContent( 'newuserlog-byemail' ) : '';
3491 $log = new LogPage( 'newusers' );
3492 $log->addEntry( $action, $this->getUserPage(), $message, array( $this->getId() ) );
3497 * Add an autocreate newuser log entry for this user
3498 * Used by things like CentralAuth and perhaps other authplugins.
3500 public function addNewUserLogEntryAutoCreate() {
3501 global $wgNewUserLog;
3502 if( empty($wgNewUserLog) ) {
3503 return true; // disabled
3505 $log = new LogPage( 'newusers', false );
3506 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3510 protected function loadOptions() {
3512 if ($this->mOptionsLoaded ||
!$this->getId() )
3515 $this->mOptions
= self
::getDefaultOptions();
3517 // Load from database
3518 $dbr = wfGetDB( DB_SLAVE
);
3520 $res = $dbr->select( 'user_properties',
3522 array('up_user' => $this->getId()),
3526 while( $row = $dbr->fetchObject( $res ) ) {
3527 $this->mOptions
[$row->up_property
] = $row->up_value
;
3530 $this->mOptionsLoaded
= true;
3532 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3535 protected function saveOptions() {
3536 $this->loadOptions();
3537 $dbw = wfGetDB( DB_MASTER
);
3539 $insert_rows = array();
3541 $saveOptions = $this->mOptions
;
3543 // Allow hooks to abort, for instance to save to a global profile.
3544 // Reset options to default state before saving.
3545 if (!wfRunHooks( 'UserSaveOptions', array($this, &$saveOptions) ) )
3548 foreach( $saveOptions as $key => $value ) {
3549 if ( ( is_null(self
::getDefaultOption($key)) &&
3550 !( $value === false ||
is_null($value) ) ) ||
3551 $value != self
::getDefaultOption( $key ) ) {
3552 $insert_rows[] = array(
3553 'up_user' => $this->getId(),
3554 'up_property' => $key,
3555 'up_value' => $value,
3561 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3562 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);