3 * Implements the User class for the %MediaWiki software.
8 * \type{\int} Number of characters in user_token field.
11 define( 'USER_TOKEN_LENGTH', 32 );
14 * \type{\int} Serialized record version.
17 define( 'MW_USER_VERSION', 6 );
20 * \type{\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',
97 * \type{\arrayof{\string}} List of member variables which are saved to the
98 * shared cache (memcached). Any operation which changes the
99 * corresponding database fields must call a cache-clearing function.
102 static $mCacheVars = array(
114 'mEmailAuthenticated',
116 'mEmailTokenExpires',
124 * \type{\arrayof{\string}} Core rights.
125 * Each of these should have a corresponding message of the form
129 static $mCoreRights = array(
172 * \type{\string} Cached results of getAllRights()
174 static $mAllRights = false;
176 /** @name Cache variables */
178 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
179 $mEmail, $mOptions, $mTouched, $mToken, $mEmailAuthenticated,
180 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups;
184 * \type{\bool} Whether the cache variables have been loaded.
189 * \type{\string} Initialization data source if mDataLoaded==false. May be one of:
190 * - 'defaults' anonymous user initialised from class defaults
191 * - 'name' initialise from mName
192 * - 'id' initialise from mId
193 * - 'session' log in from cookies or session if possible
195 * Use the User::newFrom*() family of functions to set this.
199 /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
201 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
202 $mBlockreason, $mBlock, $mEffectiveGroups;
206 * Lightweight constructor for an anonymous user.
207 * Use the User::newFrom* factory functions for other kinds of users.
211 * @see newFromConfirmationCode()
212 * @see newFromSession()
216 $this->clearInstanceCache( 'defaults' );
220 * Load the user table data for this object from the source given by mFrom.
223 if ( $this->mDataLoaded
) {
226 wfProfileIn( __METHOD__
);
228 # Set it now to avoid infinite recursion in accessors
229 $this->mDataLoaded
= true;
231 switch ( $this->mFrom
) {
233 $this->loadDefaults();
236 $this->mId
= self
::idFromName( $this->mName
);
238 # Nonexistent user placeholder object
239 $this->loadDefaults( $this->mName
);
248 $this->loadFromSession();
251 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
253 wfProfileOut( __METHOD__
);
257 * Load user table data, given mId has already been set.
258 * @return \type{\bool} false if the ID does not exist, true otherwise
261 function loadFromId() {
263 if ( $this->mId
== 0 ) {
264 $this->loadDefaults();
269 $key = wfMemcKey( 'user', 'id', $this->mId
);
270 $data = $wgMemc->get( $key );
271 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
272 # Object is expired, load from DB
277 wfDebug( "Cache miss for user {$this->mId}\n" );
279 if ( !$this->loadFromDatabase() ) {
280 # Can't load from ID, user is anonymous
283 $this->saveToCache();
285 wfDebug( "Got user {$this->mId} from cache\n" );
287 foreach ( self
::$mCacheVars as $name ) {
288 $this->$name = $data[$name];
295 * Save user data to the shared cache
297 function saveToCache() {
300 if ( $this->isAnon() ) {
301 // Anonymous users are uncached
305 foreach ( self
::$mCacheVars as $name ) {
306 $data[$name] = $this->$name;
308 $data['mVersion'] = MW_USER_VERSION
;
309 $key = wfMemcKey( 'user', 'id', $this->mId
);
311 $wgMemc->set( $key, $data );
315 /** @name newFrom*() static factory methods */
319 * Static factory method for creation from username.
321 * This is slightly less efficient than newFromId(), so use newFromId() if
322 * you have both an ID and a name handy.
324 * @param $name \type{\string} Username, validated by Title::newFromText()
325 * @param $validate \type{\mixed} Validate username. Takes the same parameters as
326 * User::getCanonicalName(), except that true is accepted as an alias
327 * for 'valid', for BC.
329 * @return \type{User} The User object, or null if the username is invalid. If the
330 * username is not present in the database, the result will be a user object
331 * with a name, zero user ID and default settings.
333 static function newFromName( $name, $validate = 'valid' ) {
334 if ( $validate === true ) {
337 $name = self
::getCanonicalName( $name, $validate );
338 if ( $name === false ) {
341 # Create unloaded user object
350 * Static factory method for creation from a given user ID.
352 * @param $id \type{\int} Valid user ID
353 * @return \type{User} The corresponding User object
355 static function newFromId( $id ) {
363 * Factory method to fetch whichever user has a given email confirmation code.
364 * This code is generated when an account is created or its e-mail address
367 * If the code is invalid or has expired, returns NULL.
369 * @param $code \type{\string} Confirmation code
370 * @return \type{User}
372 static function newFromConfirmationCode( $code ) {
373 $dbr = wfGetDB( DB_SLAVE
);
374 $id = $dbr->selectField( 'user', 'user_id', array(
375 'user_email_token' => md5( $code ),
376 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
378 if( $id !== false ) {
379 return User
::newFromId( $id );
386 * Create a new user object using data from session or cookies. If the
387 * login credentials are invalid, the result is an anonymous user.
389 * @return \type{User}
391 static function newFromSession() {
393 $user->mFrom
= 'session';
398 * Create a new user object from a user row.
399 * The row should have all fields from the user table in it.
400 * @param $row array A row from the user table
401 * @return \type{User}
403 static function newFromRow( $row ) {
405 $user->loadFromRow( $row );
413 * Get the username corresponding to a given user ID
414 * @param $id \type{\int} %User ID
415 * @return \type{\string} The corresponding username
417 static function whoIs( $id ) {
418 $dbr = wfGetDB( DB_SLAVE
);
419 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
423 * Get the real name of a user given their user ID
425 * @param $id \type{\int} %User ID
426 * @return \type{\string} The corresponding user's real name
428 static function whoIsReal( $id ) {
429 $dbr = wfGetDB( DB_SLAVE
);
430 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
434 * Get database id given a user name
435 * @param $name \type{\string} Username
436 * @return \twotypes{\int,\null} The corresponding user's ID, or null if user is nonexistent
439 static function idFromName( $name ) {
440 $nt = Title
::newFromText( $name );
441 if( is_null( $nt ) ) {
445 $dbr = wfGetDB( DB_SLAVE
);
446 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
448 if ( $s === false ) {
456 * Does the string match an anonymous IPv4 address?
458 * This function exists for username validation, in order to reject
459 * usernames which are similar in form to IP addresses. Strings such
460 * as 300.300.300.300 will return true because it looks like an IP
461 * address, despite not being strictly valid.
463 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
464 * address because the usemod software would "cloak" anonymous IP
465 * addresses like this, if we allowed accounts like this to be created
466 * new users could get the old edits of these anonymous users.
468 * @param $name \type{\string} String to match
469 * @return \type{\bool} True or false
471 static function isIP( $name ) {
472 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
476 * Is the input a valid username?
478 * Checks if the input is a valid username, we don't want an empty string,
479 * an IP address, anything that containins slashes (would mess up subpages),
480 * is longer than the maximum allowed username size or doesn't begin with
483 * @param $name \type{\string} String to match
484 * @return \type{\bool} True or false
486 static function isValidUserName( $name ) {
487 global $wgContLang, $wgMaxNameChars;
490 || User
::isIP( $name )
491 ||
strpos( $name, '/' ) !== false
492 ||
strlen( $name ) > $wgMaxNameChars
493 ||
$name != $wgContLang->ucfirst( $name ) ) {
494 wfDebugLog( 'username', __METHOD__
.
495 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
499 // Ensure that the name can't be misresolved as a different title,
500 // such as with extra namespace keys at the start.
501 $parsed = Title
::newFromText( $name );
502 if( is_null( $parsed )
503 ||
$parsed->getNamespace()
504 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
505 wfDebugLog( 'username', __METHOD__
.
506 ": '$name' invalid due to ambiguous prefixes" );
510 // Check an additional blacklist of troublemaker characters.
511 // Should these be merged into the title char list?
512 $unicodeBlacklist = '/[' .
513 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
514 '\x{00a0}' . # non-breaking space
515 '\x{2000}-\x{200f}' . # various whitespace
516 '\x{2028}-\x{202f}' . # breaks and control chars
517 '\x{3000}' . # ideographic space
518 '\x{e000}-\x{f8ff}' . # private use
520 if( preg_match( $unicodeBlacklist, $name ) ) {
521 wfDebugLog( 'username', __METHOD__
.
522 ": '$name' invalid due to blacklisted characters" );
530 * Usernames which fail to pass this function will be blocked
531 * from user login and new account registrations, but may be used
532 * internally by batch processes.
534 * If an account already exists in this form, login will be blocked
535 * by a failure to pass this function.
537 * @param $name \type{\string} String to match
538 * @return \type{\bool} True or false
540 static function isUsableName( $name ) {
541 global $wgReservedUsernames;
542 // Must be a valid username, obviously ;)
543 if ( !self
::isValidUserName( $name ) ) {
547 static $reservedUsernames = false;
548 if ( !$reservedUsernames ) {
549 $reservedUsernames = $wgReservedUsernames;
550 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
553 // Certain names may be reserved for batch processes.
554 foreach ( $reservedUsernames as $reserved ) {
555 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
556 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
558 if ( $reserved == $name ) {
566 * Usernames which fail to pass this function will be blocked
567 * from new account registrations, but may be used internally
568 * either by batch processes or by user accounts which have
569 * already been created.
571 * Additional character blacklisting may be added here
572 * rather than in isValidUserName() to avoid disrupting
575 * @param $name \type{\string} String to match
576 * @return \type{\bool} True or false
578 static function isCreatableName( $name ) {
580 self
::isUsableName( $name ) &&
582 // Registration-time character blacklisting...
583 strpos( $name, '@' ) === false;
587 * Is the input a valid password for this user?
589 * @param $password \type{\string} Desired password
590 * @return \type{\bool} True or false
592 function isValidPassword( $password ) {
593 global $wgMinimalPasswordLength, $wgContLang;
596 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
598 if( $result === false )
601 // Password needs to be long enough, and can't be the same as the username
602 return strlen( $password ) >= $wgMinimalPasswordLength
603 && $wgContLang->lc( $password ) !== $wgContLang->lc( $this->mName
);
607 * Does a string look like an e-mail address?
609 * There used to be a regular expression here, it got removed because it
610 * rejected valid addresses. Actually just check if there is '@' somewhere
611 * in the given address.
613 * @todo Check for RFC 2822 compilance (bug 959)
615 * @param $addr \type{\string} E-mail address
616 * @return \type{\bool} True or false
618 public static function isValidEmailAddr( $addr ) {
620 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
624 return strpos( $addr, '@' ) !== false;
628 * Given unvalidated user input, return a canonical username, or false if
629 * the username is invalid.
630 * @param $name \type{\string} User input
631 * @param $validate \twotypes{\string,\bool} Type of validation to use:
632 * - false No validation
633 * - 'valid' Valid for batch processes
634 * - 'usable' Valid for batch processes and login
635 * - 'creatable' Valid for batch processes, login and account creation
637 static function getCanonicalName( $name, $validate = 'valid' ) {
638 # Force usernames to capital
640 $name = $wgContLang->ucfirst( $name );
642 # Reject names containing '#'; these will be cleaned up
643 # with title normalisation, but then it's too late to
645 if( strpos( $name, '#' ) !== false )
648 # Clean up name according to title rules
649 $t = ($validate === 'valid') ?
650 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
651 # Check for invalid titles
652 if( is_null( $t ) ) {
656 # Reject various classes of invalid names
657 $name = $t->getText();
659 $name = $wgAuth->getCanonicalName( $t->getText() );
661 switch ( $validate ) {
665 if ( !User
::isValidUserName( $name ) ) {
670 if ( !User
::isUsableName( $name ) ) {
675 if ( !User
::isCreatableName( $name ) ) {
680 throw new MWException( 'Invalid parameter value for $validate in '.__METHOD__
);
686 * Count the number of edits of a user
687 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
689 * @param $uid \type{\int} %User ID to check
690 * @return \type{\int} The user's edit count
692 static function edits( $uid ) {
693 wfProfileIn( __METHOD__
);
694 $dbr = wfGetDB( DB_SLAVE
);
695 // check if the user_editcount field has been initialized
696 $field = $dbr->selectField(
697 'user', 'user_editcount',
698 array( 'user_id' => $uid ),
702 if( $field === null ) { // it has not been initialized. do so.
703 $dbw = wfGetDB( DB_MASTER
);
704 $count = $dbr->selectField(
705 'revision', 'count(*)',
706 array( 'rev_user' => $uid ),
711 array( 'user_editcount' => $count ),
712 array( 'user_id' => $uid ),
718 wfProfileOut( __METHOD__
);
723 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
724 * @todo hash random numbers to improve security, like generateToken()
726 * @return \type{\string} New random password
728 static function randomPassword() {
729 global $wgMinimalPasswordLength;
730 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
731 $l = strlen( $pwchars ) - 1;
733 $pwlength = max( 7, $wgMinimalPasswordLength );
734 $digit = mt_rand(0, $pwlength - 1);
736 for ( $i = 0; $i < $pwlength; $i++
) {
737 $np .= $i == $digit ?
chr( mt_rand(48, 57) ) : $pwchars{ mt_rand(0, $l)};
743 * Set cached properties to default.
745 * @note This no longer clears uncached lazy-initialised properties;
746 * the constructor does that instead.
749 function loadDefaults( $name = false ) {
750 wfProfileIn( __METHOD__
);
752 global $wgCookiePrefix;
755 $this->mName
= $name;
756 $this->mRealName
= '';
757 $this->mPassword
= $this->mNewpassword
= '';
758 $this->mNewpassTime
= null;
760 $this->mOptions
= null; # Defer init
762 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
763 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
765 $this->mTouched
= '0'; # Allow any pages to be cached
768 $this->setToken(); # Random
769 $this->mEmailAuthenticated
= null;
770 $this->mEmailToken
= '';
771 $this->mEmailTokenExpires
= null;
772 $this->mRegistration
= wfTimestamp( TS_MW
);
773 $this->mGroups
= array();
775 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
777 wfProfileOut( __METHOD__
);
781 * @deprecated Use wfSetupSession().
783 function SetupSession() {
784 wfDeprecated( __METHOD__
);
789 * Load user data from the session or login cookie. If there are no valid
790 * credentials, initialises the user as an anonymous user.
791 * @return \type{\bool} True if the user is logged in, false otherwise.
793 private function loadFromSession() {
794 global $wgMemc, $wgCookiePrefix;
797 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
798 if ( $result !== null ) {
802 if ( isset( $_SESSION['wsUserID'] ) ) {
803 if ( 0 != $_SESSION['wsUserID'] ) {
804 $sId = $_SESSION['wsUserID'];
806 $this->loadDefaults();
809 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
810 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
811 $_SESSION['wsUserID'] = $sId;
813 $this->loadDefaults();
816 if ( isset( $_SESSION['wsUserName'] ) ) {
817 $sName = $_SESSION['wsUserName'];
818 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
819 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
820 $_SESSION['wsUserName'] = $sName;
822 $this->loadDefaults();
826 $passwordCorrect = FALSE;
828 if ( !$this->loadFromId() ) {
829 # Not a valid ID, loadFromId has switched the object to anon for us
833 if ( isset( $_SESSION['wsToken'] ) ) {
834 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
836 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
837 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
840 # No session or persistent login cookie
841 $this->loadDefaults();
845 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
846 $_SESSION['wsToken'] = $this->mToken
;
847 wfDebug( "Logged in from $from\n" );
850 # Invalid credentials
851 wfDebug( "Can't log in from $from, invalid credentials\n" );
852 $this->loadDefaults();
858 * Load user and user_group data from the database.
859 * $this::mId must be set, this is how the user is identified.
861 * @return \type{\bool} True if the user exists, false if the user is anonymous
864 function loadFromDatabase() {
866 $this->mId
= intval( $this->mId
);
868 /** Anonymous user */
870 $this->loadDefaults();
874 $dbr = wfGetDB( DB_MASTER
);
875 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
877 if ( $s !== false ) {
878 # Initialise user table data
879 $this->loadFromRow( $s );
880 $this->mGroups
= null; // deferred
881 $this->getEditCount(); // revalidation for nulls
886 $this->loadDefaults();
892 * Initialize this object from a row from the user table.
894 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
896 function loadFromRow( $row ) {
897 $this->mDataLoaded
= true;
899 if ( isset( $row->user_id
) ) {
900 $this->mId
= $row->user_id
;
902 $this->mName
= $row->user_name
;
903 $this->mRealName
= $row->user_real_name
;
904 $this->mPassword
= $row->user_password
;
905 $this->mNewpassword
= $row->user_newpassword
;
906 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
907 $this->mEmail
= $row->user_email
;
908 $this->decodeOptions( $row->user_options
);
909 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
910 $this->mToken
= $row->user_token
;
911 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
912 $this->mEmailToken
= $row->user_email_token
;
913 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
914 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
915 $this->mEditCount
= $row->user_editcount
;
919 * Load the groups from the database if they aren't already loaded.
922 function loadGroups() {
923 if ( is_null( $this->mGroups
) ) {
924 $dbr = wfGetDB( DB_MASTER
);
925 $res = $dbr->select( 'user_groups',
927 array( 'ug_user' => $this->mId
),
929 $this->mGroups
= array();
930 while( $row = $dbr->fetchObject( $res ) ) {
931 $this->mGroups
[] = $row->ug_group
;
937 * Clear various cached data stored in this object.
938 * @param $reloadFrom \type{\string} Reload user and user_groups table data from a
939 * given source. May be "name", "id", "defaults", "session", or false for
942 function clearInstanceCache( $reloadFrom = false ) {
943 $this->mNewtalk
= -1;
944 $this->mDatePreference
= null;
945 $this->mBlockedby
= -1; # Unset
946 $this->mHash
= false;
948 $this->mRights
= null;
949 $this->mEffectiveGroups
= null;
952 $this->mDataLoaded
= false;
953 $this->mFrom
= $reloadFrom;
958 * Combine the language default options with any site-specific options
959 * and add the default language variants.
961 * @return \type{\arrayof{\string}} Array of options
963 static function getDefaultOptions() {
964 global $wgNamespacesToBeSearchedDefault;
966 * Site defaults will override the global/language defaults
968 global $wgDefaultUserOptions, $wgContLang;
969 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
972 * default language setting
974 $variant = $wgContLang->getPreferredVariant( false );
975 $defOpt['variant'] = $variant;
976 $defOpt['language'] = $variant;
978 foreach( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
979 $defOpt['searchNs'.$nsnum] = $val;
985 * Get a given default option value.
987 * @param $opt \type{\string} Name of option to retrieve
988 * @return \type{\string} Default option value
990 public static function getDefaultOption( $opt ) {
991 $defOpts = self
::getDefaultOptions();
992 if( isset( $defOpts[$opt] ) ) {
993 return $defOpts[$opt];
1000 * Get a list of user toggle names
1001 * @return \type{\arrayof{\string}} Array of user toggle names
1003 static function getToggles() {
1005 $extraToggles = array();
1006 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1007 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1012 * Get blocking information
1014 * @param $bFromSlave \type{\bool} Whether to check the slave database first. To
1015 * improve performance, non-critical checks are done
1016 * against slaves. Check when actually saving should be
1017 * done against master.
1019 function getBlockedStatus( $bFromSlave = true ) {
1020 global $wgEnableSorbs, $wgProxyWhitelist;
1022 if ( -1 != $this->mBlockedby
) {
1023 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1027 wfProfileIn( __METHOD__
);
1028 wfDebug( __METHOD__
.": checking...\n" );
1030 // Initialize data...
1031 // Otherwise something ends up stomping on $this->mBlockedby when
1032 // things get lazy-loaded later, causing false positive block hits
1033 // due to -1 !== 0. Probably session-related... Nothing should be
1034 // overwriting mBlockedby, surely?
1037 $this->mBlockedby
= 0;
1038 $this->mHideName
= 0;
1039 $this->mAllowUsertalk
= 0;
1042 if ($this->isAllowed( 'ipblock-exempt' ) ) {
1043 # Exempt from all types of IP-block
1048 $this->mBlock
= new Block();
1049 $this->mBlock
->fromMaster( !$bFromSlave );
1050 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1051 wfDebug( __METHOD__
.": Found block.\n" );
1052 $this->mBlockedby
= $this->mBlock
->mBy
;
1053 $this->mBlockreason
= $this->mBlock
->mReason
;
1054 $this->mHideName
= $this->mBlock
->mHideName
;
1055 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1056 if ( $this->isLoggedIn() ) {
1057 $this->spreadBlock();
1060 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1061 // apply to users. Note that the existence of $this->mBlock is not used to
1062 // check for edit blocks, $this->mBlockedby is instead.
1066 if ( !$this->isAllowed('proxyunbannable') && !in_array( $ip, $wgProxyWhitelist ) ) {
1068 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1069 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1070 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1074 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1075 if ( $this->inSorbsBlacklist( $ip ) ) {
1076 $this->mBlockedby
= wfMsg( 'sorbs' );
1077 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1083 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1085 wfProfileOut( __METHOD__
);
1089 * Whether the given IP is in the SORBS blacklist.
1091 * @param $ip \type{\string} IP to check
1092 * @return \type{\bool} True if blacklisted
1094 function inSorbsBlacklist( $ip ) {
1095 global $wgEnableSorbs, $wgSorbsUrl;
1097 return $wgEnableSorbs &&
1098 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1102 * Whether the given IP is in a given DNS blacklist.
1104 * @param $ip \type{\string} IP to check
1105 * @param $base \type{\string} URL of the DNS blacklist
1106 * @return \type{\bool} True if blacklisted
1108 function inDnsBlacklist( $ip, $base ) {
1109 wfProfileIn( __METHOD__
);
1113 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1114 if( IP
::isIPv4($ip) ) {
1116 $host = "$ip.$base";
1119 $ipList = gethostbynamel( $host );
1122 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1125 wfDebug( "Requested $host, not found in $base.\n" );
1129 wfProfileOut( __METHOD__
);
1134 * Is this user subject to rate limiting?
1136 * @return \type{\bool} True if rate limited
1138 public function isPingLimitable() {
1139 global $wgRateLimitsExcludedGroups;
1140 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1141 // Deprecated, but kept for backwards-compatibility config
1144 return !$this->isAllowed('noratelimit');
1148 * Primitive rate limits: enforce maximum actions per time period
1149 * to put a brake on flooding.
1151 * @note When using a shared cache like memcached, IP-address
1152 * last-hit counters will be shared across wikis.
1154 * @param $action \type{\string} Action to enforce; 'edit' if unspecified
1155 * @return \type{\bool} True if a rate limiter was tripped
1157 function pingLimiter( $action='edit' ) {
1159 # Call the 'PingLimiter' hook
1161 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1165 global $wgRateLimits;
1166 if( !isset( $wgRateLimits[$action] ) ) {
1170 # Some groups shouldn't trigger the ping limiter, ever
1171 if( !$this->isPingLimitable() )
1174 global $wgMemc, $wgRateLimitLog;
1175 wfProfileIn( __METHOD__
);
1177 $limits = $wgRateLimits[$action];
1179 $id = $this->getId();
1183 if( isset( $limits['anon'] ) && $id == 0 ) {
1184 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1187 if( isset( $limits['user'] ) && $id != 0 ) {
1188 $userLimit = $limits['user'];
1190 if( $this->isNewbie() ) {
1191 if( isset( $limits['newbie'] ) && $id != 0 ) {
1192 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1194 if( isset( $limits['ip'] ) ) {
1195 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1198 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1199 $subnet = $matches[1];
1200 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1203 // Check for group-specific permissions
1204 // If more than one group applies, use the group with the highest limit
1205 foreach ( $this->getGroups() as $group ) {
1206 if ( isset( $limits[$group] ) ) {
1207 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1208 $userLimit = $limits[$group];
1212 // Set the user limit key
1213 if ( $userLimit !== false ) {
1214 wfDebug( __METHOD__
.": effective user limit: $userLimit\n" );
1215 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1219 foreach( $keys as $key => $limit ) {
1220 list( $max, $period ) = $limit;
1221 $summary = "(limit $max in {$period}s)";
1222 $count = $wgMemc->get( $key );
1224 if( $count > $max ) {
1225 wfDebug( __METHOD__
.": tripped! $key at $count $summary\n" );
1226 if( $wgRateLimitLog ) {
1227 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1231 wfDebug( __METHOD__
.": ok. $key at $count $summary\n" );
1234 wfDebug( __METHOD__
.": adding record for $key $summary\n" );
1235 $wgMemc->add( $key, 1, intval( $period ) );
1237 $wgMemc->incr( $key );
1240 wfProfileOut( __METHOD__
);
1245 * Check if user is blocked
1247 * @param $bFromSlave \type{\bool} Whether to check the slave database instead of the master
1248 * @return \type{\bool} True if blocked, false otherwise
1250 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1251 wfDebug( "User::isBlocked: enter\n" );
1252 $this->getBlockedStatus( $bFromSlave );
1253 return $this->mBlockedby
!== 0;
1257 * Check if user is blocked from editing a particular article
1259 * @param $title \type{\string} Title to check
1260 * @param $bFromSlave \type{\bool} Whether to check the slave database instead of the master
1261 * @return \type{\bool} True if blocked, false otherwise
1263 function isBlockedFrom( $title, $bFromSlave = false ) {
1264 global $wgBlockAllowsUTEdit;
1265 wfProfileIn( __METHOD__
);
1266 wfDebug( __METHOD__
.": enter\n" );
1268 wfDebug( __METHOD__
.": asking isBlocked()\n" );
1269 $blocked = $this->isBlocked( $bFromSlave );
1270 # If a user's name is suppressed, they cannot make edits anywhere
1271 if ( !$this->mHideName
&& $this->mAllowUsertalk
&& $title->getText() === $this->getName() &&
1272 $title->getNamespace() == NS_USER_TALK
) {
1274 wfDebug( __METHOD__
.": self-talk page, ignoring any blocks\n" );
1276 wfProfileOut( __METHOD__
);
1281 * If user is blocked, return the name of the user who placed the block
1282 * @return \type{\string} name of blocker
1284 function blockedBy() {
1285 $this->getBlockedStatus();
1286 return $this->mBlockedby
;
1290 * If user is blocked, return the specified reason for the block
1291 * @return \type{\string} Blocking reason
1293 function blockedFor() {
1294 $this->getBlockedStatus();
1295 return $this->mBlockreason
;
1299 * Get the user's ID.
1300 * @return \type{\int} The user's ID; 0 if the user is anonymous or nonexistent
1303 if( $this->mId
=== null and $this->mName
!== null
1304 and User
::isIP( $this->mName
) ) {
1305 // Special case, we know the user is anonymous
1307 } elseif( $this->mId
=== null ) {
1308 // Don't load if this was initialized from an ID
1315 * Set the user and reload all fields according to a given ID
1316 * @param $v \type{\int} %User ID to reload
1318 function setId( $v ) {
1320 $this->clearInstanceCache( 'id' );
1324 * Get the user name, or the IP of an anonymous user
1325 * @return \type{\string} User's name or IP address
1327 function getName() {
1328 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1329 # Special case optimisation
1330 return $this->mName
;
1333 if ( $this->mName
=== false ) {
1335 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1337 return $this->mName
;
1342 * Set the user name.
1344 * This does not reload fields from the database according to the given
1345 * name. Rather, it is used to create a temporary "nonexistent user" for
1346 * later addition to the database. It can also be used to set the IP
1347 * address for an anonymous user to something other than the current
1350 * @note User::newFromName() has rougly the same function, when the named user
1352 * @param $str \type{\string} New user name to set
1354 function setName( $str ) {
1356 $this->mName
= $str;
1360 * Get the user's name escaped by underscores.
1361 * @return \type{\string} Username escaped by underscores
1363 function getTitleKey() {
1364 return str_replace( ' ', '_', $this->getName() );
1368 * Check if the user has new messages.
1369 * @return \type{\bool} True if the user has new messages
1371 function getNewtalk() {
1374 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1375 if( $this->mNewtalk
=== -1 ) {
1376 $this->mNewtalk
= false; # reset talk page status
1378 # Check memcached separately for anons, who have no
1379 # entire User object stored in there.
1382 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1383 $newtalk = $wgMemc->get( $key );
1384 if( strval( $newtalk ) !== '' ) {
1385 $this->mNewtalk
= (bool)$newtalk;
1387 // Since we are caching this, make sure it is up to date by getting it
1389 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1390 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1393 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1397 return (bool)$this->mNewtalk
;
1401 * Return the talk page(s) this user has new messages on.
1402 * @return \type{\arrayof{\string}} Array of page URLs
1404 function getNewMessageLinks() {
1406 if (!wfRunHooks('UserRetrieveNewTalks', array(&$this, &$talks)))
1409 if (!$this->getNewtalk())
1411 $up = $this->getUserPage();
1412 $utp = $up->getTalkPage();
1413 return array(array("wiki" => wfWikiID(), "link" => $utp->getLocalURL()));
1418 * Internal uncached check for new messages
1421 * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise
1422 * @param $id \twotypes{\string,\int} User's IP address for anonymous users, %User ID otherwise
1423 * @param $fromMaster \type{\bool} true to fetch from the master, false for a slave
1424 * @return \type{\bool} True if the user has new messages
1427 function checkNewtalk( $field, $id, $fromMaster = false ) {
1428 if ( $fromMaster ) {
1429 $db = wfGetDB( DB_MASTER
);
1431 $db = wfGetDB( DB_SLAVE
);
1433 $ok = $db->selectField( 'user_newtalk', $field,
1434 array( $field => $id ), __METHOD__
);
1435 return $ok !== false;
1439 * Add or update the new messages flag
1440 * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise
1441 * @param $id \twotypes{string,\int} User's IP address for anonymous users, %User ID otherwise
1442 * @return \type{\bool} True if successful, false otherwise
1445 function updateNewtalk( $field, $id ) {
1446 $dbw = wfGetDB( DB_MASTER
);
1447 $dbw->insert( 'user_newtalk',
1448 array( $field => $id ),
1451 if ( $dbw->affectedRows() ) {
1452 wfDebug( __METHOD__
.": set on ($field, $id)\n" );
1455 wfDebug( __METHOD__
." already set ($field, $id)\n" );
1461 * Clear the new messages flag for the given user
1462 * @param $field \type{\string} 'user_ip' for anonymous users, 'user_id' otherwise
1463 * @param $id \twotypes{\string,\int} User's IP address for anonymous users, %User ID otherwise
1464 * @return \type{\bool} True if successful, false otherwise
1467 function deleteNewtalk( $field, $id ) {
1468 $dbw = wfGetDB( DB_MASTER
);
1469 $dbw->delete( 'user_newtalk',
1470 array( $field => $id ),
1472 if ( $dbw->affectedRows() ) {
1473 wfDebug( __METHOD__
.": killed on ($field, $id)\n" );
1476 wfDebug( __METHOD__
.": already gone ($field, $id)\n" );
1482 * Update the 'You have new messages!' status.
1483 * @param $val \type{\bool} Whether the user has new messages
1485 function setNewtalk( $val ) {
1486 if( wfReadOnly() ) {
1491 $this->mNewtalk
= $val;
1493 if( $this->isAnon() ) {
1495 $id = $this->getName();
1498 $id = $this->getId();
1503 $changed = $this->updateNewtalk( $field, $id );
1505 $changed = $this->deleteNewtalk( $field, $id );
1508 if( $this->isAnon() ) {
1509 // Anons have a separate memcached space, since
1510 // user records aren't kept for them.
1511 $key = wfMemcKey( 'newtalk', 'ip', $id );
1512 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1515 $this->invalidateCache();
1520 * Generate a current or new-future timestamp to be stored in the
1521 * user_touched field when we update things.
1522 * @return \type{\string} Timestamp in TS_MW format
1524 private static function newTouchedTimestamp() {
1525 global $wgClockSkewFudge;
1526 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1530 * Clear user data from memcached.
1531 * Use after applying fun updates to the database; caller's
1532 * responsibility to update user_touched if appropriate.
1534 * Called implicitly from invalidateCache() and saveSettings().
1536 private function clearSharedCache() {
1539 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1544 * Immediately touch the user data cache for this account.
1545 * Updates user_touched field, and removes account data from memcached
1546 * for reload on the next hit.
1548 function invalidateCache() {
1551 $this->mTouched
= self
::newTouchedTimestamp();
1553 $dbw = wfGetDB( DB_MASTER
);
1554 $dbw->update( 'user',
1555 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1556 array( 'user_id' => $this->mId
),
1559 $this->clearSharedCache();
1564 * Validate the cache for this account.
1565 * @param $timestamp \type{\string} A timestamp in TS_MW format
1567 function validateCache( $timestamp ) {
1569 return ($timestamp >= $this->mTouched
);
1573 * Get the user touched timestamp
1575 function getTouched() {
1577 return $this->mTouched
;
1581 * Set the password and reset the random token.
1582 * Calls through to authentication plugin if necessary;
1583 * will have no effect if the auth plugin refuses to
1584 * pass the change through or if the legal password
1587 * As a special case, setting the password to null
1588 * wipes it, so the account cannot be logged in until
1589 * a new password is set, for instance via e-mail.
1591 * @param $str \type{\string} New password to set
1592 * @throws PasswordError on failure
1594 function setPassword( $str ) {
1597 if( $str !== null ) {
1598 if( !$wgAuth->allowPasswordChange() ) {
1599 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1602 if( !$this->isValidPassword( $str ) ) {
1603 global $wgMinimalPasswordLength;
1604 throw new PasswordError( wfMsgExt( 'passwordtooshort', array( 'parsemag' ),
1605 $wgMinimalPasswordLength ) );
1609 if( !$wgAuth->setPassword( $this, $str ) ) {
1610 throw new PasswordError( wfMsg( 'externaldberror' ) );
1613 $this->setInternalPassword( $str );
1619 * Set the password and reset the random token unconditionally.
1621 * @param $str \type{\string} New password to set
1623 function setInternalPassword( $str ) {
1627 if( $str === null ) {
1628 // Save an invalid hash...
1629 $this->mPassword
= '';
1631 $this->mPassword
= self
::crypt( $str );
1633 $this->mNewpassword
= '';
1634 $this->mNewpassTime
= null;
1638 * Get the user's current token.
1639 * @return \type{\string} Token
1641 function getToken() {
1643 return $this->mToken
;
1647 * Set the random token (used for persistent authentication)
1648 * Called from loadDefaults() among other places.
1650 * @param $token \type{\string} If specified, set the token to this value
1653 function setToken( $token = false ) {
1654 global $wgSecretKey, $wgProxyKey;
1657 if ( $wgSecretKey ) {
1658 $key = $wgSecretKey;
1659 } elseif ( $wgProxyKey ) {
1664 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1666 $this->mToken
= $token;
1671 * Set the cookie password
1673 * @param $str \type{\string} New cookie password
1676 function setCookiePassword( $str ) {
1678 $this->mCookiePassword
= md5( $str );
1682 * Set the password for a password reminder or new account email
1684 * @param $str \type{\string} New password to set
1685 * @param $throttle \type{\bool} If true, reset the throttle timestamp to the present
1687 function setNewpassword( $str, $throttle = true ) {
1689 $this->mNewpassword
= self
::crypt( $str );
1691 $this->mNewpassTime
= wfTimestampNow();
1696 * Has password reminder email been sent within the last
1697 * $wgPasswordReminderResendTime hours?
1698 * @return \type{\bool} True or false
1700 function isPasswordReminderThrottled() {
1701 global $wgPasswordReminderResendTime;
1703 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1706 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1707 return time() < $expiry;
1711 * Get the user's e-mail address
1712 * @return \type{\string} User's e-mail address
1714 function getEmail() {
1716 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1717 return $this->mEmail
;
1721 * Get the timestamp of the user's e-mail authentication
1722 * @return \type{\string} TS_MW timestamp
1724 function getEmailAuthenticationTimestamp() {
1726 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1727 return $this->mEmailAuthenticated
;
1731 * Set the user's e-mail address
1732 * @param $str \type{\string} New e-mail address
1734 function setEmail( $str ) {
1736 $this->mEmail
= $str;
1737 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1741 * Get the user's real name
1742 * @return \type{\string} User's real name
1744 function getRealName() {
1746 return $this->mRealName
;
1750 * Set the user's real name
1751 * @param $str \type{\string} New real name
1753 function setRealName( $str ) {
1755 $this->mRealName
= $str;
1759 * Get the user's current setting for a given option.
1761 * @param $oname \type{\string} The option to check
1762 * @param $defaultOverride \type{\string} A default value returned if the option does not exist
1763 * @return \type{\string} User's current value for the option
1764 * @see getBoolOption()
1765 * @see getIntOption()
1767 function getOption( $oname, $defaultOverride = '' ) {
1770 if ( is_null( $this->mOptions
) ) {
1771 if($defaultOverride != '') {
1772 return $defaultOverride;
1774 $this->mOptions
= User
::getDefaultOptions();
1777 if ( array_key_exists( $oname, $this->mOptions
) ) {
1778 return trim( $this->mOptions
[$oname] );
1780 return $defaultOverride;
1785 * Get the user's current setting for a given option, as a boolean value.
1787 * @param $oname \type{\string} The option to check
1788 * @return \type{\bool} User's current value for the option
1791 function getBoolOption( $oname ) {
1792 return (bool)$this->getOption( $oname );
1797 * Get the user's current setting for a given option, as a boolean value.
1799 * @param $oname \type{\string} The option to check
1800 * @param $defaultOverride \type{\int} A default value returned if the option does not exist
1801 * @return \type{\int} User's current value for the option
1804 function getIntOption( $oname, $defaultOverride=0 ) {
1805 $val = $this->getOption( $oname );
1807 $val = $defaultOverride;
1809 return intval( $val );
1813 * Set the given option for a user.
1815 * @param $oname \type{\string} The option to set
1816 * @param $val \type{\mixed} New value to set
1818 function setOption( $oname, $val ) {
1820 if ( is_null( $this->mOptions
) ) {
1821 $this->mOptions
= User
::getDefaultOptions();
1823 if ( $oname == 'skin' ) {
1824 # Clear cached skin, so the new one displays immediately in Special:Preferences
1825 unset( $this->mSkin
);
1827 // Filter out any newlines that may have passed through input validation.
1828 // Newlines are used to separate items in the options blob.
1830 $val = str_replace( "\r\n", "\n", $val );
1831 $val = str_replace( "\r", "\n", $val );
1832 $val = str_replace( "\n", " ", $val );
1834 // Explicitly NULL values should refer to defaults
1835 global $wgDefaultUserOptions;
1836 if( is_null($val) && isset($wgDefaultUserOptions[$oname]) ) {
1837 $val = $wgDefaultUserOptions[$oname];
1839 $this->mOptions
[$oname] = $val;
1843 * Get the user's preferred date format.
1844 * @return \type{\string} User's preferred date format
1846 function getDatePreference() {
1847 // Important migration for old data rows
1848 if ( is_null( $this->mDatePreference
) ) {
1850 $value = $this->getOption( 'date' );
1851 $map = $wgLang->getDatePreferenceMigrationMap();
1852 if ( isset( $map[$value] ) ) {
1853 $value = $map[$value];
1855 $this->mDatePreference
= $value;
1857 return $this->mDatePreference
;
1861 * Get the permissions this user has.
1862 * @return \type{\arrayof{\string}} Array of permission names
1864 function getRights() {
1865 if ( is_null( $this->mRights
) ) {
1866 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
1867 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
1868 // Force reindexation of rights when a hook has unset one of them
1869 $this->mRights
= array_values( $this->mRights
);
1871 return $this->mRights
;
1875 * Get the list of explicit group memberships this user has.
1876 * The implicit * and user groups are not included.
1877 * @return \type{\arrayof{\string}} Array of internal group names
1879 function getGroups() {
1881 return $this->mGroups
;
1885 * Get the list of implicit group memberships this user has.
1886 * This includes all explicit groups, plus 'user' if logged in,
1887 * '*' for all accounts and autopromoted groups
1889 * @param $recache \type{\bool} Whether to avoid the cache
1890 * @return \type{\arrayof{\string}} Array of internal group names
1892 function getEffectiveGroups( $recache = false ) {
1893 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
1894 $this->mEffectiveGroups
= $this->getGroups();
1895 $this->mEffectiveGroups
[] = '*';
1896 if( $this->getId() ) {
1897 $this->mEffectiveGroups
[] = 'user';
1899 $this->mEffectiveGroups
= array_unique( array_merge(
1900 $this->mEffectiveGroups
,
1901 Autopromote
::getAutopromoteGroups( $this )
1904 # Hook for additional groups
1905 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
1908 return $this->mEffectiveGroups
;
1912 * Get the user's edit count.
1913 * @return \type{\int} User's edit count
1915 function getEditCount() {
1917 if ( !isset( $this->mEditCount
) ) {
1918 /* Populate the count, if it has not been populated yet */
1919 $this->mEditCount
= User
::edits($this->mId
);
1921 return $this->mEditCount
;
1929 * Add the user to the given group.
1930 * This takes immediate effect.
1931 * @param $group \type{\string} Name of the group to add
1933 function addGroup( $group ) {
1934 $dbw = wfGetDB( DB_MASTER
);
1935 if( $this->getId() ) {
1936 $dbw->insert( 'user_groups',
1938 'ug_user' => $this->getID(),
1939 'ug_group' => $group,
1942 array( 'IGNORE' ) );
1945 $this->loadGroups();
1946 $this->mGroups
[] = $group;
1947 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
1949 $this->invalidateCache();
1953 * Remove the user from the given group.
1954 * This takes immediate effect.
1955 * @param $group \type{\string} Name of the group to remove
1957 function removeGroup( $group ) {
1959 $dbw = wfGetDB( DB_MASTER
);
1960 $dbw->delete( 'user_groups',
1962 'ug_user' => $this->getID(),
1963 'ug_group' => $group,
1965 'User::removeGroup' );
1967 $this->loadGroups();
1968 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
1969 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
1971 $this->invalidateCache();
1976 * Get whether the user is logged in
1977 * @return \type{\bool} True or false
1979 function isLoggedIn() {
1980 return $this->getID() != 0;
1984 * Get whether the user is anonymous
1985 * @return \type{\bool} True or false
1988 return !$this->isLoggedIn();
1992 * Get whether the user is a bot
1993 * @return \type{\bool} True or false
1997 wfDeprecated( __METHOD__
);
1998 return $this->isAllowed( 'bot' );
2002 * Check if user is allowed to access a feature / make an action
2003 * @param $action \type{\string} action to be checked
2004 * @return \type{\bool} True if action is allowed, else false
2006 function isAllowed($action='') {
2007 if ( $action === '' )
2008 // In the spirit of DWIM
2011 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2012 # by misconfiguration: 0 == 'foo'
2013 return in_array( $action, $this->getRights(), true );
2017 * Check whether to enable recent changes patrol features for this user
2018 * @return \type{\bool} True or false
2020 public function useRCPatrol() {
2021 global $wgUseRCPatrol;
2022 return( $wgUseRCPatrol && ($this->isAllowed('patrol') ||
$this->isAllowed('patrolmarks')) );
2026 * Check whether to enable new pages patrol features for this user
2027 * @return \type{\bool} True or false
2029 public function useNPPatrol() {
2030 global $wgUseRCPatrol, $wgUseNPPatrol;
2031 return( ($wgUseRCPatrol ||
$wgUseNPPatrol) && ($this->isAllowed('patrol') ||
$this->isAllowed('patrolmarks')) );
2035 * Get the current skin, loading it if required
2036 * @return \type{Skin} Current skin
2037 * @todo FIXME : need to check the old failback system [AV]
2039 function &getSkin() {
2041 if ( ! isset( $this->mSkin
) ) {
2042 wfProfileIn( __METHOD__
);
2045 $userSkin = $this->getOption( 'skin' );
2046 $userSkin = $wgRequest->getVal('useskin', $userSkin);
2048 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2049 wfProfileOut( __METHOD__
);
2051 return $this->mSkin
;
2055 * Check the watched status of an article.
2056 * @param $title \type{Title} Title of the article to look at
2057 * @return \type{\bool} True if article is watched
2059 function isWatched( $title ) {
2060 $wl = WatchedItem
::fromUserTitle( $this, $title );
2061 return $wl->isWatched();
2066 * @param $title \type{Title} Title of the article to look at
2068 function addWatch( $title ) {
2069 $wl = WatchedItem
::fromUserTitle( $this, $title );
2071 $this->invalidateCache();
2075 * Stop watching an article.
2076 * @param $title \type{Title} Title of the article to look at
2078 function removeWatch( $title ) {
2079 $wl = WatchedItem
::fromUserTitle( $this, $title );
2081 $this->invalidateCache();
2085 * Clear the user's notification timestamp for the given title.
2086 * If e-notif e-mails are on, they will receive notification mails on
2087 * the next change of the page if it's watched etc.
2088 * @param $title \type{Title} Title of the article to look at
2090 function clearNotification( &$title ) {
2091 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2093 # Do nothing if the database is locked to writes
2094 if( wfReadOnly() ) {
2098 if ($title->getNamespace() == NS_USER_TALK
&&
2099 $title->getText() == $this->getName() ) {
2100 if (!wfRunHooks('UserClearNewTalkNotification', array(&$this)))
2102 $this->setNewtalk( false );
2105 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2109 if( $this->isAnon() ) {
2110 // Nothing else to do...
2114 // Only update the timestamp if the page is being watched.
2115 // The query to find out if it is watched is cached both in memcached and per-invocation,
2116 // and when it does have to be executed, it can be on a slave
2117 // If this is the user's newtalk page, we always update the timestamp
2118 if ($title->getNamespace() == NS_USER_TALK
&&
2119 $title->getText() == $wgUser->getName())
2122 } elseif ( $this->getId() == $wgUser->getId() ) {
2123 $watched = $title->userIsWatching();
2128 // If the page is watched by the user (or may be watched), update the timestamp on any
2129 // any matching rows
2131 $dbw = wfGetDB( DB_MASTER
);
2132 $dbw->update( 'watchlist',
2134 'wl_notificationtimestamp' => NULL
2135 ), array( /* WHERE */
2136 'wl_title' => $title->getDBkey(),
2137 'wl_namespace' => $title->getNamespace(),
2138 'wl_user' => $this->getID()
2145 * Resets all of the given user's page-change notification timestamps.
2146 * If e-notif e-mails are on, they will receive notification mails on
2147 * the next change of any watched page.
2149 * @param $currentUser \type{\int} %User ID
2151 function clearAllNotifications( $currentUser ) {
2152 global $wgUseEnotif, $wgShowUpdatedMarker;
2153 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2154 $this->setNewtalk( false );
2157 if( $currentUser != 0 ) {
2158 $dbw = wfGetDB( DB_MASTER
);
2159 $dbw->update( 'watchlist',
2161 'wl_notificationtimestamp' => NULL
2162 ), array( /* WHERE */
2163 'wl_user' => $currentUser
2166 # We also need to clear here the "you have new message" notification for the own user_talk page
2167 # This is cleared one page view later in Article::viewUpdates();
2172 * Encode this user's options as a string
2173 * @return \type{\string} Encoded options
2176 function encodeOptions() {
2178 if ( is_null( $this->mOptions
) ) {
2179 $this->mOptions
= User
::getDefaultOptions();
2182 foreach ( $this->mOptions
as $oname => $oval ) {
2183 array_push( $a, $oname.'='.$oval );
2185 $s = implode( "\n", $a );
2190 * Set this user's options from an encoded string
2191 * @param $str \type{\string} Encoded options to import
2194 function decodeOptions( $str ) {
2195 $this->mOptions
= array();
2196 $a = explode( "\n", $str );
2197 foreach ( $a as $s ) {
2199 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2200 $this->mOptions
[$m[1]] = $m[2];
2206 * Set a cookie on the user's client. Wrapper for
2207 * WebResponse::setCookie
2209 protected function setCookie( $name, $value, $exp=0 ) {
2211 $wgRequest->response()->setcookie( $name, $value, $exp );
2215 * Clear a cookie on the user's client
2216 * @param $name \type{\string} Name of the cookie to clear
2218 protected function clearCookie( $name ) {
2219 $this->setCookie( $name, '', time() - 86400 );
2223 * Set the default cookies for this session on the user's client.
2225 function setCookies() {
2227 if ( 0 == $this->mId
) return;
2229 'wsUserID' => $this->mId
,
2230 'wsToken' => $this->mToken
,
2231 'wsUserName' => $this->getName()
2234 'UserID' => $this->mId
,
2235 'UserName' => $this->getName(),
2237 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2238 $cookies['Token'] = $this->mToken
;
2240 $cookies['Token'] = false;
2243 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2244 $_SESSION = $session +
$_SESSION;
2245 foreach ( $cookies as $name => $value ) {
2246 if ( $value === false ) {
2247 $this->clearCookie( $name );
2249 $this->setCookie( $name, $value );
2255 * Log this user out.
2259 if( wfRunHooks( 'UserLogout', array(&$this) ) ) {
2265 * Clear the user's cookies and session, and reset the instance cache.
2269 function doLogout() {
2270 $this->clearInstanceCache( 'defaults' );
2272 $_SESSION['wsUserID'] = 0;
2274 $this->clearCookie( 'UserID' );
2275 $this->clearCookie( 'Token' );
2277 # Remember when user logged out, to prevent seeing cached pages
2278 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2282 * Save this user's settings into the database.
2283 * @todo Only rarely do all these fields need to be set!
2285 function saveSettings() {
2287 if ( wfReadOnly() ) { return; }
2288 if ( 0 == $this->mId
) { return; }
2290 $this->mTouched
= self
::newTouchedTimestamp();
2292 $dbw = wfGetDB( DB_MASTER
);
2293 $dbw->update( 'user',
2295 'user_name' => $this->mName
,
2296 'user_password' => $this->mPassword
,
2297 'user_newpassword' => $this->mNewpassword
,
2298 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2299 'user_real_name' => $this->mRealName
,
2300 'user_email' => $this->mEmail
,
2301 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2302 'user_options' => $this->encodeOptions(),
2303 'user_touched' => $dbw->timestamp($this->mTouched
),
2304 'user_token' => $this->mToken
,
2305 'user_email_token' => $this->mEmailToken
,
2306 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2307 ), array( /* WHERE */
2308 'user_id' => $this->mId
2311 wfRunHooks( 'UserSaveSettings', array( $this ) );
2312 $this->clearSharedCache();
2316 * If only this user's username is known, and it exists, return the user ID.
2318 function idForName() {
2319 $s = trim( $this->getName() );
2320 if ( $s === '' ) return 0;
2322 $dbr = wfGetDB( DB_SLAVE
);
2323 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2324 if ( $id === false ) {
2331 * Add a user to the database, return the user object
2333 * @param $name \type{\string} Username to add
2334 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2335 * - password The user's password. Password logins will be disabled if this is omitted.
2336 * - newpassword A temporary password mailed to the user
2337 * - email The user's email address
2338 * - email_authenticated The email authentication timestamp
2339 * - real_name The user's real name
2340 * - options An associative array of non-default options
2341 * - token Random authentication token. Do not set.
2342 * - registration Registration timestamp. Do not set.
2344 * @return \type{User} A new User object, or null if the username already exists
2346 static function createNew( $name, $params = array() ) {
2349 if ( isset( $params['options'] ) ) {
2350 $user->mOptions
= $params['options'] +
$user->mOptions
;
2351 unset( $params['options'] );
2353 $dbw = wfGetDB( DB_MASTER
);
2354 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2356 'user_id' => $seqVal,
2357 'user_name' => $name,
2358 'user_password' => $user->mPassword
,
2359 'user_newpassword' => $user->mNewpassword
,
2360 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2361 'user_email' => $user->mEmail
,
2362 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2363 'user_real_name' => $user->mRealName
,
2364 'user_options' => $user->encodeOptions(),
2365 'user_token' => $user->mToken
,
2366 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2367 'user_editcount' => 0,
2369 foreach ( $params as $name => $value ) {
2370 $fields["user_$name"] = $value;
2372 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2373 if ( $dbw->affectedRows() ) {
2374 $newUser = User
::newFromId( $dbw->insertId() );
2382 * Add this existing user object to the database
2384 function addToDatabase() {
2386 $dbw = wfGetDB( DB_MASTER
);
2387 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2388 $dbw->insert( 'user',
2390 'user_id' => $seqVal,
2391 'user_name' => $this->mName
,
2392 'user_password' => $this->mPassword
,
2393 'user_newpassword' => $this->mNewpassword
,
2394 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2395 'user_email' => $this->mEmail
,
2396 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2397 'user_real_name' => $this->mRealName
,
2398 'user_options' => $this->encodeOptions(),
2399 'user_token' => $this->mToken
,
2400 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2401 'user_editcount' => 0,
2404 $this->mId
= $dbw->insertId();
2406 // Clear instance cache other than user table data, which is already accurate
2407 $this->clearInstanceCache();
2411 * If this (non-anonymous) user is blocked, block any IP address
2412 * they've successfully logged in from.
2414 function spreadBlock() {
2415 wfDebug( __METHOD__
."()\n" );
2417 if ( $this->mId
== 0 ) {
2421 $userblock = Block
::newFromDB( '', $this->mId
);
2422 if ( !$userblock ) {
2426 $userblock->doAutoblock( wfGetIp() );
2431 * Generate a string which will be different for any combination of
2432 * user options which would produce different parser output.
2433 * This will be used as part of the hash key for the parser cache,
2434 * so users will the same options can share the same cached data
2437 * Extensions which require it should install 'PageRenderingHash' hook,
2438 * which will give them a chance to modify this key based on their own
2441 * @return \type{\string} Page rendering hash
2443 function getPageRenderingHash() {
2444 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2446 return $this->mHash
;
2449 // stubthreshold is only included below for completeness,
2450 // it will always be 0 when this function is called by parsercache.
2452 $confstr = $this->getOption( 'math' );
2453 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2454 if ( $wgUseDynamicDates ) {
2455 $confstr .= '!' . $this->getDatePreference();
2457 $confstr .= '!' . ($this->getOption( 'numberheadings' ) ?
'1' : '');
2458 $confstr .= '!' . $wgLang->getCode();
2459 $confstr .= '!' . $this->getOption( 'thumbsize' );
2460 // add in language specific options, if any
2461 $extra = $wgContLang->getExtraHashOptions();
2464 $confstr .= $wgRenderHashAppend;
2466 // Give a chance for extensions to modify the hash, if they have
2467 // extra options or other effects on the parser cache.
2468 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2470 // Make it a valid memcached key fragment
2471 $confstr = str_replace( ' ', '_', $confstr );
2472 $this->mHash
= $confstr;
2477 * Get whether the user is explicitly blocked from account creation.
2478 * @return \type{\bool} True if blocked
2480 function isBlockedFromCreateAccount() {
2481 $this->getBlockedStatus();
2482 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2486 * Get whether the user is blocked from using Special:Emailuser.
2487 * @return \type{\bool} True if blocked
2489 function isBlockedFromEmailuser() {
2490 $this->getBlockedStatus();
2491 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2495 * Get whether the user is allowed to create an account.
2496 * @return \type{\bool} True if allowed
2498 function isAllowedToCreateAccount() {
2499 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2505 function setLoaded( $loaded ) {
2506 wfDeprecated( __METHOD__
);
2510 * Get this user's personal page title.
2512 * @return \type{Title} User's personal page title
2514 function getUserPage() {
2515 return Title
::makeTitle( NS_USER
, $this->getName() );
2519 * Get this user's talk page title.
2521 * @return \type{Title} User's talk page title
2523 function getTalkPage() {
2524 $title = $this->getUserPage();
2525 return $title->getTalkPage();
2529 * Get the maximum valid user ID.
2530 * @return \type{\int} %User ID
2533 function getMaxID() {
2534 static $res; // cache
2536 if ( isset( $res ) )
2539 $dbr = wfGetDB( DB_SLAVE
);
2540 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2545 * Determine whether the user is a newbie. Newbies are either
2546 * anonymous IPs, or the most recently created accounts.
2547 * @return \type{\bool} True if the user is a newbie
2549 function isNewbie() {
2550 return !$this->isAllowed( 'autoconfirmed' );
2554 * Is the user active? We check to see if they've made at least
2555 * X number of edits in the last Y days.
2557 * @return \type{\bool} True if the user is active, false if not.
2559 public function isActiveEditor() {
2560 global $wgActiveUserEditCount, $wgActiveUserDays;
2561 $dbr = wfGetDB( DB_SLAVE
);
2563 // Stolen without shame from RC
2564 $cutoff_unixtime = time() - ( $wgActiveUserDays * 86400 );
2565 $cutoff_unixtime = $cutoff_unixtime - ( $cutoff_unixtime %
86400 );
2566 $oldTime = $dbr->addQuotes( $dbr->timestamp( $cutoff_unixtime ) );
2568 $res = $dbr->select( 'revision', '1',
2569 array( 'rev_user_text' => $this->getName(), "rev_timestamp > $oldTime"),
2571 array('LIMIT' => $wgActiveUserEditCount ) );
2573 $count = $dbr->numRows($res);
2574 $dbr->freeResult($res);
2576 return $count == $wgActiveUserEditCount;
2580 * Check to see if the given clear-text password is one of the accepted passwords
2581 * @param $password \type{\string} user password.
2582 * @return \type{\bool} True if the given password is correct, otherwise False.
2584 function checkPassword( $password ) {
2588 // Even though we stop people from creating passwords that
2589 // are shorter than this, doesn't mean people wont be able
2590 // to. Certain authentication plugins do NOT want to save
2591 // domain passwords in a mysql database, so we should
2592 // check this (incase $wgAuth->strict() is false).
2593 if( !$this->isValidPassword( $password ) ) {
2597 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2599 } elseif( $wgAuth->strict() ) {
2600 /* Auth plugin doesn't allow local authentication */
2602 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2603 /* Auth plugin doesn't allow local authentication for this user name */
2606 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2608 } elseif ( function_exists( 'iconv' ) ) {
2609 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2610 # Check for this with iconv
2611 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2612 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2620 * Check if the given clear-text password matches the temporary password
2621 * sent by e-mail for password reset operations.
2622 * @return \type{\bool} True if matches, false otherwise
2624 function checkTemporaryPassword( $plaintext ) {
2625 return self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() );
2629 * Initialize (if necessary) and return a session token value
2630 * which can be used in edit forms to show that the user's
2631 * login credentials aren't being hijacked with a foreign form
2634 * @param $salt \twotypes{\string,\arrayof{\string}} Optional function-specific data for hashing
2635 * @return \type{\string} The new edit token
2637 function editToken( $salt = '' ) {
2638 if ( $this->isAnon() ) {
2639 return EDIT_TOKEN_SUFFIX
;
2641 if( !isset( $_SESSION['wsEditToken'] ) ) {
2642 $token = $this->generateToken();
2643 $_SESSION['wsEditToken'] = $token;
2645 $token = $_SESSION['wsEditToken'];
2647 if( is_array( $salt ) ) {
2648 $salt = implode( '|', $salt );
2650 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2655 * Generate a looking random token for various uses.
2657 * @param $salt \type{\string} Optional salt value
2658 * @return \type{\string} The new random token
2660 function generateToken( $salt = '' ) {
2661 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2662 return md5( $token . $salt );
2666 * Check given value against the token value stored in the session.
2667 * A match should confirm that the form was submitted from the
2668 * user's own login session, not a form submission from a third-party
2671 * @param $val \type{\string} Input value to compare
2672 * @param $salt \type{\string} Optional function-specific data for hashing
2673 * @return \type{\bool} Whether the token matches
2675 function matchEditToken( $val, $salt = '' ) {
2676 $sessionToken = $this->editToken( $salt );
2677 if ( $val != $sessionToken ) {
2678 wfDebug( "User::matchEditToken: broken session data\n" );
2680 return $val == $sessionToken;
2684 * Check given value against the token value stored in the session,
2685 * ignoring the suffix.
2687 * @param $val \type{\string} Input value to compare
2688 * @param $salt \type{\string} Optional function-specific data for hashing
2689 * @return \type{\bool} Whether the token matches
2691 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2692 $sessionToken = $this->editToken( $salt );
2693 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2697 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2698 * mail to the user's given address.
2700 * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure.
2702 function sendConfirmationMail() {
2704 $expiration = null; // gets passed-by-ref and defined in next line.
2705 $token = $this->confirmationToken( $expiration );
2706 $url = $this->confirmationTokenUrl( $token );
2707 $invalidateURL = $this->invalidationTokenUrl( $token );
2708 $this->saveSettings();
2710 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2711 wfMsg( 'confirmemail_body',
2715 $wgLang->timeanddate( $expiration, false ),
2720 * Send an e-mail to this user's account. Does not check for
2721 * confirmed status or validity.
2723 * @param $subject \type{\string} Message subject
2724 * @param $body \type{\string} Message body
2725 * @param $from \type{\string} Optional From address; if unspecified, default $wgPasswordSender will be used
2726 * @param $replyto \type{\string} Reply-to address
2727 * @return \twotypes{\bool,WikiError} True on success, a WikiError object on failure
2729 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2730 if( is_null( $from ) ) {
2731 global $wgPasswordSender;
2732 $from = $wgPasswordSender;
2735 $to = new MailAddress( $this );
2736 $sender = new MailAddress( $from );
2737 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2741 * Generate, store, and return a new e-mail confirmation code.
2742 * A hash (unsalted, since it's used as a key) is stored.
2744 * @note Call saveSettings() after calling this function to commit
2745 * this change to the database.
2747 * @param[out] &$expiration \type{\mixed} Accepts the expiration time
2748 * @return \type{\string} New token
2751 function confirmationToken( &$expiration ) {
2753 $expires = $now +
7 * 24 * 60 * 60;
2754 $expiration = wfTimestamp( TS_MW
, $expires );
2755 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2756 $hash = md5( $token );
2758 $this->mEmailToken
= $hash;
2759 $this->mEmailTokenExpires
= $expiration;
2764 * Return a URL the user can use to confirm their email address.
2765 * @param $token \type{\string} Accepts the email confirmation token
2766 * @return \type{\string} New token URL
2769 function confirmationTokenUrl( $token ) {
2770 return $this->getTokenUrl( 'ConfirmEmail', $token );
2773 * Return a URL the user can use to invalidate their email address.
2775 * @param $token \type{\string} Accepts the email confirmation token
2776 * @return \type{\string} New token URL
2779 function invalidationTokenUrl( $token ) {
2780 return $this->getTokenUrl( 'Invalidateemail', $token );
2784 * Internal function to format the e-mail validation/invalidation URLs.
2785 * This uses $wgArticlePath directly as a quickie hack to use the
2786 * hardcoded English names of the Special: pages, for ASCII safety.
2788 * @note Since these URLs get dropped directly into emails, using the
2789 * short English names avoids insanely long URL-encoded links, which
2790 * also sometimes can get corrupted in some browsers/mailers
2791 * (bug 6957 with Gmail and Internet Explorer).
2793 * @param $page \type{\string} Special page
2794 * @param $token \type{\string} Token
2795 * @return \type{\string} Formatted URL
2797 protected function getTokenUrl( $page, $token ) {
2798 global $wgArticlePath;
2802 "Special:$page/$token",
2807 * Mark the e-mail address confirmed.
2809 * @note Call saveSettings() after calling this function to commit the change.
2811 function confirmEmail() {
2812 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2817 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2818 * address if it was already confirmed.
2820 * @note Call saveSettings() after calling this function to commit the change.
2822 function invalidateEmail() {
2824 $this->mEmailToken
= null;
2825 $this->mEmailTokenExpires
= null;
2826 $this->setEmailAuthenticationTimestamp( null );
2831 * Set the e-mail authentication timestamp.
2832 * @param $timestamp \type{\string} TS_MW timestamp
2834 function setEmailAuthenticationTimestamp( $timestamp ) {
2836 $this->mEmailAuthenticated
= $timestamp;
2837 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2841 * Is this user allowed to send e-mails within limits of current
2842 * site configuration?
2843 * @return \type{\bool} True if allowed
2845 function canSendEmail() {
2846 $canSend = $this->isEmailConfirmed();
2847 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
2852 * Is this user allowed to receive e-mails within limits of current
2853 * site configuration?
2854 * @return \type{\bool} True if allowed
2856 function canReceiveEmail() {
2857 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
2861 * Is this user's e-mail address valid-looking and confirmed within
2862 * limits of the current site configuration?
2864 * @note If $wgEmailAuthentication is on, this may require the user to have
2865 * confirmed their address by returning a code or using a password
2866 * sent to the address from the wiki.
2868 * @return \type{\bool} True if confirmed
2870 function isEmailConfirmed() {
2871 global $wgEmailAuthentication;
2874 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
2875 if( $this->isAnon() )
2877 if( !self
::isValidEmailAddr( $this->mEmail
) )
2879 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
2888 * Check whether there is an outstanding request for e-mail confirmation.
2889 * @return \type{\bool} True if pending
2891 function isEmailConfirmationPending() {
2892 global $wgEmailAuthentication;
2893 return $wgEmailAuthentication &&
2894 !$this->isEmailConfirmed() &&
2895 $this->mEmailToken
&&
2896 $this->mEmailTokenExpires
> wfTimestamp();
2900 * Get the timestamp of account creation.
2902 * @return \twotypes{\string,\bool} string Timestamp of account creation, or false for
2903 * non-existent/anonymous user accounts.
2905 public function getRegistration() {
2906 return $this->mId
> 0
2907 ?
$this->mRegistration
2912 * Get the permissions associated with a given list of groups
2914 * @param $groups \type{\arrayof{\string}} List of internal group names
2915 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
2917 static function getGroupPermissions( $groups ) {
2918 global $wgGroupPermissions;
2920 foreach( $groups as $group ) {
2921 if( isset( $wgGroupPermissions[$group] ) ) {
2922 $rights = array_merge( $rights,
2923 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
2930 * Get all the groups who have a given permission
2932 * @param $role \type{\string} Role to check
2933 * @return \type{\arrayof{\string}} List of internal group names with the given permission
2935 static function getGroupsWithPermission( $role ) {
2936 global $wgGroupPermissions;
2937 $allowedGroups = array();
2938 foreach ( $wgGroupPermissions as $group => $rights ) {
2939 if ( isset( $rights[$role] ) && $rights[$role] ) {
2940 $allowedGroups[] = $group;
2943 return $allowedGroups;
2947 * Get the localized descriptive name for a group, if it exists
2949 * @param $group \type{\string} Internal group name
2950 * @return \type{\string} Localized descriptive group name
2952 static function getGroupName( $group ) {
2953 global $wgMessageCache;
2954 $wgMessageCache->loadAllMessages();
2955 $key = "group-$group";
2956 $name = wfMsg( $key );
2957 return $name == '' ||
wfEmptyMsg( $key, $name )
2963 * Get the localized descriptive name for a member of a group, if it exists
2965 * @param $group \type{\string} Internal group name
2966 * @return \type{\string} Localized name for group member
2968 static function getGroupMember( $group ) {
2969 global $wgMessageCache;
2970 $wgMessageCache->loadAllMessages();
2971 $key = "group-$group-member";
2972 $name = wfMsg( $key );
2973 return $name == '' ||
wfEmptyMsg( $key, $name )
2979 * Return the set of defined explicit groups.
2980 * The implicit groups (by default *, 'user' and 'autoconfirmed')
2981 * are not included, as they are defined automatically, not in the database.
2982 * @return \type{\arrayof{\string}} Array of internal group names
2984 static function getAllGroups() {
2985 global $wgGroupPermissions;
2987 array_keys( $wgGroupPermissions ),
2988 self
::getImplicitGroups()
2993 * Get a list of all available permissions.
2994 * @return \type{\arrayof{\string}} Array of permission names
2996 static function getAllRights() {
2997 if ( self
::$mAllRights === false ) {
2998 global $wgAvailableRights;
2999 if ( count( $wgAvailableRights ) ) {
3000 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3002 self
::$mAllRights = self
::$mCoreRights;
3004 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3006 return self
::$mAllRights;
3010 * Get a list of implicit groups
3011 * @return \type{\arrayof{\string}} Array of internal group names
3013 public static function getImplicitGroups() {
3014 global $wgImplicitGroups;
3015 $groups = $wgImplicitGroups;
3016 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3021 * Get the title of a page describing a particular group
3023 * @param $group \type{\string} Internal group name
3024 * @return \twotypes{Title,\bool} Title of the page if it exists, false otherwise
3026 static function getGroupPage( $group ) {
3027 global $wgMessageCache;
3028 $wgMessageCache->loadAllMessages();
3029 $page = wfMsgForContent( 'grouppage-' . $group );
3030 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3031 $title = Title
::newFromText( $page );
3032 if( is_object( $title ) )
3039 * Create a link to the group in HTML, if available;
3040 * else return the group name.
3042 * @param $group \type{\string} Internal name of the group
3043 * @param $text \type{\string} The text of the link
3044 * @return \type{\string} HTML link to the group
3046 static function makeGroupLinkHTML( $group, $text = '' ) {
3048 $text = self
::getGroupName( $group );
3050 $title = self
::getGroupPage( $group );
3053 $sk = $wgUser->getSkin();
3054 return $sk->makeLinkObj( $title, htmlspecialchars( $text ) );
3061 * Create a link to the group in Wikitext, if available;
3062 * else return the group name.
3064 * @param $group \type{\string} Internal name of the group
3065 * @param $text \type{\string} The text of the link
3066 * @return \type{\string} Wikilink to the group
3068 static function makeGroupLinkWiki( $group, $text = '' ) {
3070 $text = self
::getGroupName( $group );
3072 $title = self
::getGroupPage( $group );
3074 $page = $title->getPrefixedText();
3075 return "[[$page|$text]]";
3082 * Increment the user's edit-count field.
3083 * Will have no effect for anonymous users.
3085 function incEditCount() {
3086 if( !$this->isAnon() ) {
3087 $dbw = wfGetDB( DB_MASTER
);
3088 $dbw->update( 'user',
3089 array( 'user_editcount=user_editcount+1' ),
3090 array( 'user_id' => $this->getId() ),
3093 // Lazy initialization check...
3094 if( $dbw->affectedRows() == 0 ) {
3095 // Pull from a slave to be less cruel to servers
3096 // Accuracy isn't the point anyway here
3097 $dbr = wfGetDB( DB_SLAVE
);
3098 $count = $dbr->selectField( 'revision',
3100 array( 'rev_user' => $this->getId() ),
3103 // Now here's a goddamn hack...
3104 if( $dbr !== $dbw ) {
3105 // If we actually have a slave server, the count is
3106 // at least one behind because the current transaction
3107 // has not been committed and replicated.
3110 // But if DB_SLAVE is selecting the master, then the
3111 // count we just read includes the revision that was
3112 // just added in the working transaction.
3115 $dbw->update( 'user',
3116 array( 'user_editcount' => $count ),
3117 array( 'user_id' => $this->getId() ),
3121 // edit count in user cache too
3122 $this->invalidateCache();
3126 * Get the description of a given right
3128 * @param $right \type{\string} Right to query
3129 * @return \type{\string} Localized description of the right
3131 static function getRightDescription( $right ) {
3132 global $wgMessageCache;
3133 $wgMessageCache->loadAllMessages();
3134 $key = "right-$right";
3135 $name = wfMsg( $key );
3136 return $name == '' ||
wfEmptyMsg( $key, $name )
3142 * Make an old-style password hash
3144 * @param $password \type{\string} Plain-text password
3145 * @param $userId \type{\string} %User ID
3146 * @return \type{\string} Password hash
3148 static function oldCrypt( $password, $userId ) {
3149 global $wgPasswordSalt;
3150 if ( $wgPasswordSalt ) {
3151 return md5( $userId . '-' . md5( $password ) );
3153 return md5( $password );
3158 * Make a new-style password hash
3160 * @param $password \type{\string} Plain-text password
3161 * @param $salt \type{\string} Optional salt, may be random or the user ID.
3162 * If unspecified or false, will generate one automatically
3163 * @return \type{\string} Password hash
3165 static function crypt( $password, $salt = false ) {
3166 global $wgPasswordSalt;
3168 if($wgPasswordSalt) {
3169 if ( $salt === false ) {
3170 $salt = substr( wfGenerateToken(), 0, 8 );
3172 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3174 return ':A:' . md5( $password);
3179 * Compare a password hash with a plain-text password. Requires the user
3180 * ID if there's a chance that the hash is an old-style hash.
3182 * @param $hash \type{\string} Password hash
3183 * @param $password \type{\string} Plain-text password to compare
3184 * @param $userId \type{\string} %User ID for old-style password salt
3185 * @return \type{\bool} True if matches, false otherwise
3187 static function comparePasswords( $hash, $password, $userId = false ) {
3189 $type = substr( $hash, 0, 3 );
3190 if ( $type == ':A:' ) {
3192 return md5( $password ) === substr( $hash, 3 );
3193 } elseif ( $type == ':B:' ) {
3195 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3196 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3199 return self
::oldCrypt( $password, $userId ) === $hash;
3204 * Add a newuser log entry for this user
3205 * @param bool $byEmail, account made by email?
3207 public function addNewUserLogEntry( $byEmail = false ) {
3208 global $wgUser, $wgContLang, $wgNewUserLog;
3209 if( empty($wgNewUserLog) ) {
3210 return true; // disabled
3212 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3213 if( $this->getName() == $wgUser->getName() ) {
3217 $action = 'create2';
3218 $message = $byEmail ?
wfMsgForContent( 'newuserlog-byemail' ) : '';
3220 $log = new LogPage( 'newusers' );
3221 $log->addEntry( $action, $this->getUserPage(), $message, array( $this->getId() ) );
3226 * Add an autocreate newuser log entry for this user
3227 * Used by things like CentralAuth and perhaps other authplugins.
3229 public function addNewUserLogEntryAutoCreate() {
3230 global $wgNewUserLog;
3231 if( empty($wgNewUserLog) ) {
3232 return true; // disabled
3234 $log = new LogPage( 'newusers', false );
3235 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );