7 # Number of characters in user_token field
8 define( 'USER_TOKEN_LENGTH', 32 );
10 # Serialized record version
11 define( 'MW_USER_VERSION', 5 );
13 # Some punctuation to prevent editing from broken text-mangling proxies.
14 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
17 * Thrown by User::setPassword() on error
18 * @addtogroup Exception
20 class PasswordError
extends MWException
{
25 * The User object encapsulates all of the user-specific settings (user_id,
26 * name, rights, password, email address, options, last login time). Client
27 * classes use the getXXX() functions to access these fields. These functions
28 * do all the work of determining whether the user is logged in,
29 * whether the requested option can be satisfied from cookies or
30 * whether a database query is needed. Most of the settings needed
31 * for rendering normal pages are set in the cookie to minimize use
37 * A list of default user toggles, i.e. boolean user preferences that are
38 * displayed by Special:Preferences as checkboxes. This list can be
39 * extended via the UserToggles hook or $wgContLang->getExtraUserToggles().
41 static public $mToggles = array(
51 'editsectiononrightclick',
63 'enotifwatchlistpages',
64 'enotifusertalkpages',
67 'shownumberswatching',
82 * List of member variables which are saved to the shared cache (memcached).
83 * Any operation which changes the corresponding database fields must
84 * call a cache-clearing function.
86 static $mCacheVars = array(
98 'mEmailAuthenticated',
100 'mEmailTokenExpires',
108 * The cache variable declarations
110 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
111 $mEmail, $mOptions, $mTouched, $mToken, $mEmailAuthenticated,
112 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups;
115 * Whether the cache variables have been loaded
120 * Initialisation data source if mDataLoaded==false. May be one of:
121 * defaults anonymous user initialised from class defaults
122 * name initialise from mName
123 * id initialise from mId
124 * session log in from cookies or session if possible
126 * Use the User::newFrom*() family of functions to set this.
131 * Lazy-initialised variables, invalidated with clearInstanceCache
133 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
134 $mBlockreason, $mBlock, $mEffectiveGroups;
137 * Lightweight constructor for anonymous user
138 * Use the User::newFrom* factory functions for other kinds of users
141 $this->clearInstanceCache( 'defaults' );
145 * Load the user table data for this object from the source given by mFrom
148 if ( $this->mDataLoaded
) {
151 wfProfileIn( __METHOD__
);
153 # Set it now to avoid infinite recursion in accessors
154 $this->mDataLoaded
= true;
156 switch ( $this->mFrom
) {
158 $this->loadDefaults();
161 $this->mId
= self
::idFromName( $this->mName
);
163 # Nonexistent user placeholder object
164 $this->loadDefaults( $this->mName
);
173 $this->loadFromSession();
176 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
178 wfProfileOut( __METHOD__
);
182 * Load user table data given mId
183 * @return false if the ID does not exist, true otherwise
186 function loadFromId() {
188 if ( $this->mId
== 0 ) {
189 $this->loadDefaults();
194 $key = wfMemcKey( 'user', 'id', $this->mId
);
195 $data = $wgMemc->get( $key );
196 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
197 # Object is expired, load from DB
202 wfDebug( "Cache miss for user {$this->mId}\n" );
204 if ( !$this->loadFromDatabase() ) {
205 # Can't load from ID, user is anonymous
211 foreach ( self
::$mCacheVars as $name ) {
212 $data[$name] = $this->$name;
214 $data['mVersion'] = MW_USER_VERSION
;
215 $wgMemc->set( $key, $data );
217 wfDebug( "Got user {$this->mId} from cache\n" );
219 foreach ( self
::$mCacheVars as $name ) {
220 $this->$name = $data[$name];
227 * Static factory method for creation from username.
229 * This is slightly less efficient than newFromId(), so use newFromId() if
230 * you have both an ID and a name handy.
232 * @param string $name Username, validated by Title:newFromText()
233 * @param mixed $validate Validate username. Takes the same parameters as
234 * User::getCanonicalName(), except that true is accepted as an alias
235 * for 'valid', for BC.
237 * @return User object, or null if the username is invalid. If the username
238 * is not present in the database, the result will be a user object with
239 * a name, zero user ID and default settings.
242 static function newFromName( $name, $validate = 'valid' ) {
243 if ( $validate === true ) {
246 $name = self
::getCanonicalName( $name, $validate );
247 if ( $name === false ) {
250 # Create unloaded user object
258 static function newFromId( $id ) {
266 * Factory method to fetch whichever user has a given email confirmation code.
267 * This code is generated when an account is created or its e-mail address
270 * If the code is invalid or has expired, returns NULL.
272 * @param string $code
276 static function newFromConfirmationCode( $code ) {
277 $dbr = wfGetDB( DB_SLAVE
);
278 $id = $dbr->selectField( 'user', 'user_id', array(
279 'user_email_token' => md5( $code ),
280 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
282 if( $id !== false ) {
283 return User
::newFromId( $id );
290 * Create a new user object using data from session or cookies. If the
291 * login credentials are invalid, the result is an anonymous user.
296 static function newFromSession() {
298 $user->mFrom
= 'session';
303 * Get username given an id.
304 * @param integer $id Database user id
305 * @return string Nickname of a user
308 static function whoIs( $id ) {
309 $dbr = wfGetDB( DB_SLAVE
);
310 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
314 * Get real username given an id.
315 * @param integer $id Database user id
316 * @return string Realname of a user
319 static function whoIsReal( $id ) {
320 $dbr = wfGetDB( DB_SLAVE
);
321 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), 'User::whoIsReal' );
325 * Get database id given a user name
326 * @param string $name Nickname of a user
327 * @return integer|null Database user id (null: if non existent
330 static function idFromName( $name ) {
331 $nt = Title
::newFromText( $name );
332 if( is_null( $nt ) ) {
336 $dbr = wfGetDB( DB_SLAVE
);
337 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
339 if ( $s === false ) {
347 * Does the string match an anonymous IPv4 address?
349 * This function exists for username validation, in order to reject
350 * usernames which are similar in form to IP addresses. Strings such
351 * as 300.300.300.300 will return true because it looks like an IP
352 * address, despite not being strictly valid.
354 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
355 * address because the usemod software would "cloak" anonymous IP
356 * addresses like this, if we allowed accounts like this to be created
357 * new users could get the old edits of these anonymous users.
360 * @param string $name Nickname of a user
363 static function isIP( $name ) {
364 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || User
::isIPv6($name);
365 /*return preg_match("/^
366 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
367 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
368 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
369 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))
374 * Check if $name is an IPv6 IP.
376 static function isIPv6($name) {
378 * if it has any non-valid characters, it can't be a valid IPv6
381 if (preg_match("/[^:a-fA-F0-9]/", $name))
384 $parts = explode(":", $name);
385 if (count($parts) < 3)
387 foreach ($parts as $part) {
388 if (!preg_match("/^[0-9a-fA-F]{0,4}$/", $part))
395 * Is the input a valid username?
397 * Checks if the input is a valid username, we don't want an empty string,
398 * an IP address, anything that containins slashes (would mess up subpages),
399 * is longer than the maximum allowed username size or doesn't begin with
402 * @param string $name
406 static function isValidUserName( $name ) {
407 global $wgContLang, $wgMaxNameChars;
410 || User
::isIP( $name )
411 ||
strpos( $name, '/' ) !== false
412 ||
strlen( $name ) > $wgMaxNameChars
413 ||
$name != $wgContLang->ucfirst( $name ) )
416 // Ensure that the name can't be misresolved as a different title,
417 // such as with extra namespace keys at the start.
418 $parsed = Title
::newFromText( $name );
419 if( is_null( $parsed )
420 ||
$parsed->getNamespace()
421 ||
strcmp( $name, $parsed->getPrefixedText() ) )
424 // Check an additional blacklist of troublemaker characters.
425 // Should these be merged into the title char list?
426 $unicodeBlacklist = '/[' .
427 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
428 '\x{00a0}' . # non-breaking space
429 '\x{2000}-\x{200f}' . # various whitespace
430 '\x{2028}-\x{202f}' . # breaks and control chars
431 '\x{3000}' . # ideographic space
432 '\x{e000}-\x{f8ff}' . # private use
434 if( preg_match( $unicodeBlacklist, $name ) ) {
442 * Usernames which fail to pass this function will be blocked
443 * from user login and new account registrations, but may be used
444 * internally by batch processes.
446 * If an account already exists in this form, login will be blocked
447 * by a failure to pass this function.
449 * @param string $name
452 static function isUsableName( $name ) {
453 global $wgReservedUsernames;
455 // Must be a usable username, obviously ;)
456 self
::isValidUserName( $name ) &&
458 // Certain names may be reserved for batch processes.
459 !in_array( $name, $wgReservedUsernames );
463 * Usernames which fail to pass this function will be blocked
464 * from new account registrations, but may be used internally
465 * either by batch processes or by user accounts which have
466 * already been created.
468 * Additional character blacklisting may be added here
469 * rather than in isValidUserName() to avoid disrupting
472 * @param string $name
475 static function isCreatableName( $name ) {
477 self
::isUsableName( $name ) &&
479 // Registration-time character blacklisting...
480 strpos( $name, '@' ) === false;
484 * Is the input a valid password?
486 * @param string $password
489 function isValidPassword( $password ) {
490 global $wgMinimalPasswordLength, $wgContLang;
493 if( !wfRunHooks( 'isValidPassword', array( $password, &$result ) ) ) return $result;
494 if ($result === false) return false;
495 return (strlen( $password ) >= $wgMinimalPasswordLength) &&
496 ($wgContLang->lc( $password ) !== $wgContLang->lc( $this->mName
));
500 * Does a string look like an email address?
502 * There used to be a regular expression here, it got removed because it
503 * rejected valid addresses. Actually just check if there is '@' somewhere
504 * in the given address.
506 * @todo Check for RFC 2822 compilance (bug 959)
508 * @param string $addr email address
511 public static function isValidEmailAddr( $addr ) {
512 return strpos( $addr, '@' ) !== false;
516 * Given unvalidated user input, return a canonical username, or false if
517 * the username is invalid.
518 * @param string $name
519 * @param mixed $validate Type of validation to use:
520 * false No validation
521 * 'valid' Valid for batch processes
522 * 'usable' Valid for batch processes and login
523 * 'creatable' Valid for batch processes, login and account creation
525 static function getCanonicalName( $name, $validate = 'valid' ) {
526 # Force usernames to capital
528 $name = $wgContLang->ucfirst( $name );
530 # Reject names containing '#'; these will be cleaned up
531 # with title normalisation, but then it's too late to
533 if( strpos( $name, '#' ) !== false )
536 # Clean up name according to title rules
537 $t = Title
::newFromText( $name );
538 if( is_null( $t ) ) {
542 # Reject various classes of invalid names
543 $name = $t->getText();
545 $name = $wgAuth->getCanonicalName( $t->getText() );
547 switch ( $validate ) {
551 if ( !User
::isValidUserName( $name ) ) {
556 if ( !User
::isUsableName( $name ) ) {
561 if ( !User
::isCreatableName( $name ) ) {
566 throw new MWException( 'Invalid parameter value for $validate in '.__METHOD__
);
572 * Count the number of edits of a user
574 * It should not be static and some day should be merged as proper member function / deprecated -- domas
576 * @param int $uid The user ID to check
580 static function edits( $uid ) {
581 wfProfileIn( __METHOD__
);
582 $dbr = wfGetDB( DB_SLAVE
);
583 // check if the user_editcount field has been initialized
584 $field = $dbr->selectField(
585 'user', 'user_editcount',
586 array( 'user_id' => $uid ),
590 if( $field === null ) { // it has not been initialized. do so.
591 $dbw = wfGetDb( DB_MASTER
);
592 $count = $dbr->selectField(
593 'revision', 'count(*)',
594 array( 'rev_user' => $uid ),
599 array( 'user_editcount' => $count ),
600 array( 'user_id' => $uid ),
606 wfProfileOut( __METHOD__
);
611 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
612 * @todo hash random numbers to improve security, like generateToken()
617 static function randomPassword() {
618 global $wgMinimalPasswordLength;
619 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
620 $l = strlen( $pwchars ) - 1;
622 $pwlength = max( 7, $wgMinimalPasswordLength );
623 $digit = mt_rand(0, $pwlength - 1);
625 for ( $i = 0; $i < $pwlength; $i++
) {
626 $np .= $i == $digit ?
chr( mt_rand(48, 57) ) : $pwchars{ mt_rand(0, $l)};
632 * Set cached properties to default. Note: this no longer clears
633 * uncached lazy-initialised properties. The constructor does that instead.
637 function loadDefaults( $name = false ) {
638 wfProfileIn( __METHOD__
);
640 global $wgCookiePrefix;
643 $this->mName
= $name;
644 $this->mRealName
= '';
645 $this->mPassword
= $this->mNewpassword
= '';
646 $this->mNewpassTime
= null;
648 $this->mOptions
= null; # Defer init
650 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
651 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
653 $this->mTouched
= '0'; # Allow any pages to be cached
656 $this->setToken(); # Random
657 $this->mEmailAuthenticated
= null;
658 $this->mEmailToken
= '';
659 $this->mEmailTokenExpires
= null;
660 $this->mRegistration
= wfTimestamp( TS_MW
);
661 $this->mGroups
= array();
663 wfProfileOut( __METHOD__
);
667 * Initialise php session
668 * @deprecated use wfSetupSession()
670 function SetupSession() {
675 * Load user data from the session or login cookie. If there are no valid
676 * credentials, initialises the user as an anon.
677 * @return true if the user is logged in, false otherwise
679 private function loadFromSession() {
680 global $wgMemc, $wgCookiePrefix;
682 if ( isset( $_SESSION['wsUserID'] ) ) {
683 if ( 0 != $_SESSION['wsUserID'] ) {
684 $sId = $_SESSION['wsUserID'];
686 $this->loadDefaults();
689 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
690 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
691 $_SESSION['wsUserID'] = $sId;
693 $this->loadDefaults();
696 if ( isset( $_SESSION['wsUserName'] ) ) {
697 $sName = $_SESSION['wsUserName'];
698 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
699 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
700 $_SESSION['wsUserName'] = $sName;
702 $this->loadDefaults();
706 $passwordCorrect = FALSE;
708 if ( !$this->loadFromId() ) {
709 # Not a valid ID, loadFromId has switched the object to anon for us
713 if ( isset( $_SESSION['wsToken'] ) ) {
714 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
716 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
717 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
720 # No session or persistent login cookie
721 $this->loadDefaults();
725 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
726 $_SESSION['wsToken'] = $this->mToken
;
727 wfDebug( "Logged in from $from\n" );
730 # Invalid credentials
731 wfDebug( "Can't log in from $from, invalid credentials\n" );
732 $this->loadDefaults();
738 * Load user and user_group data from the database
739 * $this->mId must be set, this is how the user is identified.
741 * @return true if the user exists, false if the user is anonymous
744 function loadFromDatabase() {
746 $this->mId
= intval( $this->mId
);
748 /** Anonymous user */
750 $this->loadDefaults();
754 $dbr = wfGetDB( DB_MASTER
);
755 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
757 if ( $s !== false ) {
758 # Initialise user table data
759 $this->mName
= $s->user_name
;
760 $this->mRealName
= $s->user_real_name
;
761 $this->mPassword
= $s->user_password
;
762 $this->mNewpassword
= $s->user_newpassword
;
763 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $s->user_newpass_time
);
764 $this->mEmail
= $s->user_email
;
765 $this->decodeOptions( $s->user_options
);
766 $this->mTouched
= wfTimestamp(TS_MW
,$s->user_touched
);
767 $this->mToken
= $s->user_token
;
768 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $s->user_email_authenticated
);
769 $this->mEmailToken
= $s->user_email_token
;
770 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $s->user_email_token_expires
);
771 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $s->user_registration
);
772 $this->mEditCount
= $s->user_editcount
;
773 $this->getEditCount(); // revalidation for nulls
776 $res = $dbr->select( 'user_groups',
778 array( 'ug_user' => $this->mId
),
780 $this->mGroups
= array();
781 while( $row = $dbr->fetchObject( $res ) ) {
782 $this->mGroups
[] = $row->ug_group
;
788 $this->loadDefaults();
794 * Clear various cached data stored in this object.
795 * @param string $reloadFrom Reload user and user_groups table data from a
796 * given source. May be "name", "id", "defaults", "session" or false for
799 function clearInstanceCache( $reloadFrom = false ) {
800 $this->mNewtalk
= -1;
801 $this->mDatePreference
= null;
802 $this->mBlockedby
= -1; # Unset
803 $this->mHash
= false;
805 $this->mRights
= null;
806 $this->mEffectiveGroups
= null;
809 $this->mDataLoaded
= false;
810 $this->mFrom
= $reloadFrom;
815 * Combine the language default options with any site-specific options
816 * and add the default language variants.
817 * Not really private cause it's called by Language class
822 static function getDefaultOptions() {
823 global $wgNamespacesToBeSearchedDefault;
825 * Site defaults will override the global/language defaults
827 global $wgDefaultUserOptions, $wgContLang;
828 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
831 * default language setting
833 $variant = $wgContLang->getPreferredVariant( false );
834 $defOpt['variant'] = $variant;
835 $defOpt['language'] = $variant;
837 foreach( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
838 $defOpt['searchNs'.$nsnum] = $val;
844 * Get a given default option value.
851 function getDefaultOption( $opt ) {
852 $defOpts = User
::getDefaultOptions();
853 if( isset( $defOpts[$opt] ) ) {
854 return $defOpts[$opt];
861 * Get a list of user toggle names
864 static function getToggles() {
866 $extraToggles = array();
867 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
868 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
873 * Get blocking information
875 * @param bool $bFromSlave Specify whether to check slave or master. To improve performance,
876 * non-critical checks are done against slaves. Check when actually saving should be done against
879 function getBlockedStatus( $bFromSlave = true ) {
880 global $wgEnableSorbs, $wgProxyWhitelist;
882 if ( -1 != $this->mBlockedby
) {
883 wfDebug( "User::getBlockedStatus: already loaded.\n" );
887 wfProfileIn( __METHOD__
);
888 wfDebug( __METHOD__
.": checking...\n" );
890 $this->mBlockedby
= 0;
891 $this->mHideName
= 0;
894 if ($this->isAllowed( 'ipblock-exempt' ) ) {
895 # Exempt from all types of IP-block
900 $this->mBlock
= new Block();
901 $this->mBlock
->fromMaster( !$bFromSlave );
902 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
903 wfDebug( __METHOD__
.": Found block.\n" );
904 $this->mBlockedby
= $this->mBlock
->mBy
;
905 $this->mBlockreason
= $this->mBlock
->mReason
;
906 $this->mHideName
= $this->mBlock
->mHideName
;
907 if ( $this->isLoggedIn() ) {
908 $this->spreadBlock();
911 $this->mBlock
= null;
912 wfDebug( __METHOD__
.": No block.\n" );
916 if ( !$this->isAllowed('proxyunbannable') && !in_array( $ip, $wgProxyWhitelist ) ) {
919 if ( wfIsLocallyBlockedProxy( $ip ) ) {
920 $this->mBlockedby
= wfMsg( 'proxyblocker' );
921 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
925 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
926 if ( $this->inSorbsBlacklist( $ip ) ) {
927 $this->mBlockedby
= wfMsg( 'sorbs' );
928 $this->mBlockreason
= wfMsg( 'sorbsreason' );
934 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
936 wfProfileOut( __METHOD__
);
939 function inSorbsBlacklist( $ip ) {
940 global $wgEnableSorbs, $wgSorbsUrl;
942 return $wgEnableSorbs &&
943 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
946 function inDnsBlacklist( $ip, $base ) {
947 wfProfileIn( __METHOD__
);
953 if ( preg_match( '/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/', $ip, $m ) ) {
955 for ( $i=4; $i>=1; $i-- ) {
956 $host .= $m[$i] . '.';
961 $ipList = gethostbynamel( $host );
964 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
967 wfDebug( "Requested $host, not found in $base.\n" );
971 wfProfileOut( __METHOD__
);
976 * Is this user subject to rate limiting?
980 public function isPingLimitable() {
981 global $wgRateLimitsExcludedGroups;
982 return array_intersect($this->getEffectiveGroups(), $wgRateLimitsExcludedGroups) == array();
986 * Primitive rate limits: enforce maximum actions per time period
987 * to put a brake on flooding.
989 * Note: when using a shared cache like memcached, IP-address
990 * last-hit counters will be shared across wikis.
992 * @return bool true if a rate limiter was tripped
995 function pingLimiter( $action='edit' ) {
997 # Call the 'PingLimiter' hook
999 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1003 global $wgRateLimits, $wgRateLimitsExcludedGroups;
1004 if( !isset( $wgRateLimits[$action] ) ) {
1008 # Some groups shouldn't trigger the ping limiter, ever
1009 if( !$this->isPingLimitable() )
1012 global $wgMemc, $wgRateLimitLog;
1013 wfProfileIn( __METHOD__
);
1015 $limits = $wgRateLimits[$action];
1017 $id = $this->getId();
1020 if( isset( $limits['anon'] ) && $id == 0 ) {
1021 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1024 if( isset( $limits['user'] ) && $id != 0 ) {
1025 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['user'];
1027 if( $this->isNewbie() ) {
1028 if( isset( $limits['newbie'] ) && $id != 0 ) {
1029 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1031 if( isset( $limits['ip'] ) ) {
1032 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1035 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1036 $subnet = $matches[1];
1037 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1042 foreach( $keys as $key => $limit ) {
1043 list( $max, $period ) = $limit;
1044 $summary = "(limit $max in {$period}s)";
1045 $count = $wgMemc->get( $key );
1047 if( $count > $max ) {
1048 wfDebug( __METHOD__
.": tripped! $key at $count $summary\n" );
1049 if( $wgRateLimitLog ) {
1050 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1054 wfDebug( __METHOD__
.": ok. $key at $count $summary\n" );
1057 wfDebug( __METHOD__
.": adding record for $key $summary\n" );
1058 $wgMemc->add( $key, 1, intval( $period ) );
1060 $wgMemc->incr( $key );
1063 wfProfileOut( __METHOD__
);
1068 * Check if user is blocked
1069 * @return bool True if blocked, false otherwise
1071 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1072 wfDebug( "User::isBlocked: enter\n" );
1073 $this->getBlockedStatus( $bFromSlave );
1074 return $this->mBlockedby
!== 0;
1078 * Check if user is blocked from editing a particular article
1080 function isBlockedFrom( $title, $bFromSlave = false ) {
1081 global $wgBlockAllowsUTEdit;
1082 wfProfileIn( __METHOD__
);
1083 wfDebug( __METHOD__
.": enter\n" );
1085 wfDebug( __METHOD__
.": asking isBlocked()\n" );
1086 $blocked = $this->isBlocked( $bFromSlave );
1087 # If a user's name is suppressed, they cannot make edits anywhere
1088 if ( !$this->mHideName
&& $wgBlockAllowsUTEdit && $title->getText() === $this->getName() &&
1089 $title->getNamespace() == NS_USER_TALK
) {
1091 wfDebug( __METHOD__
.": self-talk page, ignoring any blocks\n" );
1093 wfProfileOut( __METHOD__
);
1098 * Get name of blocker
1099 * @return string name of blocker
1101 function blockedBy() {
1102 $this->getBlockedStatus();
1103 return $this->mBlockedby
;
1107 * Get blocking reason
1108 * @return string Blocking reason
1110 function blockedFor() {
1111 $this->getBlockedStatus();
1112 return $this->mBlockreason
;
1116 * Get the user ID. Returns 0 if the user is anonymous or nonexistent.
1124 * Set the user and reload all fields according to that ID
1125 * @deprecated use User::newFromId()
1127 function setID( $v ) {
1129 $this->clearInstanceCache( 'id' );
1133 * Get the user name, or the IP for anons
1135 function getName() {
1136 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1137 # Special case optimisation
1138 return $this->mName
;
1141 if ( $this->mName
=== false ) {
1143 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1145 return $this->mName
;
1150 * Set the user name.
1152 * This does not reload fields from the database according to the given
1153 * name. Rather, it is used to create a temporary "nonexistent user" for
1154 * later addition to the database. It can also be used to set the IP
1155 * address for an anonymous user to something other than the current
1158 * User::newFromName() has rougly the same function, when the named user
1161 function setName( $str ) {
1163 $this->mName
= $str;
1167 * Return the title dbkey form of the name, for eg user pages.
1171 function getTitleKey() {
1172 return str_replace( ' ', '_', $this->getName() );
1175 function getNewtalk() {
1178 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1179 if( $this->mNewtalk
=== -1 ) {
1180 $this->mNewtalk
= false; # reset talk page status
1182 # Check memcached separately for anons, who have no
1183 # entire User object stored in there.
1186 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1187 $newtalk = $wgMemc->get( $key );
1188 if( $newtalk != "" ) {
1189 $this->mNewtalk
= (bool)$newtalk;
1191 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName() );
1192 $wgMemc->set( $key, (int)$this->mNewtalk
, time() +
1800 );
1195 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1199 return (bool)$this->mNewtalk
;
1203 * Return the talk page(s) this user has new messages on.
1205 function getNewMessageLinks() {
1207 if (!wfRunHooks('UserRetrieveNewTalks', array(&$this, &$talks)))
1210 if (!$this->getNewtalk())
1212 $up = $this->getUserPage();
1213 $utp = $up->getTalkPage();
1214 return array(array("wiki" => wfWikiID(), "link" => $utp->getLocalURL()));
1219 * Perform a user_newtalk check on current slaves; if the memcached data
1220 * is funky we don't want newtalk state to get stuck on save, as that's
1223 * @param string $field
1228 function checkNewtalk( $field, $id ) {
1229 $dbr = wfGetDB( DB_SLAVE
);
1230 $ok = $dbr->selectField( 'user_newtalk', $field,
1231 array( $field => $id ), __METHOD__
);
1232 return $ok !== false;
1237 * @param string $field
1241 function updateNewtalk( $field, $id ) {
1242 if( $this->checkNewtalk( $field, $id ) ) {
1243 wfDebug( __METHOD__
." already set ($field, $id), ignoring\n" );
1246 $dbw = wfGetDB( DB_MASTER
);
1247 $dbw->insert( 'user_newtalk',
1248 array( $field => $id ),
1251 wfDebug( __METHOD__
.": set on ($field, $id)\n" );
1256 * Clear the new messages flag for the given user
1257 * @param string $field
1261 function deleteNewtalk( $field, $id ) {
1262 if( !$this->checkNewtalk( $field, $id ) ) {
1263 wfDebug( __METHOD__
.": already gone ($field, $id), ignoring\n" );
1266 $dbw = wfGetDB( DB_MASTER
);
1267 $dbw->delete( 'user_newtalk',
1268 array( $field => $id ),
1270 wfDebug( __METHOD__
.": killed on ($field, $id)\n" );
1275 * Update the 'You have new messages!' status.
1278 function setNewtalk( $val ) {
1279 if( wfReadOnly() ) {
1284 $this->mNewtalk
= $val;
1286 if( $this->isAnon() ) {
1288 $id = $this->getName();
1291 $id = $this->getId();
1295 $changed = $this->updateNewtalk( $field, $id );
1297 $changed = $this->deleteNewtalk( $field, $id );
1301 if( $this->isAnon() ) {
1302 // Anons have a separate memcached space, since
1303 // user records aren't kept for them.
1305 $key = wfMemcKey( 'newtalk', 'ip', $val );
1306 $wgMemc->set( $key, $val ?
1 : 0 );
1309 // Make sure the user page is watched, so a notification
1310 // will be sent out if enabled.
1311 $this->addWatch( $this->getTalkPage() );
1314 $this->invalidateCache();
1319 * Generate a current or new-future timestamp to be stored in the
1320 * user_touched field when we update things.
1322 private static function newTouchedTimestamp() {
1323 global $wgClockSkewFudge;
1324 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1328 * Clear user data from memcached.
1329 * Use after applying fun updates to the database; caller's
1330 * responsibility to update user_touched if appropriate.
1332 * Called implicitly from invalidateCache() and saveSettings().
1334 private function clearSharedCache() {
1337 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1342 * Immediately touch the user data cache for this account.
1343 * Updates user_touched field, and removes account data from memcached
1344 * for reload on the next hit.
1346 function invalidateCache() {
1349 $this->mTouched
= self
::newTouchedTimestamp();
1351 $dbw = wfGetDB( DB_MASTER
);
1352 $dbw->update( 'user',
1353 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1354 array( 'user_id' => $this->mId
),
1357 $this->clearSharedCache();
1361 function validateCache( $timestamp ) {
1363 return ($timestamp >= $this->mTouched
);
1367 * Encrypt a password.
1368 * It can eventuall salt a password @see User::addSalt()
1369 * @param string $p clear Password.
1370 * @return string Encrypted password.
1372 function encryptPassword( $p ) {
1374 return wfEncryptPassword( $this->mId
, $p );
1378 * Set the password and reset the random token
1379 * Calls through to authentication plugin if necessary;
1380 * will have no effect if the auth plugin refuses to
1381 * pass the change through or if the legal password
1384 * As a special case, setting the password to null
1385 * wipes it, so the account cannot be logged in until
1386 * a new password is set, for instance via e-mail.
1388 * @param string $str
1389 * @throws PasswordError on failure
1391 function setPassword( $str ) {
1394 if( $str !== null ) {
1395 if( !$wgAuth->allowPasswordChange() ) {
1396 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1399 if( !$this->isValidPassword( $str ) ) {
1400 global $wgMinimalPasswordLength;
1401 throw new PasswordError( wfMsg( 'passwordtooshort',
1402 $wgMinimalPasswordLength ) );
1406 if( !$wgAuth->setPassword( $this, $str ) ) {
1407 throw new PasswordError( wfMsg( 'externaldberror' ) );
1410 $this->setInternalPassword( $str );
1416 * Set the password and reset the random token no matter
1419 * @param string $str
1421 function setInternalPassword( $str ) {
1425 if( $str === null ) {
1426 // Save an invalid hash...
1427 $this->mPassword
= '';
1429 $this->mPassword
= $this->encryptPassword( $str );
1431 $this->mNewpassword
= '';
1432 $this->mNewpassTime
= null;
1435 * Set the random token (used for persistent authentication)
1436 * Called from loadDefaults() among other places.
1439 function setToken( $token = false ) {
1440 global $wgSecretKey, $wgProxyKey;
1443 if ( $wgSecretKey ) {
1444 $key = $wgSecretKey;
1445 } elseif ( $wgProxyKey ) {
1450 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1452 $this->mToken
= $token;
1456 function setCookiePassword( $str ) {
1458 $this->mCookiePassword
= md5( $str );
1462 * Set the password for a password reminder or new account email
1463 * Sets the user_newpass_time field if $throttle is true
1465 function setNewpassword( $str, $throttle = true ) {
1467 $this->mNewpassword
= $this->encryptPassword( $str );
1469 $this->mNewpassTime
= wfTimestampNow();
1474 * Returns true if a password reminder email has already been sent within
1475 * the last $wgPasswordReminderResendTime hours
1477 function isPasswordReminderThrottled() {
1478 global $wgPasswordReminderResendTime;
1480 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1483 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1484 return time() < $expiry;
1487 function getEmail() {
1489 return $this->mEmail
;
1492 function getEmailAuthenticationTimestamp() {
1494 return $this->mEmailAuthenticated
;
1497 function setEmail( $str ) {
1499 $this->mEmail
= $str;
1502 function getRealName() {
1504 return $this->mRealName
;
1507 function setRealName( $str ) {
1509 $this->mRealName
= $str;
1513 * @param string $oname The option to check
1514 * @param string $defaultOverride A default value returned if the option does not exist
1517 function getOption( $oname, $defaultOverride = '' ) {
1520 if ( is_null( $this->mOptions
) ) {
1521 if($defaultOverride != '') {
1522 return $defaultOverride;
1524 $this->mOptions
= User
::getDefaultOptions();
1527 if ( array_key_exists( $oname, $this->mOptions
) ) {
1528 return trim( $this->mOptions
[$oname] );
1530 return $defaultOverride;
1535 * Get the user's date preference, including some important migration for
1538 function getDatePreference() {
1539 if ( is_null( $this->mDatePreference
) ) {
1541 $value = $this->getOption( 'date' );
1542 $map = $wgLang->getDatePreferenceMigrationMap();
1543 if ( isset( $map[$value] ) ) {
1544 $value = $map[$value];
1546 $this->mDatePreference
= $value;
1548 return $this->mDatePreference
;
1552 * @param string $oname The option to check
1553 * @return bool False if the option is not selected, true if it is
1555 function getBoolOption( $oname ) {
1556 return (bool)$this->getOption( $oname );
1560 * Get an option as an integer value from the source string.
1561 * @param string $oname The option to check
1562 * @param int $default Optional value to return if option is unset/blank.
1565 function getIntOption( $oname, $default=0 ) {
1566 $val = $this->getOption( $oname );
1570 return intval( $val );
1573 function setOption( $oname, $val ) {
1575 if ( is_null( $this->mOptions
) ) {
1576 $this->mOptions
= User
::getDefaultOptions();
1578 if ( $oname == 'skin' ) {
1579 # Clear cached skin, so the new one displays immediately in Special:Preferences
1580 unset( $this->mSkin
);
1582 // Filter out any newlines that may have passed through input validation.
1583 // Newlines are used to separate items in the options blob.
1584 $val = str_replace( "\r\n", "\n", $val );
1585 $val = str_replace( "\r", "\n", $val );
1586 $val = str_replace( "\n", " ", $val );
1587 $this->mOptions
[$oname] = $val;
1590 function getRights() {
1591 if ( is_null( $this->mRights
) ) {
1592 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
1594 return $this->mRights
;
1598 * Get the list of explicit group memberships this user has.
1599 * The implicit * and user groups are not included.
1600 * @return array of strings
1602 function getGroups() {
1604 return $this->mGroups
;
1608 * Get the list of implicit group memberships this user has.
1609 * This includes all explicit groups, plus 'user' if logged in
1610 * and '*' for all accounts.
1611 * @param boolean $recache Don't use the cache
1612 * @return array of strings
1614 function getEffectiveGroups( $recache = false ) {
1615 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
1617 $this->mEffectiveGroups
= $this->mGroups
;
1618 $this->mEffectiveGroups
[] = '*';
1620 $this->mEffectiveGroups
[] = 'user';
1622 global $wgAutoConfirmAge, $wgAutoConfirmCount;
1624 $accountAge = time() - wfTimestampOrNull( TS_UNIX
, $this->mRegistration
);
1625 if( $accountAge >= $wgAutoConfirmAge && $this->getEditCount() >= $wgAutoConfirmCount ) {
1626 $this->mEffectiveGroups
[] = 'autoconfirmed';
1628 # Implicit group for users whose email addresses are confirmed
1629 global $wgEmailAuthentication;
1630 if( self
::isValidEmailAddr( $this->mEmail
) ) {
1631 if( $wgEmailAuthentication ) {
1632 if( $this->mEmailAuthenticated
)
1633 $this->mEffectiveGroups
[] = 'emailconfirmed';
1635 $this->mEffectiveGroups
[] = 'emailconfirmed';
1638 # Hook for additional groups
1639 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
1642 return $this->mEffectiveGroups
;
1645 /* Return the edit count for the user. This is where User::edits should have been */
1646 function getEditCount() {
1648 if ( !isset( $this->mEditCount
) ) {
1649 /* Populate the count, if it has not been populated yet */
1650 $this->mEditCount
= User
::edits($this->mId
);
1652 return $this->mEditCount
;
1660 * Add the user to the given group.
1661 * This takes immediate effect.
1662 * @param string $group
1664 function addGroup( $group ) {
1666 $dbw = wfGetDB( DB_MASTER
);
1667 if( $this->getId() ) {
1668 $dbw->insert( 'user_groups',
1670 'ug_user' => $this->getID(),
1671 'ug_group' => $group,
1674 array( 'IGNORE' ) );
1677 $this->mGroups
[] = $group;
1678 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
1680 $this->invalidateCache();
1684 * Remove the user from the given group.
1685 * This takes immediate effect.
1686 * @param string $group
1688 function removeGroup( $group ) {
1690 $dbw = wfGetDB( DB_MASTER
);
1691 $dbw->delete( 'user_groups',
1693 'ug_user' => $this->getID(),
1694 'ug_group' => $group,
1696 'User::removeGroup' );
1698 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
1699 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
1701 $this->invalidateCache();
1706 * A more legible check for non-anonymousness.
1707 * Returns true if the user is not an anonymous visitor.
1711 function isLoggedIn() {
1712 return( $this->getID() != 0 );
1716 * A more legible check for anonymousness.
1717 * Returns true if the user is an anonymous visitor.
1722 return !$this->isLoggedIn();
1726 * Whether the user is a bot
1730 return $this->isAllowed( 'bot' );
1734 * Check if user is allowed to access a feature / make an action
1735 * @param string $action Action to be checked
1736 * @return boolean True: action is allowed, False: action should not be allowed
1738 function isAllowed($action='') {
1739 if ( $action === '' )
1740 // In the spirit of DWIM
1743 return in_array( $action, $this->getRights() );
1747 * Load a skin if it doesn't exist or return it
1748 * @todo FIXME : need to check the old failback system [AV]
1750 function &getSkin() {
1752 if ( ! isset( $this->mSkin
) ) {
1753 wfProfileIn( __METHOD__
);
1756 $userSkin = $this->getOption( 'skin' );
1757 $userSkin = $wgRequest->getVal('useskin', $userSkin);
1759 $this->mSkin
=& Skin
::newFromKey( $userSkin );
1760 wfProfileOut( __METHOD__
);
1762 return $this->mSkin
;
1766 * @param string $title Article title to look at
1770 * Check watched status of an article
1771 * @return bool True if article is watched
1773 function isWatched( $title ) {
1774 $wl = WatchedItem
::fromUserTitle( $this, $title );
1775 return $wl->isWatched();
1781 function addWatch( $title ) {
1782 $wl = WatchedItem
::fromUserTitle( $this, $title );
1784 $this->invalidateCache();
1788 * Stop watching an article
1790 function removeWatch( $title ) {
1791 $wl = WatchedItem
::fromUserTitle( $this, $title );
1793 $this->invalidateCache();
1797 * Clear the user's notification timestamp for the given title.
1798 * If e-notif e-mails are on, they will receive notification mails on
1799 * the next change of the page if it's watched etc.
1801 function clearNotification( &$title ) {
1802 global $wgUser, $wgUseEnotif;
1804 # Do nothing if the database is locked to writes
1805 if( wfReadOnly() ) {
1809 if ($title->getNamespace() == NS_USER_TALK
&&
1810 $title->getText() == $this->getName() ) {
1811 if (!wfRunHooks('UserClearNewTalkNotification', array(&$this)))
1813 $this->setNewtalk( false );
1816 if( !$wgUseEnotif ) {
1820 if( $this->isAnon() ) {
1821 // Nothing else to do...
1825 // Only update the timestamp if the page is being watched.
1826 // The query to find out if it is watched is cached both in memcached and per-invocation,
1827 // and when it does have to be executed, it can be on a slave
1828 // If this is the user's newtalk page, we always update the timestamp
1829 if ($title->getNamespace() == NS_USER_TALK
&&
1830 $title->getText() == $wgUser->getName())
1833 } elseif ( $this->getID() == $wgUser->getID() ) {
1834 $watched = $title->userIsWatching();
1839 // If the page is watched by the user (or may be watched), update the timestamp on any
1840 // any matching rows
1842 $dbw = wfGetDB( DB_MASTER
);
1843 $dbw->update( 'watchlist',
1845 'wl_notificationtimestamp' => NULL
1846 ), array( /* WHERE */
1847 'wl_title' => $title->getDBkey(),
1848 'wl_namespace' => $title->getNamespace(),
1849 'wl_user' => $this->getID()
1850 ), 'User::clearLastVisited'
1858 * Resets all of the given user's page-change notification timestamps.
1859 * If e-notif e-mails are on, they will receive notification mails on
1860 * the next change of any watched page.
1862 * @param int $currentUser user ID number
1865 function clearAllNotifications( $currentUser ) {
1866 global $wgUseEnotif;
1867 if ( !$wgUseEnotif ) {
1868 $this->setNewtalk( false );
1871 if( $currentUser != 0 ) {
1873 $dbw = wfGetDB( DB_MASTER
);
1874 $dbw->update( 'watchlist',
1876 'wl_notificationtimestamp' => NULL
1877 ), array( /* WHERE */
1878 'wl_user' => $currentUser
1879 ), 'UserMailer::clearAll'
1882 # we also need to clear here the "you have new message" notification for the own user_talk page
1883 # This is cleared one page view later in Article::viewUpdates();
1889 * @return string Encoding options
1891 function encodeOptions() {
1893 if ( is_null( $this->mOptions
) ) {
1894 $this->mOptions
= User
::getDefaultOptions();
1897 foreach ( $this->mOptions
as $oname => $oval ) {
1898 array_push( $a, $oname.'='.$oval );
1900 $s = implode( "\n", $a );
1907 function decodeOptions( $str ) {
1908 $this->mOptions
= array();
1909 $a = explode( "\n", $str );
1910 foreach ( $a as $s ) {
1912 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
1913 $this->mOptions
[$m[1]] = $m[2];
1918 function setCookies() {
1919 global $wgCookieExpiration, $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookiePrefix;
1921 if ( 0 == $this->mId
) return;
1922 $exp = time() +
$wgCookieExpiration;
1924 $_SESSION['wsUserID'] = $this->mId
;
1925 setcookie( $wgCookiePrefix.'UserID', $this->mId
, $exp, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1927 $_SESSION['wsUserName'] = $this->getName();
1928 setcookie( $wgCookiePrefix.'UserName', $this->getName(), $exp, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1930 $_SESSION['wsToken'] = $this->mToken
;
1931 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
1932 setcookie( $wgCookiePrefix.'Token', $this->mToken
, $exp, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1934 setcookie( $wgCookiePrefix.'Token', '', time() - 3600 );
1940 * Clears the cookies and session, resets the instance cache
1943 global $wgCookiePath, $wgCookieDomain, $wgCookieSecure, $wgCookiePrefix;
1944 $this->clearInstanceCache( 'defaults' );
1946 $_SESSION['wsUserID'] = 0;
1948 setcookie( $wgCookiePrefix.'UserID', '', time() - 3600, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1949 setcookie( $wgCookiePrefix.'Token', '', time() - 3600, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1951 # Remember when user logged out, to prevent seeing cached pages
1952 setcookie( $wgCookiePrefix.'LoggedOut', wfTimestampNow(), time() +
86400, $wgCookiePath, $wgCookieDomain, $wgCookieSecure );
1956 * Save object settings into database
1957 * @todo Only rarely do all these fields need to be set!
1959 function saveSettings() {
1961 if ( wfReadOnly() ) { return; }
1962 if ( 0 == $this->mId
) { return; }
1964 $this->mTouched
= self
::newTouchedTimestamp();
1966 $dbw = wfGetDB( DB_MASTER
);
1967 $dbw->update( 'user',
1969 'user_name' => $this->mName
,
1970 'user_password' => $this->mPassword
,
1971 'user_newpassword' => $this->mNewpassword
,
1972 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
1973 'user_real_name' => $this->mRealName
,
1974 'user_email' => $this->mEmail
,
1975 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
1976 'user_options' => $this->encodeOptions(),
1977 'user_touched' => $dbw->timestamp($this->mTouched
),
1978 'user_token' => $this->mToken
1979 ), array( /* WHERE */
1980 'user_id' => $this->mId
1983 $this->clearSharedCache();
1988 * Checks if a user with the given name exists, returns the ID
1990 function idForName() {
1991 $s = trim( $this->getName() );
1992 if ( 0 == strcmp( '', $s ) ) return 0;
1994 $dbr = wfGetDB( DB_SLAVE
);
1995 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
1996 if ( $id === false ) {
2003 * Add a user to the database, return the user object
2005 * @param string $name The user's name
2006 * @param array $params Associative array of non-default parameters to save to the database:
2007 * password The user's password. Password logins will be disabled if this is omitted.
2008 * newpassword A temporary password mailed to the user
2009 * email The user's email address
2010 * email_authenticated The email authentication timestamp
2011 * real_name The user's real name
2012 * options An associative array of non-default options
2013 * token Random authentication token. Do not set.
2014 * registration Registration timestamp. Do not set.
2016 * @return User object, or null if the username already exists
2018 static function createNew( $name, $params = array() ) {
2021 if ( isset( $params['options'] ) ) {
2022 $user->mOptions
= $params['options'] +
$user->mOptions
;
2023 unset( $params['options'] );
2025 $dbw = wfGetDB( DB_MASTER
);
2026 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2028 'user_id' => $seqVal,
2029 'user_name' => $name,
2030 'user_password' => $user->mPassword
,
2031 'user_newpassword' => $user->mNewpassword
,
2032 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2033 'user_email' => $user->mEmail
,
2034 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2035 'user_real_name' => $user->mRealName
,
2036 'user_options' => $user->encodeOptions(),
2037 'user_token' => $user->mToken
,
2038 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2039 'user_editcount' => 0,
2041 foreach ( $params as $name => $value ) {
2042 $fields["user_$name"] = $value;
2044 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2045 if ( $dbw->affectedRows() ) {
2046 $newUser = User
::newFromId( $dbw->insertId() );
2054 * Add an existing user object to the database
2056 function addToDatabase() {
2058 $dbw = wfGetDB( DB_MASTER
);
2059 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2060 $dbw->insert( 'user',
2062 'user_id' => $seqVal,
2063 'user_name' => $this->mName
,
2064 'user_password' => $this->mPassword
,
2065 'user_newpassword' => $this->mNewpassword
,
2066 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2067 'user_email' => $this->mEmail
,
2068 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2069 'user_real_name' => $this->mRealName
,
2070 'user_options' => $this->encodeOptions(),
2071 'user_token' => $this->mToken
,
2072 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2073 'user_editcount' => 0,
2076 $this->mId
= $dbw->insertId();
2078 # Clear instance cache other than user table data, which is already accurate
2079 $this->clearInstanceCache();
2083 * If the (non-anonymous) user is blocked, this function will block any IP address
2084 * that they successfully log on from.
2086 function spreadBlock() {
2087 wfDebug( __METHOD__
."()\n" );
2089 if ( $this->mId
== 0 ) {
2093 $userblock = Block
::newFromDB( '', $this->mId
);
2094 if ( !$userblock ) {
2098 $userblock->doAutoblock( wfGetIp() );
2103 * Generate a string which will be different for any combination of
2104 * user options which would produce different parser output.
2105 * This will be used as part of the hash key for the parser cache,
2106 * so users will the same options can share the same cached data
2109 * Extensions which require it should install 'PageRenderingHash' hook,
2110 * which will give them a chance to modify this key based on their own
2115 function getPageRenderingHash() {
2116 global $wgContLang, $wgUseDynamicDates, $wgLang;
2118 return $this->mHash
;
2121 // stubthreshold is only included below for completeness,
2122 // it will always be 0 when this function is called by parsercache.
2124 $confstr = $this->getOption( 'math' );
2125 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2126 if ( $wgUseDynamicDates ) {
2127 $confstr .= '!' . $this->getDatePreference();
2129 $confstr .= '!' . ($this->getOption( 'numberheadings' ) ?
'1' : '');
2130 $confstr .= '!' . $wgLang->getCode();
2131 $confstr .= '!' . $this->getOption( 'thumbsize' );
2132 // add in language specific options, if any
2133 $extra = $wgContLang->getExtraHashOptions();
2136 // Give a chance for extensions to modify the hash, if they have
2137 // extra options or other effects on the parser cache.
2138 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2140 // Make it a valid memcached key fragment
2141 $confstr = str_replace( ' ', '_', $confstr );
2142 $this->mHash
= $confstr;
2146 function isBlockedFromCreateAccount() {
2147 $this->getBlockedStatus();
2148 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2152 * Determine if the user is blocked from using Special:Emailuser.
2157 function isBlockedFromEmailuser() {
2158 $this->getBlockedStatus();
2159 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2162 function isAllowedToCreateAccount() {
2163 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2169 function setLoaded( $loaded ) {}
2172 * Get this user's personal page title.
2177 function getUserPage() {
2178 return Title
::makeTitle( NS_USER
, $this->getName() );
2182 * Get this user's talk page title.
2187 function getTalkPage() {
2188 $title = $this->getUserPage();
2189 return $title->getTalkPage();
2195 function getMaxID() {
2196 static $res; // cache
2198 if ( isset( $res ) )
2201 $dbr = wfGetDB( DB_SLAVE
);
2202 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2207 * Determine whether the user is a newbie. Newbies are either
2208 * anonymous IPs, or the most recently created accounts.
2209 * @return bool True if it is a newbie.
2211 function isNewbie() {
2212 return !$this->isAllowed( 'autoconfirmed' );
2216 * Check to see if the given clear-text password is one of the accepted passwords
2217 * @param string $password User password.
2218 * @return bool True if the given password is correct otherwise False.
2220 function checkPassword( $password ) {
2224 // Even though we stop people from creating passwords that
2225 // are shorter than this, doesn't mean people wont be able
2226 // to. Certain authentication plugins do NOT want to save
2227 // domain passwords in a mysql database, so we should
2228 // check this (incase $wgAuth->strict() is false).
2229 if( !$this->isValidPassword( $password ) ) {
2233 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2235 } elseif( $wgAuth->strict() ) {
2236 /* Auth plugin doesn't allow local authentication */
2239 $ep = $this->encryptPassword( $password );
2240 if ( 0 == strcmp( $ep, $this->mPassword
) ) {
2242 } elseif ( function_exists( 'iconv' ) ) {
2243 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2244 # Check for this with iconv
2245 $cp1252hash = $this->encryptPassword( iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password ) );
2246 if ( 0 == strcmp( $cp1252hash, $this->mPassword
) ) {
2254 * Check if the given clear-text password matches the temporary password
2255 * sent by e-mail for password reset operations.
2258 function checkTemporaryPassword( $plaintext ) {
2259 $hash = $this->encryptPassword( $plaintext );
2260 return $hash === $this->mNewpassword
;
2264 * Initialize (if necessary) and return a session token value
2265 * which can be used in edit forms to show that the user's
2266 * login credentials aren't being hijacked with a foreign form
2269 * @param mixed $salt - Optional function-specific data for hash.
2270 * Use a string or an array of strings.
2274 function editToken( $salt = '' ) {
2275 if ( $this->isAnon() ) {
2276 return EDIT_TOKEN_SUFFIX
;
2278 if( !isset( $_SESSION['wsEditToken'] ) ) {
2279 $token = $this->generateToken();
2280 $_SESSION['wsEditToken'] = $token;
2282 $token = $_SESSION['wsEditToken'];
2284 if( is_array( $salt ) ) {
2285 $salt = implode( '|', $salt );
2287 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2292 * Generate a hex-y looking random token for various uses.
2293 * Could be made more cryptographically sure if someone cares.
2296 function generateToken( $salt = '' ) {
2297 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2298 return md5( $token . $salt );
2302 * Check given value against the token value stored in the session.
2303 * A match should confirm that the form was submitted from the
2304 * user's own login session, not a form submission from a third-party
2307 * @param string $val - the input value to compare
2308 * @param string $salt - Optional function-specific data for hash
2312 function matchEditToken( $val, $salt = '' ) {
2313 $sessionToken = $this->editToken( $salt );
2314 if ( $val != $sessionToken ) {
2315 wfDebug( "User::matchEditToken: broken session data\n" );
2317 return $val == $sessionToken;
2321 * Check whether the edit token is fine except for the suffix
2323 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2324 $sessionToken = $this->editToken( $salt );
2325 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2329 * Generate a new e-mail confirmation token and send a confirmation
2330 * mail to the user's given address.
2332 * @return mixed True on success, a WikiError object on failure.
2334 function sendConfirmationMail() {
2336 $expiration = null; // gets passed-by-ref and defined in next line.
2337 $url = $this->confirmationTokenUrl( $expiration );
2338 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2339 wfMsg( 'confirmemail_body',
2343 $wgContLang->timeanddate( $expiration, false ) ) );
2347 * Send an e-mail to this user's account. Does not check for
2348 * confirmed status or validity.
2350 * @param string $subject
2351 * @param string $body
2352 * @param strong $from Optional from address; default $wgPasswordSender will be used otherwise.
2353 * @return mixed True on success, a WikiError object on failure.
2355 function sendMail( $subject, $body, $from = null ) {
2356 if( is_null( $from ) ) {
2357 global $wgPasswordSender;
2358 $from = $wgPasswordSender;
2361 require_once( 'UserMailer.php' );
2362 $to = new MailAddress( $this );
2363 $sender = new MailAddress( $from );
2364 $error = userMailer( $to, $sender, $subject, $body );
2366 if( $error == '' ) {
2369 return new WikiError( $error );
2374 * Generate, store, and return a new e-mail confirmation code.
2375 * A hash (unsalted since it's used as a key) is stored.
2376 * @param &$expiration mixed output: accepts the expiration time
2380 function confirmationToken( &$expiration ) {
2382 $expires = $now +
7 * 24 * 60 * 60;
2383 $expiration = wfTimestamp( TS_MW
, $expires );
2385 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2386 $hash = md5( $token );
2388 $dbw = wfGetDB( DB_MASTER
);
2389 $dbw->update( 'user',
2390 array( 'user_email_token' => $hash,
2391 'user_email_token_expires' => $dbw->timestamp( $expires ) ),
2392 array( 'user_id' => $this->mId
),
2399 * Generate and store a new e-mail confirmation token, and return
2400 * the URL the user can use to confirm.
2401 * @param &$expiration mixed output: accepts the expiration time
2405 function confirmationTokenUrl( &$expiration ) {
2406 $token = $this->confirmationToken( $expiration );
2407 $title = SpecialPage
::getTitleFor( 'Confirmemail', $token );
2408 return $title->getFullUrl();
2412 * Mark the e-mail address confirmed and save.
2414 function confirmEmail() {
2416 $this->mEmailAuthenticated
= wfTimestampNow();
2417 $this->saveSettings();
2422 * Is this user allowed to send e-mails within limits of current
2423 * site configuration?
2426 function canSendEmail() {
2427 return $this->isEmailConfirmed();
2431 * Is this user allowed to receive e-mails within limits of current
2432 * site configuration?
2435 function canReceiveEmail() {
2436 return $this->canSendEmail() && !$this->getOption( 'disablemail' );
2440 * Is this user's e-mail address valid-looking and confirmed within
2441 * limits of the current site configuration?
2443 * If $wgEmailAuthentication is on, this may require the user to have
2444 * confirmed their address by returning a code or using a password
2445 * sent to the address from the wiki.
2449 function isEmailConfirmed() {
2450 global $wgEmailAuthentication;
2453 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
2454 if( $this->isAnon() )
2456 if( !self
::isValidEmailAddr( $this->mEmail
) )
2458 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
2467 * Return true if there is an outstanding request for e-mail confirmation.
2470 function isEmailConfirmationPending() {
2471 global $wgEmailAuthentication;
2472 return $wgEmailAuthentication &&
2473 !$this->isEmailConfirmed() &&
2474 $this->mEmailToken
&&
2475 $this->mEmailTokenExpires
> wfTimestamp();
2479 * Get the timestamp of account creation, or false for
2480 * non-existent/anonymous user accounts
2484 public function getRegistration() {
2485 return $this->mId
> 0
2486 ?
$this->mRegistration
2491 * @param array $groups list of groups
2492 * @return array list of permission key names for given groups combined
2495 static function getGroupPermissions( $groups ) {
2496 global $wgGroupPermissions;
2498 foreach( $groups as $group ) {
2499 if( isset( $wgGroupPermissions[$group] ) ) {
2500 $rights = array_merge( $rights,
2501 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
2508 * @param string $group key name
2509 * @return string localized descriptive name for group, if provided
2512 static function getGroupName( $group ) {
2513 MessageCache
::loadAllMessages();
2514 $key = "group-$group";
2515 $name = wfMsg( $key );
2516 return $name == '' ||
wfEmptyMsg( $key, $name )
2522 * @param string $group key name
2523 * @return string localized descriptive name for member of a group, if provided
2526 static function getGroupMember( $group ) {
2527 MessageCache
::loadAllMessages();
2528 $key = "group-$group-member";
2529 $name = wfMsg( $key );
2530 return $name == '' ||
wfEmptyMsg( $key, $name )
2536 * Return the set of defined explicit groups.
2537 * The *, 'user', 'autoconfirmed' and 'emailconfirmed'
2538 * groups are not included, as they are defined
2539 * automatically, not in the database.
2543 static function getAllGroups() {
2544 global $wgGroupPermissions;
2546 array_keys( $wgGroupPermissions ),
2547 array( '*', 'user', 'autoconfirmed', 'emailconfirmed' ) );
2551 * Get the title of a page describing a particular group
2553 * @param $group Name of the group
2556 static function getGroupPage( $group ) {
2557 MessageCache
::loadAllMessages();
2558 $page = wfMsgForContent( 'grouppage-' . $group );
2559 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
2560 $title = Title
::newFromText( $page );
2561 if( is_object( $title ) )
2568 * Create a link to the group in HTML, if available
2570 * @param $group Name of the group
2571 * @param $text The text of the link
2574 static function makeGroupLinkHTML( $group, $text = '' ) {
2576 $text = self
::getGroupName( $group );
2578 $title = self
::getGroupPage( $group );
2581 $sk = $wgUser->getSkin();
2582 return $sk->makeLinkObj( $title, htmlspecialchars( $text ) );
2589 * Create a link to the group in Wikitext, if available
2591 * @param $group Name of the group
2592 * @param $text The text of the link (by default, the name of the group)
2595 static function makeGroupLinkWiki( $group, $text = '' ) {
2597 $text = self
::getGroupName( $group );
2599 $title = self
::getGroupPage( $group );
2601 $page = $title->getPrefixedText();
2602 return "[[$page|$text]]";
2609 * Increment the user's edit-count field.
2610 * Will have no effect for anonymous users.
2612 function incEditCount() {
2613 if( !$this->isAnon() ) {
2614 $dbw = wfGetDB( DB_MASTER
);
2615 $dbw->update( 'user',
2616 array( 'user_editcount=user_editcount+1' ),
2617 array( 'user_id' => $this->getId() ),
2620 // Lazy initialization check...
2621 if( $dbw->affectedRows() == 0 ) {
2622 // Pull from a slave to be less cruel to servers
2623 // Accuracy isn't the point anyway here
2624 $dbr = wfGetDB( DB_SLAVE
);
2625 $count = $dbr->selectField( 'revision',
2627 array( 'rev_user' => $this->getId() ),
2630 // Now here's a goddamn hack...
2631 if( $dbr !== $dbw ) {
2632 // If we actually have a slave server, the count is
2633 // at least one behind because the current transaction
2634 // has not been committed and replicated.
2637 // But if DB_SLAVE is selecting the master, then the
2638 // count we just read includes the revision that was
2639 // just added in the working transaction.
2642 $dbw->update( 'user',
2643 array( 'user_editcount' => $count ),
2644 array( 'user_id' => $this->getId() ),
2648 // edit count in user cache too
2649 $this->invalidateCache();