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 accessable 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(
113 'move-rootuserpages',
117 'override-export-depth',
138 'userrights-interwiki',
142 * \string Cached results of getAllRights()
144 static $mAllRights = false;
146 /** @name Cache variables */
148 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
149 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
150 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
154 * \bool Whether the cache variables have been loaded.
156 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
159 * \string Initialization data source if mDataLoaded==false. May be one of:
160 * - 'defaults' anonymous user initialised from class defaults
161 * - 'name' initialise from mName
162 * - 'id' initialise from mId
163 * - 'session' log in from cookies or session if possible
165 * Use the User::newFrom*() family of functions to set this.
169 /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
171 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
172 $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
173 $mLocked, $mHideName, $mOptions;
176 static $idCacheByName = array();
179 * Lightweight constructor for an anonymous user.
180 * Use the User::newFrom* factory functions for other kinds of users.
184 * @see newFromConfirmationCode()
185 * @see newFromSession()
188 function __construct() {
189 $this->clearInstanceCache( 'defaults' );
193 * Load the user table data for this object from the source given by mFrom.
196 if ( $this->mDataLoaded
) {
199 wfProfileIn( __METHOD__
);
201 # Set it now to avoid infinite recursion in accessors
202 $this->mDataLoaded
= true;
204 switch ( $this->mFrom
) {
206 $this->loadDefaults();
209 $this->mId
= self
::idFromName( $this->mName
);
211 # Nonexistent user placeholder object
212 $this->loadDefaults( $this->mName
);
221 $this->loadFromSession();
222 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
225 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
227 wfProfileOut( __METHOD__
);
231 * Load user table data, given mId has already been set.
232 * @return \bool false if the ID does not exist, true otherwise
235 function loadFromId() {
237 if ( $this->mId
== 0 ) {
238 $this->loadDefaults();
243 $key = wfMemcKey( 'user', 'id', $this->mId
);
244 $data = $wgMemc->get( $key );
245 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
246 # Object is expired, load from DB
251 wfDebug( "Cache miss for user {$this->mId}\n" );
253 if ( !$this->loadFromDatabase() ) {
254 # Can't load from ID, user is anonymous
257 $this->saveToCache();
259 wfDebug( "Got user {$this->mId} from cache\n" );
261 foreach ( self
::$mCacheVars as $name ) {
262 $this->$name = $data[$name];
269 * Save user data to the shared cache
271 function saveToCache() {
274 $this->loadOptions();
275 if ( $this->isAnon() ) {
276 // Anonymous users are uncached
280 foreach ( self
::$mCacheVars as $name ) {
281 $data[$name] = $this->$name;
283 $data['mVersion'] = MW_USER_VERSION
;
284 $key = wfMemcKey( 'user', 'id', $this->mId
);
286 $wgMemc->set( $key, $data );
290 /** @name newFrom*() static factory methods */
294 * Static factory method for creation from username.
296 * This is slightly less efficient than newFromId(), so use newFromId() if
297 * you have both an ID and a name handy.
299 * @param $name \string Username, validated by Title::newFromText()
300 * @param $validate \mixed Validate username. Takes the same parameters as
301 * User::getCanonicalName(), except that true is accepted as an alias
302 * for 'valid', for BC.
304 * @return \type{User} The User object, or false if the username is invalid
305 * (e.g. if it contains illegal characters or is an IP address). If the
306 * username is not present in the database, the result will be a user object
307 * with a name, zero user ID and default settings.
309 static function newFromName( $name, $validate = 'valid' ) {
310 if ( $validate === true ) {
313 $name = self
::getCanonicalName( $name, $validate );
314 if ( $name === false ) {
317 # Create unloaded user object
326 * Static factory method for creation from a given user ID.
328 * @param $id \int Valid user ID
329 * @return \type{User} The corresponding User object
331 static function newFromId( $id ) {
339 * Factory method to fetch whichever user has a given email confirmation code.
340 * This code is generated when an account is created or its e-mail address
343 * If the code is invalid or has expired, returns NULL.
345 * @param $code \string Confirmation code
346 * @return \type{User}
348 static function newFromConfirmationCode( $code ) {
349 $dbr = wfGetDB( DB_SLAVE
);
350 $id = $dbr->selectField( 'user', 'user_id', array(
351 'user_email_token' => md5( $code ),
352 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
354 if( $id !== false ) {
355 return User
::newFromId( $id );
362 * Create a new user object using data from session or cookies. If the
363 * login credentials are invalid, the result is an anonymous user.
365 * @return \type{User}
367 static function newFromSession() {
369 $user->mFrom
= 'session';
374 * Create a new user object from a user row.
375 * The row should have all fields from the user table in it.
376 * @param $row array A row from the user table
377 * @return \type{User}
379 static function newFromRow( $row ) {
381 $user->loadFromRow( $row );
389 * Get the username corresponding to a given user ID
390 * @param $id \int User ID
391 * @return \string The corresponding username
393 static function whoIs( $id ) {
394 $dbr = wfGetDB( DB_SLAVE
);
395 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
399 * Get the real name of a user given their user ID
401 * @param $id \int User ID
402 * @return \string The corresponding user's real name
404 static function whoIsReal( $id ) {
405 $dbr = wfGetDB( DB_SLAVE
);
406 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
410 * Get database id given a user name
411 * @param $name \string Username
412 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
414 static function idFromName( $name ) {
415 $nt = Title
::makeTitleSafe( NS_USER
, $name );
416 if( is_null( $nt ) ) {
421 if ( isset( self
::$idCacheByName[$name] ) ) {
422 return self
::$idCacheByName[$name];
425 $dbr = wfGetDB( DB_SLAVE
);
426 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
428 if ( $s === false ) {
431 $result = $s->user_id
;
434 self
::$idCacheByName[$name] = $result;
436 if ( count( self
::$idCacheByName ) > 1000 ) {
437 self
::$idCacheByName = array();
444 * Does the string match an anonymous IPv4 address?
446 * This function exists for username validation, in order to reject
447 * usernames which are similar in form to IP addresses. Strings such
448 * as 300.300.300.300 will return true because it looks like an IP
449 * address, despite not being strictly valid.
451 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
452 * address because the usemod software would "cloak" anonymous IP
453 * addresses like this, if we allowed accounts like this to be created
454 * new users could get the old edits of these anonymous users.
456 * @param $name \string String to match
457 * @return \bool True or false
459 static function isIP( $name ) {
460 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
464 * Is the input a valid username?
466 * Checks if the input is a valid username, we don't want an empty string,
467 * an IP address, anything that containins slashes (would mess up subpages),
468 * is longer than the maximum allowed username size or doesn't begin with
471 * @param $name \string String to match
472 * @return \bool True or false
474 static function isValidUserName( $name ) {
475 global $wgContLang, $wgMaxNameChars;
478 || User
::isIP( $name )
479 ||
strpos( $name, '/' ) !== false
480 ||
strlen( $name ) > $wgMaxNameChars
481 ||
$name != $wgContLang->ucfirst( $name ) ) {
482 wfDebugLog( 'username', __METHOD__
.
483 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
487 // Ensure that the name can't be misresolved as a different title,
488 // such as with extra namespace keys at the start.
489 $parsed = Title
::newFromText( $name );
490 if( is_null( $parsed )
491 ||
$parsed->getNamespace()
492 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
493 wfDebugLog( 'username', __METHOD__
.
494 ": '$name' invalid due to ambiguous prefixes" );
498 // Check an additional blacklist of troublemaker characters.
499 // Should these be merged into the title char list?
500 $unicodeBlacklist = '/[' .
501 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
502 '\x{00a0}' . # non-breaking space
503 '\x{2000}-\x{200f}' . # various whitespace
504 '\x{2028}-\x{202f}' . # breaks and control chars
505 '\x{3000}' . # ideographic space
506 '\x{e000}-\x{f8ff}' . # private use
508 if( preg_match( $unicodeBlacklist, $name ) ) {
509 wfDebugLog( 'username', __METHOD__
.
510 ": '$name' invalid due to blacklisted characters" );
518 * Usernames which fail to pass this function will be blocked
519 * from user login and new account registrations, but may be used
520 * internally by batch processes.
522 * If an account already exists in this form, login will be blocked
523 * by a failure to pass this function.
525 * @param $name \string String to match
526 * @return \bool True or false
528 static function isUsableName( $name ) {
529 global $wgReservedUsernames;
530 // Must be a valid username, obviously ;)
531 if ( !self
::isValidUserName( $name ) ) {
535 static $reservedUsernames = false;
536 if ( !$reservedUsernames ) {
537 $reservedUsernames = $wgReservedUsernames;
538 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
541 // Certain names may be reserved for batch processes.
542 foreach ( $reservedUsernames as $reserved ) {
543 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
544 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
546 if ( $reserved == $name ) {
554 * Usernames which fail to pass this function will be blocked
555 * from new account registrations, but may be used internally
556 * either by batch processes or by user accounts which have
557 * already been created.
559 * Additional blacklisting may be added here rather than in
560 * isValidUserName() to avoid disrupting existing accounts.
562 * @param $name \string String to match
563 * @return \bool True or false
565 static function isCreatableName( $name ) {
566 global $wgInvalidUsernameCharacters;
568 // Ensure that the username isn't longer than 235 bytes, so that
569 // (at least for the builtin skins) user javascript and css files
570 // will work. (bug 23080)
571 if( strlen( $name ) > 235 ) {
572 wfDebugLog( 'username', __METHOD__
.
573 ": '$name' invalid due to length" );
577 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
578 wfDebugLog( 'username', __METHOD__
.
579 ": '$name' invalid due to wgInvalidUsernameCharacters" );
583 return self
::isUsableName( $name );
587 * Is the input a valid password for this user?
589 * @param $password String Desired password
590 * @return bool True or false
592 function isValidPassword( $password ) {
593 //simple boolean wrapper for getPasswordValidity
594 return $this->getPasswordValidity( $password ) === true;
598 * Given unvalidated password input, return error message on failure.
600 * @param $password String Desired password
601 * @return mixed: true on success, string of error message on failure
603 function getPasswordValidity( $password ) {
604 global $wgMinimalPasswordLength, $wgContLang;
606 $result = false; //init $result to false for the internal checks
608 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
611 if ( $result === false ) {
612 if( strlen( $password ) < $wgMinimalPasswordLength ) {
613 return 'passwordtooshort';
614 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
615 return 'password-name-match';
617 //it seems weird returning true here, but this is because of the
618 //initialization of $result to false above. If the hook is never run or it
619 //doesn't modify $result, then we will likely get down into this if with
623 } elseif( $result === true ) {
626 return $result; //the isValidPassword hook set a string $result and returned true
631 * Does a string look like an e-mail address?
633 * There used to be a regular expression here, it got removed because it
634 * rejected valid addresses. Actually just check if there is '@' somewhere
635 * in the given address.
637 * @todo Check for RFC 2822 compilance (bug 959)
639 * @param $addr \string E-mail address
640 * @return \bool True or false
642 public static function isValidEmailAddr( $addr ) {
644 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
648 return strpos( $addr, '@' ) !== false;
652 * Given unvalidated user input, return a canonical username, or false if
653 * the username is invalid.
654 * @param $name \string User input
655 * @param $validate \types{\string,\bool} Type of validation to use:
656 * - false No validation
657 * - 'valid' Valid for batch processes
658 * - 'usable' Valid for batch processes and login
659 * - 'creatable' Valid for batch processes, login and account creation
661 static function getCanonicalName( $name, $validate = 'valid' ) {
662 # Force usernames to capital
664 $name = $wgContLang->ucfirst( $name );
666 # Reject names containing '#'; these will be cleaned up
667 # with title normalisation, but then it's too late to
669 if( strpos( $name, '#' ) !== false )
672 # Clean up name according to title rules
673 $t = ( $validate === 'valid' ) ?
674 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
675 # Check for invalid titles
676 if( is_null( $t ) ) {
680 # Reject various classes of invalid names
681 $name = $t->getText();
683 $name = $wgAuth->getCanonicalName( $t->getText() );
685 switch ( $validate ) {
689 if ( !User
::isValidUserName( $name ) ) {
694 if ( !User
::isUsableName( $name ) ) {
699 if ( !User
::isCreatableName( $name ) ) {
704 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
710 * Count the number of edits of a user
711 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
713 * @param $uid \int User ID to check
714 * @return \int The user's edit count
716 static function edits( $uid ) {
717 wfProfileIn( __METHOD__
);
718 $dbr = wfGetDB( DB_SLAVE
);
719 // check if the user_editcount field has been initialized
720 $field = $dbr->selectField(
721 'user', 'user_editcount',
722 array( 'user_id' => $uid ),
726 if( $field === null ) { // it has not been initialized. do so.
727 $dbw = wfGetDB( DB_MASTER
);
728 $count = $dbr->selectField(
729 'revision', 'count(*)',
730 array( 'rev_user' => $uid ),
735 array( 'user_editcount' => $count ),
736 array( 'user_id' => $uid ),
742 wfProfileOut( __METHOD__
);
747 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
748 * @todo hash random numbers to improve security, like generateToken()
750 * @return \string New random password
752 static function randomPassword() {
753 global $wgMinimalPasswordLength;
754 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
755 $l = strlen( $pwchars ) - 1;
757 $pwlength = max( 7, $wgMinimalPasswordLength );
758 $digit = mt_rand( 0, $pwlength - 1 );
760 for ( $i = 0; $i < $pwlength; $i++
) {
761 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
767 * Set cached properties to default.
769 * @note This no longer clears uncached lazy-initialised properties;
770 * the constructor does that instead.
773 function loadDefaults( $name = false ) {
774 wfProfileIn( __METHOD__
);
779 $this->mName
= $name;
780 $this->mRealName
= '';
781 $this->mPassword
= $this->mNewpassword
= '';
782 $this->mNewpassTime
= null;
784 $this->mOptionOverrides
= null;
785 $this->mOptionsLoaded
= false;
787 if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) {
788 $this->mTouched
= wfTimestamp( TS_MW
, $wgRequest->getCookie( 'LoggedOut' ) );
790 $this->mTouched
= '0'; # Allow any pages to be cached
793 $this->setToken(); # Random
794 $this->mEmailAuthenticated
= null;
795 $this->mEmailToken
= '';
796 $this->mEmailTokenExpires
= null;
797 $this->mRegistration
= wfTimestamp( TS_MW
);
798 $this->mGroups
= array();
800 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
802 wfProfileOut( __METHOD__
);
806 * @deprecated Use wfSetupSession().
808 function SetupSession() {
809 wfDeprecated( __METHOD__
);
814 * Load user data from the session or login cookie. If there are no valid
815 * credentials, initialises the user as an anonymous user.
816 * @return \bool True if the user is logged in, false otherwise.
818 private function loadFromSession() {
819 global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy;
822 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
823 if ( $result !== null ) {
827 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
828 $extUser = ExternalUser
::newFromCookie();
830 # TODO: Automatically create the user here (or probably a bit
831 # lower down, in fact)
835 if ( $wgRequest->getCookie( 'UserID' ) !== null ) {
836 $sId = intval( $wgRequest->getCookie( 'UserID' ) );
837 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
838 $this->loadDefaults(); // Possible collision!
839 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
840 cookie user ID ($sId) don't match!" );
843 $_SESSION['wsUserID'] = $sId;
844 } else if ( isset( $_SESSION['wsUserID'] ) ) {
845 if ( $_SESSION['wsUserID'] != 0 ) {
846 $sId = $_SESSION['wsUserID'];
848 $this->loadDefaults();
852 $this->loadDefaults();
856 if ( isset( $_SESSION['wsUserName'] ) ) {
857 $sName = $_SESSION['wsUserName'];
858 } else if ( $wgRequest->getCookie('UserName') !== null ) {
859 $sName = $wgRequest->getCookie('UserName');
860 $_SESSION['wsUserName'] = $sName;
862 $this->loadDefaults();
866 $passwordCorrect = FALSE;
868 if ( !$this->loadFromId() ) {
869 # Not a valid ID, loadFromId has switched the object to anon for us
873 global $wgBlockDisablesLogin;
874 if( $wgBlockDisablesLogin && $this->isBlocked() ) {
875 # User blocked and we've disabled blocked user logins
876 $this->loadDefaults();
880 if ( isset( $_SESSION['wsToken'] ) ) {
881 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
883 } else if ( $wgRequest->getCookie( 'Token' ) !== null ) {
884 $passwordCorrect = $this->mToken
== $wgRequest->getCookie( 'Token' );
887 # No session or persistent login cookie
888 $this->loadDefaults();
892 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
893 $_SESSION['wsToken'] = $this->mToken
;
894 wfDebug( "Logged in from $from\n" );
897 # Invalid credentials
898 wfDebug( "Can't log in from $from, invalid credentials\n" );
899 $this->loadDefaults();
905 * Load user and user_group data from the database.
906 * $this::mId must be set, this is how the user is identified.
908 * @return \bool True if the user exists, false if the user is anonymous
911 function loadFromDatabase() {
913 $this->mId
= intval( $this->mId
);
915 /** Anonymous user */
917 $this->loadDefaults();
921 $dbr = wfGetDB( DB_MASTER
);
922 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
924 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
926 if ( $s !== false ) {
927 # Initialise user table data
928 $this->loadFromRow( $s );
929 $this->mGroups
= null; // deferred
930 $this->getEditCount(); // revalidation for nulls
935 $this->loadDefaults();
941 * Initialize this object from a row from the user table.
943 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
945 function loadFromRow( $row ) {
946 $this->mDataLoaded
= true;
948 if ( isset( $row->user_id
) ) {
949 $this->mId
= intval( $row->user_id
);
951 $this->mName
= $row->user_name
;
952 $this->mRealName
= $row->user_real_name
;
953 $this->mPassword
= $row->user_password
;
954 $this->mNewpassword
= $row->user_newpassword
;
955 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
956 $this->mEmail
= $row->user_email
;
957 $this->decodeOptions( $row->user_options
);
958 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
959 $this->mToken
= $row->user_token
;
960 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
961 $this->mEmailToken
= $row->user_email_token
;
962 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
963 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
964 $this->mEditCount
= $row->user_editcount
;
968 * Load the groups from the database if they aren't already loaded.
971 function loadGroups() {
972 if ( is_null( $this->mGroups
) ) {
973 $dbr = wfGetDB( DB_MASTER
);
974 $res = $dbr->select( 'user_groups',
976 array( 'ug_user' => $this->mId
),
978 $this->mGroups
= array();
979 while( $row = $dbr->fetchObject( $res ) ) {
980 $this->mGroups
[] = $row->ug_group
;
986 * Clear various cached data stored in this object.
987 * @param $reloadFrom \string Reload user and user_groups table data from a
988 * given source. May be "name", "id", "defaults", "session", or false for
991 function clearInstanceCache( $reloadFrom = false ) {
992 $this->mNewtalk
= -1;
993 $this->mDatePreference
= null;
994 $this->mBlockedby
= -1; # Unset
995 $this->mHash
= false;
997 $this->mRights
= null;
998 $this->mEffectiveGroups
= null;
999 $this->mOptions
= null;
1001 if ( $reloadFrom ) {
1002 $this->mDataLoaded
= false;
1003 $this->mFrom
= $reloadFrom;
1008 * Combine the language default options with any site-specific options
1009 * and add the default language variants.
1011 * @return \type{\arrayof{\string}} Array of options
1013 static function getDefaultOptions() {
1014 global $wgNamespacesToBeSearchedDefault;
1016 * Site defaults will override the global/language defaults
1018 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1019 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1022 * default language setting
1024 $variant = $wgContLang->getPreferredVariant( false );
1025 $defOpt['variant'] = $variant;
1026 $defOpt['language'] = $variant;
1027 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1028 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1030 $defOpt['skin'] = $wgDefaultSkin;
1036 * Get a given default option value.
1038 * @param $opt \string Name of option to retrieve
1039 * @return \string Default option value
1041 public static function getDefaultOption( $opt ) {
1042 $defOpts = self
::getDefaultOptions();
1043 if( isset( $defOpts[$opt] ) ) {
1044 return $defOpts[$opt];
1052 * Get blocking information
1054 * @param $bFromSlave \bool Whether to check the slave database first. To
1055 * improve performance, non-critical checks are done
1056 * against slaves. Check when actually saving should be
1057 * done against master.
1059 function getBlockedStatus( $bFromSlave = true ) {
1060 global $wgProxyWhitelist, $wgUser;
1062 if ( -1 != $this->mBlockedby
) {
1063 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1067 wfProfileIn( __METHOD__
);
1068 wfDebug( __METHOD__
.": checking...\n" );
1070 // Initialize data...
1071 // Otherwise something ends up stomping on $this->mBlockedby when
1072 // things get lazy-loaded later, causing false positive block hits
1073 // due to -1 !== 0. Probably session-related... Nothing should be
1074 // overwriting mBlockedby, surely?
1077 $this->mBlockedby
= 0;
1078 $this->mHideName
= 0;
1079 $this->mAllowUsertalk
= 0;
1081 # Check if we are looking at an IP or a logged-in user
1082 if ( $this->isIP( $this->getName() ) ) {
1083 $ip = $this->getName();
1085 # Check if we are looking at the current user
1086 # If we don't, and the user is logged in, we don't know about
1087 # his IP / autoblock status, so ignore autoblock of current user's IP
1088 if ( $this->getID() != $wgUser->getID() ) {
1091 # Get IP of current user
1096 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1097 # Exempt from all types of IP-block
1102 $this->mBlock
= new Block();
1103 $this->mBlock
->fromMaster( !$bFromSlave );
1104 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1105 wfDebug( __METHOD__
. ": Found block.\n" );
1106 $this->mBlockedby
= $this->mBlock
->mBy
;
1107 if( $this->mBlockedby
== 0 )
1108 $this->mBlockedby
= $this->mBlock
->mByName
;
1109 $this->mBlockreason
= $this->mBlock
->mReason
;
1110 $this->mHideName
= $this->mBlock
->mHideName
;
1111 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1112 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1113 $this->spreadBlock();
1116 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1117 // apply to users. Note that the existence of $this->mBlock is not used to
1118 // check for edit blocks, $this->mBlockedby is instead.
1122 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1124 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1125 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1126 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1130 if ( !$this->mBlockedby
&& !$this->getID() ) {
1131 if ( $this->isDnsBlacklisted( $ip ) ) {
1132 $this->mBlockedby
= wfMsg( 'sorbs' );
1133 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1139 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1141 wfProfileOut( __METHOD__
);
1145 * Whether the given IP is in a DNS blacklist.
1147 * @param $ip \string IP to check
1148 * @param $checkWhitelist Boolean: whether to check the whitelist first
1149 * @return \bool True if blacklisted.
1151 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1152 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1153 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1155 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1158 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1161 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1162 return $this->inDnsBlacklist( $ip, $urls );
1166 * Whether the given IP is in a given DNS blacklist.
1168 * @param $ip \string IP to check
1169 * @param $bases \string or Array of Strings: URL of the DNS blacklist
1170 * @return \bool True if blacklisted.
1172 function inDnsBlacklist( $ip, $bases ) {
1173 wfProfileIn( __METHOD__
);
1177 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1178 if( IP
::isIPv4( $ip ) ) {
1179 # Reverse IP, bug 21255
1180 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1182 foreach( (array)$bases as $base ) {
1184 $host = "$ipReversed.$base";
1187 $ipList = gethostbynamel( $host );
1190 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1194 wfDebug( "Requested $host, not found in $base.\n" );
1199 wfProfileOut( __METHOD__
);
1204 * Is this user subject to rate limiting?
1206 * @return \bool True if rate limited
1208 public function isPingLimitable() {
1209 global $wgRateLimitsExcludedGroups;
1210 global $wgRateLimitsExcludedIPs;
1211 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1212 // Deprecated, but kept for backwards-compatibility config
1215 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1216 // No other good way currently to disable rate limits
1217 // for specific IPs. :P
1218 // But this is a crappy hack and should die.
1221 return !$this->isAllowed('noratelimit');
1225 * Primitive rate limits: enforce maximum actions per time period
1226 * to put a brake on flooding.
1228 * @note When using a shared cache like memcached, IP-address
1229 * last-hit counters will be shared across wikis.
1231 * @param $action \string Action to enforce; 'edit' if unspecified
1232 * @return \bool True if a rate limiter was tripped
1234 function pingLimiter( $action = 'edit' ) {
1235 # Call the 'PingLimiter' hook
1237 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1241 global $wgRateLimits;
1242 if( !isset( $wgRateLimits[$action] ) ) {
1246 # Some groups shouldn't trigger the ping limiter, ever
1247 if( !$this->isPingLimitable() )
1250 global $wgMemc, $wgRateLimitLog;
1251 wfProfileIn( __METHOD__
);
1253 $limits = $wgRateLimits[$action];
1255 $id = $this->getId();
1259 if( isset( $limits['anon'] ) && $id == 0 ) {
1260 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1263 if( isset( $limits['user'] ) && $id != 0 ) {
1264 $userLimit = $limits['user'];
1266 if( $this->isNewbie() ) {
1267 if( isset( $limits['newbie'] ) && $id != 0 ) {
1268 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1270 if( isset( $limits['ip'] ) ) {
1271 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1274 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1275 $subnet = $matches[1];
1276 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1279 // Check for group-specific permissions
1280 // If more than one group applies, use the group with the highest limit
1281 foreach ( $this->getGroups() as $group ) {
1282 if ( isset( $limits[$group] ) ) {
1283 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1284 $userLimit = $limits[$group];
1288 // Set the user limit key
1289 if ( $userLimit !== false ) {
1290 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1291 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1295 foreach( $keys as $key => $limit ) {
1296 list( $max, $period ) = $limit;
1297 $summary = "(limit $max in {$period}s)";
1298 $count = $wgMemc->get( $key );
1301 if( $count > $max ) {
1302 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1303 if( $wgRateLimitLog ) {
1304 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1308 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1311 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1312 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1314 $wgMemc->incr( $key );
1317 wfProfileOut( __METHOD__
);
1322 * Check if user is blocked
1324 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1325 * @return \bool True if blocked, false otherwise
1327 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1328 wfDebug( "User::isBlocked: enter\n" );
1329 $this->getBlockedStatus( $bFromSlave );
1330 return $this->mBlockedby
!== 0;
1334 * Check if user is blocked from editing a particular article
1336 * @param $title \string Title to check
1337 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1338 * @return \bool True if blocked, false otherwise
1340 function isBlockedFrom( $title, $bFromSlave = false ) {
1341 global $wgBlockAllowsUTEdit;
1342 wfProfileIn( __METHOD__
);
1343 wfDebug( __METHOD__
. ": enter\n" );
1345 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1346 $blocked = $this->isBlocked( $bFromSlave );
1347 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1348 # If a user's name is suppressed, they cannot make edits anywhere
1349 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1350 $title->getNamespace() == NS_USER_TALK
) {
1352 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1355 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1357 wfProfileOut( __METHOD__
);
1362 * If user is blocked, return the name of the user who placed the block
1363 * @return \string name of blocker
1365 function blockedBy() {
1366 $this->getBlockedStatus();
1367 return $this->mBlockedby
;
1371 * If user is blocked, return the specified reason for the block
1372 * @return \string Blocking reason
1374 function blockedFor() {
1375 $this->getBlockedStatus();
1376 return $this->mBlockreason
;
1380 * If user is blocked, return the ID for the block
1381 * @return \int Block ID
1383 function getBlockId() {
1384 $this->getBlockedStatus();
1385 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1389 * Check if user is blocked on all wikis.
1390 * Do not use for actual edit permission checks!
1391 * This is intented for quick UI checks.
1393 * @param $ip \type{\string} IP address, uses current client if none given
1394 * @return \type{\bool} True if blocked, false otherwise
1396 function isBlockedGlobally( $ip = '' ) {
1397 if( $this->mBlockedGlobally
!== null ) {
1398 return $this->mBlockedGlobally
;
1400 // User is already an IP?
1401 if( IP
::isIPAddress( $this->getName() ) ) {
1402 $ip = $this->getName();
1407 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1408 $this->mBlockedGlobally
= (bool)$blocked;
1409 return $this->mBlockedGlobally
;
1413 * Check if user account is locked
1415 * @return \type{\bool} True if locked, false otherwise
1417 function isLocked() {
1418 if( $this->mLocked
!== null ) {
1419 return $this->mLocked
;
1422 $authUser = $wgAuth->getUserInstance( $this );
1423 $this->mLocked
= (bool)$authUser->isLocked();
1424 return $this->mLocked
;
1428 * Check if user account is hidden
1430 * @return \type{\bool} True if hidden, false otherwise
1432 function isHidden() {
1433 if( $this->mHideName
!== null ) {
1434 return $this->mHideName
;
1436 $this->getBlockedStatus();
1437 if( !$this->mHideName
) {
1439 $authUser = $wgAuth->getUserInstance( $this );
1440 $this->mHideName
= (bool)$authUser->isHidden();
1442 return $this->mHideName
;
1446 * Get the user's ID.
1447 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1450 if( $this->mId
=== null and $this->mName
!== null
1451 and User
::isIP( $this->mName
) ) {
1452 // Special case, we know the user is anonymous
1454 } elseif( $this->mId
=== null ) {
1455 // Don't load if this was initialized from an ID
1462 * Set the user and reload all fields according to a given ID
1463 * @param $v \int User ID to reload
1465 function setId( $v ) {
1467 $this->clearInstanceCache( 'id' );
1471 * Get the user name, or the IP of an anonymous user
1472 * @return \string User's name or IP address
1474 function getName() {
1475 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1476 # Special case optimisation
1477 return $this->mName
;
1480 if ( $this->mName
=== false ) {
1482 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1484 return $this->mName
;
1489 * Set the user name.
1491 * This does not reload fields from the database according to the given
1492 * name. Rather, it is used to create a temporary "nonexistent user" for
1493 * later addition to the database. It can also be used to set the IP
1494 * address for an anonymous user to something other than the current
1497 * @note User::newFromName() has rougly the same function, when the named user
1499 * @param $str \string New user name to set
1501 function setName( $str ) {
1503 $this->mName
= $str;
1507 * Get the user's name escaped by underscores.
1508 * @return \string Username escaped by underscores.
1510 function getTitleKey() {
1511 return str_replace( ' ', '_', $this->getName() );
1515 * Check if the user has new messages.
1516 * @return \bool True if the user has new messages
1518 function getNewtalk() {
1521 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1522 if( $this->mNewtalk
=== -1 ) {
1523 $this->mNewtalk
= false; # reset talk page status
1525 # Check memcached separately for anons, who have no
1526 # entire User object stored in there.
1529 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1530 $newtalk = $wgMemc->get( $key );
1531 if( strval( $newtalk ) !== '' ) {
1532 $this->mNewtalk
= (bool)$newtalk;
1534 // Since we are caching this, make sure it is up to date by getting it
1536 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1537 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1540 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1544 return (bool)$this->mNewtalk
;
1548 * Return the talk page(s) this user has new messages on.
1549 * @return \type{\arrayof{\string}} Array of page URLs
1551 function getNewMessageLinks() {
1553 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1556 if( !$this->getNewtalk() )
1558 $up = $this->getUserPage();
1559 $utp = $up->getTalkPage();
1560 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1564 * Internal uncached check for new messages
1567 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1568 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1569 * @param $fromMaster \bool true to fetch from the master, false for a slave
1570 * @return \bool True if the user has new messages
1573 function checkNewtalk( $field, $id, $fromMaster = false ) {
1574 if ( $fromMaster ) {
1575 $db = wfGetDB( DB_MASTER
);
1577 $db = wfGetDB( DB_SLAVE
);
1579 $ok = $db->selectField( 'user_newtalk', $field,
1580 array( $field => $id ), __METHOD__
);
1581 return $ok !== false;
1585 * Add or update the new messages flag
1586 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1587 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1588 * @return \bool True if successful, false otherwise
1591 function updateNewtalk( $field, $id ) {
1592 $dbw = wfGetDB( DB_MASTER
);
1593 $dbw->insert( 'user_newtalk',
1594 array( $field => $id ),
1597 if ( $dbw->affectedRows() ) {
1598 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1601 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1607 * Clear the new messages flag for the given user
1608 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1609 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1610 * @return \bool True if successful, false otherwise
1613 function deleteNewtalk( $field, $id ) {
1614 $dbw = wfGetDB( DB_MASTER
);
1615 $dbw->delete( 'user_newtalk',
1616 array( $field => $id ),
1618 if ( $dbw->affectedRows() ) {
1619 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1622 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1628 * Update the 'You have new messages!' status.
1629 * @param $val \bool Whether the user has new messages
1631 function setNewtalk( $val ) {
1632 if( wfReadOnly() ) {
1637 $this->mNewtalk
= $val;
1639 if( $this->isAnon() ) {
1641 $id = $this->getName();
1644 $id = $this->getId();
1649 $changed = $this->updateNewtalk( $field, $id );
1651 $changed = $this->deleteNewtalk( $field, $id );
1654 if( $this->isAnon() ) {
1655 // Anons have a separate memcached space, since
1656 // user records aren't kept for them.
1657 $key = wfMemcKey( 'newtalk', 'ip', $id );
1658 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1661 $this->invalidateCache();
1666 * Generate a current or new-future timestamp to be stored in the
1667 * user_touched field when we update things.
1668 * @return \string Timestamp in TS_MW format
1670 private static function newTouchedTimestamp() {
1671 global $wgClockSkewFudge;
1672 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1676 * Clear user data from memcached.
1677 * Use after applying fun updates to the database; caller's
1678 * responsibility to update user_touched if appropriate.
1680 * Called implicitly from invalidateCache() and saveSettings().
1682 private function clearSharedCache() {
1686 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1691 * Immediately touch the user data cache for this account.
1692 * Updates user_touched field, and removes account data from memcached
1693 * for reload on the next hit.
1695 function invalidateCache() {
1696 if( wfReadOnly() ) {
1701 $this->mTouched
= self
::newTouchedTimestamp();
1703 $dbw = wfGetDB( DB_MASTER
);
1704 $dbw->update( 'user',
1705 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1706 array( 'user_id' => $this->mId
),
1709 $this->clearSharedCache();
1714 * Validate the cache for this account.
1715 * @param $timestamp \string A timestamp in TS_MW format
1717 function validateCache( $timestamp ) {
1719 return ( $timestamp >= $this->mTouched
);
1723 * Get the user touched timestamp
1725 function getTouched() {
1727 return $this->mTouched
;
1731 * Set the password and reset the random token.
1732 * Calls through to authentication plugin if necessary;
1733 * will have no effect if the auth plugin refuses to
1734 * pass the change through or if the legal password
1737 * As a special case, setting the password to null
1738 * wipes it, so the account cannot be logged in until
1739 * a new password is set, for instance via e-mail.
1741 * @param $str \string New password to set
1742 * @throws PasswordError on failure
1744 function setPassword( $str ) {
1747 if( $str !== null ) {
1748 if( !$wgAuth->allowPasswordChange() ) {
1749 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1752 if( !$this->isValidPassword( $str ) ) {
1753 global $wgMinimalPasswordLength;
1754 $valid = $this->getPasswordValidity( $str );
1755 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1756 $wgMinimalPasswordLength ) );
1760 if( !$wgAuth->setPassword( $this, $str ) ) {
1761 throw new PasswordError( wfMsg( 'externaldberror' ) );
1764 $this->setInternalPassword( $str );
1770 * Set the password and reset the random token unconditionally.
1772 * @param $str \string New password to set
1774 function setInternalPassword( $str ) {
1778 if( $str === null ) {
1779 // Save an invalid hash...
1780 $this->mPassword
= '';
1782 $this->mPassword
= self
::crypt( $str );
1784 $this->mNewpassword
= '';
1785 $this->mNewpassTime
= null;
1789 * Get the user's current token.
1790 * @return \string Token
1792 function getToken() {
1794 return $this->mToken
;
1798 * Set the random token (used for persistent authentication)
1799 * Called from loadDefaults() among other places.
1801 * @param $token \string If specified, set the token to this value
1804 function setToken( $token = false ) {
1805 global $wgSecretKey, $wgProxyKey;
1808 if ( $wgSecretKey ) {
1809 $key = $wgSecretKey;
1810 } elseif ( $wgProxyKey ) {
1815 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1817 $this->mToken
= $token;
1822 * Set the cookie password
1824 * @param $str \string New cookie password
1827 function setCookiePassword( $str ) {
1829 $this->mCookiePassword
= md5( $str );
1833 * Set the password for a password reminder or new account email
1835 * @param $str \string New password to set
1836 * @param $throttle \bool If true, reset the throttle timestamp to the present
1838 function setNewpassword( $str, $throttle = true ) {
1840 $this->mNewpassword
= self
::crypt( $str );
1842 $this->mNewpassTime
= wfTimestampNow();
1847 * Has password reminder email been sent within the last
1848 * $wgPasswordReminderResendTime hours?
1849 * @return \bool True or false
1851 function isPasswordReminderThrottled() {
1852 global $wgPasswordReminderResendTime;
1854 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1857 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1858 return time() < $expiry;
1862 * Get the user's e-mail address
1863 * @return \string User's email address
1865 function getEmail() {
1867 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1868 return $this->mEmail
;
1872 * Get the timestamp of the user's e-mail authentication
1873 * @return \string TS_MW timestamp
1875 function getEmailAuthenticationTimestamp() {
1877 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1878 return $this->mEmailAuthenticated
;
1882 * Set the user's e-mail address
1883 * @param $str \string New e-mail address
1885 function setEmail( $str ) {
1887 $this->mEmail
= $str;
1888 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1892 * Get the user's real name
1893 * @return \string User's real name
1895 function getRealName() {
1897 return $this->mRealName
;
1901 * Set the user's real name
1902 * @param $str \string New real name
1904 function setRealName( $str ) {
1906 $this->mRealName
= $str;
1910 * Get the user's current setting for a given option.
1912 * @param $oname \string The option to check
1913 * @param $defaultOverride \string A default value returned if the option does not exist
1914 * @return \string User's current value for the option
1915 * @see getBoolOption()
1916 * @see getIntOption()
1918 function getOption( $oname, $defaultOverride = null ) {
1919 $this->loadOptions();
1921 if ( is_null( $this->mOptions
) ) {
1922 if($defaultOverride != '') {
1923 return $defaultOverride;
1925 $this->mOptions
= User
::getDefaultOptions();
1928 if ( array_key_exists( $oname, $this->mOptions
) ) {
1929 return $this->mOptions
[$oname];
1931 return $defaultOverride;
1936 * Get all user's options
1940 public function getOptions() {
1941 $this->loadOptions();
1942 return $this->mOptions
;
1946 * Get the user's current setting for a given option, as a boolean value.
1948 * @param $oname \string The option to check
1949 * @return \bool User's current value for the option
1952 function getBoolOption( $oname ) {
1953 return (bool)$this->getOption( $oname );
1958 * Get the user's current setting for a given option, as a boolean value.
1960 * @param $oname \string The option to check
1961 * @param $defaultOverride \int A default value returned if the option does not exist
1962 * @return \int User's current value for the option
1965 function getIntOption( $oname, $defaultOverride=0 ) {
1966 $val = $this->getOption( $oname );
1968 $val = $defaultOverride;
1970 return intval( $val );
1974 * Set the given option for a user.
1976 * @param $oname \string The option to set
1977 * @param $val \mixed New value to set
1979 function setOption( $oname, $val ) {
1981 $this->loadOptions();
1983 if ( $oname == 'skin' ) {
1984 # Clear cached skin, so the new one displays immediately in Special:Preferences
1985 unset( $this->mSkin
);
1988 // Explicitly NULL values should refer to defaults
1989 global $wgDefaultUserOptions;
1990 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
1991 $val = $wgDefaultUserOptions[$oname];
1994 $this->mOptions
[$oname] = $val;
1998 * Reset all options to the site defaults
2000 function resetOptions() {
2001 $this->mOptions
= User
::getDefaultOptions();
2005 * Get the user's preferred date format.
2006 * @return \string User's preferred date format
2008 function getDatePreference() {
2009 // Important migration for old data rows
2010 if ( is_null( $this->mDatePreference
) ) {
2012 $value = $this->getOption( 'date' );
2013 $map = $wgLang->getDatePreferenceMigrationMap();
2014 if ( isset( $map[$value] ) ) {
2015 $value = $map[$value];
2017 $this->mDatePreference
= $value;
2019 return $this->mDatePreference
;
2023 * Get the user preferred stub threshold
2025 function getStubThreshold() {
2026 global $wgMaxArticleSize; # Maximum article size, in Kb
2027 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2028 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2029 # If they have set an impossible value, disable the preference
2030 # so we can use the parser cache again.
2037 * Get the permissions this user has.
2038 * @return \type{\arrayof{\string}} Array of permission names
2040 function getRights() {
2041 if ( is_null( $this->mRights
) ) {
2042 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2043 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2044 // Force reindexation of rights when a hook has unset one of them
2045 $this->mRights
= array_values( $this->mRights
);
2047 return $this->mRights
;
2051 * Get the list of explicit group memberships this user has.
2052 * The implicit * and user groups are not included.
2053 * @return \type{\arrayof{\string}} Array of internal group names
2055 function getGroups() {
2057 return $this->mGroups
;
2061 * Get the list of implicit group memberships this user has.
2062 * This includes all explicit groups, plus 'user' if logged in,
2063 * '*' for all accounts and autopromoted groups
2064 * @param $recache \bool Whether to avoid the cache
2065 * @return \type{\arrayof{\string}} Array of internal group names
2067 function getEffectiveGroups( $recache = false ) {
2068 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2069 wfProfileIn( __METHOD__
);
2070 $this->mEffectiveGroups
= $this->getGroups();
2071 $this->mEffectiveGroups
[] = '*';
2072 if( $this->getId() ) {
2073 $this->mEffectiveGroups
[] = 'user';
2075 $this->mEffectiveGroups
= array_unique( array_merge(
2076 $this->mEffectiveGroups
,
2077 Autopromote
::getAutopromoteGroups( $this )
2080 # Hook for additional groups
2081 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2083 wfProfileOut( __METHOD__
);
2085 return $this->mEffectiveGroups
;
2089 * Get the user's edit count.
2090 * @return \int User'e edit count
2092 function getEditCount() {
2093 if( $this->getId() ) {
2094 if ( !isset( $this->mEditCount
) ) {
2095 /* Populate the count, if it has not been populated yet */
2096 $this->mEditCount
= User
::edits( $this->mId
);
2098 return $this->mEditCount
;
2106 * Add the user to the given group.
2107 * This takes immediate effect.
2108 * @param $group \string Name of the group to add
2110 function addGroup( $group ) {
2111 $dbw = wfGetDB( DB_MASTER
);
2112 if( $this->getId() ) {
2113 $dbw->insert( 'user_groups',
2115 'ug_user' => $this->getID(),
2116 'ug_group' => $group,
2119 array( 'IGNORE' ) );
2122 $this->loadGroups();
2123 $this->mGroups
[] = $group;
2124 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2126 $this->invalidateCache();
2130 * Remove the user from the given group.
2131 * This takes immediate effect.
2132 * @param $group \string Name of the group to remove
2134 function removeGroup( $group ) {
2136 $dbw = wfGetDB( DB_MASTER
);
2137 $dbw->delete( 'user_groups',
2139 'ug_user' => $this->getID(),
2140 'ug_group' => $group,
2143 $this->loadGroups();
2144 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2145 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2147 $this->invalidateCache();
2151 * Get whether the user is logged in
2152 * @return \bool True or false
2154 function isLoggedIn() {
2155 return $this->getID() != 0;
2159 * Get whether the user is anonymous
2160 * @return \bool True or false
2163 return !$this->isLoggedIn();
2167 * Get whether the user is a bot
2168 * @return \bool True or false
2172 wfDeprecated( __METHOD__
);
2173 return $this->isAllowed( 'bot' );
2177 * Check if user is allowed to access a feature / make an action
2178 * @param $action \string action to be checked
2179 * @return \bool True if action is allowed, else false
2181 function isAllowed( $action = '' ) {
2182 if ( $action === '' )
2183 return true; // In the spirit of DWIM
2184 # Patrolling may not be enabled
2185 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2186 global $wgUseRCPatrol, $wgUseNPPatrol;
2187 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2190 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2191 # by misconfiguration: 0 == 'foo'
2192 return in_array( $action, $this->getRights(), true );
2196 * Check whether to enable recent changes patrol features for this user
2197 * @return \bool True or false
2199 public function useRCPatrol() {
2200 global $wgUseRCPatrol;
2201 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2205 * Check whether to enable new pages patrol features for this user
2206 * @return \bool True or false
2208 public function useNPPatrol() {
2209 global $wgUseRCPatrol, $wgUseNPPatrol;
2210 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2214 * Get the current skin, loading it if required, and setting a title
2215 * @param $t Title: the title to use in the skin
2216 * @return Skin The current skin
2217 * @todo FIXME : need to check the old failback system [AV]
2219 function getSkin( $t = null ) {
2221 $skin = $this->createSkinObject();
2222 $skin->setTitle( $t );
2225 if ( ! $this->mSkin
) {
2226 $this->mSkin
= $this->createSkinObject();
2229 if ( ! $this->mSkin
->getTitle() ) {
2231 $t = $wgOut->getTitle();
2232 $this->mSkin
->setTitle($t);
2235 return $this->mSkin
;
2239 // Creates a Skin object, for getSkin()
2240 private function createSkinObject() {
2241 wfProfileIn( __METHOD__
);
2243 global $wgHiddenPrefs;
2244 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2247 $userSkin = $this->getOption( 'skin' );
2248 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2250 # if we're not allowing users to override, then use the default
2251 global $wgDefaultSkin;
2252 $userSkin = $wgDefaultSkin;
2255 $skin = Skin
::newFromKey( $userSkin );
2256 wfProfileOut( __METHOD__
);
2262 * Check the watched status of an article.
2263 * @param $title \type{Title} Title of the article to look at
2264 * @return \bool True if article is watched
2266 function isWatched( $title ) {
2267 $wl = WatchedItem
::fromUserTitle( $this, $title );
2268 return $wl->isWatched();
2273 * @param $title \type{Title} Title of the article to look at
2275 function addWatch( $title ) {
2276 $wl = WatchedItem
::fromUserTitle( $this, $title );
2278 $this->invalidateCache();
2282 * Stop watching an article.
2283 * @param $title \type{Title} Title of the article to look at
2285 function removeWatch( $title ) {
2286 $wl = WatchedItem
::fromUserTitle( $this, $title );
2288 $this->invalidateCache();
2292 * Clear the user's notification timestamp for the given title.
2293 * If e-notif e-mails are on, they will receive notification mails on
2294 * the next change of the page if it's watched etc.
2295 * @param $title \type{Title} Title of the article to look at
2297 function clearNotification( &$title ) {
2298 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2300 # Do nothing if the database is locked to writes
2301 if( wfReadOnly() ) {
2305 if( $title->getNamespace() == NS_USER_TALK
&&
2306 $title->getText() == $this->getName() ) {
2307 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2309 $this->setNewtalk( false );
2312 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2316 if( $this->isAnon() ) {
2317 // Nothing else to do...
2321 // Only update the timestamp if the page is being watched.
2322 // The query to find out if it is watched is cached both in memcached and per-invocation,
2323 // and when it does have to be executed, it can be on a slave
2324 // If this is the user's newtalk page, we always update the timestamp
2325 if( $title->getNamespace() == NS_USER_TALK
&&
2326 $title->getText() == $wgUser->getName() )
2329 } elseif ( $this->getId() == $wgUser->getId() ) {
2330 $watched = $title->userIsWatching();
2335 // If the page is watched by the user (or may be watched), update the timestamp on any
2336 // any matching rows
2338 $dbw = wfGetDB( DB_MASTER
);
2339 $dbw->update( 'watchlist',
2341 'wl_notificationtimestamp' => null
2342 ), array( /* WHERE */
2343 'wl_title' => $title->getDBkey(),
2344 'wl_namespace' => $title->getNamespace(),
2345 'wl_user' => $this->getID()
2352 * Resets all of the given user's page-change notification timestamps.
2353 * If e-notif e-mails are on, they will receive notification mails on
2354 * the next change of any watched page.
2356 * @param $currentUser \int User ID
2358 function clearAllNotifications( $currentUser ) {
2359 global $wgUseEnotif, $wgShowUpdatedMarker;
2360 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2361 $this->setNewtalk( false );
2364 if( $currentUser != 0 ) {
2365 $dbw = wfGetDB( DB_MASTER
);
2366 $dbw->update( 'watchlist',
2368 'wl_notificationtimestamp' => null
2369 ), array( /* WHERE */
2370 'wl_user' => $currentUser
2373 # We also need to clear here the "you have new message" notification for the own user_talk page
2374 # This is cleared one page view later in Article::viewUpdates();
2379 * Set this user's options from an encoded string
2380 * @param $str \string Encoded options to import
2383 function decodeOptions( $str ) {
2387 $this->mOptionsLoaded
= true;
2388 $this->mOptionOverrides
= array();
2390 $this->mOptions
= array();
2391 $a = explode( "\n", $str );
2392 foreach ( $a as $s ) {
2394 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2395 $this->mOptions
[$m[1]] = $m[2];
2396 $this->mOptionOverrides
[$m[1]] = $m[2];
2402 * Set a cookie on the user's client. Wrapper for
2403 * WebResponse::setCookie
2404 * @param $name \string Name of the cookie to set
2405 * @param $value \string Value to set
2406 * @param $exp \int Expiration time, as a UNIX time value;
2407 * if 0 or not specified, use the default $wgCookieExpiration
2409 protected function setCookie( $name, $value, $exp = 0 ) {
2411 $wgRequest->response()->setcookie( $name, $value, $exp );
2415 * Clear a cookie on the user's client
2416 * @param $name \string Name of the cookie to clear
2418 protected function clearCookie( $name ) {
2419 $this->setCookie( $name, '', time() - 86400 );
2423 * Set the default cookies for this session on the user's client.
2425 function setCookies() {
2427 if ( 0 == $this->mId
) return;
2429 'wsUserID' => $this->mId
,
2430 'wsToken' => $this->mToken
,
2431 'wsUserName' => $this->getName()
2434 'UserID' => $this->mId
,
2435 'UserName' => $this->getName(),
2437 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2438 $cookies['Token'] = $this->mToken
;
2440 $cookies['Token'] = false;
2443 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2444 #check for null, since the hook could cause a null value
2445 if ( !is_null( $session ) && isset( $_SESSION ) ){
2446 $_SESSION = $session +
$_SESSION;
2448 foreach ( $cookies as $name => $value ) {
2449 if ( $value === false ) {
2450 $this->clearCookie( $name );
2452 $this->setCookie( $name, $value );
2458 * Log this user out.
2461 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2467 * Clear the user's cookies and session, and reset the instance cache.
2471 function doLogout() {
2472 $this->clearInstanceCache( 'defaults' );
2474 $_SESSION['wsUserID'] = 0;
2476 $this->clearCookie( 'UserID' );
2477 $this->clearCookie( 'Token' );
2479 # Remember when user logged out, to prevent seeing cached pages
2480 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2484 * Save this user's settings into the database.
2485 * @todo Only rarely do all these fields need to be set!
2487 function saveSettings() {
2489 if ( wfReadOnly() ) { return; }
2490 if ( 0 == $this->mId
) { return; }
2492 $this->mTouched
= self
::newTouchedTimestamp();
2494 $dbw = wfGetDB( DB_MASTER
);
2495 $dbw->update( 'user',
2497 'user_name' => $this->mName
,
2498 'user_password' => $this->mPassword
,
2499 'user_newpassword' => $this->mNewpassword
,
2500 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2501 'user_real_name' => $this->mRealName
,
2502 'user_email' => $this->mEmail
,
2503 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2504 'user_options' => '',
2505 'user_touched' => $dbw->timestamp( $this->mTouched
),
2506 'user_token' => $this->mToken
,
2507 'user_email_token' => $this->mEmailToken
,
2508 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2509 ), array( /* WHERE */
2510 'user_id' => $this->mId
2514 $this->saveOptions();
2516 wfRunHooks( 'UserSaveSettings', array( $this ) );
2517 $this->clearSharedCache();
2518 $this->getUserPage()->invalidateCache();
2522 * If only this user's username is known, and it exists, return the user ID.
2524 function idForName() {
2525 $s = trim( $this->getName() );
2526 if ( $s === '' ) return 0;
2528 $dbr = wfGetDB( DB_SLAVE
);
2529 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2530 if ( $id === false ) {
2537 * Add a user to the database, return the user object
2539 * @param $name \string Username to add
2540 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2541 * - password The user's password. Password logins will be disabled if this is omitted.
2542 * - newpassword A temporary password mailed to the user
2543 * - email The user's email address
2544 * - email_authenticated The email authentication timestamp
2545 * - real_name The user's real name
2546 * - options An associative array of non-default options
2547 * - token Random authentication token. Do not set.
2548 * - registration Registration timestamp. Do not set.
2550 * @return \type{User} A new User object, or null if the username already exists
2552 static function createNew( $name, $params = array() ) {
2555 if ( isset( $params['options'] ) ) {
2556 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2557 unset( $params['options'] );
2559 $dbw = wfGetDB( DB_MASTER
);
2560 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2562 'user_id' => $seqVal,
2563 'user_name' => $name,
2564 'user_password' => $user->mPassword
,
2565 'user_newpassword' => $user->mNewpassword
,
2566 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2567 'user_email' => $user->mEmail
,
2568 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2569 'user_real_name' => $user->mRealName
,
2570 'user_options' => '',
2571 'user_token' => $user->mToken
,
2572 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2573 'user_editcount' => 0,
2575 foreach ( $params as $name => $value ) {
2576 $fields["user_$name"] = $value;
2578 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2579 if ( $dbw->affectedRows() ) {
2580 $newUser = User
::newFromId( $dbw->insertId() );
2588 * Add this existing user object to the database
2590 function addToDatabase() {
2592 $dbw = wfGetDB( DB_MASTER
);
2593 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2594 $dbw->insert( 'user',
2596 'user_id' => $seqVal,
2597 'user_name' => $this->mName
,
2598 'user_password' => $this->mPassword
,
2599 'user_newpassword' => $this->mNewpassword
,
2600 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2601 'user_email' => $this->mEmail
,
2602 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2603 'user_real_name' => $this->mRealName
,
2604 'user_options' => '',
2605 'user_token' => $this->mToken
,
2606 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2607 'user_editcount' => 0,
2610 $this->mId
= $dbw->insertId();
2612 // Clear instance cache other than user table data, which is already accurate
2613 $this->clearInstanceCache();
2615 $this->saveOptions();
2619 * If this (non-anonymous) user is blocked, block any IP address
2620 * they've successfully logged in from.
2622 function spreadBlock() {
2623 wfDebug( __METHOD__
. "()\n" );
2625 if ( $this->mId
== 0 ) {
2629 $userblock = Block
::newFromDB( '', $this->mId
);
2630 if ( !$userblock ) {
2634 $userblock->doAutoblock( wfGetIP() );
2638 * Generate a string which will be different for any combination of
2639 * user options which would produce different parser output.
2640 * This will be used as part of the hash key for the parser cache,
2641 * so users with the same options can share the same cached data
2644 * Extensions which require it should install 'PageRenderingHash' hook,
2645 * which will give them a chance to modify this key based on their own
2648 * @return \string Page rendering hash
2650 function getPageRenderingHash() {
2651 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2653 return $this->mHash
;
2656 // stubthreshold is only included below for completeness,
2657 // since it disables the parser cache, its value will always
2658 // be 0 when this function is called by parsercache.
2660 $confstr = $this->getOption( 'math' );
2661 $confstr .= '!' . $this->getStubThreshold();
2662 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2663 $confstr .= '!' . $this->getDatePreference();
2665 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2666 $confstr .= '!' . $wgLang->getCode();
2667 $confstr .= '!' . $this->getOption( 'thumbsize' );
2668 // add in language specific options, if any
2669 $extra = $wgContLang->getExtraHashOptions();
2672 // Since the skin could be overloading link(), it should be
2673 // included here but in practice, none of our skins do that.
2675 $confstr .= $wgRenderHashAppend;
2677 // Give a chance for extensions to modify the hash, if they have
2678 // extra options or other effects on the parser cache.
2679 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2681 // Make it a valid memcached key fragment
2682 $confstr = str_replace( ' ', '_', $confstr );
2683 $this->mHash
= $confstr;
2688 * Get whether the user is explicitly blocked from account creation.
2689 * @return \bool True if blocked
2691 function isBlockedFromCreateAccount() {
2692 $this->getBlockedStatus();
2693 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2697 * Get whether the user is blocked from using Special:Emailuser.
2698 * @return \bool True if blocked
2700 function isBlockedFromEmailuser() {
2701 $this->getBlockedStatus();
2702 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2706 * Get whether the user is allowed to create an account.
2707 * @return \bool True if allowed
2709 function isAllowedToCreateAccount() {
2710 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2714 * Get this user's personal page title.
2716 * @return \type{Title} User's personal page title
2718 function getUserPage() {
2719 return Title
::makeTitle( NS_USER
, $this->getName() );
2723 * Get this user's talk page title.
2725 * @return \type{Title} User's talk page title
2727 function getTalkPage() {
2728 $title = $this->getUserPage();
2729 return $title->getTalkPage();
2733 * Get the maximum valid user ID.
2734 * @return \int User ID
2737 function getMaxID() {
2738 static $res; // cache
2740 if ( isset( $res ) )
2743 $dbr = wfGetDB( DB_SLAVE
);
2744 return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__
);
2749 * Determine whether the user is a newbie. Newbies are either
2750 * anonymous IPs, or the most recently created accounts.
2751 * @return \bool True if the user is a newbie
2753 function isNewbie() {
2754 return !$this->isAllowed( 'autoconfirmed' );
2758 * Check to see if the given clear-text password is one of the accepted passwords
2759 * @param $password \string user password.
2760 * @return \bool True if the given password is correct, otherwise False.
2762 function checkPassword( $password ) {
2766 // Even though we stop people from creating passwords that
2767 // are shorter than this, doesn't mean people wont be able
2768 // to. Certain authentication plugins do NOT want to save
2769 // domain passwords in a mysql database, so we should
2770 // check this (incase $wgAuth->strict() is false).
2771 if( !$this->isValidPassword( $password ) ) {
2775 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2777 } elseif( $wgAuth->strict() ) {
2778 /* Auth plugin doesn't allow local authentication */
2780 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2781 /* Auth plugin doesn't allow local authentication for this user name */
2784 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2786 } elseif ( function_exists( 'iconv' ) ) {
2787 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2788 # Check for this with iconv
2789 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2790 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2798 * Check if the given clear-text password matches the temporary password
2799 * sent by e-mail for password reset operations.
2800 * @return \bool True if matches, false otherwise
2802 function checkTemporaryPassword( $plaintext ) {
2803 global $wgNewPasswordExpiry;
2804 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2806 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2807 return ( time() < $expiry );
2814 * Initialize (if necessary) and return a session token value
2815 * which can be used in edit forms to show that the user's
2816 * login credentials aren't being hijacked with a foreign form
2819 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2820 * @return \string The new edit token
2822 function editToken( $salt = '' ) {
2823 if ( $this->isAnon() ) {
2824 return EDIT_TOKEN_SUFFIX
;
2826 if( !isset( $_SESSION['wsEditToken'] ) ) {
2827 $token = self
::generateToken();
2828 $_SESSION['wsEditToken'] = $token;
2830 $token = $_SESSION['wsEditToken'];
2832 if( is_array( $salt ) ) {
2833 $salt = implode( '|', $salt );
2835 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2840 * Generate a looking random token for various uses.
2842 * @param $salt \string Optional salt value
2843 * @return \string The new random token
2845 public static function generateToken( $salt = '' ) {
2846 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2847 return md5( $token . $salt );
2851 * Check given value against the token value stored in the session.
2852 * A match should confirm that the form was submitted from the
2853 * user's own login session, not a form submission from a third-party
2856 * @param $val \string Input value to compare
2857 * @param $salt \string Optional function-specific data for hashing
2858 * @return \bool Whether the token matches
2860 function matchEditToken( $val, $salt = '' ) {
2861 $sessionToken = $this->editToken( $salt );
2862 if ( $val != $sessionToken ) {
2863 wfDebug( "User::matchEditToken: broken session data\n" );
2865 return $val == $sessionToken;
2869 * Check given value against the token value stored in the session,
2870 * ignoring the suffix.
2872 * @param $val \string Input value to compare
2873 * @param $salt \string Optional function-specific data for hashing
2874 * @return \bool Whether the token matches
2876 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2877 $sessionToken = $this->editToken( $salt );
2878 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2882 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2883 * mail to the user's given address.
2885 * @param $changed Boolean: whether the adress changed
2886 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2888 function sendConfirmationMail( $changed = false ) {
2890 $expiration = null; // gets passed-by-ref and defined in next line.
2891 $token = $this->confirmationToken( $expiration );
2892 $url = $this->confirmationTokenUrl( $token );
2893 $invalidateURL = $this->invalidationTokenUrl( $token );
2894 $this->saveSettings();
2896 $message = $changed ?
'confirmemail_body_changed' : 'confirmemail_body';
2897 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2902 $wgLang->timeanddate( $expiration, false ),
2904 $wgLang->date( $expiration, false ),
2905 $wgLang->time( $expiration, false ) ) );
2909 * Send an e-mail to this user's account. Does not check for
2910 * confirmed status or validity.
2912 * @param $subject \string Message subject
2913 * @param $body \string Message body
2914 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2915 * @param $replyto \string Reply-To address
2916 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2918 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2919 if( is_null( $from ) ) {
2920 global $wgPasswordSender;
2921 $from = $wgPasswordSender;
2924 $to = new MailAddress( $this );
2925 $sender = new MailAddress( $from );
2926 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2930 * Generate, store, and return a new e-mail confirmation code.
2931 * A hash (unsalted, since it's used as a key) is stored.
2933 * @note Call saveSettings() after calling this function to commit
2934 * this change to the database.
2936 * @param[out] &$expiration \mixed Accepts the expiration time
2937 * @return \string New token
2940 function confirmationToken( &$expiration ) {
2942 $expires = $now +
7 * 24 * 60 * 60;
2943 $expiration = wfTimestamp( TS_MW
, $expires );
2944 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
2945 $hash = md5( $token );
2947 $this->mEmailToken
= $hash;
2948 $this->mEmailTokenExpires
= $expiration;
2953 * Return a URL the user can use to confirm their email address.
2954 * @param $token \string Accepts the email confirmation token
2955 * @return \string New token URL
2958 function confirmationTokenUrl( $token ) {
2959 return $this->getTokenUrl( 'ConfirmEmail', $token );
2963 * Return a URL the user can use to invalidate their email address.
2964 * @param $token \string Accepts the email confirmation token
2965 * @return \string New token URL
2968 function invalidationTokenUrl( $token ) {
2969 return $this->getTokenUrl( 'Invalidateemail', $token );
2973 * Internal function to format the e-mail validation/invalidation URLs.
2974 * This uses $wgArticlePath directly as a quickie hack to use the
2975 * hardcoded English names of the Special: pages, for ASCII safety.
2977 * @note Since these URLs get dropped directly into emails, using the
2978 * short English names avoids insanely long URL-encoded links, which
2979 * also sometimes can get corrupted in some browsers/mailers
2980 * (bug 6957 with Gmail and Internet Explorer).
2982 * @param $page \string Special page
2983 * @param $token \string Token
2984 * @return \string Formatted URL
2986 protected function getTokenUrl( $page, $token ) {
2987 global $wgArticlePath;
2991 "Special:$page/$token",
2996 * Mark the e-mail address confirmed.
2998 * @note Call saveSettings() after calling this function to commit the change.
3000 function confirmEmail() {
3001 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3002 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3007 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3008 * address if it was already confirmed.
3010 * @note Call saveSettings() after calling this function to commit the change.
3012 function invalidateEmail() {
3014 $this->mEmailToken
= null;
3015 $this->mEmailTokenExpires
= null;
3016 $this->setEmailAuthenticationTimestamp( null );
3017 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3022 * Set the e-mail authentication timestamp.
3023 * @param $timestamp \string TS_MW timestamp
3025 function setEmailAuthenticationTimestamp( $timestamp ) {
3027 $this->mEmailAuthenticated
= $timestamp;
3028 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3032 * Is this user allowed to send e-mails within limits of current
3033 * site configuration?
3034 * @return \bool True if allowed
3036 function canSendEmail() {
3037 global $wgEnableEmail, $wgEnableUserEmail;
3038 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3041 $canSend = $this->isEmailConfirmed();
3042 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3047 * Is this user allowed to receive e-mails within limits of current
3048 * site configuration?
3049 * @return \bool True if allowed
3051 function canReceiveEmail() {
3052 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3056 * Is this user's e-mail address valid-looking and confirmed within
3057 * limits of the current site configuration?
3059 * @note If $wgEmailAuthentication is on, this may require the user to have
3060 * confirmed their address by returning a code or using a password
3061 * sent to the address from the wiki.
3063 * @return \bool True if confirmed
3065 function isEmailConfirmed() {
3066 global $wgEmailAuthentication;
3069 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3070 if( $this->isAnon() )
3072 if( !self
::isValidEmailAddr( $this->mEmail
) )
3074 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3083 * Check whether there is an outstanding request for e-mail confirmation.
3084 * @return \bool True if pending
3086 function isEmailConfirmationPending() {
3087 global $wgEmailAuthentication;
3088 return $wgEmailAuthentication &&
3089 !$this->isEmailConfirmed() &&
3090 $this->mEmailToken
&&
3091 $this->mEmailTokenExpires
> wfTimestamp();
3095 * Get the timestamp of account creation.
3097 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3098 * non-existent/anonymous user accounts.
3100 public function getRegistration() {
3101 return $this->getId() > 0
3102 ?
$this->mRegistration
3107 * Get the timestamp of the first edit
3109 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3110 * non-existent/anonymous user accounts.
3112 public function getFirstEditTimestamp() {
3113 if( $this->getId() == 0 ) return false; // anons
3114 $dbr = wfGetDB( DB_SLAVE
);
3115 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3116 array( 'rev_user' => $this->getId() ),
3118 array( 'ORDER BY' => 'rev_timestamp ASC' )
3120 if( !$time ) return false; // no edits
3121 return wfTimestamp( TS_MW
, $time );
3125 * Get the permissions associated with a given list of groups
3127 * @param $groups \type{\arrayof{\string}} List of internal group names
3128 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3130 static function getGroupPermissions( $groups ) {
3131 global $wgGroupPermissions, $wgRevokePermissions;
3133 // grant every granted permission first
3134 foreach( $groups as $group ) {
3135 if( isset( $wgGroupPermissions[$group] ) ) {
3136 $rights = array_merge( $rights,
3137 // array_filter removes empty items
3138 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3141 // now revoke the revoked permissions
3142 foreach( $groups as $group ) {
3143 if( isset( $wgRevokePermissions[$group] ) ) {
3144 $rights = array_diff( $rights,
3145 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3148 return array_unique( $rights );
3152 * Get all the groups who have a given permission
3154 * @param $role \string Role to check
3155 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3157 static function getGroupsWithPermission( $role ) {
3158 global $wgGroupPermissions;
3159 $allowedGroups = array();
3160 foreach ( $wgGroupPermissions as $group => $rights ) {
3161 if ( isset( $rights[$role] ) && $rights[$role] ) {
3162 $allowedGroups[] = $group;
3165 return $allowedGroups;
3169 * Get the localized descriptive name for a group, if it exists
3171 * @param $group \string Internal group name
3172 * @return \string Localized descriptive group name
3174 static function getGroupName( $group ) {
3175 $key = "group-$group";
3176 $name = wfMsg( $key );
3177 return $name == '' ||
wfEmptyMsg( $key, $name )
3183 * Get the localized descriptive name for a member of a group, if it exists
3185 * @param $group \string Internal group name
3186 * @return \string Localized name for group member
3188 static function getGroupMember( $group ) {
3189 $key = "group-$group-member";
3190 $name = wfMsg( $key );
3191 return $name == '' ||
wfEmptyMsg( $key, $name )
3197 * Return the set of defined explicit groups.
3198 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3199 * are not included, as they are defined automatically, not in the database.
3200 * @return \type{\arrayof{\string}} Array of internal group names
3202 static function getAllGroups() {
3203 global $wgGroupPermissions, $wgRevokePermissions;
3205 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3206 self
::getImplicitGroups()
3211 * Get a list of all available permissions.
3212 * @return \type{\arrayof{\string}} Array of permission names
3214 static function getAllRights() {
3215 if ( self
::$mAllRights === false ) {
3216 global $wgAvailableRights;
3217 if ( count( $wgAvailableRights ) ) {
3218 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3220 self
::$mAllRights = self
::$mCoreRights;
3222 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3224 return self
::$mAllRights;
3228 * Get a list of implicit groups
3229 * @return \type{\arrayof{\string}} Array of internal group names
3231 public static function getImplicitGroups() {
3232 global $wgImplicitGroups;
3233 $groups = $wgImplicitGroups;
3234 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3239 * Get the title of a page describing a particular group
3241 * @param $group \string Internal group name
3242 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3244 static function getGroupPage( $group ) {
3245 $page = wfMsgForContent( 'grouppage-' . $group );
3246 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3247 $title = Title
::newFromText( $page );
3248 if( is_object( $title ) )
3255 * Create a link to the group in HTML, if available;
3256 * else return the group name.
3258 * @param $group \string Internal name of the group
3259 * @param $text \string The text of the link
3260 * @return \string HTML link to the group
3262 static function makeGroupLinkHTML( $group, $text = '' ) {
3264 $text = self
::getGroupName( $group );
3266 $title = self
::getGroupPage( $group );
3269 $sk = $wgUser->getSkin();
3270 return $sk->link( $title, htmlspecialchars( $text ) );
3277 * Create a link to the group in Wikitext, if available;
3278 * else return the group name.
3280 * @param $group \string Internal name of the group
3281 * @param $text \string The text of the link
3282 * @return \string Wikilink to the group
3284 static function makeGroupLinkWiki( $group, $text = '' ) {
3286 $text = self
::getGroupName( $group );
3288 $title = self
::getGroupPage( $group );
3290 $page = $title->getPrefixedText();
3291 return "[[$page|$text]]";
3298 * Returns an array of the groups that a particular group can add/remove.
3300 * @param $group String: the group to check for whether it can add/remove
3301 * @return Array array( 'add' => array( addablegroups ),
3302 * 'remove' => array( removablegroups ),
3303 * 'add-self' => array( addablegroups to self),
3304 * 'remove-self' => array( removable groups from self) )
3306 static function changeableByGroup( $group ) {
3307 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3309 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3310 if( empty( $wgAddGroups[$group] ) ) {
3311 // Don't add anything to $groups
3312 } elseif( $wgAddGroups[$group] === true ) {
3313 // You get everything
3314 $groups['add'] = self
::getAllGroups();
3315 } elseif( is_array( $wgAddGroups[$group] ) ) {
3316 $groups['add'] = $wgAddGroups[$group];
3319 // Same thing for remove
3320 if( empty( $wgRemoveGroups[$group] ) ) {
3321 } elseif( $wgRemoveGroups[$group] === true ) {
3322 $groups['remove'] = self
::getAllGroups();
3323 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3324 $groups['remove'] = $wgRemoveGroups[$group];
3327 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3328 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3329 foreach( $wgGroupsAddToSelf as $key => $value ) {
3330 if( is_int( $key ) ) {
3331 $wgGroupsAddToSelf['user'][] = $value;
3336 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3337 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3338 if( is_int( $key ) ) {
3339 $wgGroupsRemoveFromSelf['user'][] = $value;
3344 // Now figure out what groups the user can add to him/herself
3345 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3346 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3347 // No idea WHY this would be used, but it's there
3348 $groups['add-self'] = User
::getAllGroups();
3349 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3350 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3353 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3354 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3355 $groups['remove-self'] = User
::getAllGroups();
3356 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3357 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3364 * Returns an array of groups that this user can add and remove
3365 * @return Array array( 'add' => array( addablegroups ),
3366 * 'remove' => array( removablegroups ),
3367 * 'add-self' => array( addablegroups to self),
3368 * 'remove-self' => array( removable groups from self) )
3370 function changeableGroups() {
3371 if( $this->isAllowed( 'userrights' ) ) {
3372 // This group gives the right to modify everything (reverse-
3373 // compatibility with old "userrights lets you change
3375 // Using array_merge to make the groups reindexed
3376 $all = array_merge( User
::getAllGroups() );
3380 'add-self' => array(),
3381 'remove-self' => array()
3385 // Okay, it's not so simple, we will have to go through the arrays
3388 'remove' => array(),
3389 'add-self' => array(),
3390 'remove-self' => array()
3392 $addergroups = $this->getEffectiveGroups();
3394 foreach( $addergroups as $addergroup ) {
3395 $groups = array_merge_recursive(
3396 $groups, $this->changeableByGroup( $addergroup )
3398 $groups['add'] = array_unique( $groups['add'] );
3399 $groups['remove'] = array_unique( $groups['remove'] );
3400 $groups['add-self'] = array_unique( $groups['add-self'] );
3401 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3407 * Increment the user's edit-count field.
3408 * Will have no effect for anonymous users.
3410 function incEditCount() {
3411 if( !$this->isAnon() ) {
3412 $dbw = wfGetDB( DB_MASTER
);
3413 $dbw->update( 'user',
3414 array( 'user_editcount=user_editcount+1' ),
3415 array( 'user_id' => $this->getId() ),
3418 // Lazy initialization check...
3419 if( $dbw->affectedRows() == 0 ) {
3420 // Pull from a slave to be less cruel to servers
3421 // Accuracy isn't the point anyway here
3422 $dbr = wfGetDB( DB_SLAVE
);
3423 $count = $dbr->selectField( 'revision',
3425 array( 'rev_user' => $this->getId() ),
3428 // Now here's a goddamn hack...
3429 if( $dbr !== $dbw ) {
3430 // If we actually have a slave server, the count is
3431 // at least one behind because the current transaction
3432 // has not been committed and replicated.
3435 // But if DB_SLAVE is selecting the master, then the
3436 // count we just read includes the revision that was
3437 // just added in the working transaction.
3440 $dbw->update( 'user',
3441 array( 'user_editcount' => $count ),
3442 array( 'user_id' => $this->getId() ),
3446 // edit count in user cache too
3447 $this->invalidateCache();
3451 * Get the description of a given right
3453 * @param $right \string Right to query
3454 * @return \string Localized description of the right
3456 static function getRightDescription( $right ) {
3457 $key = "right-$right";
3458 $name = wfMsg( $key );
3459 return $name == '' ||
wfEmptyMsg( $key, $name )
3465 * Make an old-style password hash
3467 * @param $password \string Plain-text password
3468 * @param $userId \string User ID
3469 * @return \string Password hash
3471 static function oldCrypt( $password, $userId ) {
3472 global $wgPasswordSalt;
3473 if ( $wgPasswordSalt ) {
3474 return md5( $userId . '-' . md5( $password ) );
3476 return md5( $password );
3481 * Make a new-style password hash
3483 * @param $password \string Plain-text password
3484 * @param $salt \string Optional salt, may be random or the user ID.
3485 * If unspecified or false, will generate one automatically
3486 * @return \string Password hash
3488 static function crypt( $password, $salt = false ) {
3489 global $wgPasswordSalt;
3492 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3496 if( $wgPasswordSalt ) {
3497 if ( $salt === false ) {
3498 $salt = substr( wfGenerateToken(), 0, 8 );
3500 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3502 return ':A:' . md5( $password );
3507 * Compare a password hash with a plain-text password. Requires the user
3508 * ID if there's a chance that the hash is an old-style hash.
3510 * @param $hash \string Password hash
3511 * @param $password \string Plain-text password to compare
3512 * @param $userId \string User ID for old-style password salt
3515 static function comparePasswords( $hash, $password, $userId = false ) {
3516 $type = substr( $hash, 0, 3 );
3519 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3523 if ( $type == ':A:' ) {
3525 return md5( $password ) === substr( $hash, 3 );
3526 } elseif ( $type == ':B:' ) {
3528 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3529 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3532 return self
::oldCrypt( $password, $userId ) === $hash;
3537 * Add a newuser log entry for this user
3539 * @param $byEmail Boolean: account made by email?
3540 * @param $reason String: user supplied reason
3542 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3543 global $wgUser, $wgContLang, $wgNewUserLog;
3544 if( empty( $wgNewUserLog ) ) {
3545 return true; // disabled
3548 if( $this->getName() == $wgUser->getName() ) {
3551 $action = 'create2';
3553 if ( $reason === '' ) {
3554 $reason = wfMsgForContent( 'newuserlog-byemail' );
3556 $reason = $wgContLang->commaList( array(
3557 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3561 $log = new LogPage( 'newusers' );
3564 $this->getUserPage(),
3566 array( $this->getId() )
3572 * Add an autocreate newuser log entry for this user
3573 * Used by things like CentralAuth and perhaps other authplugins.
3575 public function addNewUserLogEntryAutoCreate() {
3576 global $wgNewUserLog, $wgLogAutocreatedAccounts;
3577 if( !$wgNewUserLog ||
!$wgLogAutocreatedAccounts ) {
3578 return true; // disabled
3580 $log = new LogPage( 'newusers', false );
3581 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3585 protected function loadOptions() {
3587 if ( $this->mOptionsLoaded ||
!$this->getId() )
3590 $this->mOptions
= self
::getDefaultOptions();
3592 // Maybe load from the object
3593 if ( !is_null( $this->mOptionOverrides
) ) {
3594 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3595 foreach( $this->mOptionOverrides
as $key => $value ) {
3596 $this->mOptions
[$key] = $value;
3599 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3600 // Load from database
3601 $dbr = wfGetDB( DB_SLAVE
);
3603 $res = $dbr->select(
3606 array( 'up_user' => $this->getId() ),
3610 while( $row = $dbr->fetchObject( $res ) ) {
3611 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3612 $this->mOptions
[$row->up_property
] = $row->up_value
;
3616 $this->mOptionsLoaded
= true;
3618 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3621 protected function saveOptions() {
3622 global $wgAllowPrefChange;
3624 $extuser = ExternalUser
::newFromUser( $this );
3626 $this->loadOptions();
3627 $dbw = wfGetDB( DB_MASTER
);
3629 $insert_rows = array();
3631 $saveOptions = $this->mOptions
;
3633 // Allow hooks to abort, for instance to save to a global profile.
3634 // Reset options to default state before saving.
3635 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3638 foreach( $saveOptions as $key => $value ) {
3639 # Don't bother storing default values
3640 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3641 !( $value === false ||
is_null($value) ) ) ||
3642 $value != self
::getDefaultOption( $key ) ) {
3643 $insert_rows[] = array(
3644 'up_user' => $this->getId(),
3645 'up_property' => $key,
3646 'up_value' => $value,
3649 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3650 switch ( $wgAllowPrefChange[$key] ) {
3656 $extuser->setPref( $key, $value );
3662 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3663 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3668 * Provide an array of HTML5 attributes to put on an input element
3669 * intended for the user to enter a new password. This may include
3670 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3672 * Do *not* use this when asking the user to enter his current password!
3673 * Regardless of configuration, users may have invalid passwords for whatever
3674 * reason (e.g., they were set before requirements were tightened up).
3675 * Only use it when asking for a new password, like on account creation or
3678 * Obviously, you still need to do server-side checking.
3680 * NOTE: A combination of bugs in various browsers means that this function
3681 * actually just returns array() unconditionally at the moment. May as
3682 * well keep it around for when the browser bugs get fixed, though.
3684 * @return array Array of HTML attributes suitable for feeding to
3685 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3686 * That will potentially output invalid XHTML 1.0 Transitional, and will
3687 * get confused by the boolean attribute syntax used.)
3689 public static function passwordChangeInputAttribs() {
3690 global $wgMinimalPasswordLength;
3692 if ( $wgMinimalPasswordLength == 0 ) {
3696 # Note that the pattern requirement will always be satisfied if the
3697 # input is empty, so we need required in all cases.
3699 # FIXME (bug 23769): This needs to not claim the password is required
3700 # if e-mail confirmation is being used. Since HTML5 input validation
3701 # is b0rked anyway in some browsers, just return nothing. When it's
3702 # re-enabled, fix this code to not output required for e-mail
3704 #$ret = array( 'required' );
3707 # We can't actually do this right now, because Opera 9.6 will print out
3708 # the entered password visibly in its error message! When other
3709 # browsers add support for this attribute, or Opera fixes its support,
3710 # we can add support with a version check to avoid doing this on Opera
3711 # versions where it will be a problem. Reported to Opera as
3712 # DSK-262266, but they don't have a public bug tracker for us to follow.
3714 if ( $wgMinimalPasswordLength > 1 ) {
3715 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3716 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3717 $wgMinimalPasswordLength );
3725 * Format the user message using a hook, a template, or, failing these, a static format.
3726 * @param $subject String the subject of the message
3727 * @param $text String the content of the message
3728 * @param $signature String the signature, if provided.
3730 static protected function formatUserMessage( $subject, $text, $signature ) {
3731 if ( wfRunHooks( 'FormatUserMessage',
3732 array( $subject, &$text, $signature ) ) ) {
3734 $signature = empty($signature) ?
"~~~~~" : "{$signature} ~~~~~";
3736 $template = Title
::newFromText( wfMsgForContent( 'usermessage-template' ) );
3738 ||
$template->getNamespace() !== NS_TEMPLATE
3739 ||
!$template->exists() ) {
3740 $text = "\n== $subject ==\n\n$text\n\n-- $signature";
3742 $text = '{{'. $template->getText()
3743 . " | subject=$subject | body=$text | signature=$signature }}";
3751 * Leave a user a message
3752 * @param $subject String the subject of the message
3753 * @param $text String the message to leave
3754 * @param $signature String Text to leave in the signature
3755 * @param $summary String the summary for this change, defaults to
3756 * "Leave system message."
3757 * @param $editor User The user leaving the message, defaults to
3758 * "{{MediaWiki:usermessage-editor}}"
3759 * @param $flags Int default edit flags
3761 * @return boolean true if it was successful
3763 public function leaveUserMessage( $subject, $text, $signature = "",
3764 $summary = null, $editor = null, $flags = 0 ) {
3765 if ( !isset( $summary ) ) {
3766 $summary = wfMsgForContent( 'usermessage-summary' );
3769 if ( !isset( $editor ) ) {
3770 $editor = User
::newFromName( wfMsgForContent( 'usermessage-editor' ) );
3771 if ( !$editor->isLoggedIn() ) {
3772 $editor->addToDatabase();
3776 $article = new Article( $this->getTalkPage() );
3777 wfRunHooks( 'SetupUserMessageArticle',
3778 array( $this, &$article, $subject, $text, $signature, $summary, $editor ) );
3781 $text = self
::formatUserMessage( $subject, $text, $signature );
3782 $flags = $article->checkFlags( $flags );
3784 if ( $flags & EDIT_UPDATE
) {
3785 $text = $article->getContent() . $text;
3788 $dbw = wfGetDB( DB_MASTER
);
3792 $status = $article->doEdit( $text, $summary, $flags, false, $editor );
3793 } catch ( DBQueryError
$e ) {
3794 $status = Status
::newFatal("DB Error");
3797 if ( $status->isGood() ) {
3798 // Set newtalk with the right user ID
3799 $this->setNewtalk( true );
3800 wfRunHooks( 'AfterUserMessage',
3801 array( $this, $article, $summary, $text, $signature, $summary, $editor ) );
3804 // The article was concurrently created
3805 wfDebug( __METHOD__
. ": Error ".$status->getWikiText() );
3809 return $status->isGood();