3 * Implements the User class for the %MediaWiki software.
8 * \int Number of characters in user_token field.
11 define( 'USER_TOKEN_LENGTH', 32 );
14 * \int Serialized record version.
17 define( 'MW_USER_VERSION', 8 );
20 * \string Some punctuation to prevent editing from broken text-mangling proxies.
23 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
26 * Thrown by User::setPassword() on error.
29 class PasswordError
extends MWException
{
34 * The User object encapsulates all of the user-specific settings (user_id,
35 * name, rights, password, email address, options, last login time). Client
36 * classes use the getXXX() functions to access these fields. These functions
37 * do all the work of determining whether the user is logged in,
38 * whether the requested option can be satisfied from cookies or
39 * whether a database query is needed. Most of the settings needed
40 * for rendering normal pages are set in the cookie to minimize use
45 * Global constants made accessible as class constants so that autoloader
48 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
49 const MW_USER_VERSION
= MW_USER_VERSION
;
50 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
53 * \type{\arrayof{\string}} List of member variables which are saved to the
54 * shared cache (memcached). Any operation which changes the
55 * corresponding database fields must call a cache-clearing function.
58 static $mCacheVars = array(
69 'mEmailAuthenticated',
76 // user_properties table
81 * \type{\arrayof{\string}} Core rights.
82 * Each of these should have a corresponding message of the form
86 static $mCoreRights = array(
114 'move-rootuserpages',
118 'override-export-depth',
139 'userrights-interwiki',
143 * \string Cached results of getAllRights()
145 static $mAllRights = false;
147 /** @name Cache variables */
149 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
150 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
151 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
155 * \bool Whether the cache variables have been loaded.
157 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
160 * \string Initialization data source if mDataLoaded==false. May be one of:
161 * - 'defaults' anonymous user initialised from class defaults
162 * - 'name' initialise from mName
163 * - 'id' initialise from mId
164 * - 'session' log in from cookies or session if possible
166 * Use the User::newFrom*() family of functions to set this.
170 /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
172 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
173 $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
174 $mLocked, $mHideName, $mOptions;
177 static $idCacheByName = array();
180 * Lightweight constructor for an anonymous user.
181 * Use the User::newFrom* factory functions for other kinds of users.
185 * @see newFromConfirmationCode()
186 * @see newFromSession()
189 function __construct() {
190 $this->clearInstanceCache( 'defaults' );
194 * Load the user table data for this object from the source given by mFrom.
197 if ( $this->mDataLoaded
) {
200 wfProfileIn( __METHOD__
);
202 # Set it now to avoid infinite recursion in accessors
203 $this->mDataLoaded
= true;
205 switch ( $this->mFrom
) {
207 $this->loadDefaults();
210 $this->mId
= self
::idFromName( $this->mName
);
212 # Nonexistent user placeholder object
213 $this->loadDefaults( $this->mName
);
222 $this->loadFromSession();
223 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
226 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
228 wfProfileOut( __METHOD__
);
232 * Load user table data, given mId has already been set.
233 * @return \bool false if the ID does not exist, true otherwise
236 function loadFromId() {
238 if ( $this->mId
== 0 ) {
239 $this->loadDefaults();
244 $key = wfMemcKey( 'user', 'id', $this->mId
);
245 $data = $wgMemc->get( $key );
246 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
247 # Object is expired, load from DB
252 wfDebug( "User: cache miss for user {$this->mId}\n" );
254 if ( !$this->loadFromDatabase() ) {
255 # Can't load from ID, user is anonymous
258 $this->saveToCache();
260 wfDebug( "User: got user {$this->mId} from cache\n" );
262 foreach ( self
::$mCacheVars as $name ) {
263 $this->$name = $data[$name];
270 * Save user data to the shared cache
272 function saveToCache() {
275 $this->loadOptions();
276 if ( $this->isAnon() ) {
277 // Anonymous users are uncached
281 foreach ( self
::$mCacheVars as $name ) {
282 $data[$name] = $this->$name;
284 $data['mVersion'] = MW_USER_VERSION
;
285 $key = wfMemcKey( 'user', 'id', $this->mId
);
287 $wgMemc->set( $key, $data );
291 /** @name newFrom*() static factory methods */
295 * Static factory method for creation from username.
297 * This is slightly less efficient than newFromId(), so use newFromId() if
298 * you have both an ID and a name handy.
300 * @param $name \string Username, validated by Title::newFromText()
301 * @param $validate \mixed Validate username. Takes the same parameters as
302 * User::getCanonicalName(), except that true is accepted as an alias
303 * for 'valid', for BC.
305 * @return User The User object, or false if the username is invalid
306 * (e.g. if it contains illegal characters or is an IP address). If the
307 * username is not present in the database, the result will be a user object
308 * with a name, zero user ID and default settings.
310 static function newFromName( $name, $validate = 'valid' ) {
311 if ( $validate === true ) {
314 $name = self
::getCanonicalName( $name, $validate );
315 if ( $name === false ) {
318 # Create unloaded user object
327 * Static factory method for creation from a given user ID.
329 * @param $id \int Valid user ID
330 * @return \type{User} The corresponding User object
332 static function newFromId( $id ) {
340 * Factory method to fetch whichever user has a given email confirmation code.
341 * This code is generated when an account is created or its e-mail address
344 * If the code is invalid or has expired, returns NULL.
346 * @param $code \string Confirmation code
347 * @return \type{User}
349 static function newFromConfirmationCode( $code ) {
350 $dbr = wfGetDB( DB_SLAVE
);
351 $id = $dbr->selectField( 'user', 'user_id', array(
352 'user_email_token' => md5( $code ),
353 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
355 if( $id !== false ) {
356 return User
::newFromId( $id );
363 * Create a new user object using data from session or cookies. If the
364 * login credentials are invalid, the result is an anonymous user.
366 * @return \type{User}
368 static function newFromSession() {
370 $user->mFrom
= 'session';
375 * Create a new user object from a user row.
376 * The row should have all fields from the user table in it.
377 * @param $row array A row from the user table
378 * @return \type{User}
380 static function newFromRow( $row ) {
382 $user->loadFromRow( $row );
390 * Get the username corresponding to a given user ID
391 * @param $id \int User ID
392 * @return \string The corresponding username
394 static function whoIs( $id ) {
395 $dbr = wfGetDB( DB_SLAVE
);
396 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
400 * Get the real name of a user given their user ID
402 * @param $id \int User ID
403 * @return \string The corresponding user's real name
405 static function whoIsReal( $id ) {
406 $dbr = wfGetDB( DB_SLAVE
);
407 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
411 * Get database id given a user name
412 * @param $name \string Username
413 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
415 static function idFromName( $name ) {
416 $nt = Title
::makeTitleSafe( NS_USER
, $name );
417 if( is_null( $nt ) ) {
422 if ( isset( self
::$idCacheByName[$name] ) ) {
423 return self
::$idCacheByName[$name];
426 $dbr = wfGetDB( DB_SLAVE
);
427 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
429 if ( $s === false ) {
432 $result = $s->user_id
;
435 self
::$idCacheByName[$name] = $result;
437 if ( count( self
::$idCacheByName ) > 1000 ) {
438 self
::$idCacheByName = array();
445 * Does the string match an anonymous IPv4 address?
447 * This function exists for username validation, in order to reject
448 * usernames which are similar in form to IP addresses. Strings such
449 * as 300.300.300.300 will return true because it looks like an IP
450 * address, despite not being strictly valid.
452 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
453 * address because the usemod software would "cloak" anonymous IP
454 * addresses like this, if we allowed accounts like this to be created
455 * new users could get the old edits of these anonymous users.
457 * @param $name \string String to match
458 * @return \bool True or false
460 static function isIP( $name ) {
461 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
465 * Is the input a valid username?
467 * Checks if the input is a valid username, we don't want an empty string,
468 * an IP address, anything that containins slashes (would mess up subpages),
469 * is longer than the maximum allowed username size or doesn't begin with
472 * @param $name \string String to match
473 * @return \bool True or false
475 static function isValidUserName( $name ) {
476 global $wgContLang, $wgMaxNameChars;
479 || User
::isIP( $name )
480 ||
strpos( $name, '/' ) !== false
481 ||
strlen( $name ) > $wgMaxNameChars
482 ||
$name != $wgContLang->ucfirst( $name ) ) {
483 wfDebugLog( 'username', __METHOD__
.
484 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
488 // Ensure that the name can't be misresolved as a different title,
489 // such as with extra namespace keys at the start.
490 $parsed = Title
::newFromText( $name );
491 if( is_null( $parsed )
492 ||
$parsed->getNamespace()
493 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
494 wfDebugLog( 'username', __METHOD__
.
495 ": '$name' invalid due to ambiguous prefixes" );
499 // Check an additional blacklist of troublemaker characters.
500 // Should these be merged into the title char list?
501 $unicodeBlacklist = '/[' .
502 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
503 '\x{00a0}' . # non-breaking space
504 '\x{2000}-\x{200f}' . # various whitespace
505 '\x{2028}-\x{202f}' . # breaks and control chars
506 '\x{3000}' . # ideographic space
507 '\x{e000}-\x{f8ff}' . # private use
509 if( preg_match( $unicodeBlacklist, $name ) ) {
510 wfDebugLog( 'username', __METHOD__
.
511 ": '$name' invalid due to blacklisted characters" );
519 * Usernames which fail to pass this function will be blocked
520 * from user login and new account registrations, but may be used
521 * internally by batch processes.
523 * If an account already exists in this form, login will be blocked
524 * by a failure to pass this function.
526 * @param $name \string String to match
527 * @return \bool True or false
529 static function isUsableName( $name ) {
530 global $wgReservedUsernames;
531 // Must be a valid username, obviously ;)
532 if ( !self
::isValidUserName( $name ) ) {
536 static $reservedUsernames = false;
537 if ( !$reservedUsernames ) {
538 $reservedUsernames = $wgReservedUsernames;
539 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
542 // Certain names may be reserved for batch processes.
543 foreach ( $reservedUsernames as $reserved ) {
544 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
545 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
547 if ( $reserved == $name ) {
555 * Usernames which fail to pass this function will be blocked
556 * from new account registrations, but may be used internally
557 * either by batch processes or by user accounts which have
558 * already been created.
560 * Additional blacklisting may be added here rather than in
561 * isValidUserName() to avoid disrupting existing accounts.
563 * @param $name \string String to match
564 * @return \bool True or false
566 static function isCreatableName( $name ) {
567 global $wgInvalidUsernameCharacters;
569 // Ensure that the username isn't longer than 235 bytes, so that
570 // (at least for the builtin skins) user javascript and css files
571 // will work. (bug 23080)
572 if( strlen( $name ) > 235 ) {
573 wfDebugLog( 'username', __METHOD__
.
574 ": '$name' invalid due to length" );
578 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
579 wfDebugLog( 'username', __METHOD__
.
580 ": '$name' invalid due to wgInvalidUsernameCharacters" );
584 return self
::isUsableName( $name );
588 * Is the input a valid password for this user?
590 * @param $password String Desired password
591 * @return bool True or false
593 function isValidPassword( $password ) {
594 //simple boolean wrapper for getPasswordValidity
595 return $this->getPasswordValidity( $password ) === true;
599 * Given unvalidated password input, return error message on failure.
601 * @param $password String Desired password
602 * @return mixed: true on success, string of error message on failure
604 function getPasswordValidity( $password ) {
605 global $wgMinimalPasswordLength, $wgWeakPasswords, $wgContLang;
607 $result = false; //init $result to false for the internal checks
609 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
612 $lcPassword = $wgContLang->lc( $password );
614 if ( $result === false ) {
615 if( strlen( $password ) < $wgMinimalPasswordLength ) {
616 return 'passwordtooshort';
617 } elseif ( $lcPassword == $wgContLang->lc( $this->mName
) ) {
618 return 'password-name-match';
619 } elseif ( in_array( $lcPassword, $wgWeakPasswords ) ) {
620 return 'password-too-weak';
622 //it seems weird returning true here, but this is because of the
623 //initialization of $result to false above. If the hook is never run or it
624 //doesn't modify $result, then we will likely get down into this if with
628 } elseif( $result === true ) {
631 return $result; //the isValidPassword hook set a string $result and returned true
636 * Does a string look like an e-mail address?
638 * There used to be a regular expression here, it got removed because it
639 * rejected valid addresses. Actually just check if there is '@' somewhere
640 * in the given address.
642 * @todo Check for RFC 2822 compilance (bug 959)
644 * @param $addr \string E-mail address
645 * @return \bool True or false
647 public static function isValidEmailAddr( $addr ) {
649 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
652 $rfc5322_atext = "a-z0-9!#$%&'*+-\/=?^_`{|}—~" ;
653 $rfc1034_ldh_str = "a-z0-9-" ;
655 $HTML5_email_regexp = "/
657 [$rfc5322_atext\\.]+ # user part which is liberal :p
659 [$rfc1034_ldh_str]+ # First domain part
660 (\\.[$rfc1034_ldh_str]+)+ # Following part prefixed with a dot
662 /ix" ; // case Insensitive, eXtended
664 return (bool) preg_match( $HTML5_email_regexp, $addr );
668 * Given unvalidated user input, return a canonical username, or false if
669 * the username is invalid.
670 * @param $name \string User input
671 * @param $validate \types{\string,\bool} Type of validation to use:
672 * - false No validation
673 * - 'valid' Valid for batch processes
674 * - 'usable' Valid for batch processes and login
675 * - 'creatable' Valid for batch processes, login and account creation
677 static function getCanonicalName( $name, $validate = 'valid' ) {
678 # Force usernames to capital
680 $name = $wgContLang->ucfirst( $name );
682 # Reject names containing '#'; these will be cleaned up
683 # with title normalisation, but then it's too late to
685 if( strpos( $name, '#' ) !== false )
688 # Clean up name according to title rules
689 $t = ( $validate === 'valid' ) ?
690 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
691 # Check for invalid titles
692 if( is_null( $t ) ) {
696 # Reject various classes of invalid names
698 $name = $wgAuth->getCanonicalName( $t->getText() );
700 switch ( $validate ) {
704 if ( !User
::isValidUserName( $name ) ) {
709 if ( !User
::isUsableName( $name ) ) {
714 if ( !User
::isCreatableName( $name ) ) {
719 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
725 * Count the number of edits of a user
726 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
728 * @param $uid \int User ID to check
729 * @return \int The user's edit count
731 static function edits( $uid ) {
732 wfProfileIn( __METHOD__
);
733 $dbr = wfGetDB( DB_SLAVE
);
734 // check if the user_editcount field has been initialized
735 $field = $dbr->selectField(
736 'user', 'user_editcount',
737 array( 'user_id' => $uid ),
741 if( $field === null ) { // it has not been initialized. do so.
742 $dbw = wfGetDB( DB_MASTER
);
743 $count = $dbr->selectField(
744 'revision', 'count(*)',
745 array( 'rev_user' => $uid ),
750 array( 'user_editcount' => $count ),
751 array( 'user_id' => $uid ),
757 wfProfileOut( __METHOD__
);
762 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
763 * @todo hash random numbers to improve security, like generateToken()
765 * @return \string New random password
767 static function randomPassword() {
768 global $wgMinimalPasswordLength;
769 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
770 $l = strlen( $pwchars ) - 1;
772 $pwlength = max( 7, $wgMinimalPasswordLength );
773 $digit = mt_rand( 0, $pwlength - 1 );
775 for ( $i = 0; $i < $pwlength; $i++
) {
776 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
782 * Set cached properties to default.
784 * @note This no longer clears uncached lazy-initialised properties;
785 * the constructor does that instead.
788 function loadDefaults( $name = false ) {
789 wfProfileIn( __METHOD__
);
794 $this->mName
= $name;
795 $this->mRealName
= '';
796 $this->mPassword
= $this->mNewpassword
= '';
797 $this->mNewpassTime
= null;
799 $this->mOptionOverrides
= null;
800 $this->mOptionsLoaded
= false;
802 if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) {
803 $this->mTouched
= wfTimestamp( TS_MW
, $wgRequest->getCookie( 'LoggedOut' ) );
805 $this->mTouched
= '0'; # Allow any pages to be cached
808 $this->setToken(); # Random
809 $this->mEmailAuthenticated
= null;
810 $this->mEmailToken
= '';
811 $this->mEmailTokenExpires
= null;
812 $this->mRegistration
= wfTimestamp( TS_MW
);
813 $this->mGroups
= array();
815 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
817 wfProfileOut( __METHOD__
);
821 * @deprecated Use wfSetupSession().
823 function SetupSession() {
824 wfDeprecated( __METHOD__
);
829 * Load user data from the session or login cookie. If there are no valid
830 * credentials, initialises the user as an anonymous user.
831 * @return \bool True if the user is logged in, false otherwise.
833 private function loadFromSession() {
834 global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy;
837 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
838 if ( $result !== null ) {
842 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
843 $extUser = ExternalUser
::newFromCookie();
845 # TODO: Automatically create the user here (or probably a bit
846 # lower down, in fact)
850 if ( $wgRequest->getCookie( 'UserID' ) !== null ) {
851 $sId = intval( $wgRequest->getCookie( 'UserID' ) );
852 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
853 $this->loadDefaults(); // Possible collision!
854 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
855 cookie user ID ($sId) don't match!" );
858 $_SESSION['wsUserID'] = $sId;
859 } else if ( isset( $_SESSION['wsUserID'] ) ) {
860 if ( $_SESSION['wsUserID'] != 0 ) {
861 $sId = $_SESSION['wsUserID'];
863 $this->loadDefaults();
867 $this->loadDefaults();
871 if ( isset( $_SESSION['wsUserName'] ) ) {
872 $sName = $_SESSION['wsUserName'];
873 } else if ( $wgRequest->getCookie('UserName') !== null ) {
874 $sName = $wgRequest->getCookie('UserName');
875 $_SESSION['wsUserName'] = $sName;
877 $this->loadDefaults();
882 if ( !$this->loadFromId() ) {
883 # Not a valid ID, loadFromId has switched the object to anon for us
887 global $wgBlockDisablesLogin;
888 if( $wgBlockDisablesLogin && $this->isBlocked() ) {
889 # User blocked and we've disabled blocked user logins
890 $this->loadDefaults();
894 if ( isset( $_SESSION['wsToken'] ) ) {
895 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
897 } else if ( $wgRequest->getCookie( 'Token' ) !== null ) {
898 $passwordCorrect = $this->mToken
== $wgRequest->getCookie( 'Token' );
901 # No session or persistent login cookie
902 $this->loadDefaults();
906 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
907 $_SESSION['wsToken'] = $this->mToken
;
908 wfDebug( "User: logged in from $from\n" );
911 # Invalid credentials
912 wfDebug( "User: can't log in from $from, invalid credentials\n" );
913 $this->loadDefaults();
919 * Load user and user_group data from the database.
920 * $this::mId must be set, this is how the user is identified.
922 * @return \bool True if the user exists, false if the user is anonymous
925 function loadFromDatabase() {
927 $this->mId
= intval( $this->mId
);
929 /** Anonymous user */
931 $this->loadDefaults();
935 $dbr = wfGetDB( DB_MASTER
);
936 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
938 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
940 if ( $s !== false ) {
941 # Initialise user table data
942 $this->loadFromRow( $s );
943 $this->mGroups
= null; // deferred
944 $this->getEditCount(); // revalidation for nulls
949 $this->loadDefaults();
955 * Initialize this object from a row from the user table.
957 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
959 function loadFromRow( $row ) {
960 $this->mDataLoaded
= true;
962 if ( isset( $row->user_id
) ) {
963 $this->mId
= intval( $row->user_id
);
965 $this->mName
= $row->user_name
;
966 $this->mRealName
= $row->user_real_name
;
967 $this->mPassword
= $row->user_password
;
968 $this->mNewpassword
= $row->user_newpassword
;
969 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
970 $this->mEmail
= $row->user_email
;
971 $this->decodeOptions( $row->user_options
);
972 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
973 $this->mToken
= $row->user_token
;
974 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
975 $this->mEmailToken
= $row->user_email_token
;
976 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
977 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
978 $this->mEditCount
= $row->user_editcount
;
982 * Load the groups from the database if they aren't already loaded.
985 function loadGroups() {
986 if ( is_null( $this->mGroups
) ) {
987 $dbr = wfGetDB( DB_MASTER
);
988 $res = $dbr->select( 'user_groups',
990 array( 'ug_user' => $this->mId
),
992 $this->mGroups
= array();
993 foreach ( $res as $row ) {
994 $this->mGroups
[] = $row->ug_group
;
1000 * Clear various cached data stored in this object.
1001 * @param $reloadFrom \string Reload user and user_groups table data from a
1002 * given source. May be "name", "id", "defaults", "session", or false for
1005 function clearInstanceCache( $reloadFrom = false ) {
1006 $this->mNewtalk
= -1;
1007 $this->mDatePreference
= null;
1008 $this->mBlockedby
= -1; # Unset
1009 $this->mHash
= false;
1010 $this->mSkin
= null;
1011 $this->mRights
= null;
1012 $this->mEffectiveGroups
= null;
1013 $this->mOptions
= null;
1015 if ( $reloadFrom ) {
1016 $this->mDataLoaded
= false;
1017 $this->mFrom
= $reloadFrom;
1022 * Combine the language default options with any site-specific options
1023 * and add the default language variants.
1025 * @return \type{\arrayof{\string}} Array of options
1027 static function getDefaultOptions() {
1028 global $wgNamespacesToBeSearchedDefault;
1030 * Site defaults will override the global/language defaults
1032 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1033 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1036 * default language setting
1038 $variant = $wgContLang->getDefaultVariant();
1039 $defOpt['variant'] = $variant;
1040 $defOpt['language'] = $variant;
1041 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1042 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1044 $defOpt['skin'] = $wgDefaultSkin;
1050 * Get a given default option value.
1052 * @param $opt \string Name of option to retrieve
1053 * @return \string Default option value
1055 public static function getDefaultOption( $opt ) {
1056 $defOpts = self
::getDefaultOptions();
1057 if( isset( $defOpts[$opt] ) ) {
1058 return $defOpts[$opt];
1066 * Get blocking information
1068 * @param $bFromSlave \bool Whether to check the slave database first. To
1069 * improve performance, non-critical checks are done
1070 * against slaves. Check when actually saving should be
1071 * done against master.
1073 function getBlockedStatus( $bFromSlave = true ) {
1074 global $wgProxyWhitelist, $wgUser;
1076 if ( -1 != $this->mBlockedby
) {
1077 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1081 wfProfileIn( __METHOD__
);
1082 wfDebug( __METHOD__
.": checking...\n" );
1084 // Initialize data...
1085 // Otherwise something ends up stomping on $this->mBlockedby when
1086 // things get lazy-loaded later, causing false positive block hits
1087 // due to -1 !== 0. Probably session-related... Nothing should be
1088 // overwriting mBlockedby, surely?
1091 $this->mBlockedby
= 0;
1092 $this->mHideName
= 0;
1093 $this->mAllowUsertalk
= 0;
1095 # Check if we are looking at an IP or a logged-in user
1096 if ( $this->isIP( $this->getName() ) ) {
1097 $ip = $this->getName();
1099 # Check if we are looking at the current user
1100 # If we don't, and the user is logged in, we don't know about
1101 # his IP / autoblock status, so ignore autoblock of current user's IP
1102 if ( $this->getID() != $wgUser->getID() ) {
1105 # Get IP of current user
1110 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1111 # Exempt from all types of IP-block
1116 $this->mBlock
= new Block();
1117 $this->mBlock
->fromMaster( !$bFromSlave );
1118 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1119 wfDebug( __METHOD__
. ": Found block.\n" );
1120 $this->mBlockedby
= $this->mBlock
->mBy
;
1121 if( $this->mBlockedby
== 0 )
1122 $this->mBlockedby
= $this->mBlock
->mByName
;
1123 $this->mBlockreason
= $this->mBlock
->mReason
;
1124 $this->mHideName
= $this->mBlock
->mHideName
;
1125 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1126 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1127 $this->spreadBlock();
1130 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1131 // apply to users. Note that the existence of $this->mBlock is not used to
1132 // check for edit blocks, $this->mBlockedby is instead.
1136 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1138 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1139 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1140 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1144 if ( !$this->mBlockedby
&& !$this->getID() ) {
1145 if ( $this->isDnsBlacklisted( $ip ) ) {
1146 $this->mBlockedby
= wfMsg( 'sorbs' );
1147 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1153 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1155 wfProfileOut( __METHOD__
);
1159 * Whether the given IP is in a DNS blacklist.
1161 * @param $ip \string IP to check
1162 * @param $checkWhitelist Boolean: whether to check the whitelist first
1163 * @return \bool True if blacklisted.
1165 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1166 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1167 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1169 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1172 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1175 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1176 return $this->inDnsBlacklist( $ip, $urls );
1180 * Whether the given IP is in a given DNS blacklist.
1182 * @param $ip \string IP to check
1183 * @param $bases \string or Array of Strings: URL of the DNS blacklist
1184 * @return \bool True if blacklisted.
1186 function inDnsBlacklist( $ip, $bases ) {
1187 wfProfileIn( __METHOD__
);
1190 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1191 if( IP
::isIPv4( $ip ) ) {
1192 # Reverse IP, bug 21255
1193 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1195 foreach( (array)$bases as $base ) {
1197 $host = "$ipReversed.$base";
1200 $ipList = gethostbynamel( $host );
1203 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1207 wfDebug( "Requested $host, not found in $base.\n" );
1212 wfProfileOut( __METHOD__
);
1217 * Is this user subject to rate limiting?
1219 * @return \bool True if rate limited
1221 public function isPingLimitable() {
1222 global $wgRateLimitsExcludedGroups;
1223 global $wgRateLimitsExcludedIPs;
1224 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1225 // Deprecated, but kept for backwards-compatibility config
1228 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1229 // No other good way currently to disable rate limits
1230 // for specific IPs. :P
1231 // But this is a crappy hack and should die.
1234 return !$this->isAllowed('noratelimit');
1238 * Primitive rate limits: enforce maximum actions per time period
1239 * to put a brake on flooding.
1241 * @note When using a shared cache like memcached, IP-address
1242 * last-hit counters will be shared across wikis.
1244 * @param $action \string Action to enforce; 'edit' if unspecified
1245 * @return \bool True if a rate limiter was tripped
1247 function pingLimiter( $action = 'edit' ) {
1248 # Call the 'PingLimiter' hook
1250 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1254 global $wgRateLimits;
1255 if( !isset( $wgRateLimits[$action] ) ) {
1259 # Some groups shouldn't trigger the ping limiter, ever
1260 if( !$this->isPingLimitable() )
1263 global $wgMemc, $wgRateLimitLog;
1264 wfProfileIn( __METHOD__
);
1266 $limits = $wgRateLimits[$action];
1268 $id = $this->getId();
1272 if( isset( $limits['anon'] ) && $id == 0 ) {
1273 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1276 if( isset( $limits['user'] ) && $id != 0 ) {
1277 $userLimit = $limits['user'];
1279 if( $this->isNewbie() ) {
1280 if( isset( $limits['newbie'] ) && $id != 0 ) {
1281 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1283 if( isset( $limits['ip'] ) ) {
1284 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1287 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1288 $subnet = $matches[1];
1289 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1292 // Check for group-specific permissions
1293 // If more than one group applies, use the group with the highest limit
1294 foreach ( $this->getGroups() as $group ) {
1295 if ( isset( $limits[$group] ) ) {
1296 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1297 $userLimit = $limits[$group];
1301 // Set the user limit key
1302 if ( $userLimit !== false ) {
1303 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1304 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1308 foreach( $keys as $key => $limit ) {
1309 list( $max, $period ) = $limit;
1310 $summary = "(limit $max in {$period}s)";
1311 $count = $wgMemc->get( $key );
1314 if( $count > $max ) {
1315 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1316 if( $wgRateLimitLog ) {
1317 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1321 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1324 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1325 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1327 $wgMemc->incr( $key );
1330 wfProfileOut( __METHOD__
);
1335 * Check if user is blocked
1337 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1338 * @return \bool True if blocked, false otherwise
1340 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1341 wfDebug( "User::isBlocked: enter\n" );
1342 $this->getBlockedStatus( $bFromSlave );
1343 return $this->mBlockedby
!== 0;
1347 * Check if user is blocked from editing a particular article
1349 * @param $title \string Title to check
1350 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1351 * @return \bool True if blocked, false otherwise
1353 function isBlockedFrom( $title, $bFromSlave = false ) {
1354 global $wgBlockAllowsUTEdit;
1355 wfProfileIn( __METHOD__
);
1356 wfDebug( __METHOD__
. ": enter\n" );
1358 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1359 $blocked = $this->isBlocked( $bFromSlave );
1360 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1361 # If a user's name is suppressed, they cannot make edits anywhere
1362 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1363 $title->getNamespace() == NS_USER_TALK
) {
1365 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1368 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1370 wfProfileOut( __METHOD__
);
1375 * If user is blocked, return the name of the user who placed the block
1376 * @return \string name of blocker
1378 function blockedBy() {
1379 $this->getBlockedStatus();
1380 return $this->mBlockedby
;
1384 * If user is blocked, return the specified reason for the block
1385 * @return \string Blocking reason
1387 function blockedFor() {
1388 $this->getBlockedStatus();
1389 return $this->mBlockreason
;
1393 * If user is blocked, return the ID for the block
1394 * @return \int Block ID
1396 function getBlockId() {
1397 $this->getBlockedStatus();
1398 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1402 * Check if user is blocked on all wikis.
1403 * Do not use for actual edit permission checks!
1404 * This is intented for quick UI checks.
1406 * @param $ip \type{\string} IP address, uses current client if none given
1407 * @return \type{\bool} True if blocked, false otherwise
1409 function isBlockedGlobally( $ip = '' ) {
1410 if( $this->mBlockedGlobally
!== null ) {
1411 return $this->mBlockedGlobally
;
1413 // User is already an IP?
1414 if( IP
::isIPAddress( $this->getName() ) ) {
1415 $ip = $this->getName();
1420 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1421 $this->mBlockedGlobally
= (bool)$blocked;
1422 return $this->mBlockedGlobally
;
1426 * Check if user account is locked
1428 * @return \type{\bool} True if locked, false otherwise
1430 function isLocked() {
1431 if( $this->mLocked
!== null ) {
1432 return $this->mLocked
;
1435 $authUser = $wgAuth->getUserInstance( $this );
1436 $this->mLocked
= (bool)$authUser->isLocked();
1437 return $this->mLocked
;
1441 * Check if user account is hidden
1443 * @return \type{\bool} True if hidden, false otherwise
1445 function isHidden() {
1446 if( $this->mHideName
!== null ) {
1447 return $this->mHideName
;
1449 $this->getBlockedStatus();
1450 if( !$this->mHideName
) {
1452 $authUser = $wgAuth->getUserInstance( $this );
1453 $this->mHideName
= (bool)$authUser->isHidden();
1455 return $this->mHideName
;
1459 * Get the user's ID.
1460 * @return Integer The user's ID; 0 if the user is anonymous or nonexistent
1463 if( $this->mId
=== null and $this->mName
!== null
1464 and User
::isIP( $this->mName
) ) {
1465 // Special case, we know the user is anonymous
1467 } elseif( $this->mId
=== null ) {
1468 // Don't load if this was initialized from an ID
1475 * Set the user and reload all fields according to a given ID
1476 * @param $v \int User ID to reload
1478 function setId( $v ) {
1480 $this->clearInstanceCache( 'id' );
1484 * Get the user name, or the IP of an anonymous user
1485 * @return \string User's name or IP address
1487 function getName() {
1488 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1489 # Special case optimisation
1490 return $this->mName
;
1493 if ( $this->mName
=== false ) {
1495 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1497 return $this->mName
;
1502 * Set the user name.
1504 * This does not reload fields from the database according to the given
1505 * name. Rather, it is used to create a temporary "nonexistent user" for
1506 * later addition to the database. It can also be used to set the IP
1507 * address for an anonymous user to something other than the current
1510 * @note User::newFromName() has rougly the same function, when the named user
1512 * @param $str \string New user name to set
1514 function setName( $str ) {
1516 $this->mName
= $str;
1520 * Get the user's name escaped by underscores.
1521 * @return \string Username escaped by underscores.
1523 function getTitleKey() {
1524 return str_replace( ' ', '_', $this->getName() );
1528 * Check if the user has new messages.
1529 * @return \bool True if the user has new messages
1531 function getNewtalk() {
1534 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1535 if( $this->mNewtalk
=== -1 ) {
1536 $this->mNewtalk
= false; # reset talk page status
1538 # Check memcached separately for anons, who have no
1539 # entire User object stored in there.
1542 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1543 $newtalk = $wgMemc->get( $key );
1544 if( strval( $newtalk ) !== '' ) {
1545 $this->mNewtalk
= (bool)$newtalk;
1547 // Since we are caching this, make sure it is up to date by getting it
1549 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1550 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1553 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1557 return (bool)$this->mNewtalk
;
1561 * Return the talk page(s) this user has new messages on.
1562 * @return \type{\arrayof{\string}} Array of page URLs
1564 function getNewMessageLinks() {
1566 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1569 if( !$this->getNewtalk() )
1571 $up = $this->getUserPage();
1572 $utp = $up->getTalkPage();
1573 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1577 * Internal uncached check for new messages
1580 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1581 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1582 * @param $fromMaster \bool true to fetch from the master, false for a slave
1583 * @return \bool True if the user has new messages
1586 function checkNewtalk( $field, $id, $fromMaster = false ) {
1587 if ( $fromMaster ) {
1588 $db = wfGetDB( DB_MASTER
);
1590 $db = wfGetDB( DB_SLAVE
);
1592 $ok = $db->selectField( 'user_newtalk', $field,
1593 array( $field => $id ), __METHOD__
);
1594 return $ok !== false;
1598 * Add or update the new messages flag
1599 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1600 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1601 * @return \bool True if successful, false otherwise
1604 function updateNewtalk( $field, $id ) {
1605 $dbw = wfGetDB( DB_MASTER
);
1606 $dbw->insert( 'user_newtalk',
1607 array( $field => $id ),
1610 if ( $dbw->affectedRows() ) {
1611 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1614 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1620 * Clear the new messages flag for the given user
1621 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1622 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1623 * @return \bool True if successful, false otherwise
1626 function deleteNewtalk( $field, $id ) {
1627 $dbw = wfGetDB( DB_MASTER
);
1628 $dbw->delete( 'user_newtalk',
1629 array( $field => $id ),
1631 if ( $dbw->affectedRows() ) {
1632 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1635 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1641 * Update the 'You have new messages!' status.
1642 * @param $val \bool Whether the user has new messages
1644 function setNewtalk( $val ) {
1645 if( wfReadOnly() ) {
1650 $this->mNewtalk
= $val;
1652 if( $this->isAnon() ) {
1654 $id = $this->getName();
1657 $id = $this->getId();
1662 $changed = $this->updateNewtalk( $field, $id );
1664 $changed = $this->deleteNewtalk( $field, $id );
1667 if( $this->isAnon() ) {
1668 // Anons have a separate memcached space, since
1669 // user records aren't kept for them.
1670 $key = wfMemcKey( 'newtalk', 'ip', $id );
1671 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1674 $this->invalidateCache();
1679 * Generate a current or new-future timestamp to be stored in the
1680 * user_touched field when we update things.
1681 * @return \string Timestamp in TS_MW format
1683 private static function newTouchedTimestamp() {
1684 global $wgClockSkewFudge;
1685 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1689 * Clear user data from memcached.
1690 * Use after applying fun updates to the database; caller's
1691 * responsibility to update user_touched if appropriate.
1693 * Called implicitly from invalidateCache() and saveSettings().
1695 private function clearSharedCache() {
1699 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1704 * Immediately touch the user data cache for this account.
1705 * Updates user_touched field, and removes account data from memcached
1706 * for reload on the next hit.
1708 function invalidateCache() {
1709 if( wfReadOnly() ) {
1714 $this->mTouched
= self
::newTouchedTimestamp();
1716 $dbw = wfGetDB( DB_MASTER
);
1717 $dbw->update( 'user',
1718 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1719 array( 'user_id' => $this->mId
),
1722 $this->clearSharedCache();
1727 * Validate the cache for this account.
1728 * @param $timestamp \string A timestamp in TS_MW format
1730 function validateCache( $timestamp ) {
1732 return ( $timestamp >= $this->mTouched
);
1736 * Get the user touched timestamp
1738 function getTouched() {
1740 return $this->mTouched
;
1744 * Set the password and reset the random token.
1745 * Calls through to authentication plugin if necessary;
1746 * will have no effect if the auth plugin refuses to
1747 * pass the change through or if the legal password
1750 * As a special case, setting the password to null
1751 * wipes it, so the account cannot be logged in until
1752 * a new password is set, for instance via e-mail.
1754 * @param $str \string New password to set
1755 * @throws PasswordError on failure
1757 function setPassword( $str ) {
1760 if( $str !== null ) {
1761 if( !$wgAuth->allowPasswordChange() ) {
1762 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1765 if( !$this->isValidPassword( $str ) ) {
1766 global $wgMinimalPasswordLength;
1767 $valid = $this->getPasswordValidity( $str );
1768 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1769 $wgMinimalPasswordLength ) );
1773 if( !$wgAuth->setPassword( $this, $str ) ) {
1774 throw new PasswordError( wfMsg( 'externaldberror' ) );
1777 $this->setInternalPassword( $str );
1783 * Set the password and reset the random token unconditionally.
1785 * @param $str \string New password to set
1787 function setInternalPassword( $str ) {
1791 if( $str === null ) {
1792 // Save an invalid hash...
1793 $this->mPassword
= '';
1795 $this->mPassword
= self
::crypt( $str );
1797 $this->mNewpassword
= '';
1798 $this->mNewpassTime
= null;
1802 * Get the user's current token.
1803 * @return \string Token
1805 function getToken() {
1807 return $this->mToken
;
1811 * Set the random token (used for persistent authentication)
1812 * Called from loadDefaults() among other places.
1814 * @param $token \string If specified, set the token to this value
1817 function setToken( $token = false ) {
1818 global $wgSecretKey, $wgProxyKey;
1821 if ( $wgSecretKey ) {
1822 $key = $wgSecretKey;
1823 } elseif ( $wgProxyKey ) {
1828 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1830 $this->mToken
= $token;
1835 * Set the cookie password
1837 * @param $str \string New cookie password
1840 function setCookiePassword( $str ) {
1842 $this->mCookiePassword
= md5( $str );
1846 * Set the password for a password reminder or new account email
1848 * @param $str \string New password to set
1849 * @param $throttle \bool If true, reset the throttle timestamp to the present
1851 function setNewpassword( $str, $throttle = true ) {
1853 $this->mNewpassword
= self
::crypt( $str );
1855 $this->mNewpassTime
= wfTimestampNow();
1860 * Has password reminder email been sent within the last
1861 * $wgPasswordReminderResendTime hours?
1862 * @return \bool True or false
1864 function isPasswordReminderThrottled() {
1865 global $wgPasswordReminderResendTime;
1867 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1870 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1871 return time() < $expiry;
1875 * Get the user's e-mail address
1876 * @return \string User's email address
1878 function getEmail() {
1880 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1881 return $this->mEmail
;
1885 * Get the timestamp of the user's e-mail authentication
1886 * @return \string TS_MW timestamp
1888 function getEmailAuthenticationTimestamp() {
1890 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1891 return $this->mEmailAuthenticated
;
1895 * Set the user's e-mail address
1896 * @param $str \string New e-mail address
1898 function setEmail( $str ) {
1900 $this->mEmail
= $str;
1901 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1905 * Get the user's real name
1906 * @return \string User's real name
1908 function getRealName() {
1910 return $this->mRealName
;
1914 * Set the user's real name
1915 * @param $str \string New real name
1917 function setRealName( $str ) {
1919 $this->mRealName
= $str;
1923 * Get the user's current setting for a given option.
1925 * @param $oname \string The option to check
1926 * @param $defaultOverride \string A default value returned if the option does not exist
1927 * @return \string User's current value for the option
1928 * @see getBoolOption()
1929 * @see getIntOption()
1931 function getOption( $oname, $defaultOverride = null ) {
1932 $this->loadOptions();
1934 if ( is_null( $this->mOptions
) ) {
1935 if($defaultOverride != '') {
1936 return $defaultOverride;
1938 $this->mOptions
= User
::getDefaultOptions();
1941 if ( array_key_exists( $oname, $this->mOptions
) ) {
1942 return $this->mOptions
[$oname];
1944 return $defaultOverride;
1949 * Get all user's options
1953 public function getOptions() {
1954 $this->loadOptions();
1955 return $this->mOptions
;
1959 * Get the user's current setting for a given option, as a boolean value.
1961 * @param $oname \string The option to check
1962 * @return \bool User's current value for the option
1965 function getBoolOption( $oname ) {
1966 return (bool)$this->getOption( $oname );
1971 * Get the user's current setting for a given option, as a boolean value.
1973 * @param $oname \string The option to check
1974 * @param $defaultOverride \int A default value returned if the option does not exist
1975 * @return \int User's current value for the option
1978 function getIntOption( $oname, $defaultOverride=0 ) {
1979 $val = $this->getOption( $oname );
1981 $val = $defaultOverride;
1983 return intval( $val );
1987 * Set the given option for a user.
1989 * @param $oname \string The option to set
1990 * @param $val \mixed New value to set
1992 function setOption( $oname, $val ) {
1994 $this->loadOptions();
1996 if ( $oname == 'skin' ) {
1997 # Clear cached skin, so the new one displays immediately in Special:Preferences
1998 $this->mSkin
= null;
2001 // Explicitly NULL values should refer to defaults
2002 global $wgDefaultUserOptions;
2003 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2004 $val = $wgDefaultUserOptions[$oname];
2007 $this->mOptions
[$oname] = $val;
2011 * Reset all options to the site defaults
2013 function resetOptions() {
2014 $this->mOptions
= User
::getDefaultOptions();
2018 * Get the user's preferred date format.
2019 * @return \string User's preferred date format
2021 function getDatePreference() {
2022 // Important migration for old data rows
2023 if ( is_null( $this->mDatePreference
) ) {
2025 $value = $this->getOption( 'date' );
2026 $map = $wgLang->getDatePreferenceMigrationMap();
2027 if ( isset( $map[$value] ) ) {
2028 $value = $map[$value];
2030 $this->mDatePreference
= $value;
2032 return $this->mDatePreference
;
2036 * Get the user preferred stub threshold
2038 function getStubThreshold() {
2039 global $wgMaxArticleSize; # Maximum article size, in Kb
2040 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2041 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2042 # If they have set an impossible value, disable the preference
2043 # so we can use the parser cache again.
2050 * Get the permissions this user has.
2051 * @return \type{\arrayof{\string}} Array of permission names
2053 function getRights() {
2054 if ( is_null( $this->mRights
) ) {
2055 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2056 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2057 // Force reindexation of rights when a hook has unset one of them
2058 $this->mRights
= array_values( $this->mRights
);
2060 return $this->mRights
;
2064 * Get the list of explicit group memberships this user has.
2065 * The implicit * and user groups are not included.
2066 * @return \type{\arrayof{\string}} Array of internal group names
2068 function getGroups() {
2070 return $this->mGroups
;
2074 * Get the list of implicit group memberships this user has.
2075 * This includes all explicit groups, plus 'user' if logged in,
2076 * '*' for all accounts and autopromoted groups
2077 * @param $recache \bool Whether to avoid the cache
2078 * @return \type{\arrayof{\string}} Array of internal group names
2080 function getEffectiveGroups( $recache = false ) {
2081 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2082 wfProfileIn( __METHOD__
);
2083 $this->mEffectiveGroups
= $this->getGroups();
2084 $this->mEffectiveGroups
[] = '*';
2085 if( $this->getId() ) {
2086 $this->mEffectiveGroups
[] = 'user';
2088 $this->mEffectiveGroups
= array_unique( array_merge(
2089 $this->mEffectiveGroups
,
2090 Autopromote
::getAutopromoteGroups( $this )
2093 # Hook for additional groups
2094 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2096 wfProfileOut( __METHOD__
);
2098 return $this->mEffectiveGroups
;
2102 * Get the user's edit count.
2103 * @return \int User'e edit count
2105 function getEditCount() {
2106 if( $this->getId() ) {
2107 if ( !isset( $this->mEditCount
) ) {
2108 /* Populate the count, if it has not been populated yet */
2109 $this->mEditCount
= User
::edits( $this->mId
);
2111 return $this->mEditCount
;
2119 * Add the user to the given group.
2120 * This takes immediate effect.
2121 * @param $group \string Name of the group to add
2123 function addGroup( $group ) {
2124 $dbw = wfGetDB( DB_MASTER
);
2125 if( $this->getId() ) {
2126 $dbw->insert( 'user_groups',
2128 'ug_user' => $this->getID(),
2129 'ug_group' => $group,
2132 array( 'IGNORE' ) );
2135 $this->loadGroups();
2136 $this->mGroups
[] = $group;
2137 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2139 $this->invalidateCache();
2143 * Remove the user from the given group.
2144 * This takes immediate effect.
2145 * @param $group \string Name of the group to remove
2147 function removeGroup( $group ) {
2149 $dbw = wfGetDB( DB_MASTER
);
2150 $dbw->delete( 'user_groups',
2152 'ug_user' => $this->getID(),
2153 'ug_group' => $group,
2156 $this->loadGroups();
2157 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2158 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2160 $this->invalidateCache();
2164 * Get whether the user is logged in
2165 * @return \bool True or false
2167 function isLoggedIn() {
2168 return $this->getID() != 0;
2172 * Get whether the user is anonymous
2173 * @return \bool True or false
2176 return !$this->isLoggedIn();
2180 * Get whether the user is a bot
2181 * @return \bool True or false
2185 wfDeprecated( __METHOD__
);
2186 return $this->isAllowed( 'bot' );
2190 * Check if user is allowed to access a feature / make an action
2191 * @param $action \string action to be checked
2192 * @return Boolean: True if action is allowed, else false
2194 function isAllowed( $action = '' ) {
2195 if ( $action === '' ) {
2196 return true; // In the spirit of DWIM
2198 # Patrolling may not be enabled
2199 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2200 global $wgUseRCPatrol, $wgUseNPPatrol;
2201 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2204 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2205 # by misconfiguration: 0 == 'foo'
2206 return in_array( $action, $this->getRights(), true );
2210 * Check whether to enable recent changes patrol features for this user
2211 * @return Boolean: True or false
2213 public function useRCPatrol() {
2214 global $wgUseRCPatrol;
2215 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2219 * Check whether to enable new pages patrol features for this user
2220 * @return \bool True or false
2222 public function useNPPatrol() {
2223 global $wgUseRCPatrol, $wgUseNPPatrol;
2224 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2228 * Get the current skin, loading it if required, and setting a title
2229 * @param $t Title: the title to use in the skin
2230 * @return Skin The current skin
2231 * @todo FIXME : need to check the old failback system [AV]
2233 function getSkin( $t = null ) {
2235 $skin = $this->createSkinObject();
2236 $skin->setTitle( $t );
2239 if ( !$this->mSkin
) {
2240 $this->mSkin
= $this->createSkinObject();
2243 if ( !$this->mSkin
->getTitle() ) {
2245 $t = $wgOut->getTitle();
2246 $this->mSkin
->setTitle($t);
2249 return $this->mSkin
;
2253 // Creates a Skin object, for getSkin()
2254 private function createSkinObject() {
2255 wfProfileIn( __METHOD__
);
2257 global $wgHiddenPrefs;
2258 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2261 $userSkin = $this->getOption( 'skin' );
2262 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2264 # if we're not allowing users to override, then use the default
2265 global $wgDefaultSkin;
2266 $userSkin = $wgDefaultSkin;
2269 $skin = Skin
::newFromKey( $userSkin );
2270 wfProfileOut( __METHOD__
);
2276 * Check the watched status of an article.
2277 * @param $title \type{Title} Title of the article to look at
2278 * @return \bool True if article is watched
2280 function isWatched( $title ) {
2281 $wl = WatchedItem
::fromUserTitle( $this, $title );
2282 return $wl->isWatched();
2287 * @param $title \type{Title} Title of the article to look at
2289 function addWatch( $title ) {
2290 $wl = WatchedItem
::fromUserTitle( $this, $title );
2292 $this->invalidateCache();
2296 * Stop watching an article.
2297 * @param $title \type{Title} Title of the article to look at
2299 function removeWatch( $title ) {
2300 $wl = WatchedItem
::fromUserTitle( $this, $title );
2302 $this->invalidateCache();
2306 * Clear the user's notification timestamp for the given title.
2307 * If e-notif e-mails are on, they will receive notification mails on
2308 * the next change of the page if it's watched etc.
2309 * @param $title \type{Title} Title of the article to look at
2311 function clearNotification( &$title ) {
2312 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2314 # Do nothing if the database is locked to writes
2315 if( wfReadOnly() ) {
2319 if( $title->getNamespace() == NS_USER_TALK
&&
2320 $title->getText() == $this->getName() ) {
2321 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2323 $this->setNewtalk( false );
2326 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2330 if( $this->isAnon() ) {
2331 // Nothing else to do...
2335 // Only update the timestamp if the page is being watched.
2336 // The query to find out if it is watched is cached both in memcached and per-invocation,
2337 // and when it does have to be executed, it can be on a slave
2338 // If this is the user's newtalk page, we always update the timestamp
2339 if( $title->getNamespace() == NS_USER_TALK
&&
2340 $title->getText() == $wgUser->getName() )
2343 } elseif ( $this->getId() == $wgUser->getId() ) {
2344 $watched = $title->userIsWatching();
2349 // If the page is watched by the user (or may be watched), update the timestamp on any
2350 // any matching rows
2352 $dbw = wfGetDB( DB_MASTER
);
2353 $dbw->update( 'watchlist',
2355 'wl_notificationtimestamp' => null
2356 ), array( /* WHERE */
2357 'wl_title' => $title->getDBkey(),
2358 'wl_namespace' => $title->getNamespace(),
2359 'wl_user' => $this->getID()
2366 * Resets all of the given user's page-change notification timestamps.
2367 * If e-notif e-mails are on, they will receive notification mails on
2368 * the next change of any watched page.
2370 * @param $currentUser \int User ID
2372 function clearAllNotifications( $currentUser ) {
2373 global $wgUseEnotif, $wgShowUpdatedMarker;
2374 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2375 $this->setNewtalk( false );
2378 if( $currentUser != 0 ) {
2379 $dbw = wfGetDB( DB_MASTER
);
2380 $dbw->update( 'watchlist',
2382 'wl_notificationtimestamp' => null
2383 ), array( /* WHERE */
2384 'wl_user' => $currentUser
2387 # We also need to clear here the "you have new message" notification for the own user_talk page
2388 # This is cleared one page view later in Article::viewUpdates();
2393 * Set this user's options from an encoded string
2394 * @param $str \string Encoded options to import
2397 function decodeOptions( $str ) {
2401 $this->mOptionsLoaded
= true;
2402 $this->mOptionOverrides
= array();
2404 // If an option is not set in $str, use the default value
2405 $this->mOptions
= self
::getDefaultOptions();
2407 $a = explode( "\n", $str );
2408 foreach ( $a as $s ) {
2410 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2411 $this->mOptions
[$m[1]] = $m[2];
2412 $this->mOptionOverrides
[$m[1]] = $m[2];
2418 * Set a cookie on the user's client. Wrapper for
2419 * WebResponse::setCookie
2420 * @param $name \string Name of the cookie to set
2421 * @param $value \string Value to set
2422 * @param $exp \int Expiration time, as a UNIX time value;
2423 * if 0 or not specified, use the default $wgCookieExpiration
2425 protected function setCookie( $name, $value, $exp = 0 ) {
2427 $wgRequest->response()->setcookie( $name, $value, $exp );
2431 * Clear a cookie on the user's client
2432 * @param $name \string Name of the cookie to clear
2434 protected function clearCookie( $name ) {
2435 $this->setCookie( $name, '', time() - 86400 );
2439 * Set the default cookies for this session on the user's client.
2441 function setCookies() {
2443 if ( 0 == $this->mId
) return;
2445 'wsUserID' => $this->mId
,
2446 'wsToken' => $this->mToken
,
2447 'wsUserName' => $this->getName()
2450 'UserID' => $this->mId
,
2451 'UserName' => $this->getName(),
2453 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2454 $cookies['Token'] = $this->mToken
;
2456 $cookies['Token'] = false;
2459 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2460 #check for null, since the hook could cause a null value
2461 if ( !is_null( $session ) && isset( $_SESSION ) ){
2462 $_SESSION = $session +
$_SESSION;
2464 foreach ( $cookies as $name => $value ) {
2465 if ( $value === false ) {
2466 $this->clearCookie( $name );
2468 $this->setCookie( $name, $value );
2474 * Log this user out.
2477 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2483 * Clear the user's cookies and session, and reset the instance cache.
2487 function doLogout() {
2488 $this->clearInstanceCache( 'defaults' );
2490 $_SESSION['wsUserID'] = 0;
2492 $this->clearCookie( 'UserID' );
2493 $this->clearCookie( 'Token' );
2495 # Remember when user logged out, to prevent seeing cached pages
2496 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2500 * Save this user's settings into the database.
2501 * @todo Only rarely do all these fields need to be set!
2503 function saveSettings() {
2505 if ( wfReadOnly() ) { return; }
2506 if ( 0 == $this->mId
) { return; }
2508 $this->mTouched
= self
::newTouchedTimestamp();
2510 $dbw = wfGetDB( DB_MASTER
);
2511 $dbw->update( 'user',
2513 'user_name' => $this->mName
,
2514 'user_password' => $this->mPassword
,
2515 'user_newpassword' => $this->mNewpassword
,
2516 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2517 'user_real_name' => $this->mRealName
,
2518 'user_email' => $this->mEmail
,
2519 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2520 'user_options' => '',
2521 'user_touched' => $dbw->timestamp( $this->mTouched
),
2522 'user_token' => $this->mToken
,
2523 'user_email_token' => $this->mEmailToken
,
2524 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2525 ), array( /* WHERE */
2526 'user_id' => $this->mId
2530 $this->saveOptions();
2532 wfRunHooks( 'UserSaveSettings', array( $this ) );
2533 $this->clearSharedCache();
2534 $this->getUserPage()->invalidateCache();
2538 * If only this user's username is known, and it exists, return the user ID.
2540 function idForName() {
2541 $s = trim( $this->getName() );
2542 if ( $s === '' ) return 0;
2544 $dbr = wfGetDB( DB_SLAVE
);
2545 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2546 if ( $id === false ) {
2553 * Add a user to the database, return the user object
2555 * @param $name \string Username to add
2556 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2557 * - password The user's password. Password logins will be disabled if this is omitted.
2558 * - newpassword A temporary password mailed to the user
2559 * - email The user's email address
2560 * - email_authenticated The email authentication timestamp
2561 * - real_name The user's real name
2562 * - options An associative array of non-default options
2563 * - token Random authentication token. Do not set.
2564 * - registration Registration timestamp. Do not set.
2566 * @return \type{User} A new User object, or null if the username already exists
2568 static function createNew( $name, $params = array() ) {
2571 if ( isset( $params['options'] ) ) {
2572 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2573 unset( $params['options'] );
2575 $dbw = wfGetDB( DB_MASTER
);
2576 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2579 'user_id' => $seqVal,
2580 'user_name' => $name,
2581 'user_password' => $user->mPassword
,
2582 'user_newpassword' => $user->mNewpassword
,
2583 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2584 'user_email' => $user->mEmail
,
2585 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2586 'user_real_name' => $user->mRealName
,
2587 'user_options' => '',
2588 'user_token' => $user->mToken
,
2589 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2590 'user_editcount' => 0,
2592 foreach ( $params as $name => $value ) {
2593 $fields["user_$name"] = $value;
2595 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2596 if ( $dbw->affectedRows() ) {
2597 $newUser = User
::newFromId( $dbw->insertId() );
2605 * Add this existing user object to the database
2607 function addToDatabase() {
2609 $dbw = wfGetDB( DB_MASTER
);
2610 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2611 $dbw->insert( 'user',
2613 'user_id' => $seqVal,
2614 'user_name' => $this->mName
,
2615 'user_password' => $this->mPassword
,
2616 'user_newpassword' => $this->mNewpassword
,
2617 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2618 'user_email' => $this->mEmail
,
2619 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2620 'user_real_name' => $this->mRealName
,
2621 'user_options' => '',
2622 'user_token' => $this->mToken
,
2623 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2624 'user_editcount' => 0,
2627 $this->mId
= $dbw->insertId();
2629 // Clear instance cache other than user table data, which is already accurate
2630 $this->clearInstanceCache();
2632 $this->saveOptions();
2636 * If this (non-anonymous) user is blocked, block any IP address
2637 * they've successfully logged in from.
2639 function spreadBlock() {
2640 wfDebug( __METHOD__
. "()\n" );
2642 if ( $this->mId
== 0 ) {
2646 $userblock = Block
::newFromDB( '', $this->mId
);
2647 if ( !$userblock ) {
2651 $userblock->doAutoblock( wfGetIP() );
2655 * Generate a string which will be different for any combination of
2656 * user options which would produce different parser output.
2657 * This will be used as part of the hash key for the parser cache,
2658 * so users with the same options can share the same cached data
2661 * Extensions which require it should install 'PageRenderingHash' hook,
2662 * which will give them a chance to modify this key based on their own
2665 * @deprecated use the ParserOptions object to get the relevant options
2666 * @return \string Page rendering hash
2668 function getPageRenderingHash() {
2669 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2671 return $this->mHash
;
2673 wfDeprecated( __METHOD__
);
2675 // stubthreshold is only included below for completeness,
2676 // since it disables the parser cache, its value will always
2677 // be 0 when this function is called by parsercache.
2679 $confstr = $this->getOption( 'math' );
2680 $confstr .= '!' . $this->getStubThreshold();
2681 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2682 $confstr .= '!' . $this->getDatePreference();
2684 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2685 $confstr .= '!' . $wgLang->getCode();
2686 $confstr .= '!' . $this->getOption( 'thumbsize' );
2687 // add in language specific options, if any
2688 $extra = $wgContLang->getExtraHashOptions();
2691 // Since the skin could be overloading link(), it should be
2692 // included here but in practice, none of our skins do that.
2694 $confstr .= $wgRenderHashAppend;
2696 // Give a chance for extensions to modify the hash, if they have
2697 // extra options or other effects on the parser cache.
2698 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2700 // Make it a valid memcached key fragment
2701 $confstr = str_replace( ' ', '_', $confstr );
2702 $this->mHash
= $confstr;
2707 * Get whether the user is explicitly blocked from account creation.
2708 * @return \bool True if blocked
2710 function isBlockedFromCreateAccount() {
2711 $this->getBlockedStatus();
2712 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2716 * Get whether the user is blocked from using Special:Emailuser.
2717 * @return Boolean: True if blocked
2719 function isBlockedFromEmailuser() {
2720 $this->getBlockedStatus();
2721 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2725 * Get whether the user is allowed to create an account.
2726 * @return Boolean: True if allowed
2728 function isAllowedToCreateAccount() {
2729 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2733 * Get this user's personal page title.
2735 * @return Title: User's personal page title
2737 function getUserPage() {
2738 return Title
::makeTitle( NS_USER
, $this->getName() );
2742 * Get this user's talk page title.
2744 * @return Title: User's talk page title
2746 function getTalkPage() {
2747 $title = $this->getUserPage();
2748 return $title->getTalkPage();
2752 * Get the maximum valid user ID.
2753 * @return Integer: User ID
2756 function getMaxID() {
2757 static $res; // cache
2759 if ( isset( $res ) ) {
2762 $dbr = wfGetDB( DB_SLAVE
);
2763 return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__
);
2768 * Determine whether the user is a newbie. Newbies are either
2769 * anonymous IPs, or the most recently created accounts.
2770 * @return Boolean: True if the user is a newbie
2772 function isNewbie() {
2773 return !$this->isAllowed( 'autoconfirmed' );
2777 * Check to see if the given clear-text password is one of the accepted passwords
2778 * @param $password String: user password.
2779 * @return Boolean: True if the given password is correct, otherwise False.
2781 function checkPassword( $password ) {
2785 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2787 } elseif( $wgAuth->strict() ) {
2788 /* Auth plugin doesn't allow local authentication */
2790 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2791 /* Auth plugin doesn't allow local authentication for this user name */
2794 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2796 } elseif ( function_exists( 'iconv' ) ) {
2797 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2798 # Check for this with iconv
2799 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2800 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2808 * Check if the given clear-text password matches the temporary password
2809 * sent by e-mail for password reset operations.
2810 * @return Boolean: True if matches, false otherwise
2812 function checkTemporaryPassword( $plaintext ) {
2813 global $wgNewPasswordExpiry;
2814 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2816 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2817 return ( time() < $expiry );
2824 * Initialize (if necessary) and return a session token value
2825 * which can be used in edit forms to show that the user's
2826 * login credentials aren't being hijacked with a foreign form
2829 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2830 * @return \string The new edit token
2832 function editToken( $salt = '' ) {
2833 if ( $this->isAnon() ) {
2834 return EDIT_TOKEN_SUFFIX
;
2836 if( !isset( $_SESSION['wsEditToken'] ) ) {
2837 $token = self
::generateToken();
2838 $_SESSION['wsEditToken'] = $token;
2840 $token = $_SESSION['wsEditToken'];
2842 if( is_array( $salt ) ) {
2843 $salt = implode( '|', $salt );
2845 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2850 * Generate a looking random token for various uses.
2852 * @param $salt \string Optional salt value
2853 * @return \string The new random token
2855 public static function generateToken( $salt = '' ) {
2856 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2857 return md5( $token . $salt );
2861 * Check given value against the token value stored in the session.
2862 * A match should confirm that the form was submitted from the
2863 * user's own login session, not a form submission from a third-party
2866 * @param $val \string Input value to compare
2867 * @param $salt \string Optional function-specific data for hashing
2868 * @return Boolean: Whether the token matches
2870 function matchEditToken( $val, $salt = '' ) {
2871 $sessionToken = $this->editToken( $salt );
2872 if ( $val != $sessionToken ) {
2873 wfDebug( "User::matchEditToken: broken session data\n" );
2875 return $val == $sessionToken;
2879 * Check given value against the token value stored in the session,
2880 * ignoring the suffix.
2882 * @param $val \string Input value to compare
2883 * @param $salt \string Optional function-specific data for hashing
2884 * @return Boolean: Whether the token matches
2886 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2887 $sessionToken = $this->editToken( $salt );
2888 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2892 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2893 * mail to the user's given address.
2895 * @param $changed Boolean: whether the adress changed
2896 * @return Status object
2898 function sendConfirmationMail( $changed = false ) {
2900 $expiration = null; // gets passed-by-ref and defined in next line.
2901 $token = $this->confirmationToken( $expiration );
2902 $url = $this->confirmationTokenUrl( $token );
2903 $invalidateURL = $this->invalidationTokenUrl( $token );
2904 $this->saveSettings();
2906 $message = $changed ?
'confirmemail_body_changed' : 'confirmemail_body';
2907 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2912 $wgLang->timeanddate( $expiration, false ),
2914 $wgLang->date( $expiration, false ),
2915 $wgLang->time( $expiration, false ) ) );
2919 * Send an e-mail to this user's account. Does not check for
2920 * confirmed status or validity.
2922 * @param $subject \string Message subject
2923 * @param $body \string Message body
2924 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2925 * @param $replyto \string Reply-To address
2926 * @return Status object
2928 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2929 if( is_null( $from ) ) {
2930 global $wgPasswordSender, $wgPasswordSenderName;
2931 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
2933 $sender = new MailAddress( $from );
2936 $to = new MailAddress( $this );
2937 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2941 * Generate, store, and return a new e-mail confirmation code.
2942 * A hash (unsalted, since it's used as a key) is stored.
2944 * @note Call saveSettings() after calling this function to commit
2945 * this change to the database.
2947 * @param[out] &$expiration \mixed Accepts the expiration time
2948 * @return \string New token
2951 function confirmationToken( &$expiration ) {
2953 $expires = $now +
7 * 24 * 60 * 60;
2954 $expiration = wfTimestamp( TS_MW
, $expires );
2955 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
2956 $hash = md5( $token );
2958 $this->mEmailToken
= $hash;
2959 $this->mEmailTokenExpires
= $expiration;
2964 * Return a URL the user can use to confirm their email address.
2965 * @param $token \string Accepts the email confirmation token
2966 * @return \string New token URL
2969 function confirmationTokenUrl( $token ) {
2970 return $this->getTokenUrl( 'ConfirmEmail', $token );
2974 * Return a URL the user can use to invalidate their email address.
2975 * @param $token \string Accepts the email confirmation token
2976 * @return \string New token URL
2979 function invalidationTokenUrl( $token ) {
2980 return $this->getTokenUrl( 'Invalidateemail', $token );
2984 * Internal function to format the e-mail validation/invalidation URLs.
2985 * This uses $wgArticlePath directly as a quickie hack to use the
2986 * hardcoded English names of the Special: pages, for ASCII safety.
2988 * @note Since these URLs get dropped directly into emails, using the
2989 * short English names avoids insanely long URL-encoded links, which
2990 * also sometimes can get corrupted in some browsers/mailers
2991 * (bug 6957 with Gmail and Internet Explorer).
2993 * @param $page \string Special page
2994 * @param $token \string Token
2995 * @return \string Formatted URL
2997 protected function getTokenUrl( $page, $token ) {
2998 global $wgArticlePath;
3002 "Special:$page/$token",
3007 * Mark the e-mail address confirmed.
3009 * @note Call saveSettings() after calling this function to commit the change.
3011 function confirmEmail() {
3012 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3013 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3018 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3019 * address if it was already confirmed.
3021 * @note Call saveSettings() after calling this function to commit the change.
3023 function invalidateEmail() {
3025 $this->mEmailToken
= null;
3026 $this->mEmailTokenExpires
= null;
3027 $this->setEmailAuthenticationTimestamp( null );
3028 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3033 * Set the e-mail authentication timestamp.
3034 * @param $timestamp \string TS_MW timestamp
3036 function setEmailAuthenticationTimestamp( $timestamp ) {
3038 $this->mEmailAuthenticated
= $timestamp;
3039 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3043 * Is this user allowed to send e-mails within limits of current
3044 * site configuration?
3045 * @return Boolean: True if allowed
3047 function canSendEmail() {
3048 global $wgEnableEmail, $wgEnableUserEmail;
3049 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3052 $canSend = $this->isEmailConfirmed();
3053 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3058 * Is this user allowed to receive e-mails within limits of current
3059 * site configuration?
3060 * @return Boolean: True if allowed
3062 function canReceiveEmail() {
3063 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3067 * Is this user's e-mail address valid-looking and confirmed within
3068 * limits of the current site configuration?
3070 * @note If $wgEmailAuthentication is on, this may require the user to have
3071 * confirmed their address by returning a code or using a password
3072 * sent to the address from the wiki.
3074 * @return Boolean: True if confirmed
3076 function isEmailConfirmed() {
3077 global $wgEmailAuthentication;
3080 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3081 if( $this->isAnon() )
3083 if( !self
::isValidEmailAddr( $this->mEmail
) )
3085 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3094 * Check whether there is an outstanding request for e-mail confirmation.
3095 * @return Boolean: True if pending
3097 function isEmailConfirmationPending() {
3098 global $wgEmailAuthentication;
3099 return $wgEmailAuthentication &&
3100 !$this->isEmailConfirmed() &&
3101 $this->mEmailToken
&&
3102 $this->mEmailTokenExpires
> wfTimestamp();
3106 * Get the timestamp of account creation.
3108 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3109 * non-existent/anonymous user accounts.
3111 public function getRegistration() {
3112 return $this->getId() > 0
3113 ?
$this->mRegistration
3118 * Get the timestamp of the first edit
3120 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3121 * non-existent/anonymous user accounts.
3123 public function getFirstEditTimestamp() {
3124 if( $this->getId() == 0 ) return false; // anons
3125 $dbr = wfGetDB( DB_SLAVE
);
3126 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3127 array( 'rev_user' => $this->getId() ),
3129 array( 'ORDER BY' => 'rev_timestamp ASC' )
3131 if( !$time ) return false; // no edits
3132 return wfTimestamp( TS_MW
, $time );
3136 * Get the permissions associated with a given list of groups
3138 * @param $groups \type{\arrayof{\string}} List of internal group names
3139 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3141 static function getGroupPermissions( $groups ) {
3142 global $wgGroupPermissions, $wgRevokePermissions;
3144 // grant every granted permission first
3145 foreach( $groups as $group ) {
3146 if( isset( $wgGroupPermissions[$group] ) ) {
3147 $rights = array_merge( $rights,
3148 // array_filter removes empty items
3149 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3152 // now revoke the revoked permissions
3153 foreach( $groups as $group ) {
3154 if( isset( $wgRevokePermissions[$group] ) ) {
3155 $rights = array_diff( $rights,
3156 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3159 return array_unique( $rights );
3163 * Get all the groups who have a given permission
3165 * @param $role \string Role to check
3166 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3168 static function getGroupsWithPermission( $role ) {
3169 global $wgGroupPermissions;
3170 $allowedGroups = array();
3171 foreach ( $wgGroupPermissions as $group => $rights ) {
3172 if ( isset( $rights[$role] ) && $rights[$role] ) {
3173 $allowedGroups[] = $group;
3176 return $allowedGroups;
3180 * Get the localized descriptive name for a group, if it exists
3182 * @param $group \string Internal group name
3183 * @return \string Localized descriptive group name
3185 static function getGroupName( $group ) {
3186 $key = "group-$group";
3187 $name = wfMsg( $key );
3188 return $name == '' ||
wfEmptyMsg( $key, $name )
3194 * Get the localized descriptive name for a member of a group, if it exists
3196 * @param $group \string Internal group name
3197 * @return \string Localized name for group member
3199 static function getGroupMember( $group ) {
3200 $key = "group-$group-member";
3201 $name = wfMsg( $key );
3202 return $name == '' ||
wfEmptyMsg( $key, $name )
3208 * Return the set of defined explicit groups.
3209 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3210 * are not included, as they are defined automatically, not in the database.
3211 * @return Array of internal group names
3213 static function getAllGroups() {
3214 global $wgGroupPermissions, $wgRevokePermissions;
3216 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3217 self
::getImplicitGroups()
3222 * Get a list of all available permissions.
3223 * @return Array of permission names
3225 static function getAllRights() {
3226 if ( self
::$mAllRights === false ) {
3227 global $wgAvailableRights;
3228 if ( count( $wgAvailableRights ) ) {
3229 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3231 self
::$mAllRights = self
::$mCoreRights;
3233 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3235 return self
::$mAllRights;
3239 * Get a list of implicit groups
3240 * @return \type{\arrayof{\string}} Array of internal group names
3242 public static function getImplicitGroups() {
3243 global $wgImplicitGroups;
3244 $groups = $wgImplicitGroups;
3245 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3250 * Get the title of a page describing a particular group
3252 * @param $group \string Internal group name
3253 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3255 static function getGroupPage( $group ) {
3256 $page = wfMsgForContent( 'grouppage-' . $group );
3257 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3258 $title = Title
::newFromText( $page );
3259 if( is_object( $title ) )
3266 * Create a link to the group in HTML, if available;
3267 * else return the group name.
3269 * @param $group \string Internal name of the group
3270 * @param $text \string The text of the link
3271 * @return \string HTML link to the group
3273 static function makeGroupLinkHTML( $group, $text = '' ) {
3275 $text = self
::getGroupName( $group );
3277 $title = self
::getGroupPage( $group );
3280 $sk = $wgUser->getSkin();
3281 return $sk->link( $title, htmlspecialchars( $text ) );
3288 * Create a link to the group in Wikitext, if available;
3289 * else return the group name.
3291 * @param $group \string Internal name of the group
3292 * @param $text \string The text of the link
3293 * @return \string Wikilink to the group
3295 static function makeGroupLinkWiki( $group, $text = '' ) {
3297 $text = self
::getGroupName( $group );
3299 $title = self
::getGroupPage( $group );
3301 $page = $title->getPrefixedText();
3302 return "[[$page|$text]]";
3309 * Returns an array of the groups that a particular group can add/remove.
3311 * @param $group String: the group to check for whether it can add/remove
3312 * @return Array array( 'add' => array( addablegroups ),
3313 * 'remove' => array( removablegroups ),
3314 * 'add-self' => array( addablegroups to self),
3315 * 'remove-self' => array( removable groups from self) )
3317 static function changeableByGroup( $group ) {
3318 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3320 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3321 if( empty( $wgAddGroups[$group] ) ) {
3322 // Don't add anything to $groups
3323 } elseif( $wgAddGroups[$group] === true ) {
3324 // You get everything
3325 $groups['add'] = self
::getAllGroups();
3326 } elseif( is_array( $wgAddGroups[$group] ) ) {
3327 $groups['add'] = $wgAddGroups[$group];
3330 // Same thing for remove
3331 if( empty( $wgRemoveGroups[$group] ) ) {
3332 } elseif( $wgRemoveGroups[$group] === true ) {
3333 $groups['remove'] = self
::getAllGroups();
3334 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3335 $groups['remove'] = $wgRemoveGroups[$group];
3338 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3339 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3340 foreach( $wgGroupsAddToSelf as $key => $value ) {
3341 if( is_int( $key ) ) {
3342 $wgGroupsAddToSelf['user'][] = $value;
3347 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3348 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3349 if( is_int( $key ) ) {
3350 $wgGroupsRemoveFromSelf['user'][] = $value;
3355 // Now figure out what groups the user can add to him/herself
3356 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3357 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3358 // No idea WHY this would be used, but it's there
3359 $groups['add-self'] = User
::getAllGroups();
3360 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3361 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3364 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3365 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3366 $groups['remove-self'] = User
::getAllGroups();
3367 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3368 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3375 * Returns an array of groups that this user can add and remove
3376 * @return Array array( 'add' => array( addablegroups ),
3377 * 'remove' => array( removablegroups ),
3378 * 'add-self' => array( addablegroups to self),
3379 * 'remove-self' => array( removable groups from self) )
3381 function changeableGroups() {
3382 if( $this->isAllowed( 'userrights' ) ) {
3383 // This group gives the right to modify everything (reverse-
3384 // compatibility with old "userrights lets you change
3386 // Using array_merge to make the groups reindexed
3387 $all = array_merge( User
::getAllGroups() );
3391 'add-self' => array(),
3392 'remove-self' => array()
3396 // Okay, it's not so simple, we will have to go through the arrays
3399 'remove' => array(),
3400 'add-self' => array(),
3401 'remove-self' => array()
3403 $addergroups = $this->getEffectiveGroups();
3405 foreach( $addergroups as $addergroup ) {
3406 $groups = array_merge_recursive(
3407 $groups, $this->changeableByGroup( $addergroup )
3409 $groups['add'] = array_unique( $groups['add'] );
3410 $groups['remove'] = array_unique( $groups['remove'] );
3411 $groups['add-self'] = array_unique( $groups['add-self'] );
3412 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3418 * Increment the user's edit-count field.
3419 * Will have no effect for anonymous users.
3421 function incEditCount() {
3422 if( !$this->isAnon() ) {
3423 $dbw = wfGetDB( DB_MASTER
);
3424 $dbw->update( 'user',
3425 array( 'user_editcount=user_editcount+1' ),
3426 array( 'user_id' => $this->getId() ),
3429 // Lazy initialization check...
3430 if( $dbw->affectedRows() == 0 ) {
3431 // Pull from a slave to be less cruel to servers
3432 // Accuracy isn't the point anyway here
3433 $dbr = wfGetDB( DB_SLAVE
);
3434 $count = $dbr->selectField( 'revision',
3436 array( 'rev_user' => $this->getId() ),
3439 // Now here's a goddamn hack...
3440 if( $dbr !== $dbw ) {
3441 // If we actually have a slave server, the count is
3442 // at least one behind because the current transaction
3443 // has not been committed and replicated.
3446 // But if DB_SLAVE is selecting the master, then the
3447 // count we just read includes the revision that was
3448 // just added in the working transaction.
3451 $dbw->update( 'user',
3452 array( 'user_editcount' => $count ),
3453 array( 'user_id' => $this->getId() ),
3457 // edit count in user cache too
3458 $this->invalidateCache();
3462 * Get the description of a given right
3464 * @param $right \string Right to query
3465 * @return \string Localized description of the right
3467 static function getRightDescription( $right ) {
3468 $key = "right-$right";
3469 $name = wfMsg( $key );
3470 return $name == '' ||
wfEmptyMsg( $key, $name )
3476 * Make an old-style password hash
3478 * @param $password \string Plain-text password
3479 * @param $userId \string User ID
3480 * @return \string Password hash
3482 static function oldCrypt( $password, $userId ) {
3483 global $wgPasswordSalt;
3484 if ( $wgPasswordSalt ) {
3485 return md5( $userId . '-' . md5( $password ) );
3487 return md5( $password );
3492 * Make a new-style password hash
3494 * @param $password \string Plain-text password
3495 * @param $salt \string Optional salt, may be random or the user ID.
3496 * If unspecified or false, will generate one automatically
3497 * @return \string Password hash
3499 static function crypt( $password, $salt = false ) {
3500 global $wgPasswordSalt;
3503 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3507 if( $wgPasswordSalt ) {
3508 if ( $salt === false ) {
3509 $salt = substr( wfGenerateToken(), 0, 8 );
3511 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3513 return ':A:' . md5( $password );
3518 * Compare a password hash with a plain-text password. Requires the user
3519 * ID if there's a chance that the hash is an old-style hash.
3521 * @param $hash \string Password hash
3522 * @param $password \string Plain-text password to compare
3523 * @param $userId \string User ID for old-style password salt
3526 static function comparePasswords( $hash, $password, $userId = false ) {
3527 $type = substr( $hash, 0, 3 );
3530 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3534 if ( $type == ':A:' ) {
3536 return md5( $password ) === substr( $hash, 3 );
3537 } elseif ( $type == ':B:' ) {
3539 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3540 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3543 return self
::oldCrypt( $password, $userId ) === $hash;
3548 * Add a newuser log entry for this user
3550 * @param $byEmail Boolean: account made by email?
3551 * @param $reason String: user supplied reason
3553 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3554 global $wgUser, $wgContLang, $wgNewUserLog;
3555 if( empty( $wgNewUserLog ) ) {
3556 return true; // disabled
3559 if( $this->getName() == $wgUser->getName() ) {
3562 $action = 'create2';
3564 if ( $reason === '' ) {
3565 $reason = wfMsgForContent( 'newuserlog-byemail' );
3567 $reason = $wgContLang->commaList( array(
3568 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3572 $log = new LogPage( 'newusers' );
3575 $this->getUserPage(),
3577 array( $this->getId() )
3583 * Add an autocreate newuser log entry for this user
3584 * Used by things like CentralAuth and perhaps other authplugins.
3586 public function addNewUserLogEntryAutoCreate() {
3587 global $wgNewUserLog, $wgLogAutocreatedAccounts;
3588 if( !$wgNewUserLog ||
!$wgLogAutocreatedAccounts ) {
3589 return true; // disabled
3591 $log = new LogPage( 'newusers', false );
3592 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3596 protected function loadOptions() {
3598 if ( $this->mOptionsLoaded ||
!$this->getId() )
3601 $this->mOptions
= self
::getDefaultOptions();
3603 // Maybe load from the object
3604 if ( !is_null( $this->mOptionOverrides
) ) {
3605 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3606 foreach( $this->mOptionOverrides
as $key => $value ) {
3607 $this->mOptions
[$key] = $value;
3610 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
3611 // Load from database
3612 $dbr = wfGetDB( DB_SLAVE
);
3614 $res = $dbr->select(
3617 array( 'up_user' => $this->getId() ),
3621 foreach ( $res as $row ) {
3622 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3623 $this->mOptions
[$row->up_property
] = $row->up_value
;
3627 $this->mOptionsLoaded
= true;
3629 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3632 protected function saveOptions() {
3633 global $wgAllowPrefChange;
3635 $extuser = ExternalUser
::newFromUser( $this );
3637 $this->loadOptions();
3638 $dbw = wfGetDB( DB_MASTER
);
3640 $insert_rows = array();
3642 $saveOptions = $this->mOptions
;
3644 // Allow hooks to abort, for instance to save to a global profile.
3645 // Reset options to default state before saving.
3646 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3649 foreach( $saveOptions as $key => $value ) {
3650 # Don't bother storing default values
3651 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3652 !( $value === false ||
is_null($value) ) ) ||
3653 $value != self
::getDefaultOption( $key ) ) {
3654 $insert_rows[] = array(
3655 'up_user' => $this->getId(),
3656 'up_property' => $key,
3657 'up_value' => $value,
3660 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3661 switch ( $wgAllowPrefChange[$key] ) {
3667 $extuser->setPref( $key, $value );
3673 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3674 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3679 * Provide an array of HTML5 attributes to put on an input element
3680 * intended for the user to enter a new password. This may include
3681 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3683 * Do *not* use this when asking the user to enter his current password!
3684 * Regardless of configuration, users may have invalid passwords for whatever
3685 * reason (e.g., they were set before requirements were tightened up).
3686 * Only use it when asking for a new password, like on account creation or
3689 * Obviously, you still need to do server-side checking.
3691 * NOTE: A combination of bugs in various browsers means that this function
3692 * actually just returns array() unconditionally at the moment. May as
3693 * well keep it around for when the browser bugs get fixed, though.
3695 * @return array Array of HTML attributes suitable for feeding to
3696 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3697 * That will potentially output invalid XHTML 1.0 Transitional, and will
3698 * get confused by the boolean attribute syntax used.)
3700 public static function passwordChangeInputAttribs() {
3701 global $wgMinimalPasswordLength;
3703 if ( $wgMinimalPasswordLength == 0 ) {
3707 # Note that the pattern requirement will always be satisfied if the
3708 # input is empty, so we need required in all cases.
3710 # FIXME (bug 23769): This needs to not claim the password is required
3711 # if e-mail confirmation is being used. Since HTML5 input validation
3712 # is b0rked anyway in some browsers, just return nothing. When it's
3713 # re-enabled, fix this code to not output required for e-mail
3715 #$ret = array( 'required' );
3718 # We can't actually do this right now, because Opera 9.6 will print out
3719 # the entered password visibly in its error message! When other
3720 # browsers add support for this attribute, or Opera fixes its support,
3721 # we can add support with a version check to avoid doing this on Opera
3722 # versions where it will be a problem. Reported to Opera as
3723 # DSK-262266, but they don't have a public bug tracker for us to follow.
3725 if ( $wgMinimalPasswordLength > 1 ) {
3726 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3727 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3728 $wgMinimalPasswordLength );
3736 * Format the user message using a hook, a template, or, failing these, a static format.
3737 * @param $subject String the subject of the message
3738 * @param $text String the content of the message
3739 * @param $signature String the signature, if provided.
3741 static protected function formatUserMessage( $subject, $text, $signature ) {
3742 if ( wfRunHooks( 'FormatUserMessage',
3743 array( $subject, &$text, $signature ) ) ) {
3745 $signature = empty($signature) ?
"~~~~~" : "{$signature} ~~~~~";
3747 $template = Title
::newFromText( wfMsgForContent( 'usermessage-template' ) );
3749 ||
$template->getNamespace() !== NS_TEMPLATE
3750 ||
!$template->exists() ) {
3751 $text = "\n== $subject ==\n\n$text\n\n-- $signature";
3753 $text = '{{'. $template->getText()
3754 . " | subject=$subject | body=$text | signature=$signature }}";
3762 * Leave a user a message
3763 * @param $subject String the subject of the message
3764 * @param $text String the message to leave
3765 * @param $signature String Text to leave in the signature
3766 * @param $summary String the summary for this change, defaults to
3767 * "Leave system message."
3768 * @param $editor User The user leaving the message, defaults to
3769 * "{{MediaWiki:usermessage-editor}}"
3770 * @param $flags Int default edit flags
3772 * @return boolean true if it was successful
3774 public function leaveUserMessage( $subject, $text, $signature = "",
3775 $summary = null, $editor = null, $flags = 0 ) {
3776 if ( !isset( $summary ) ) {
3777 $summary = wfMsgForContent( 'usermessage-summary' );
3780 if ( !isset( $editor ) ) {
3781 $editor = User
::newFromName( wfMsgForContent( 'usermessage-editor' ) );
3782 if ( !$editor->isLoggedIn() ) {
3783 $editor->addToDatabase();
3787 $article = new Article( $this->getTalkPage() );
3788 wfRunHooks( 'SetupUserMessageArticle',
3789 array( $this, &$article, $subject, $text, $signature, $summary, $editor ) );
3792 $text = self
::formatUserMessage( $subject, $text, $signature );
3793 $flags = $article->checkFlags( $flags );
3795 if ( $flags & EDIT_UPDATE
) {
3796 $text = $article->getContent() . $text;
3799 $dbw = wfGetDB( DB_MASTER
);
3803 $status = $article->doEdit( $text, $summary, $flags, false, $editor );
3804 } catch ( DBQueryError
$e ) {
3805 $status = Status
::newFatal("DB Error");
3808 if ( $status->isGood() ) {
3809 // Set newtalk with the right user ID
3810 $this->setNewtalk( true );
3811 wfRunHooks( 'AfterUserMessage',
3812 array( $this, $article, $summary, $text, $signature, $summary, $editor ) );
3815 // The article was concurrently created
3816 wfDebug( __METHOD__
. ": Error ".$status->getWikiText() );
3820 return $status->isGood();