3 * Implements the User class for the %MediaWiki software.
8 * Int Number of characters in user_token field.
11 define( 'USER_TOKEN_LENGTH', 32 );
14 * Int Serialized record version.
17 define( 'MW_USER_VERSION', 8 );
20 * String Some punctuation to prevent editing from broken text-mangling proxies.
23 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
26 * Thrown by User::setPassword() on error.
29 class PasswordError
extends MWException
{
34 * The User object encapsulates all of the user-specific settings (user_id,
35 * name, rights, password, email address, options, last login time). Client
36 * classes use the getXXX() functions to access these fields. These functions
37 * do all the work of determining whether the user is logged in,
38 * whether the requested option can be satisfied from cookies or
39 * whether a database query is needed. Most of the settings needed
40 * for rendering normal pages are set in the cookie to minimize use
45 * Global constants made accessible as class constants so that autoloader
48 const USER_TOKEN_LENGTH
= USER_TOKEN_LENGTH
;
49 const MW_USER_VERSION
= MW_USER_VERSION
;
50 const EDIT_TOKEN_SUFFIX
= EDIT_TOKEN_SUFFIX
;
53 * Array of Strings 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 * Array of Strings Core rights.
82 * Each of these should have a corresponding message of the form
86 static $mCoreRights = array(
114 'move-rootuserpages',
118 'override-export-depth',
139 'userrights-interwiki',
143 * String Cached results of getAllRights()
145 static $mAllRights = false;
147 /** @name Cache variables */
149 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
150 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
151 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
155 * Bool Whether the cache variables have been loaded.
157 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
160 * String Initialization data source if mDataLoaded==false. May be one of:
161 * - 'defaults' anonymous user initialised from class defaults
162 * - 'name' initialise from mName
163 * - 'id' initialise from mId
164 * - 'session' log in from cookies or session if possible
166 * Use the User::newFrom*() family of functions to set this.
171 * Lazy-initialized variables, invalidated with clearInstanceCache
173 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
174 $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
175 $mLocked, $mHideName, $mOptions;
177 static $idCacheByName = array();
180 * Lightweight constructor for an anonymous user.
181 * Use the User::newFrom* factory functions for other kinds of users.
185 * @see newFromConfirmationCode()
186 * @see newFromSession()
189 function __construct() {
190 $this->clearInstanceCache( 'defaults' );
194 * Load the user table data for this object from the source given by mFrom.
197 if ( $this->mDataLoaded
) {
200 wfProfileIn( __METHOD__
);
202 # Set it now to avoid infinite recursion in accessors
203 $this->mDataLoaded
= true;
205 switch ( $this->mFrom
) {
207 $this->loadDefaults();
210 $this->mId
= self
::idFromName( $this->mName
);
212 # Nonexistent user placeholder object
213 $this->loadDefaults( $this->mName
);
222 $this->loadFromSession();
223 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
226 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
228 wfProfileOut( __METHOD__
);
232 * Load user table data, given mId has already been set.
233 * @return Bool false if the ID does not exist, true otherwise
236 function loadFromId() {
238 if ( $this->mId
== 0 ) {
239 $this->loadDefaults();
244 $key = wfMemcKey( 'user', 'id', $this->mId
);
245 $data = $wgMemc->get( $key );
246 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
247 # Object is expired, load from DB
252 wfDebug( "User: cache miss for user {$this->mId}\n" );
254 if ( !$this->loadFromDatabase() ) {
255 # Can't load from ID, user is anonymous
258 $this->saveToCache();
260 wfDebug( "User: got user {$this->mId} from cache\n" );
262 foreach ( self
::$mCacheVars as $name ) {
263 $this->$name = $data[$name];
270 * Save user data to the shared cache
272 function saveToCache() {
275 $this->loadOptions();
276 if ( $this->isAnon() ) {
277 // Anonymous users are uncached
281 foreach ( self
::$mCacheVars as $name ) {
282 $data[$name] = $this->$name;
284 $data['mVersion'] = MW_USER_VERSION
;
285 $key = wfMemcKey( 'user', 'id', $this->mId
);
287 $wgMemc->set( $key, $data );
291 /** @name newFrom*() static factory methods */
295 * Static factory method for creation from username.
297 * This is slightly less efficient than newFromId(), so use newFromId() if
298 * you have both an ID and a name handy.
300 * @param $name String Username, validated by Title::newFromText()
301 * @param $validate String|Bool Validate username. Takes the same parameters as
302 * User::getCanonicalName(), except that true is accepted as an alias
303 * for 'valid', for BC.
305 * @return User object, or false if the username is invalid
306 * (e.g. if it contains illegal characters or is an IP address). If the
307 * username is not present in the database, the result will be a user object
308 * with a name, zero user ID and default settings.
310 static function newFromName( $name, $validate = 'valid' ) {
311 if ( $validate === true ) {
314 $name = self
::getCanonicalName( $name, $validate );
315 if ( $name === false ) {
318 # Create unloaded user object
327 * Static factory method for creation from a given user ID.
329 * @param $id Int Valid user ID
330 * @return User The corresponding User object
332 static function newFromId( $id ) {
340 * Factory method to fetch whichever user has a given email confirmation code.
341 * This code is generated when an account is created or its e-mail address
344 * If the code is invalid or has expired, returns NULL.
346 * @param $code String Confirmation code
349 static function newFromConfirmationCode( $code ) {
350 $dbr = wfGetDB( DB_SLAVE
);
351 $id = $dbr->selectField( 'user', 'user_id', array(
352 'user_email_token' => md5( $code ),
353 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
355 if( $id !== false ) {
356 return User
::newFromId( $id );
363 * Create a new user object using data from session or cookies. If the
364 * login credentials are invalid, the result is an anonymous user.
368 static function newFromSession() {
370 $user->mFrom
= 'session';
375 * Create a new user object from a user row.
376 * The row should have all fields from the user table in it.
377 * @param $row Array A row from the user table
380 static function newFromRow( $row ) {
382 $user->loadFromRow( $row );
390 * Get the username corresponding to a given user ID
391 * @param $id Int User ID
392 * @return String The corresponding username
394 static function whoIs( $id ) {
395 $dbr = wfGetDB( DB_SLAVE
);
396 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), __METHOD__
);
400 * Get the real name of a user given their user ID
402 * @param $id Int User ID
403 * @return String The corresponding user's real name
405 static function whoIsReal( $id ) {
406 $dbr = wfGetDB( DB_SLAVE
);
407 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
411 * Get database id given a user name
412 * @param $name String Username
413 * @return Int|Null The corresponding user's ID, or null if user is nonexistent
415 static function idFromName( $name ) {
416 $nt = Title
::makeTitleSafe( NS_USER
, $name );
417 if( is_null( $nt ) ) {
422 if ( isset( self
::$idCacheByName[$name] ) ) {
423 return self
::$idCacheByName[$name];
426 $dbr = wfGetDB( DB_SLAVE
);
427 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
429 if ( $s === false ) {
432 $result = $s->user_id
;
435 self
::$idCacheByName[$name] = $result;
437 if ( count( self
::$idCacheByName ) > 1000 ) {
438 self
::$idCacheByName = array();
445 * Does the string match an anonymous IPv4 address?
447 * This function exists for username validation, in order to reject
448 * usernames which are similar in form to IP addresses. Strings such
449 * as 300.300.300.300 will return true because it looks like an IP
450 * address, despite not being strictly valid.
452 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
453 * address because the usemod software would "cloak" anonymous IP
454 * addresses like this, if we allowed accounts like this to be created
455 * new users could get the old edits of these anonymous users.
457 * @param $name String to match
460 static function isIP( $name ) {
461 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
465 * Is the input a valid username?
467 * Checks if the input is a valid username, we don't want an empty string,
468 * an IP address, anything that containins slashes (would mess up subpages),
469 * is longer than the maximum allowed username size or doesn't begin with
472 * @param $name String to match
475 static function isValidUserName( $name ) {
476 global $wgContLang, $wgMaxNameChars;
479 || User
::isIP( $name )
480 ||
strpos( $name, '/' ) !== false
481 ||
strlen( $name ) > $wgMaxNameChars
482 ||
$name != $wgContLang->ucfirst( $name ) ) {
483 wfDebugLog( 'username', __METHOD__
.
484 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
488 // Ensure that the name can't be misresolved as a different title,
489 // such as with extra namespace keys at the start.
490 $parsed = Title
::newFromText( $name );
491 if( is_null( $parsed )
492 ||
$parsed->getNamespace()
493 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
494 wfDebugLog( 'username', __METHOD__
.
495 ": '$name' invalid due to ambiguous prefixes" );
499 // Check an additional blacklist of troublemaker characters.
500 // Should these be merged into the title char list?
501 $unicodeBlacklist = '/[' .
502 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
503 '\x{00a0}' . # non-breaking space
504 '\x{2000}-\x{200f}' . # various whitespace
505 '\x{2028}-\x{202f}' . # breaks and control chars
506 '\x{3000}' . # ideographic space
507 '\x{e000}-\x{f8ff}' . # private use
509 if( preg_match( $unicodeBlacklist, $name ) ) {
510 wfDebugLog( 'username', __METHOD__
.
511 ": '$name' invalid due to blacklisted characters" );
519 * Usernames which fail to pass this function will be blocked
520 * from user login and new account registrations, but may be used
521 * internally by batch processes.
523 * If an account already exists in this form, login will be blocked
524 * by a failure to pass this function.
526 * @param $name String to match
529 static function isUsableName( $name ) {
530 global $wgReservedUsernames;
531 // Must be a valid username, obviously ;)
532 if ( !self
::isValidUserName( $name ) ) {
536 static $reservedUsernames = false;
537 if ( !$reservedUsernames ) {
538 $reservedUsernames = $wgReservedUsernames;
539 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
542 // Certain names may be reserved for batch processes.
543 foreach ( $reservedUsernames as $reserved ) {
544 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
545 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
547 if ( $reserved == $name ) {
555 * Usernames which fail to pass this function will be blocked
556 * from new account registrations, but may be used internally
557 * either by batch processes or by user accounts which have
558 * already been created.
560 * Additional blacklisting may be added here rather than in
561 * isValidUserName() to avoid disrupting existing accounts.
563 * @param $name String to match
566 static function isCreatableName( $name ) {
567 global $wgInvalidUsernameCharacters;
569 // Ensure that the username isn't longer than 235 bytes, so that
570 // (at least for the builtin skins) user javascript and css files
571 // will work. (bug 23080)
572 if( strlen( $name ) > 235 ) {
573 wfDebugLog( 'username', __METHOD__
.
574 ": '$name' invalid due to length" );
578 if( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
579 wfDebugLog( 'username', __METHOD__
.
580 ": '$name' invalid due to wgInvalidUsernameCharacters" );
584 return self
::isUsableName( $name );
588 * Is the input a valid password for this user?
590 * @param $password String Desired password
593 function isValidPassword( $password ) {
594 //simple boolean wrapper for getPasswordValidity
595 return $this->getPasswordValidity( $password ) === true;
599 * Given unvalidated password input, return error message on failure.
601 * @param $password String Desired password
602 * @return mixed: true on success, string of error message on failure
604 function getPasswordValidity( $password ) {
605 global $wgMinimalPasswordLength, $wgContLang;
607 static $blockedLogins = array(
608 'Useruser' => 'Passpass', 'Useruser1' => 'Passpass1', # r75589
609 'Apitestsysop' => 'testpass', 'Apitestuser' => 'testpass' # r75605
612 $result = false; //init $result to false for the internal checks
614 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
617 if ( $result === false ) {
618 if( strlen( $password ) < $wgMinimalPasswordLength ) {
619 return 'passwordtooshort';
620 } elseif ( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
621 return 'password-name-match';
622 } elseif ( isset( $blockedLogins[ $this->getName() ] ) && $password == $blockedLogins[ $this->getName() ] ) {
623 return 'password-login-forbidden';
625 //it seems weird returning true here, but this is because of the
626 //initialization of $result to false above. If the hook is never run or it
627 //doesn't modify $result, then we will likely get down into this if with
631 } elseif( $result === true ) {
634 return $result; //the isValidPassword hook set a string $result and returned true
639 * Does a string look like an e-mail address?
641 * This validate an email address using an HTML5 specification found at:
642 * http://www.whatwg.org/specs/web-apps/current-work/multipage/states-of-the-type-attribute.html#valid-e-mail-address
643 * Which as of 2011-01-24 says:
644 * A valid e-mail address is a string that matches the ABNF production
645 * 1*( atext / "." ) "@" ldh-str *( "." ldh-str ) where atext is defined
646 * in RFC 5322 section 3.2.3, and ldh-str is defined in RFC 1034 section
648 * This function is an implementation of the specification as requested in
651 * @todo Check for RFC 2822 compilance (bug 959)
653 * @param $addr String E-mail address
656 public static function isValidEmailAddr( $addr ) {
658 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
661 $rfc5322_atext = "a-z0-9!#$%&'*+-\/=?^_`{|}~" ;
662 $rfc1034_ldh_str = "a-z0-9-" ;
664 $HTML5_email_regexp = "/
666 [$rfc5322_atext\\.]+ # user part which is liberal :p
668 [$rfc1034_ldh_str]+ # First domain part
669 (\\.[$rfc1034_ldh_str]+)* # Following part prefixed with a dot
671 /ix" ; // case Insensitive, eXtended
673 return (bool) preg_match( $HTML5_email_regexp, $addr );
677 * Given unvalidated user input, return a canonical username, or false if
678 * the username is invalid.
679 * @param $name String User input
680 * @param $validate String|Bool type of validation to use:
681 * - false No validation
682 * - 'valid' Valid for batch processes
683 * - 'usable' Valid for batch processes and login
684 * - 'creatable' Valid for batch processes, login and account creation
686 static function getCanonicalName( $name, $validate = 'valid' ) {
687 # Force usernames to capital
689 $name = $wgContLang->ucfirst( $name );
691 # Reject names containing '#'; these will be cleaned up
692 # with title normalisation, but then it's too late to
694 if( strpos( $name, '#' ) !== false )
697 # Clean up name according to title rules
698 $t = ( $validate === 'valid' ) ?
699 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
700 # Check for invalid titles
701 if( is_null( $t ) ) {
705 # Reject various classes of invalid names
707 $name = $wgAuth->getCanonicalName( $t->getText() );
709 switch ( $validate ) {
713 if ( !User
::isValidUserName( $name ) ) {
718 if ( !User
::isUsableName( $name ) ) {
723 if ( !User
::isCreatableName( $name ) ) {
728 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
734 * Count the number of edits of a user
735 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
737 * @param $uid Int User ID to check
738 * @return Int the user's edit count
740 static function edits( $uid ) {
741 wfProfileIn( __METHOD__
);
742 $dbr = wfGetDB( DB_SLAVE
);
743 // check if the user_editcount field has been initialized
744 $field = $dbr->selectField(
745 'user', 'user_editcount',
746 array( 'user_id' => $uid ),
750 if( $field === null ) { // it has not been initialized. do so.
751 $dbw = wfGetDB( DB_MASTER
);
752 $count = $dbr->selectField(
753 'revision', 'count(*)',
754 array( 'rev_user' => $uid ),
759 array( 'user_editcount' => $count ),
760 array( 'user_id' => $uid ),
766 wfProfileOut( __METHOD__
);
771 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
772 * @todo hash random numbers to improve security, like generateToken()
774 * @return String new random password
776 static function randomPassword() {
777 global $wgMinimalPasswordLength;
778 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
779 $l = strlen( $pwchars ) - 1;
781 $pwlength = max( 7, $wgMinimalPasswordLength );
782 $digit = mt_rand( 0, $pwlength - 1 );
784 for ( $i = 0; $i < $pwlength; $i++
) {
785 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
791 * Set cached properties to default.
793 * @note This no longer clears uncached lazy-initialised properties;
794 * the constructor does that instead.
797 function loadDefaults( $name = false ) {
798 wfProfileIn( __METHOD__
);
803 $this->mName
= $name;
804 $this->mRealName
= '';
805 $this->mPassword
= $this->mNewpassword
= '';
806 $this->mNewpassTime
= null;
808 $this->mOptionOverrides
= null;
809 $this->mOptionsLoaded
= false;
811 if( $wgRequest->getCookie( 'LoggedOut' ) !== null ) {
812 $this->mTouched
= wfTimestamp( TS_MW
, $wgRequest->getCookie( 'LoggedOut' ) );
814 $this->mTouched
= '0'; # Allow any pages to be cached
817 $this->setToken(); # Random
818 $this->mEmailAuthenticated
= null;
819 $this->mEmailToken
= '';
820 $this->mEmailTokenExpires
= null;
821 $this->mRegistration
= wfTimestamp( TS_MW
);
822 $this->mGroups
= array();
824 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
826 wfProfileOut( __METHOD__
);
830 * Load user data from the session or login cookie. If there are no valid
831 * credentials, initialises the user as an anonymous user.
832 * @return Bool True if the user is logged in, false otherwise.
834 private function loadFromSession() {
835 global $wgRequest, $wgExternalAuthType, $wgAutocreatePolicy;
838 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
839 if ( $result !== null ) {
843 if ( $wgExternalAuthType && $wgAutocreatePolicy == 'view' ) {
844 $extUser = ExternalUser
::newFromCookie();
846 # TODO: Automatically create the user here (or probably a bit
847 # lower down, in fact)
851 if ( $wgRequest->getCookie( 'UserID' ) !== null ) {
852 $sId = intval( $wgRequest->getCookie( 'UserID' ) );
853 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
854 $this->loadDefaults(); // Possible collision!
855 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
856 cookie user ID ($sId) don't match!" );
859 $_SESSION['wsUserID'] = $sId;
860 } else if ( isset( $_SESSION['wsUserID'] ) ) {
861 if ( $_SESSION['wsUserID'] != 0 ) {
862 $sId = $_SESSION['wsUserID'];
864 $this->loadDefaults();
868 $this->loadDefaults();
872 if ( isset( $_SESSION['wsUserName'] ) ) {
873 $sName = $_SESSION['wsUserName'];
874 } else if ( $wgRequest->getCookie('UserName') !== null ) {
875 $sName = $wgRequest->getCookie('UserName');
876 $_SESSION['wsUserName'] = $sName;
878 $this->loadDefaults();
883 if ( !$this->loadFromId() ) {
884 # Not a valid ID, loadFromId has switched the object to anon for us
888 global $wgBlockDisablesLogin;
889 if( $wgBlockDisablesLogin && $this->isBlocked() ) {
890 # User blocked and we've disabled blocked user logins
891 $this->loadDefaults();
895 if ( isset( $_SESSION['wsToken'] ) ) {
896 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
898 } else if ( $wgRequest->getCookie( 'Token' ) !== null ) {
899 $passwordCorrect = $this->mToken
== $wgRequest->getCookie( 'Token' );
902 # No session or persistent login cookie
903 $this->loadDefaults();
907 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
908 $_SESSION['wsToken'] = $this->mToken
;
909 wfDebug( "User: logged in from $from\n" );
912 # Invalid credentials
913 wfDebug( "User: can't log in from $from, invalid credentials\n" );
914 $this->loadDefaults();
920 * Load user and user_group data from the database.
921 * $this::mId must be set, this is how the user is identified.
923 * @return Bool True if the user exists, false if the user is anonymous
926 function loadFromDatabase() {
928 $this->mId
= intval( $this->mId
);
930 /** Anonymous user */
932 $this->loadDefaults();
936 $dbr = wfGetDB( DB_MASTER
);
937 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
939 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
941 if ( $s !== false ) {
942 # Initialise user table data
943 $this->loadFromRow( $s );
944 $this->mGroups
= null; // deferred
945 $this->getEditCount(); // revalidation for nulls
950 $this->loadDefaults();
956 * Initialize this object from a row from the user table.
958 * @param $row Array Row from the user table to load.
960 function loadFromRow( $row ) {
961 $this->mDataLoaded
= true;
963 if ( isset( $row->user_id
) ) {
964 $this->mId
= intval( $row->user_id
);
966 $this->mName
= $row->user_name
;
967 $this->mRealName
= $row->user_real_name
;
968 $this->mPassword
= $row->user_password
;
969 $this->mNewpassword
= $row->user_newpassword
;
970 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
971 $this->mEmail
= $row->user_email
;
972 $this->decodeOptions( $row->user_options
);
973 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
974 $this->mToken
= $row->user_token
;
975 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
976 $this->mEmailToken
= $row->user_email_token
;
977 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
978 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
979 $this->mEditCount
= $row->user_editcount
;
983 * Load the groups from the database if they aren't already loaded.
986 function loadGroups() {
987 if ( is_null( $this->mGroups
) ) {
988 $dbr = wfGetDB( DB_MASTER
);
989 $res = $dbr->select( 'user_groups',
991 array( 'ug_user' => $this->mId
),
993 $this->mGroups
= array();
994 foreach ( $res as $row ) {
995 $this->mGroups
[] = $row->ug_group
;
1001 * Clear various cached data stored in this object.
1002 * @param $reloadFrom String Reload user and user_groups table data from a
1003 * given source. May be "name", "id", "defaults", "session", or false for
1006 function clearInstanceCache( $reloadFrom = false ) {
1007 $this->mNewtalk
= -1;
1008 $this->mDatePreference
= null;
1009 $this->mBlockedby
= -1; # Unset
1010 $this->mHash
= false;
1011 $this->mSkin
= null;
1012 $this->mRights
= null;
1013 $this->mEffectiveGroups
= null;
1014 $this->mOptions
= null;
1016 if ( $reloadFrom ) {
1017 $this->mDataLoaded
= false;
1018 $this->mFrom
= $reloadFrom;
1023 * Combine the language default options with any site-specific options
1024 * and add the default language variants.
1026 * @return Array of String options
1028 static function getDefaultOptions() {
1029 global $wgNamespacesToBeSearchedDefault;
1031 * Site defaults will override the global/language defaults
1033 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1034 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1037 * default language setting
1039 $variant = $wgContLang->getDefaultVariant();
1040 $defOpt['variant'] = $variant;
1041 $defOpt['language'] = $variant;
1042 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1043 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1045 $defOpt['skin'] = $wgDefaultSkin;
1051 * Get a given default option value.
1053 * @param $opt String Name of option to retrieve
1054 * @return String Default option value
1056 public static function getDefaultOption( $opt ) {
1057 $defOpts = self
::getDefaultOptions();
1058 if( isset( $defOpts[$opt] ) ) {
1059 return $defOpts[$opt];
1067 * Get blocking information
1069 * @param $bFromSlave Bool Whether to check the slave database first. To
1070 * improve performance, non-critical checks are done
1071 * against slaves. Check when actually saving should be
1072 * done against master.
1074 function getBlockedStatus( $bFromSlave = true ) {
1075 global $wgProxyWhitelist, $wgUser;
1077 if ( -1 != $this->mBlockedby
) {
1081 wfProfileIn( __METHOD__
);
1082 wfDebug( __METHOD__
.": checking...\n" );
1084 // Initialize data...
1085 // Otherwise something ends up stomping on $this->mBlockedby when
1086 // things get lazy-loaded later, causing false positive block hits
1087 // due to -1 !== 0. Probably session-related... Nothing should be
1088 // overwriting mBlockedby, surely?
1091 $this->mBlockedby
= 0;
1092 $this->mHideName
= 0;
1093 $this->mAllowUsertalk
= 0;
1095 # Check if we are looking at an IP or a logged-in user
1096 if ( $this->isIP( $this->getName() ) ) {
1097 $ip = $this->getName();
1099 # Check if we are looking at the current user
1100 # If we don't, and the user is logged in, we don't know about
1101 # his IP / autoblock status, so ignore autoblock of current user's IP
1102 if ( $this->getID() != $wgUser->getID() ) {
1105 # Get IP of current user
1110 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1111 # Exempt from all types of IP-block
1116 $this->mBlock
= new Block();
1117 $this->mBlock
->fromMaster( !$bFromSlave );
1118 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1119 wfDebug( __METHOD__
. ": Found block.\n" );
1120 $this->mBlockedby
= $this->mBlock
->mBy
;
1121 if( $this->mBlockedby
== 0 )
1122 $this->mBlockedby
= $this->mBlock
->mByName
;
1123 $this->mBlockreason
= $this->mBlock
->mReason
;
1124 $this->mHideName
= $this->mBlock
->mHideName
;
1125 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1126 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1127 $this->spreadBlock();
1130 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1131 // apply to users. Note that the existence of $this->mBlock is not used to
1132 // check for edit blocks, $this->mBlockedby is instead.
1136 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1138 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1139 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1140 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1144 if ( !$this->mBlockedby
&& !$this->getID() ) {
1145 if ( $this->isDnsBlacklisted( $ip ) ) {
1146 $this->mBlockedby
= wfMsg( 'sorbs' );
1147 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1153 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1155 wfProfileOut( __METHOD__
);
1159 * Whether the given IP is in a DNS blacklist.
1161 * @param $ip String IP to check
1162 * @param $checkWhitelist Bool: whether to check the whitelist first
1163 * @return Bool True if blacklisted.
1165 function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1166 global $wgEnableSorbs, $wgEnableDnsBlacklist,
1167 $wgSorbsUrl, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1169 if ( !$wgEnableDnsBlacklist && !$wgEnableSorbs )
1172 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) )
1175 $urls = array_merge( $wgDnsBlacklistUrls, (array)$wgSorbsUrl );
1176 return $this->inDnsBlacklist( $ip, $urls );
1180 * Whether the given IP is in a given DNS blacklist.
1182 * @param $ip String IP to check
1183 * @param $bases String|Array of Strings: URL of the DNS blacklist
1184 * @return Bool True if blacklisted.
1186 function inDnsBlacklist( $ip, $bases ) {
1187 wfProfileIn( __METHOD__
);
1190 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1191 if( IP
::isIPv4( $ip ) ) {
1192 # Reverse IP, bug 21255
1193 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1195 foreach( (array)$bases as $base ) {
1197 $host = "$ipReversed.$base";
1200 $ipList = gethostbynamel( $host );
1203 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1207 wfDebug( "Requested $host, not found in $base.\n" );
1212 wfProfileOut( __METHOD__
);
1217 * Is this user subject to rate limiting?
1219 * @return Bool True if rate limited
1221 public function isPingLimitable() {
1222 global $wgRateLimitsExcludedGroups;
1223 global $wgRateLimitsExcludedIPs;
1224 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1225 // Deprecated, but kept for backwards-compatibility config
1228 if( in_array( wfGetIP(), $wgRateLimitsExcludedIPs ) ) {
1229 // No other good way currently to disable rate limits
1230 // for specific IPs. :P
1231 // But this is a crappy hack and should die.
1234 return !$this->isAllowed('noratelimit');
1238 * Primitive rate limits: enforce maximum actions per time period
1239 * to put a brake on flooding.
1241 * @note When using a shared cache like memcached, IP-address
1242 * last-hit counters will be shared across wikis.
1244 * @param $action String Action to enforce; 'edit' if unspecified
1245 * @return Bool True if a rate limiter was tripped
1247 function pingLimiter( $action = 'edit' ) {
1248 # Call the 'PingLimiter' hook
1250 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1254 global $wgRateLimits;
1255 if( !isset( $wgRateLimits[$action] ) ) {
1259 # Some groups shouldn't trigger the ping limiter, ever
1260 if( !$this->isPingLimitable() )
1263 global $wgMemc, $wgRateLimitLog;
1264 wfProfileIn( __METHOD__
);
1266 $limits = $wgRateLimits[$action];
1268 $id = $this->getId();
1272 if( isset( $limits['anon'] ) && $id == 0 ) {
1273 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1276 if( isset( $limits['user'] ) && $id != 0 ) {
1277 $userLimit = $limits['user'];
1279 if( $this->isNewbie() ) {
1280 if( isset( $limits['newbie'] ) && $id != 0 ) {
1281 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1283 if( isset( $limits['ip'] ) ) {
1284 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1287 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1288 $subnet = $matches[1];
1289 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1292 // Check for group-specific permissions
1293 // If more than one group applies, use the group with the highest limit
1294 foreach ( $this->getGroups() as $group ) {
1295 if ( isset( $limits[$group] ) ) {
1296 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1297 $userLimit = $limits[$group];
1301 // Set the user limit key
1302 if ( $userLimit !== false ) {
1303 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1304 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1308 foreach( $keys as $key => $limit ) {
1309 list( $max, $period ) = $limit;
1310 $summary = "(limit $max in {$period}s)";
1311 $count = $wgMemc->get( $key );
1314 if( $count > $max ) {
1315 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1316 if( $wgRateLimitLog ) {
1317 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1321 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1324 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1325 $wgMemc->add( $key, 0, intval( $period ) ); // first ping
1327 $wgMemc->incr( $key );
1330 wfProfileOut( __METHOD__
);
1335 * Check if user is blocked
1337 * @param $bFromSlave Bool Whether to check the slave database instead of the master
1338 * @return Bool True if blocked, false otherwise
1340 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1341 $this->getBlockedStatus( $bFromSlave );
1342 return $this->mBlockedby
!== 0;
1346 * Check if user is blocked from editing a particular article
1348 * @param $title Title to check
1349 * @param $bFromSlave Bool whether to check the slave database instead of the master
1352 function isBlockedFrom( $title, $bFromSlave = false ) {
1353 global $wgBlockAllowsUTEdit;
1354 wfProfileIn( __METHOD__
);
1356 $blocked = $this->isBlocked( $bFromSlave );
1357 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1358 # If a user's name is suppressed, they cannot make edits anywhere
1359 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1360 $title->getNamespace() == NS_USER_TALK
) {
1362 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1365 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1367 wfProfileOut( __METHOD__
);
1372 * If user is blocked, return the name of the user who placed the block
1373 * @return String name of blocker
1375 function blockedBy() {
1376 $this->getBlockedStatus();
1377 return $this->mBlockedby
;
1381 * If user is blocked, return the specified reason for the block
1382 * @return String Blocking reason
1384 function blockedFor() {
1385 $this->getBlockedStatus();
1386 return $this->mBlockreason
;
1390 * If user is blocked, return the ID for the block
1391 * @return Int Block ID
1393 function getBlockId() {
1394 $this->getBlockedStatus();
1395 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1399 * Check if user is blocked on all wikis.
1400 * Do not use for actual edit permission checks!
1401 * This is intented for quick UI checks.
1403 * @param $ip String IP address, uses current client if none given
1404 * @return Bool True if blocked, false otherwise
1406 function isBlockedGlobally( $ip = '' ) {
1407 if( $this->mBlockedGlobally
!== null ) {
1408 return $this->mBlockedGlobally
;
1410 // User is already an IP?
1411 if( IP
::isIPAddress( $this->getName() ) ) {
1412 $ip = $this->getName();
1417 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1418 $this->mBlockedGlobally
= (bool)$blocked;
1419 return $this->mBlockedGlobally
;
1423 * Check if user account is locked
1425 * @return Bool True if locked, false otherwise
1427 function isLocked() {
1428 if( $this->mLocked
!== null ) {
1429 return $this->mLocked
;
1432 $authUser = $wgAuth->getUserInstance( $this );
1433 $this->mLocked
= (bool)$authUser->isLocked();
1434 return $this->mLocked
;
1438 * Check if user account is hidden
1440 * @return Bool True if hidden, false otherwise
1442 function isHidden() {
1443 if( $this->mHideName
!== null ) {
1444 return $this->mHideName
;
1446 $this->getBlockedStatus();
1447 if( !$this->mHideName
) {
1449 $authUser = $wgAuth->getUserInstance( $this );
1450 $this->mHideName
= (bool)$authUser->isHidden();
1452 return $this->mHideName
;
1456 * Get the user's ID.
1457 * @return Int The user's ID; 0 if the user is anonymous or nonexistent
1460 if( $this->mId
=== null and $this->mName
!== null
1461 and User
::isIP( $this->mName
) ) {
1462 // Special case, we know the user is anonymous
1464 } elseif( $this->mId
=== null ) {
1465 // Don't load if this was initialized from an ID
1472 * Set the user and reload all fields according to a given ID
1473 * @param $v Int User ID to reload
1475 function setId( $v ) {
1477 $this->clearInstanceCache( 'id' );
1481 * Get the user name, or the IP of an anonymous user
1482 * @return String User's name or IP address
1484 function getName() {
1485 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1486 # Special case optimisation
1487 return $this->mName
;
1490 if ( $this->mName
=== false ) {
1492 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1494 return $this->mName
;
1499 * Set the user name.
1501 * This does not reload fields from the database according to the given
1502 * name. Rather, it is used to create a temporary "nonexistent user" for
1503 * later addition to the database. It can also be used to set the IP
1504 * address for an anonymous user to something other than the current
1507 * @note User::newFromName() has rougly the same function, when the named user
1509 * @param $str String New user name to set
1511 function setName( $str ) {
1513 $this->mName
= $str;
1517 * Get the user's name escaped by underscores.
1518 * @return String Username escaped by underscores.
1520 function getTitleKey() {
1521 return str_replace( ' ', '_', $this->getName() );
1525 * Check if the user has new messages.
1526 * @return Bool True if the user has new messages
1528 function getNewtalk() {
1531 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1532 if( $this->mNewtalk
=== -1 ) {
1533 $this->mNewtalk
= false; # reset talk page status
1535 # Check memcached separately for anons, who have no
1536 # entire User object stored in there.
1539 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1540 $newtalk = $wgMemc->get( $key );
1541 if( strval( $newtalk ) !== '' ) {
1542 $this->mNewtalk
= (bool)$newtalk;
1544 // Since we are caching this, make sure it is up to date by getting it
1546 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1547 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1550 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1554 return (bool)$this->mNewtalk
;
1558 * Return the talk page(s) this user has new messages on.
1559 * @return Array of String page URLs
1561 function getNewMessageLinks() {
1563 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1566 if( !$this->getNewtalk() )
1568 $up = $this->getUserPage();
1569 $utp = $up->getTalkPage();
1570 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1574 * Internal uncached check for new messages
1577 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1578 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1579 * @param $fromMaster Bool true to fetch from the master, false for a slave
1580 * @return Bool True if the user has new messages
1583 function checkNewtalk( $field, $id, $fromMaster = false ) {
1584 if ( $fromMaster ) {
1585 $db = wfGetDB( DB_MASTER
);
1587 $db = wfGetDB( DB_SLAVE
);
1589 $ok = $db->selectField( 'user_newtalk', $field,
1590 array( $field => $id ), __METHOD__
);
1591 return $ok !== false;
1595 * Add or update the new messages flag
1596 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1597 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1598 * @return Bool True if successful, false otherwise
1601 function updateNewtalk( $field, $id ) {
1602 $dbw = wfGetDB( DB_MASTER
);
1603 $dbw->insert( 'user_newtalk',
1604 array( $field => $id ),
1607 if ( $dbw->affectedRows() ) {
1608 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1611 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1617 * Clear the new messages flag for the given user
1618 * @param $field String 'user_ip' for anonymous users, 'user_id' otherwise
1619 * @param $id String|Int User's IP address for anonymous users, User ID otherwise
1620 * @return Bool True if successful, false otherwise
1623 function deleteNewtalk( $field, $id ) {
1624 $dbw = wfGetDB( DB_MASTER
);
1625 $dbw->delete( 'user_newtalk',
1626 array( $field => $id ),
1628 if ( $dbw->affectedRows() ) {
1629 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1632 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1638 * Update the 'You have new messages!' status.
1639 * @param $val Bool Whether the user has new messages
1641 function setNewtalk( $val ) {
1642 if( wfReadOnly() ) {
1647 $this->mNewtalk
= $val;
1649 if( $this->isAnon() ) {
1651 $id = $this->getName();
1654 $id = $this->getId();
1659 $changed = $this->updateNewtalk( $field, $id );
1661 $changed = $this->deleteNewtalk( $field, $id );
1664 if( $this->isAnon() ) {
1665 // Anons have a separate memcached space, since
1666 // user records aren't kept for them.
1667 $key = wfMemcKey( 'newtalk', 'ip', $id );
1668 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1671 $this->invalidateCache();
1676 * Generate a current or new-future timestamp to be stored in the
1677 * user_touched field when we update things.
1678 * @return String Timestamp in TS_MW format
1680 private static function newTouchedTimestamp() {
1681 global $wgClockSkewFudge;
1682 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1686 * Clear user data from memcached.
1687 * Use after applying fun updates to the database; caller's
1688 * responsibility to update user_touched if appropriate.
1690 * Called implicitly from invalidateCache() and saveSettings().
1692 private function clearSharedCache() {
1696 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1701 * Immediately touch the user data cache for this account.
1702 * Updates user_touched field, and removes account data from memcached
1703 * for reload on the next hit.
1705 function invalidateCache() {
1706 if( wfReadOnly() ) {
1711 $this->mTouched
= self
::newTouchedTimestamp();
1713 $dbw = wfGetDB( DB_MASTER
);
1714 $dbw->update( 'user',
1715 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1716 array( 'user_id' => $this->mId
),
1719 $this->clearSharedCache();
1724 * Validate the cache for this account.
1725 * @param $timestamp String A timestamp in TS_MW format
1727 function validateCache( $timestamp ) {
1729 return ( $timestamp >= $this->mTouched
);
1733 * Get the user touched timestamp
1734 * @return String timestamp
1736 function getTouched() {
1738 return $this->mTouched
;
1742 * Set the password and reset the random token.
1743 * Calls through to authentication plugin if necessary;
1744 * will have no effect if the auth plugin refuses to
1745 * pass the change through or if the legal password
1748 * As a special case, setting the password to null
1749 * wipes it, so the account cannot be logged in until
1750 * a new password is set, for instance via e-mail.
1752 * @param $str String New password to set
1753 * @throws PasswordError on failure
1755 function setPassword( $str ) {
1758 if( $str !== null ) {
1759 if( !$wgAuth->allowPasswordChange() ) {
1760 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1763 if( !$this->isValidPassword( $str ) ) {
1764 global $wgMinimalPasswordLength;
1765 $valid = $this->getPasswordValidity( $str );
1766 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1767 $wgMinimalPasswordLength ) );
1771 if( !$wgAuth->setPassword( $this, $str ) ) {
1772 throw new PasswordError( wfMsg( 'externaldberror' ) );
1775 $this->setInternalPassword( $str );
1781 * Set the password and reset the random token unconditionally.
1783 * @param $str String New password to set
1785 function setInternalPassword( $str ) {
1789 if( $str === null ) {
1790 // Save an invalid hash...
1791 $this->mPassword
= '';
1793 $this->mPassword
= self
::crypt( $str );
1795 $this->mNewpassword
= '';
1796 $this->mNewpassTime
= null;
1800 * Get the user's current token.
1801 * @return String Token
1803 function getToken() {
1805 return $this->mToken
;
1809 * Set the random token (used for persistent authentication)
1810 * Called from loadDefaults() among other places.
1812 * @param $token String If specified, set the token to this value
1815 function setToken( $token = false ) {
1816 global $wgSecretKey, $wgProxyKey;
1819 if ( $wgSecretKey ) {
1820 $key = $wgSecretKey;
1821 } elseif ( $wgProxyKey ) {
1826 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1828 $this->mToken
= $token;
1833 * Set the cookie password
1835 * @param $str String New cookie password
1838 function setCookiePassword( $str ) {
1840 $this->mCookiePassword
= md5( $str );
1844 * Set the password for a password reminder or new account email
1846 * @param $str String New password to set
1847 * @param $throttle Bool If true, reset the throttle timestamp to the present
1849 function setNewpassword( $str, $throttle = true ) {
1851 $this->mNewpassword
= self
::crypt( $str );
1853 $this->mNewpassTime
= wfTimestampNow();
1858 * Has password reminder email been sent within the last
1859 * $wgPasswordReminderResendTime hours?
1862 function isPasswordReminderThrottled() {
1863 global $wgPasswordReminderResendTime;
1865 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1868 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1869 return time() < $expiry;
1873 * Get the user's e-mail address
1874 * @return String User's email address
1876 function getEmail() {
1878 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1879 return $this->mEmail
;
1883 * Get the timestamp of the user's e-mail authentication
1884 * @return String TS_MW timestamp
1886 function getEmailAuthenticationTimestamp() {
1888 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1889 return $this->mEmailAuthenticated
;
1893 * Set the user's e-mail address
1894 * @param $str String New e-mail address
1896 function setEmail( $str ) {
1898 $this->mEmail
= $str;
1899 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1903 * Get the user's real name
1904 * @return String User's real name
1906 function getRealName() {
1908 return $this->mRealName
;
1912 * Set the user's real name
1913 * @param $str String New real name
1915 function setRealName( $str ) {
1917 $this->mRealName
= $str;
1921 * Get the user's current setting for a given option.
1923 * @param $oname String The option to check
1924 * @param $defaultOverride String A default value returned if the option does not exist
1925 * @return String User's current value for the option
1926 * @see getBoolOption()
1927 * @see getIntOption()
1929 function getOption( $oname, $defaultOverride = null ) {
1930 $this->loadOptions();
1932 if ( is_null( $this->mOptions
) ) {
1933 if($defaultOverride != '') {
1934 return $defaultOverride;
1936 $this->mOptions
= User
::getDefaultOptions();
1939 if ( array_key_exists( $oname, $this->mOptions
) ) {
1940 return $this->mOptions
[$oname];
1942 return $defaultOverride;
1947 * Get all user's options
1951 public function getOptions() {
1952 $this->loadOptions();
1953 return $this->mOptions
;
1957 * Get the user's current setting for a given option, as a boolean value.
1959 * @param $oname String The option to check
1960 * @return Bool User's current value for the option
1963 function getBoolOption( $oname ) {
1964 return (bool)$this->getOption( $oname );
1969 * Get the user's current setting for a given option, as a boolean value.
1971 * @param $oname String The option to check
1972 * @param $defaultOverride Int A default value returned if the option does not exist
1973 * @return Int User's current value for the option
1976 function getIntOption( $oname, $defaultOverride=0 ) {
1977 $val = $this->getOption( $oname );
1979 $val = $defaultOverride;
1981 return intval( $val );
1985 * Set the given option for a user.
1987 * @param $oname String The option to set
1988 * @param $val mixed New value to set
1990 function setOption( $oname, $val ) {
1992 $this->loadOptions();
1994 if ( $oname == 'skin' ) {
1995 # Clear cached skin, so the new one displays immediately in Special:Preferences
1996 $this->mSkin
= null;
1999 // Explicitly NULL values should refer to defaults
2000 global $wgDefaultUserOptions;
2001 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
2002 $val = $wgDefaultUserOptions[$oname];
2005 $this->mOptions
[$oname] = $val;
2009 * Reset all options to the site defaults
2011 function resetOptions() {
2012 $this->mOptions
= User
::getDefaultOptions();
2016 * Get the user's preferred date format.
2017 * @return String User's preferred date format
2019 function getDatePreference() {
2020 // Important migration for old data rows
2021 if ( is_null( $this->mDatePreference
) ) {
2023 $value = $this->getOption( 'date' );
2024 $map = $wgLang->getDatePreferenceMigrationMap();
2025 if ( isset( $map[$value] ) ) {
2026 $value = $map[$value];
2028 $this->mDatePreference
= $value;
2030 return $this->mDatePreference
;
2034 * Get the user preferred stub threshold
2036 function getStubThreshold() {
2037 global $wgMaxArticleSize; # Maximum article size, in Kb
2038 $threshold = intval( $this->getOption( 'stubthreshold' ) );
2039 if ( $threshold > $wgMaxArticleSize * 1024 ) {
2040 # If they have set an impossible value, disable the preference
2041 # so we can use the parser cache again.
2048 * Get the permissions this user has.
2049 * @return Array of String permission names
2051 function getRights() {
2052 if ( is_null( $this->mRights
) ) {
2053 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2054 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2055 // Force reindexation of rights when a hook has unset one of them
2056 $this->mRights
= array_values( $this->mRights
);
2058 return $this->mRights
;
2062 * Get the list of explicit group memberships this user has.
2063 * The implicit * and user groups are not included.
2064 * @return Array of String internal group names
2066 function getGroups() {
2068 return $this->mGroups
;
2072 * Get the list of implicit group memberships this user has.
2073 * This includes all explicit groups, plus 'user' if logged in,
2074 * '*' for all accounts, and autopromoted groups
2075 * @param $recache Bool Whether to avoid the cache
2076 * @return Array of String internal group names
2078 function getEffectiveGroups( $recache = false ) {
2079 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2080 wfProfileIn( __METHOD__
);
2081 $this->mEffectiveGroups
= $this->getGroups();
2082 $this->mEffectiveGroups
[] = '*';
2083 if( $this->getId() ) {
2084 $this->mEffectiveGroups
[] = 'user';
2086 $this->mEffectiveGroups
= array_unique( array_merge(
2087 $this->mEffectiveGroups
,
2088 Autopromote
::getAutopromoteGroups( $this )
2091 # Hook for additional groups
2092 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2094 wfProfileOut( __METHOD__
);
2096 return $this->mEffectiveGroups
;
2100 * Get the user's edit count.
2103 function getEditCount() {
2104 if( $this->getId() ) {
2105 if ( !isset( $this->mEditCount
) ) {
2106 /* Populate the count, if it has not been populated yet */
2107 $this->mEditCount
= User
::edits( $this->mId
);
2109 return $this->mEditCount
;
2117 * Add the user to the given group.
2118 * This takes immediate effect.
2119 * @param $group String Name of the group to add
2121 function addGroup( $group ) {
2122 $dbw = wfGetDB( DB_MASTER
);
2123 if( $this->getId() ) {
2124 $dbw->insert( 'user_groups',
2126 'ug_user' => $this->getID(),
2127 'ug_group' => $group,
2130 array( 'IGNORE' ) );
2133 $this->loadGroups();
2134 $this->mGroups
[] = $group;
2135 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2137 $this->invalidateCache();
2141 * Remove the user from the given group.
2142 * This takes immediate effect.
2143 * @param $group String Name of the group to remove
2145 function removeGroup( $group ) {
2147 $dbw = wfGetDB( DB_MASTER
);
2148 $dbw->delete( 'user_groups',
2150 'ug_user' => $this->getID(),
2151 'ug_group' => $group,
2154 $this->loadGroups();
2155 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2156 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2158 $this->invalidateCache();
2162 * Get whether the user is logged in
2165 function isLoggedIn() {
2166 return $this->getID() != 0;
2170 * Get whether the user is anonymous
2174 return !$this->isLoggedIn();
2178 * Check if user is allowed to access a feature / make an action
2179 * @param $action String action to be checked
2180 * @return Boolean: True if action is allowed, else false
2182 function isAllowed( $action = '' ) {
2183 if ( $action === '' ) {
2184 return true; // In the spirit of DWIM
2186 # Patrolling may not be enabled
2187 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2188 global $wgUseRCPatrol, $wgUseNPPatrol;
2189 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2192 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2193 # by misconfiguration: 0 == 'foo'
2194 return in_array( $action, $this->getRights(), true );
2198 * Check whether to enable recent changes patrol features for this user
2199 * @return Boolean: True or false
2201 public function useRCPatrol() {
2202 global $wgUseRCPatrol;
2203 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2207 * Check whether to enable new pages patrol features for this user
2208 * @return Bool True or false
2210 public function useNPPatrol() {
2211 global $wgUseRCPatrol, $wgUseNPPatrol;
2212 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2216 * Get the current skin, loading it if required, and setting a title
2217 * @param $t Title: the title to use in the skin
2218 * @return Skin The current skin
2219 * @todo: FIXME : need to check the old failback system [AV]
2221 function getSkin( $t = null ) {
2223 $skin = $this->createSkinObject();
2224 $skin->setTitle( $t );
2227 if ( !$this->mSkin
) {
2228 $this->mSkin
= $this->createSkinObject();
2231 if ( !$this->mSkin
->getTitle() ) {
2233 $t = $wgOut->getTitle();
2234 $this->mSkin
->setTitle($t);
2237 return $this->mSkin
;
2241 // Creates a Skin object, for getSkin()
2242 private function createSkinObject() {
2243 wfProfileIn( __METHOD__
);
2245 global $wgHiddenPrefs;
2246 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2249 $userSkin = $this->getOption( 'skin' );
2250 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2252 # if we're not allowing users to override, then use the default
2253 global $wgDefaultSkin;
2254 $userSkin = $wgDefaultSkin;
2257 $skin = Skin
::newFromKey( $userSkin );
2258 wfProfileOut( __METHOD__
);
2264 * Check the watched status of an article.
2265 * @param $title Title of the article to look at
2268 function isWatched( $title ) {
2269 $wl = WatchedItem
::fromUserTitle( $this, $title );
2270 return $wl->isWatched();
2275 * @param $title Title of the article to look at
2277 function addWatch( $title ) {
2278 $wl = WatchedItem
::fromUserTitle( $this, $title );
2280 $this->invalidateCache();
2284 * Stop watching an article.
2285 * @param $title Title of the article to look at
2287 function removeWatch( $title ) {
2288 $wl = WatchedItem
::fromUserTitle( $this, $title );
2290 $this->invalidateCache();
2294 * Clear the user's notification timestamp for the given title.
2295 * If e-notif e-mails are on, they will receive notification mails on
2296 * the next change of the page if it's watched etc.
2297 * @param $title Title of the article to look at
2299 function clearNotification( &$title ) {
2300 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2302 # Do nothing if the database is locked to writes
2303 if( wfReadOnly() ) {
2307 if( $title->getNamespace() == NS_USER_TALK
&&
2308 $title->getText() == $this->getName() ) {
2309 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2311 $this->setNewtalk( false );
2314 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2318 if( $this->isAnon() ) {
2319 // Nothing else to do...
2323 // Only update the timestamp if the page is being watched.
2324 // The query to find out if it is watched is cached both in memcached and per-invocation,
2325 // and when it does have to be executed, it can be on a slave
2326 // If this is the user's newtalk page, we always update the timestamp
2327 if( $title->getNamespace() == NS_USER_TALK
&&
2328 $title->getText() == $wgUser->getName() )
2331 } elseif ( $this->getId() == $wgUser->getId() ) {
2332 $watched = $title->userIsWatching();
2337 // If the page is watched by the user (or may be watched), update the timestamp on any
2338 // any matching rows
2340 $dbw = wfGetDB( DB_MASTER
);
2341 $dbw->update( 'watchlist',
2343 'wl_notificationtimestamp' => null
2344 ), array( /* WHERE */
2345 'wl_title' => $title->getDBkey(),
2346 'wl_namespace' => $title->getNamespace(),
2347 'wl_user' => $this->getID()
2354 * Resets all of the given user's page-change notification timestamps.
2355 * If e-notif e-mails are on, they will receive notification mails on
2356 * the next change of any watched page.
2358 * @param $currentUser Int User ID
2360 function clearAllNotifications( $currentUser ) {
2361 global $wgUseEnotif, $wgShowUpdatedMarker;
2362 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2363 $this->setNewtalk( false );
2366 if( $currentUser != 0 ) {
2367 $dbw = wfGetDB( DB_MASTER
);
2368 $dbw->update( 'watchlist',
2370 'wl_notificationtimestamp' => null
2371 ), array( /* WHERE */
2372 'wl_user' => $currentUser
2375 # We also need to clear here the "you have new message" notification for the own user_talk page
2376 # This is cleared one page view later in Article::viewUpdates();
2381 * Set this user's options from an encoded string
2382 * @param $str String Encoded options to import
2385 function decodeOptions( $str ) {
2389 $this->mOptionsLoaded
= true;
2390 $this->mOptionOverrides
= array();
2392 // If an option is not set in $str, use the default value
2393 $this->mOptions
= self
::getDefaultOptions();
2395 $a = explode( "\n", $str );
2396 foreach ( $a as $s ) {
2398 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2399 $this->mOptions
[$m[1]] = $m[2];
2400 $this->mOptionOverrides
[$m[1]] = $m[2];
2406 * Set a cookie on the user's client. Wrapper for
2407 * WebResponse::setCookie
2408 * @param $name String Name of the cookie to set
2409 * @param $value String Value to set
2410 * @param $exp Int Expiration time, as a UNIX time value;
2411 * if 0 or not specified, use the default $wgCookieExpiration
2413 protected function setCookie( $name, $value, $exp = 0 ) {
2415 $wgRequest->response()->setcookie( $name, $value, $exp );
2419 * Clear a cookie on the user's client
2420 * @param $name String Name of the cookie to clear
2422 protected function clearCookie( $name ) {
2423 $this->setCookie( $name, '', time() - 86400 );
2427 * Set the default cookies for this session on the user's client.
2429 function setCookies() {
2431 if ( 0 == $this->mId
) return;
2433 'wsUserID' => $this->mId
,
2434 'wsToken' => $this->mToken
,
2435 'wsUserName' => $this->getName()
2438 'UserID' => $this->mId
,
2439 'UserName' => $this->getName(),
2441 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2442 $cookies['Token'] = $this->mToken
;
2444 $cookies['Token'] = false;
2447 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2448 #check for null, since the hook could cause a null value
2449 if ( !is_null( $session ) && isset( $_SESSION ) ){
2450 $_SESSION = $session +
$_SESSION;
2452 foreach ( $cookies as $name => $value ) {
2453 if ( $value === false ) {
2454 $this->clearCookie( $name );
2456 $this->setCookie( $name, $value );
2462 * Log this user out.
2465 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2471 * Clear the user's cookies and session, and reset the instance cache.
2475 function doLogout() {
2476 $this->clearInstanceCache( 'defaults' );
2478 $_SESSION['wsUserID'] = 0;
2480 $this->clearCookie( 'UserID' );
2481 $this->clearCookie( 'Token' );
2483 # Remember when user logged out, to prevent seeing cached pages
2484 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2488 * Save this user's settings into the database.
2489 * @todo Only rarely do all these fields need to be set!
2491 function saveSettings() {
2493 if ( wfReadOnly() ) { return; }
2494 if ( 0 == $this->mId
) { return; }
2496 $this->mTouched
= self
::newTouchedTimestamp();
2498 $dbw = wfGetDB( DB_MASTER
);
2499 $dbw->update( 'user',
2501 'user_name' => $this->mName
,
2502 'user_password' => $this->mPassword
,
2503 'user_newpassword' => $this->mNewpassword
,
2504 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2505 'user_real_name' => $this->mRealName
,
2506 'user_email' => $this->mEmail
,
2507 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2508 'user_options' => '',
2509 'user_touched' => $dbw->timestamp( $this->mTouched
),
2510 'user_token' => $this->mToken
,
2511 'user_email_token' => $this->mEmailToken
,
2512 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2513 ), array( /* WHERE */
2514 'user_id' => $this->mId
2518 $this->saveOptions();
2520 wfRunHooks( 'UserSaveSettings', array( $this ) );
2521 $this->clearSharedCache();
2522 $this->getUserPage()->invalidateCache();
2526 * If only this user's username is known, and it exists, return the user ID.
2529 function idForName() {
2530 $s = trim( $this->getName() );
2531 if ( $s === '' ) return 0;
2533 $dbr = wfGetDB( DB_SLAVE
);
2534 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2535 if ( $id === false ) {
2542 * Add a user to the database, return the user object
2544 * @param $name String Username to add
2545 * @param $params Array of Strings Non-default parameters to save to the database:
2546 * - password The user's password. Password logins will be disabled if this is omitted.
2547 * - newpassword A temporary password mailed to the user
2548 * - email The user's email address
2549 * - email_authenticated The email authentication timestamp
2550 * - real_name The user's real name
2551 * - options An associative array of non-default options
2552 * - token Random authentication token. Do not set.
2553 * - registration Registration timestamp. Do not set.
2555 * @return User object, or null if the username already exists
2557 static function createNew( $name, $params = array() ) {
2560 if ( isset( $params['options'] ) ) {
2561 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2562 unset( $params['options'] );
2564 $dbw = wfGetDB( DB_MASTER
);
2565 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2568 'user_id' => $seqVal,
2569 'user_name' => $name,
2570 'user_password' => $user->mPassword
,
2571 'user_newpassword' => $user->mNewpassword
,
2572 'user_newpass_time' => $dbw->timestampOrNull( $user->mNewpassTime
),
2573 'user_email' => $user->mEmail
,
2574 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2575 'user_real_name' => $user->mRealName
,
2576 'user_options' => '',
2577 'user_token' => $user->mToken
,
2578 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2579 'user_editcount' => 0,
2581 foreach ( $params as $name => $value ) {
2582 $fields["user_$name"] = $value;
2584 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2585 if ( $dbw->affectedRows() ) {
2586 $newUser = User
::newFromId( $dbw->insertId() );
2594 * Add this existing user object to the database
2596 function addToDatabase() {
2598 $dbw = wfGetDB( DB_MASTER
);
2599 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2600 $dbw->insert( 'user',
2602 'user_id' => $seqVal,
2603 'user_name' => $this->mName
,
2604 'user_password' => $this->mPassword
,
2605 'user_newpassword' => $this->mNewpassword
,
2606 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2607 'user_email' => $this->mEmail
,
2608 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2609 'user_real_name' => $this->mRealName
,
2610 'user_options' => '',
2611 'user_token' => $this->mToken
,
2612 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2613 'user_editcount' => 0,
2616 $this->mId
= $dbw->insertId();
2618 // Clear instance cache other than user table data, which is already accurate
2619 $this->clearInstanceCache();
2621 $this->saveOptions();
2625 * If this (non-anonymous) user is blocked, block any IP address
2626 * they've successfully logged in from.
2628 function spreadBlock() {
2629 wfDebug( __METHOD__
. "()\n" );
2631 if ( $this->mId
== 0 ) {
2635 $userblock = Block
::newFromDB( '', $this->mId
);
2636 if ( !$userblock ) {
2640 $userblock->doAutoblock( wfGetIP() );
2644 * Generate a string which will be different for any combination of
2645 * user options which would produce different parser output.
2646 * This will be used as part of the hash key for the parser cache,
2647 * so users with the same options can share the same cached data
2650 * Extensions which require it should install 'PageRenderingHash' hook,
2651 * which will give them a chance to modify this key based on their own
2654 * @deprecated @since 1.17 use the ParserOptions object to get the relevant options
2655 * @return String Page rendering hash
2657 function getPageRenderingHash() {
2658 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2660 return $this->mHash
;
2662 wfDeprecated( __METHOD__
);
2664 // stubthreshold is only included below for completeness,
2665 // since it disables the parser cache, its value will always
2666 // be 0 when this function is called by parsercache.
2668 $confstr = $this->getOption( 'math' );
2669 $confstr .= '!' . $this->getStubThreshold();
2670 if ( $wgUseDynamicDates ) { # This is wrong (bug 24714)
2671 $confstr .= '!' . $this->getDatePreference();
2673 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2674 $confstr .= '!' . $wgLang->getCode();
2675 $confstr .= '!' . $this->getOption( 'thumbsize' );
2676 // add in language specific options, if any
2677 $extra = $wgContLang->getExtraHashOptions();
2680 // Since the skin could be overloading link(), it should be
2681 // included here but in practice, none of our skins do that.
2683 $confstr .= $wgRenderHashAppend;
2685 // Give a chance for extensions to modify the hash, if they have
2686 // extra options or other effects on the parser cache.
2687 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2689 // Make it a valid memcached key fragment
2690 $confstr = str_replace( ' ', '_', $confstr );
2691 $this->mHash
= $confstr;
2696 * Get whether the user is explicitly blocked from account creation.
2699 function isBlockedFromCreateAccount() {
2700 $this->getBlockedStatus();
2701 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2705 * Get whether the user is blocked from using Special:Emailuser.
2708 function isBlockedFromEmailuser() {
2709 $this->getBlockedStatus();
2710 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2714 * Get whether the user is allowed to create an account.
2717 function isAllowedToCreateAccount() {
2718 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2722 * Get this user's personal page title.
2724 * @return Title: User's personal page title
2726 function getUserPage() {
2727 return Title
::makeTitle( NS_USER
, $this->getName() );
2731 * Get this user's talk page title.
2733 * @return Title: User's talk page title
2735 function getTalkPage() {
2736 $title = $this->getUserPage();
2737 return $title->getTalkPage();
2741 * Get the maximum valid user ID.
2742 * @return Integer: User ID
2745 function getMaxID() {
2746 static $res; // cache
2748 if ( isset( $res ) ) {
2751 $dbr = wfGetDB( DB_SLAVE
);
2752 return $res = $dbr->selectField( 'user', 'max(user_id)', false, __METHOD__
);
2757 * Determine whether the user is a newbie. Newbies are either
2758 * anonymous IPs, or the most recently created accounts.
2761 function isNewbie() {
2762 return !$this->isAllowed( 'autoconfirmed' );
2766 * Check to see if the given clear-text password is one of the accepted passwords
2767 * @param $password String: user password.
2768 * @return Boolean: True if the given password is correct, otherwise False.
2770 function checkPassword( $password ) {
2774 // Even though we stop people from creating passwords that
2775 // are shorter than this, doesn't mean people wont be able
2776 // to. Certain authentication plugins do NOT want to save
2777 // domain passwords in a mysql database, so we should
2778 // check this (in case $wgAuth->strict() is false).
2779 if( !$this->isValidPassword( $password ) ) {
2783 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2785 } elseif( $wgAuth->strict() ) {
2786 /* Auth plugin doesn't allow local authentication */
2788 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2789 /* Auth plugin doesn't allow local authentication for this user name */
2792 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2794 } elseif ( function_exists( 'iconv' ) ) {
2795 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2796 # Check for this with iconv
2797 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2798 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2806 * Check if the given clear-text password matches the temporary password
2807 * sent by e-mail for password reset operations.
2808 * @return Boolean: True if matches, false otherwise
2810 function checkTemporaryPassword( $plaintext ) {
2811 global $wgNewPasswordExpiry;
2812 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2813 if ( is_null( $this->mNewpassTime
) ) {
2816 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2817 return ( time() < $expiry );
2824 * Initialize (if necessary) and return a session token value
2825 * which can be used in edit forms to show that the user's
2826 * login credentials aren't being hijacked with a foreign form
2829 * @param $salt String|Array of Strings Optional function-specific data for hashing
2830 * @return String The new edit token
2832 function editToken( $salt = '' ) {
2833 if ( $this->isAnon() ) {
2834 return EDIT_TOKEN_SUFFIX
;
2836 if( !isset( $_SESSION['wsEditToken'] ) ) {
2837 $token = self
::generateToken();
2838 $_SESSION['wsEditToken'] = $token;
2840 $token = $_SESSION['wsEditToken'];
2842 if( is_array( $salt ) ) {
2843 $salt = implode( '|', $salt );
2845 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2850 * Generate a looking random token for various uses.
2852 * @param $salt String Optional salt value
2853 * @return String The new random token
2855 public static function generateToken( $salt = '' ) {
2856 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2857 return md5( $token . $salt );
2861 * Check given value against the token value stored in the session.
2862 * A match should confirm that the form was submitted from the
2863 * user's own login session, not a form submission from a third-party
2866 * @param $val String Input value to compare
2867 * @param $salt String Optional function-specific data for hashing
2868 * @return Boolean: Whether the token matches
2870 function matchEditToken( $val, $salt = '' ) {
2871 $sessionToken = $this->editToken( $salt );
2872 if ( $val != $sessionToken ) {
2873 wfDebug( "User::matchEditToken: broken session data\n" );
2875 return $val == $sessionToken;
2879 * Check given value against the token value stored in the session,
2880 * ignoring the suffix.
2882 * @param $val String Input value to compare
2883 * @param $salt String Optional function-specific data for hashing
2884 * @return Boolean: Whether the token matches
2886 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2887 $sessionToken = $this->editToken( $salt );
2888 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2892 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2893 * mail to the user's given address.
2895 * @param $changed Boolean: whether the adress changed
2896 * @return Status object
2898 function sendConfirmationMail( $changed = false ) {
2900 $expiration = null; // gets passed-by-ref and defined in next line.
2901 $token = $this->confirmationToken( $expiration );
2902 $url = $this->confirmationTokenUrl( $token );
2903 $invalidateURL = $this->invalidationTokenUrl( $token );
2904 $this->saveSettings();
2906 $message = $changed ?
'confirmemail_body_changed' : 'confirmemail_body';
2907 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2912 $wgLang->timeanddate( $expiration, false ),
2914 $wgLang->date( $expiration, false ),
2915 $wgLang->time( $expiration, false ) ) );
2919 * Send an e-mail to this user's account. Does not check for
2920 * confirmed status or validity.
2922 * @param $subject String Message subject
2923 * @param $body String Message body
2924 * @param $from String Optional From address; if unspecified, default $wgPasswordSender will be used
2925 * @param $replyto String Reply-To address
2928 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2929 if( is_null( $from ) ) {
2930 global $wgPasswordSender, $wgPasswordSenderName;
2931 $sender = new MailAddress( $wgPasswordSender, $wgPasswordSenderName );
2933 $sender = new MailAddress( $from );
2936 $to = new MailAddress( $this );
2937 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2941 * Generate, store, and return a new e-mail confirmation code.
2942 * A hash (unsalted, since it's used as a key) is stored.
2944 * @note Call saveSettings() after calling this function to commit
2945 * this change to the database.
2947 * @param[out] &$expiration \mixed Accepts the expiration time
2948 * @return String New token
2951 function confirmationToken( &$expiration ) {
2953 $expires = $now +
7 * 24 * 60 * 60;
2954 $expiration = wfTimestamp( TS_MW
, $expires );
2955 $token = self
::generateToken( $this->mId
. $this->mEmail
. $expires );
2956 $hash = md5( $token );
2958 $this->mEmailToken
= $hash;
2959 $this->mEmailTokenExpires
= $expiration;
2964 * Return a URL the user can use to confirm their email address.
2965 * @param $token String Accepts the email confirmation token
2966 * @return String New token URL
2969 function confirmationTokenUrl( $token ) {
2970 return $this->getTokenUrl( 'ConfirmEmail', $token );
2974 * Return a URL the user can use to invalidate their email address.
2975 * @param $token String Accepts the email confirmation token
2976 * @return String New token URL
2979 function invalidationTokenUrl( $token ) {
2980 return $this->getTokenUrl( 'Invalidateemail', $token );
2984 * Internal function to format the e-mail validation/invalidation URLs.
2985 * This uses $wgArticlePath directly as a quickie hack to use the
2986 * hardcoded English names of the Special: pages, for ASCII safety.
2988 * @note Since these URLs get dropped directly into emails, using the
2989 * short English names avoids insanely long URL-encoded links, which
2990 * also sometimes can get corrupted in some browsers/mailers
2991 * (bug 6957 with Gmail and Internet Explorer).
2993 * @param $page String Special page
2994 * @param $token String Token
2995 * @return String Formatted URL
2997 protected function getTokenUrl( $page, $token ) {
2998 global $wgArticlePath;
3002 "Special:$page/$token",
3007 * Mark the e-mail address confirmed.
3009 * @note Call saveSettings() after calling this function to commit the change.
3011 function confirmEmail() {
3012 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
3013 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
3018 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
3019 * address if it was already confirmed.
3021 * @note Call saveSettings() after calling this function to commit the change.
3023 function invalidateEmail() {
3025 $this->mEmailToken
= null;
3026 $this->mEmailTokenExpires
= null;
3027 $this->setEmailAuthenticationTimestamp( null );
3028 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
3033 * Set the e-mail authentication timestamp.
3034 * @param $timestamp String TS_MW timestamp
3036 function setEmailAuthenticationTimestamp( $timestamp ) {
3038 $this->mEmailAuthenticated
= $timestamp;
3039 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
3043 * Is this user allowed to send e-mails within limits of current
3044 * site configuration?
3047 function canSendEmail() {
3048 global $wgEnableEmail, $wgEnableUserEmail;
3049 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$this->isAllowed( 'sendemail' ) ) {
3052 $canSend = $this->isEmailConfirmed();
3053 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
3058 * Is this user allowed to receive e-mails within limits of current
3059 * site configuration?
3062 function canReceiveEmail() {
3063 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3067 * Is this user's e-mail address valid-looking and confirmed within
3068 * limits of the current site configuration?
3070 * @note If $wgEmailAuthentication is on, this may require the user to have
3071 * confirmed their address by returning a code or using a password
3072 * sent to the address from the wiki.
3076 function isEmailConfirmed() {
3077 global $wgEmailAuthentication;
3080 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3081 if( $this->isAnon() )
3083 if( !self
::isValidEmailAddr( $this->mEmail
) )
3085 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3094 * Check whether there is an outstanding request for e-mail confirmation.
3097 function isEmailConfirmationPending() {
3098 global $wgEmailAuthentication;
3099 return $wgEmailAuthentication &&
3100 !$this->isEmailConfirmed() &&
3101 $this->mEmailToken
&&
3102 $this->mEmailTokenExpires
> wfTimestamp();
3106 * Get the timestamp of account creation.
3108 * @return String|Bool Timestamp of account creation, or false for
3109 * non-existent/anonymous user accounts.
3111 public function getRegistration() {
3112 return $this->getId() > 0
3113 ?
$this->mRegistration
3118 * Get the timestamp of the first edit
3120 * @return String|Bool Timestamp of first edit, or false for
3121 * non-existent/anonymous user accounts.
3123 public function getFirstEditTimestamp() {
3124 if( $this->getId() == 0 ) {
3125 return false; // anons
3127 $dbr = wfGetDB( DB_SLAVE
);
3128 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3129 array( 'rev_user' => $this->getId() ),
3131 array( 'ORDER BY' => 'rev_timestamp ASC' )
3134 return false; // no edits
3136 return wfTimestamp( TS_MW
, $time );
3140 * Get the permissions associated with a given list of groups
3142 * @param $groups Array of Strings List of internal group names
3143 * @return Array of Strings List of permission key names for given groups combined
3145 static function getGroupPermissions( $groups ) {
3146 global $wgGroupPermissions, $wgRevokePermissions;
3148 // grant every granted permission first
3149 foreach( $groups as $group ) {
3150 if( isset( $wgGroupPermissions[$group] ) ) {
3151 $rights = array_merge( $rights,
3152 // array_filter removes empty items
3153 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3156 // now revoke the revoked permissions
3157 foreach( $groups as $group ) {
3158 if( isset( $wgRevokePermissions[$group] ) ) {
3159 $rights = array_diff( $rights,
3160 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3163 return array_unique( $rights );
3167 * Get all the groups who have a given permission
3169 * @param $role String Role to check
3170 * @return Array of Strings List of internal group names with the given permission
3172 static function getGroupsWithPermission( $role ) {
3173 global $wgGroupPermissions;
3174 $allowedGroups = array();
3175 foreach ( $wgGroupPermissions as $group => $rights ) {
3176 if ( isset( $rights[$role] ) && $rights[$role] ) {
3177 $allowedGroups[] = $group;
3180 return $allowedGroups;
3184 * Get the localized descriptive name for a group, if it exists
3186 * @param $group String Internal group name
3187 * @return String Localized descriptive group name
3189 static function getGroupName( $group ) {
3190 $msg = wfMessage( "group-$group" );
3191 return $msg->isBlank() ?
$group : $msg->text();
3195 * Get the localized descriptive name for a member of a group, if it exists
3197 * @param $group String Internal group name
3198 * @return String Localized name for group member
3200 static function getGroupMember( $group ) {
3201 $msg = wfMessage( "group-$group-member" );
3202 return $msg->isBlank() ?
$group : $msg->text();
3206 * Return the set of defined explicit groups.
3207 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3208 * are not included, as they are defined automatically, not in the database.
3209 * @return Array of internal group names
3211 static function getAllGroups() {
3212 global $wgGroupPermissions, $wgRevokePermissions;
3214 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3215 self
::getImplicitGroups()
3220 * Get a list of all available permissions.
3221 * @return Array of permission names
3223 static function getAllRights() {
3224 if ( self
::$mAllRights === false ) {
3225 global $wgAvailableRights;
3226 if ( count( $wgAvailableRights ) ) {
3227 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3229 self
::$mAllRights = self
::$mCoreRights;
3231 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3233 return self
::$mAllRights;
3237 * Get a list of implicit groups
3238 * @return Array of Strings Array of internal group names
3240 public static function getImplicitGroups() {
3241 global $wgImplicitGroups;
3242 $groups = $wgImplicitGroups;
3243 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3248 * Get the title of a page describing a particular group
3250 * @param $group String Internal group name
3251 * @return Title|Bool Title of the page if it exists, false otherwise
3253 static function getGroupPage( $group ) {
3254 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
3255 if( $msg->exists() ) {
3256 $title = Title
::newFromText( $msg->text() );
3257 if( is_object( $title ) )
3264 * Create a link to the group in HTML, if available;
3265 * else return the group name.
3267 * @param $group String Internal name of the group
3268 * @param $text String The text of the link
3269 * @return String HTML link to the group
3271 static function makeGroupLinkHTML( $group, $text = '' ) {
3273 $text = self
::getGroupName( $group );
3275 $title = self
::getGroupPage( $group );
3278 $sk = $wgUser->getSkin();
3279 return $sk->link( $title, htmlspecialchars( $text ) );
3286 * Create a link to the group in Wikitext, if available;
3287 * else return the group name.
3289 * @param $group String Internal name of the group
3290 * @param $text String The text of the link
3291 * @return String Wikilink to the group
3293 static function makeGroupLinkWiki( $group, $text = '' ) {
3295 $text = self
::getGroupName( $group );
3297 $title = self
::getGroupPage( $group );
3299 $page = $title->getPrefixedText();
3300 return "[[$page|$text]]";
3307 * Returns an array of the groups that a particular group can add/remove.
3309 * @param $group String: the group to check for whether it can add/remove
3310 * @return Array array( 'add' => array( addablegroups ),
3311 * 'remove' => array( removablegroups ),
3312 * 'add-self' => array( addablegroups to self),
3313 * 'remove-self' => array( removable groups from self) )
3315 static function changeableByGroup( $group ) {
3316 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3318 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3319 if( empty( $wgAddGroups[$group] ) ) {
3320 // Don't add anything to $groups
3321 } elseif( $wgAddGroups[$group] === true ) {
3322 // You get everything
3323 $groups['add'] = self
::getAllGroups();
3324 } elseif( is_array( $wgAddGroups[$group] ) ) {
3325 $groups['add'] = $wgAddGroups[$group];
3328 // Same thing for remove
3329 if( empty( $wgRemoveGroups[$group] ) ) {
3330 } elseif( $wgRemoveGroups[$group] === true ) {
3331 $groups['remove'] = self
::getAllGroups();
3332 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3333 $groups['remove'] = $wgRemoveGroups[$group];
3336 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3337 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3338 foreach( $wgGroupsAddToSelf as $key => $value ) {
3339 if( is_int( $key ) ) {
3340 $wgGroupsAddToSelf['user'][] = $value;
3345 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3346 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3347 if( is_int( $key ) ) {
3348 $wgGroupsRemoveFromSelf['user'][] = $value;
3353 // Now figure out what groups the user can add to him/herself
3354 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3355 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3356 // No idea WHY this would be used, but it's there
3357 $groups['add-self'] = User
::getAllGroups();
3358 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3359 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3362 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3363 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3364 $groups['remove-self'] = User
::getAllGroups();
3365 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3366 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3373 * Returns an array of groups that this user can add and remove
3374 * @return Array array( 'add' => array( addablegroups ),
3375 * 'remove' => array( removablegroups ),
3376 * 'add-self' => array( addablegroups to self),
3377 * 'remove-self' => array( removable groups from self) )
3379 function changeableGroups() {
3380 if( $this->isAllowed( 'userrights' ) ) {
3381 // This group gives the right to modify everything (reverse-
3382 // compatibility with old "userrights lets you change
3384 // Using array_merge to make the groups reindexed
3385 $all = array_merge( User
::getAllGroups() );
3389 'add-self' => array(),
3390 'remove-self' => array()
3394 // Okay, it's not so simple, we will have to go through the arrays
3397 'remove' => array(),
3398 'add-self' => array(),
3399 'remove-self' => array()
3401 $addergroups = $this->getEffectiveGroups();
3403 foreach( $addergroups as $addergroup ) {
3404 $groups = array_merge_recursive(
3405 $groups, $this->changeableByGroup( $addergroup )
3407 $groups['add'] = array_unique( $groups['add'] );
3408 $groups['remove'] = array_unique( $groups['remove'] );
3409 $groups['add-self'] = array_unique( $groups['add-self'] );
3410 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3416 * Increment the user's edit-count field.
3417 * Will have no effect for anonymous users.
3419 function incEditCount() {
3420 if( !$this->isAnon() ) {
3421 $dbw = wfGetDB( DB_MASTER
);
3422 $dbw->update( 'user',
3423 array( 'user_editcount=user_editcount+1' ),
3424 array( 'user_id' => $this->getId() ),
3427 // Lazy initialization check...
3428 if( $dbw->affectedRows() == 0 ) {
3429 // Pull from a slave to be less cruel to servers
3430 // Accuracy isn't the point anyway here
3431 $dbr = wfGetDB( DB_SLAVE
);
3432 $count = $dbr->selectField( 'revision',
3434 array( 'rev_user' => $this->getId() ),
3437 // Now here's a goddamn hack...
3438 if( $dbr !== $dbw ) {
3439 // If we actually have a slave server, the count is
3440 // at least one behind because the current transaction
3441 // has not been committed and replicated.
3444 // But if DB_SLAVE is selecting the master, then the
3445 // count we just read includes the revision that was
3446 // just added in the working transaction.
3449 $dbw->update( 'user',
3450 array( 'user_editcount' => $count ),
3451 array( 'user_id' => $this->getId() ),
3455 // edit count in user cache too
3456 $this->invalidateCache();
3460 * Get the description of a given right
3462 * @param $right String Right to query
3463 * @return String Localized description of the right
3465 static function getRightDescription( $right ) {
3466 $key = "right-$right";
3467 $name = wfMsg( $key );
3468 return $name == '' ||
wfEmptyMsg( $key, $name )
3474 * Make an old-style password hash
3476 * @param $password String Plain-text password
3477 * @param $userId String User ID
3478 * @return String Password hash
3480 static function oldCrypt( $password, $userId ) {
3481 global $wgPasswordSalt;
3482 if ( $wgPasswordSalt ) {
3483 return md5( $userId . '-' . md5( $password ) );
3485 return md5( $password );
3490 * Make a new-style password hash
3492 * @param $password String Plain-text password
3493 * @param $salt String Optional salt, may be random or the user ID.
3494 * If unspecified or false, will generate one automatically
3495 * @return String Password hash
3497 static function crypt( $password, $salt = false ) {
3498 global $wgPasswordSalt;
3501 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3505 if( $wgPasswordSalt ) {
3506 if ( $salt === false ) {
3507 $salt = substr( wfGenerateToken(), 0, 8 );
3509 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3511 return ':A:' . md5( $password );
3516 * Compare a password hash with a plain-text password. Requires the user
3517 * ID if there's a chance that the hash is an old-style hash.
3519 * @param $hash String Password hash
3520 * @param $password String Plain-text password to compare
3521 * @param $userId String User ID for old-style password salt
3524 static function comparePasswords( $hash, $password, $userId = false ) {
3525 $type = substr( $hash, 0, 3 );
3528 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3532 if ( $type == ':A:' ) {
3534 return md5( $password ) === substr( $hash, 3 );
3535 } elseif ( $type == ':B:' ) {
3537 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3538 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3541 return self
::oldCrypt( $password, $userId ) === $hash;
3546 * Add a newuser log entry for this user
3548 * @param $byEmail Boolean: account made by email?
3549 * @param $reason String: user supplied reason
3551 public function addNewUserLogEntry( $byEmail = false, $reason = '' ) {
3552 global $wgUser, $wgContLang, $wgNewUserLog;
3553 if( empty( $wgNewUserLog ) ) {
3554 return true; // disabled
3557 if( $this->getName() == $wgUser->getName() ) {
3560 $action = 'create2';
3562 if ( $reason === '' ) {
3563 $reason = wfMsgForContent( 'newuserlog-byemail' );
3565 $reason = $wgContLang->commaList( array(
3566 $reason, wfMsgForContent( 'newuserlog-byemail' ) ) );
3570 $log = new LogPage( 'newusers' );
3573 $this->getUserPage(),
3575 array( $this->getId() )
3581 * Add an autocreate newuser log entry for this user
3582 * Used by things like CentralAuth and perhaps other authplugins.
3584 public function addNewUserLogEntryAutoCreate() {
3585 global $wgNewUserLog, $wgLogAutocreatedAccounts;
3586 if( !$wgNewUserLog ||
!$wgLogAutocreatedAccounts ) {
3587 return true; // disabled
3589 $log = new LogPage( 'newusers', false );
3590 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3594 protected function loadOptions() {
3596 if ( $this->mOptionsLoaded ||
!$this->getId() )
3599 $this->mOptions
= self
::getDefaultOptions();
3601 // Maybe load from the object
3602 if ( !is_null( $this->mOptionOverrides
) ) {
3603 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
3604 foreach( $this->mOptionOverrides
as $key => $value ) {
3605 $this->mOptions
[$key] = $value;
3608 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
3609 // Load from database
3610 $dbr = wfGetDB( DB_SLAVE
);
3612 $res = $dbr->select(
3615 array( 'up_user' => $this->getId() ),
3619 foreach ( $res as $row ) {
3620 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3621 $this->mOptions
[$row->up_property
] = $row->up_value
;
3625 $this->mOptionsLoaded
= true;
3627 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3630 protected function saveOptions() {
3631 global $wgAllowPrefChange;
3633 $extuser = ExternalUser
::newFromUser( $this );
3635 $this->loadOptions();
3636 $dbw = wfGetDB( DB_MASTER
);
3638 $insert_rows = array();
3640 $saveOptions = $this->mOptions
;
3642 // Allow hooks to abort, for instance to save to a global profile.
3643 // Reset options to default state before saving.
3644 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3647 foreach( $saveOptions as $key => $value ) {
3648 # Don't bother storing default values
3649 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3650 !( $value === false ||
is_null($value) ) ) ||
3651 $value != self
::getDefaultOption( $key ) ) {
3652 $insert_rows[] = array(
3653 'up_user' => $this->getId(),
3654 'up_property' => $key,
3655 'up_value' => $value,
3658 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3659 switch ( $wgAllowPrefChange[$key] ) {
3665 $extuser->setPref( $key, $value );
3671 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3672 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3677 * Provide an array of HTML5 attributes to put on an input element
3678 * intended for the user to enter a new password. This may include
3679 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3681 * Do *not* use this when asking the user to enter his current password!
3682 * Regardless of configuration, users may have invalid passwords for whatever
3683 * reason (e.g., they were set before requirements were tightened up).
3684 * Only use it when asking for a new password, like on account creation or
3687 * Obviously, you still need to do server-side checking.
3689 * NOTE: A combination of bugs in various browsers means that this function
3690 * actually just returns array() unconditionally at the moment. May as
3691 * well keep it around for when the browser bugs get fixed, though.
3693 * FIXME : This does not belong here; put it in Html or Linker or somewhere
3695 * @return array Array of HTML attributes suitable for feeding to
3696 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3697 * That will potentially output invalid XHTML 1.0 Transitional, and will
3698 * get confused by the boolean attribute syntax used.)
3700 public static function passwordChangeInputAttribs() {
3701 global $wgMinimalPasswordLength;
3703 if ( $wgMinimalPasswordLength == 0 ) {
3707 # Note that the pattern requirement will always be satisfied if the
3708 # input is empty, so we need required in all cases.
3710 # FIXME (bug 23769): This needs to not claim the password is required
3711 # if e-mail confirmation is being used. Since HTML5 input validation
3712 # is b0rked anyway in some browsers, just return nothing. When it's
3713 # re-enabled, fix this code to not output required for e-mail
3715 #$ret = array( 'required' );
3718 # We can't actually do this right now, because Opera 9.6 will print out
3719 # the entered password visibly in its error message! When other
3720 # browsers add support for this attribute, or Opera fixes its support,
3721 # we can add support with a version check to avoid doing this on Opera
3722 # versions where it will be a problem. Reported to Opera as
3723 # DSK-262266, but they don't have a public bug tracker for us to follow.
3725 if ( $wgMinimalPasswordLength > 1 ) {
3726 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3727 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3728 $wgMinimalPasswordLength );
3736 * Format the user message using a hook, a template, or, failing these, a static format.
3737 * @param $subject String the subject of the message
3738 * @param $text String the content of the message
3739 * @param $signature String the signature, if provided.
3741 static protected function formatUserMessage( $subject, $text, $signature ) {
3742 if ( wfRunHooks( 'FormatUserMessage',
3743 array( $subject, &$text, $signature ) ) ) {
3745 $signature = empty($signature) ?
"~~~~~" : "{$signature} ~~~~~";
3747 $template = Title
::newFromText( wfMsgForContent( 'usermessage-template' ) );
3749 ||
$template->getNamespace() !== NS_TEMPLATE
3750 ||
!$template->exists() ) {
3751 $text = "\n== $subject ==\n\n$text\n\n-- $signature";
3753 $text = '{{'. $template->getText()
3754 . " | subject=$subject | body=$text | signature=$signature }}";
3762 * Leave a user a message
3763 * @param $subject String the subject of the message
3764 * @param $text String the message to leave
3765 * @param $signature String Text to leave in the signature
3766 * @param $summary String the summary for this change, defaults to
3767 * "Leave system message."
3768 * @param $editor User The user leaving the message, defaults to
3769 * "{{MediaWiki:usermessage-editor}}"
3770 * @param $flags Int default edit flags
3772 * @return boolean true if it was successful
3774 public function leaveUserMessage( $subject, $text, $signature = "",
3775 $summary = null, $editor = null, $flags = 0 ) {
3776 if ( !isset( $summary ) ) {
3777 $summary = wfMsgForContent( 'usermessage-summary' );
3780 if ( !isset( $editor ) ) {
3781 $editor = User
::newFromName( wfMsgForContent( 'usermessage-editor' ) );
3782 if ( !$editor->isLoggedIn() ) {
3783 $editor->addToDatabase();
3787 $article = new Article( $this->getTalkPage() );
3788 wfRunHooks( 'SetupUserMessageArticle',
3789 array( $this, &$article, $subject, $text, $signature, $summary, $editor ) );
3792 $text = self
::formatUserMessage( $subject, $text, $signature );
3793 $flags = $article->checkFlags( $flags );
3795 if ( $flags & EDIT_UPDATE
) {
3796 $text = $article->getContent() . $text;
3799 $dbw = wfGetDB( DB_MASTER
);
3803 $status = $article->doEdit( $text, $summary, $flags, false, $editor );
3804 } catch ( DBQueryError
$e ) {
3805 $status = Status
::newFatal("DB Error");
3808 if ( $status->isGood() ) {
3809 // Set newtalk with the right user ID
3810 $this->setNewtalk( true );
3811 wfRunHooks( 'AfterUserMessage',
3812 array( $this, $article, $summary, $text, $signature, $summary, $editor ) );
3815 // The article was concurrently created
3816 wfDebug( __METHOD__
. ": Error ".$status->getWikiText() );
3820 return $status->isGood();