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
46 * \type{\arrayof{\string}} A list of default user toggles, i.e., boolean user
47 * preferences that are displayed by Special:Preferences as checkboxes.
48 * This list can be extended via the UserToggles hook or by
49 * $wgContLang::getExtraUserToggles().
52 public static $mToggles = array(
62 'editsectiononrightclick',
74 'enotifwatchlistpages',
75 'enotifusertalkpages',
78 'shownumberswatching',
98 * \type{\arrayof{\string}} List of member variables which are saved to the
99 * shared cache (memcached). Any operation which changes the
100 * corresponding database fields must call a cache-clearing function.
103 static $mCacheVars = array(
114 'mEmailAuthenticated',
116 'mEmailTokenExpires',
121 // user_properties table
126 * \type{\arrayof{\string}} Core rights.
127 * Each of these should have a corresponding message of the form
131 static $mCoreRights = array(
158 'move-rootuserpages',
162 'override-export-depth',
182 'userrights-interwiki',
186 * \string Cached results of getAllRights()
188 static $mAllRights = false;
190 /** @name Cache variables */
192 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
193 $mEmail, $mTouched, $mToken, $mEmailAuthenticated,
194 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups, $mOptionOverrides;
198 * \bool Whether the cache variables have been loaded.
200 var $mDataLoaded, $mAuthLoaded, $mOptionsLoaded;
203 * \string Initialization data source if mDataLoaded==false. May be one of:
204 * - 'defaults' anonymous user initialised from class defaults
205 * - 'name' initialise from mName
206 * - 'id' initialise from mId
207 * - 'session' log in from cookies or session if possible
209 * Use the User::newFrom*() family of functions to set this.
213 /** @name Lazy-initialized variables, invalidated with clearInstanceCache */
215 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
216 $mBlockreason, $mBlock, $mEffectiveGroups, $mBlockedGlobally,
217 $mLocked, $mHideName, $mOptions;
220 static $idCacheByName = array();
223 * Lightweight constructor for an anonymous user.
224 * Use the User::newFrom* factory functions for other kinds of users.
228 * @see newFromConfirmationCode()
229 * @see newFromSession()
233 $this->clearInstanceCache( 'defaults' );
237 * Load the user table data for this object from the source given by mFrom.
240 if ( $this->mDataLoaded
) {
243 wfProfileIn( __METHOD__
);
245 # Set it now to avoid infinite recursion in accessors
246 $this->mDataLoaded
= true;
248 switch ( $this->mFrom
) {
250 $this->loadDefaults();
253 $this->mId
= self
::idFromName( $this->mName
);
255 # Nonexistent user placeholder object
256 $this->loadDefaults( $this->mName
);
265 $this->loadFromSession();
266 wfRunHooks( 'UserLoadAfterLoadFromSession', array( $this ) );
269 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
271 wfProfileOut( __METHOD__
);
275 * Load user table data, given mId has already been set.
276 * @return \bool false if the ID does not exist, true otherwise
279 function loadFromId() {
281 if ( $this->mId
== 0 ) {
282 $this->loadDefaults();
287 $key = wfMemcKey( 'user', 'id', $this->mId
);
288 $data = $wgMemc->get( $key );
289 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
290 # Object is expired, load from DB
295 wfDebug( "Cache miss for user {$this->mId}\n" );
297 if ( !$this->loadFromDatabase() ) {
298 # Can't load from ID, user is anonymous
301 $this->saveToCache();
303 wfDebug( "Got user {$this->mId} from cache\n" );
305 foreach ( self
::$mCacheVars as $name ) {
306 $this->$name = $data[$name];
313 * Save user data to the shared cache
315 function saveToCache() {
318 $this->loadOptions();
319 if ( $this->isAnon() ) {
320 // Anonymous users are uncached
324 foreach ( self
::$mCacheVars as $name ) {
325 $data[$name] = $this->$name;
327 $data['mVersion'] = MW_USER_VERSION
;
328 $key = wfMemcKey( 'user', 'id', $this->mId
);
330 $wgMemc->set( $key, $data );
334 /** @name newFrom*() static factory methods */
338 * Static factory method for creation from username.
340 * This is slightly less efficient than newFromId(), so use newFromId() if
341 * you have both an ID and a name handy.
343 * @param $name \string Username, validated by Title::newFromText()
344 * @param $validate \mixed Validate username. Takes the same parameters as
345 * User::getCanonicalName(), except that true is accepted as an alias
346 * for 'valid', for BC.
348 * @return \type{User} The User object, or null if the username is invalid. If the
349 * username is not present in the database, the result will be a user object
350 * with a name, zero user ID and default settings.
352 static function newFromName( $name, $validate = 'valid' ) {
353 if ( $validate === true ) {
356 $name = self
::getCanonicalName( $name, $validate );
357 if ( $name === false ) {
360 # Create unloaded user object
369 * Static factory method for creation from a given user ID.
371 * @param $id \int Valid user ID
372 * @return \type{User} The corresponding User object
374 static function newFromId( $id ) {
382 * Factory method to fetch whichever user has a given email confirmation code.
383 * This code is generated when an account is created or its e-mail address
386 * If the code is invalid or has expired, returns NULL.
388 * @param $code \string Confirmation code
389 * @return \type{User}
391 static function newFromConfirmationCode( $code ) {
392 $dbr = wfGetDB( DB_SLAVE
);
393 $id = $dbr->selectField( 'user', 'user_id', array(
394 'user_email_token' => md5( $code ),
395 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
397 if( $id !== false ) {
398 return User
::newFromId( $id );
405 * Create a new user object using data from session or cookies. If the
406 * login credentials are invalid, the result is an anonymous user.
408 * @return \type{User}
410 static function newFromSession() {
412 $user->mFrom
= 'session';
417 * Create a new user object from a user row.
418 * The row should have all fields from the user table in it.
419 * @param $row array A row from the user table
420 * @return \type{User}
422 static function newFromRow( $row ) {
424 $user->loadFromRow( $row );
432 * Get the username corresponding to a given user ID
433 * @param $id \int User ID
434 * @return \string The corresponding username
436 static function whoIs( $id ) {
437 $dbr = wfGetDB( DB_SLAVE
);
438 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
442 * Get the real name of a user given their user ID
444 * @param $id \int User ID
445 * @return \string The corresponding user's real name
447 static function whoIsReal( $id ) {
448 $dbr = wfGetDB( DB_SLAVE
);
449 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
453 * Get database id given a user name
454 * @param $name \string Username
455 * @return \types{\int,\null} The corresponding user's ID, or null if user is nonexistent
457 static function idFromName( $name ) {
458 $nt = Title
::makeTitleSafe( NS_USER
, $name );
459 if( is_null( $nt ) ) {
464 if ( isset( self
::$idCacheByName[$name] ) ) {
465 return self
::$idCacheByName[$name];
468 $dbr = wfGetDB( DB_SLAVE
);
469 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
471 if ( $s === false ) {
474 $result = $s->user_id
;
477 self
::$idCacheByName[$name] = $result;
479 if ( count( self
::$idCacheByName ) > 1000 ) {
480 self
::$idCacheByName = array();
487 * Does the string match an anonymous IPv4 address?
489 * This function exists for username validation, in order to reject
490 * usernames which are similar in form to IP addresses. Strings such
491 * as 300.300.300.300 will return true because it looks like an IP
492 * address, despite not being strictly valid.
494 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
495 * address because the usemod software would "cloak" anonymous IP
496 * addresses like this, if we allowed accounts like this to be created
497 * new users could get the old edits of these anonymous users.
499 * @param $name \string String to match
500 * @return \bool True or false
502 static function isIP( $name ) {
503 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || IP
::isIPv6($name);
507 * Is the input a valid username?
509 * Checks if the input is a valid username, we don't want an empty string,
510 * an IP address, anything that containins slashes (would mess up subpages),
511 * is longer than the maximum allowed username size or doesn't begin with
514 * @param $name \string String to match
515 * @return \bool True or false
517 static function isValidUserName( $name ) {
518 global $wgContLang, $wgMaxNameChars;
521 || User
::isIP( $name )
522 ||
strpos( $name, '/' ) !== false
523 ||
strlen( $name ) > $wgMaxNameChars
524 ||
$name != Title
::capitalize( $name, NS_USER
) ) {
525 wfDebugLog( 'username', __METHOD__
.
526 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
530 // Ensure that the name can't be misresolved as a different title,
531 // such as with extra namespace keys at the start.
532 $parsed = Title
::newFromText( $name );
533 if( is_null( $parsed )
534 ||
$parsed->getNamespace()
535 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
536 wfDebugLog( 'username', __METHOD__
.
537 ": '$name' invalid due to ambiguous prefixes" );
541 // Check an additional blacklist of troublemaker characters.
542 // Should these be merged into the title char list?
543 $unicodeBlacklist = '/[' .
544 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
545 '\x{00a0}' . # non-breaking space
546 '\x{2000}-\x{200f}' . # various whitespace
547 '\x{2028}-\x{202f}' . # breaks and control chars
548 '\x{3000}' . # ideographic space
549 '\x{e000}-\x{f8ff}' . # private use
551 if( preg_match( $unicodeBlacklist, $name ) ) {
552 wfDebugLog( 'username', __METHOD__
.
553 ": '$name' invalid due to blacklisted characters" );
561 * Usernames which fail to pass this function will be blocked
562 * from user login and new account registrations, but may be used
563 * internally by batch processes.
565 * If an account already exists in this form, login will be blocked
566 * by a failure to pass this function.
568 * @param $name \string String to match
569 * @return \bool True or false
571 static function isUsableName( $name ) {
572 global $wgReservedUsernames;
573 // Must be a valid username, obviously ;)
574 if ( !self
::isValidUserName( $name ) ) {
578 static $reservedUsernames = false;
579 if ( !$reservedUsernames ) {
580 $reservedUsernames = $wgReservedUsernames;
581 wfRunHooks( 'UserGetReservedNames', array( &$reservedUsernames ) );
584 // Certain names may be reserved for batch processes.
585 foreach ( $reservedUsernames as $reserved ) {
586 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
587 $reserved = wfMsgForContent( substr( $reserved, 4 ) );
589 if ( $reserved == $name ) {
597 * Usernames which fail to pass this function will be blocked
598 * from new account registrations, but may be used internally
599 * either by batch processes or by user accounts which have
600 * already been created.
602 * Additional character blacklisting may be added here
603 * rather than in isValidUserName() to avoid disrupting
606 * @param $name \string String to match
607 * @return \bool True or false
609 static function isCreatableName( $name ) {
610 global $wgInvalidUsernameCharacters;
612 self
::isUsableName( $name ) &&
614 // Registration-time character blacklisting...
615 !preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name );
619 * Is the input a valid password for this user?
621 * @param $password String Desired password
622 * @return mixed: true on success, string of error message on failure
624 function isValidPassword( $password ) {
625 global $wgMinimalPasswordLength, $wgContLang;
627 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
630 // Password needs to be long enough
631 if( strlen( $password ) < $wgMinimalPasswordLength ) {
632 return 'passwordtooshort';
633 } elseif( $wgContLang->lc( $password ) == $wgContLang->lc( $this->mName
) ) {
634 return 'password-name-match';
641 * Does a string look like an e-mail address?
643 * There used to be a regular expression here, it got removed because it
644 * rejected valid addresses. Actually just check if there is '@' somewhere
645 * in the given address.
647 * @todo Check for RFC 2822 compilance (bug 959)
649 * @param $addr \string E-mail address
650 * @return \bool True or false
652 public static function isValidEmailAddr( $addr ) {
654 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
658 return strpos( $addr, '@' ) !== false;
662 * Given unvalidated user input, return a canonical username, or false if
663 * the username is invalid.
664 * @param $name \string User input
665 * @param $validate \types{\string,\bool} Type of validation to use:
666 * - false No validation
667 * - 'valid' Valid for batch processes
668 * - 'usable' Valid for batch processes and login
669 * - 'creatable' Valid for batch processes, login and account creation
671 static function getCanonicalName( $name, $validate = 'valid' ) {
672 # Maybe force usernames to capital
673 $name = Title
::capitalize( $name, NS_USER
);
675 # Reject names containing '#'; these will be cleaned up
676 # with title normalisation, but then it's too late to
678 if( strpos( $name, '#' ) !== false )
681 # Clean up name according to title rules
682 $t = ( $validate === 'valid' ) ?
683 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
684 # Check for invalid titles
685 if( is_null( $t ) ) {
689 # Reject various classes of invalid names
690 $name = $t->getText();
692 $name = $wgAuth->getCanonicalName( $t->getText() );
694 switch ( $validate ) {
698 if ( !User
::isValidUserName( $name ) ) {
703 if ( !User
::isUsableName( $name ) ) {
708 if ( !User
::isCreatableName( $name ) ) {
713 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
719 * Count the number of edits of a user
720 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
722 * @param $uid \int User ID to check
723 * @return \int The user's edit count
725 static function edits( $uid ) {
726 wfProfileIn( __METHOD__
);
727 $dbr = wfGetDB( DB_SLAVE
);
728 // check if the user_editcount field has been initialized
729 $field = $dbr->selectField(
730 'user', 'user_editcount',
731 array( 'user_id' => $uid ),
735 if( $field === null ) { // it has not been initialized. do so.
736 $dbw = wfGetDB( DB_MASTER
);
737 $count = $dbr->selectField(
738 'revision', 'count(*)',
739 array( 'rev_user' => $uid ),
744 array( 'user_editcount' => $count ),
745 array( 'user_id' => $uid ),
751 wfProfileOut( __METHOD__
);
756 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
757 * @todo hash random numbers to improve security, like generateToken()
759 * @return \string New random password
761 static function randomPassword() {
762 global $wgMinimalPasswordLength;
763 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
764 $l = strlen( $pwchars ) - 1;
766 $pwlength = max( 7, $wgMinimalPasswordLength );
767 $digit = mt_rand( 0, $pwlength - 1 );
769 for ( $i = 0; $i < $pwlength; $i++
) {
770 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
776 * Set cached properties to default.
778 * @note This no longer clears uncached lazy-initialised properties;
779 * the constructor does that instead.
782 function loadDefaults( $name = false ) {
783 wfProfileIn( __METHOD__
);
785 global $wgCookiePrefix;
788 $this->mName
= $name;
789 $this->mRealName
= '';
790 $this->mPassword
= $this->mNewpassword
= '';
791 $this->mNewpassTime
= null;
793 $this->mOptionOverrides
= null;
794 $this->mOptionsLoaded
= false;
796 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
797 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
799 $this->mTouched
= '0'; # Allow any pages to be cached
802 $this->setToken(); # Random
803 $this->mEmailAuthenticated
= null;
804 $this->mEmailToken
= '';
805 $this->mEmailTokenExpires
= null;
806 $this->mRegistration
= wfTimestamp( TS_MW
);
807 $this->mGroups
= array();
809 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
811 wfProfileOut( __METHOD__
);
815 * @deprecated Use wfSetupSession().
817 function SetupSession() {
818 wfDeprecated( __METHOD__
);
823 * Load user data from the session or login cookie. If there are no valid
824 * credentials, initialises the user as an anonymous user.
825 * @return \bool True if the user is logged in, false otherwise.
827 private function loadFromSession() {
828 global $wgMemc, $wgCookiePrefix;
831 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
832 if ( $result !== null ) {
836 if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
837 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
838 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
839 $this->loadDefaults(); // Possible collision!
840 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
841 cookie user ID ($sId) don't match!" );
844 $_SESSION['wsUserID'] = $sId;
845 } else if ( isset( $_SESSION['wsUserID'] ) ) {
846 if ( $_SESSION['wsUserID'] != 0 ) {
847 $sId = $_SESSION['wsUserID'];
849 $this->loadDefaults();
853 $this->loadDefaults();
857 if ( isset( $_SESSION['wsUserName'] ) ) {
858 $sName = $_SESSION['wsUserName'];
859 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
860 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
861 $_SESSION['wsUserName'] = $sName;
863 $this->loadDefaults();
867 $passwordCorrect = FALSE;
869 if ( !$this->loadFromId() ) {
870 # Not a valid ID, loadFromId has switched the object to anon for us
874 if ( isset( $_SESSION['wsToken'] ) ) {
875 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
877 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
878 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
881 # No session or persistent login cookie
882 $this->loadDefaults();
886 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
887 $_SESSION['wsToken'] = $this->mToken
;
888 wfDebug( "Logged in from $from\n" );
891 # Invalid credentials
892 wfDebug( "Can't log in from $from, invalid credentials\n" );
893 $this->loadDefaults();
899 * Load user and user_group data from the database.
900 * $this::mId must be set, this is how the user is identified.
902 * @return \bool True if the user exists, false if the user is anonymous
905 function loadFromDatabase() {
907 $this->mId
= intval( $this->mId
);
909 /** Anonymous user */
911 $this->loadDefaults();
915 $dbr = wfGetDB( DB_MASTER
);
916 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
918 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
920 if ( $s !== false ) {
921 # Initialise user table data
922 $this->loadFromRow( $s );
923 $this->mGroups
= null; // deferred
924 $this->getEditCount(); // revalidation for nulls
929 $this->loadDefaults();
935 * Initialize this object from a row from the user table.
937 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
939 function loadFromRow( $row ) {
940 $this->mDataLoaded
= true;
942 if ( isset( $row->user_id
) ) {
943 $this->mId
= intval( $row->user_id
);
945 $this->mName
= $row->user_name
;
946 $this->mRealName
= $row->user_real_name
;
947 $this->mPassword
= $row->user_password
;
948 $this->mNewpassword
= $row->user_newpassword
;
949 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
950 $this->mEmail
= $row->user_email
;
951 $this->decodeOptions( $row->user_options
);
952 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
953 $this->mToken
= $row->user_token
;
954 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
955 $this->mEmailToken
= $row->user_email_token
;
956 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
957 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
958 $this->mEditCount
= $row->user_editcount
;
962 * Load the groups from the database if they aren't already loaded.
965 function loadGroups() {
966 if ( is_null( $this->mGroups
) ) {
967 $dbr = wfGetDB( DB_MASTER
);
968 $res = $dbr->select( 'user_groups',
970 array( 'ug_user' => $this->mId
),
972 $this->mGroups
= array();
973 while( $row = $dbr->fetchObject( $res ) ) {
974 $this->mGroups
[] = $row->ug_group
;
980 * Clear various cached data stored in this object.
981 * @param $reloadFrom \string Reload user and user_groups table data from a
982 * given source. May be "name", "id", "defaults", "session", or false for
985 function clearInstanceCache( $reloadFrom = false ) {
986 $this->mNewtalk
= -1;
987 $this->mDatePreference
= null;
988 $this->mBlockedby
= -1; # Unset
989 $this->mHash
= false;
991 $this->mRights
= null;
992 $this->mEffectiveGroups
= null;
993 $this->mOptions
= null;
996 $this->mDataLoaded
= false;
997 $this->mFrom
= $reloadFrom;
1002 * Combine the language default options with any site-specific options
1003 * and add the default language variants.
1005 * @return \type{\arrayof{\string}} Array of options
1007 static function getDefaultOptions() {
1008 global $wgNamespacesToBeSearchedDefault;
1010 * Site defaults will override the global/language defaults
1012 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1013 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1016 * default language setting
1018 $variant = $wgContLang->getPreferredVariant( false );
1019 $defOpt['variant'] = $variant;
1020 $defOpt['language'] = $variant;
1021 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1022 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1024 $defOpt['skin'] = $wgDefaultSkin;
1030 * Get a given default option value.
1032 * @param $opt \string Name of option to retrieve
1033 * @return \string Default option value
1035 public static function getDefaultOption( $opt ) {
1036 $defOpts = self
::getDefaultOptions();
1037 if( isset( $defOpts[$opt] ) ) {
1038 return $defOpts[$opt];
1045 * Get a list of user toggle names
1046 * @return \type{\arrayof{\string}} Array of user toggle names
1048 static function getToggles() {
1049 global $wgContLang, $wgUseRCPatrol;
1050 $extraToggles = array();
1051 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1052 if( $wgUseRCPatrol ) {
1053 $extraToggles[] = 'hidepatrolled';
1054 $extraToggles[] = 'newpageshidepatrolled';
1055 $extraToggles[] = 'watchlisthidepatrolled';
1057 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1062 * Get blocking information
1064 * @param $bFromSlave \bool Whether to check the slave database first. To
1065 * improve performance, non-critical checks are done
1066 * against slaves. Check when actually saving should be
1067 * done against master.
1069 function getBlockedStatus( $bFromSlave = true ) {
1070 global $wgEnableSorbs, $wgProxyWhitelist, $wgUser;
1072 if ( -1 != $this->mBlockedby
) {
1073 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1077 wfProfileIn( __METHOD__
);
1078 wfDebug( __METHOD__
.": checking...\n" );
1080 // Initialize data...
1081 // Otherwise something ends up stomping on $this->mBlockedby when
1082 // things get lazy-loaded later, causing false positive block hits
1083 // due to -1 !== 0. Probably session-related... Nothing should be
1084 // overwriting mBlockedby, surely?
1087 $this->mBlockedby
= 0;
1088 $this->mHideName
= 0;
1089 $this->mAllowUsertalk
= 0;
1091 # Check if we are looking at an IP or a logged-in user
1092 if ( $this->isIP( $this->getName() ) ) {
1093 $ip = $this->getName();
1095 # Check if we are looking at the current user
1096 # If we don't, and the user is logged in, we don't know about
1097 # his IP / autoblock status, so ignore autoblock of current user's IP
1098 if ( $this->getID() != $wgUser->getID() ) {
1101 # Get IP of current user
1106 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1107 # Exempt from all types of IP-block
1112 $this->mBlock
= new Block();
1113 $this->mBlock
->fromMaster( !$bFromSlave );
1114 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1115 wfDebug( __METHOD__
. ": Found block.\n" );
1116 $this->mBlockedby
= $this->mBlock
->mBy
;
1117 $this->mBlockreason
= $this->mBlock
->mReason
;
1118 $this->mHideName
= $this->mBlock
->mHideName
;
1119 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1120 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1121 $this->spreadBlock();
1124 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1125 // apply to users. Note that the existence of $this->mBlock is not used to
1126 // check for edit blocks, $this->mBlockedby is instead.
1130 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1132 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1133 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1134 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1138 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1139 if ( $this->inSorbsBlacklist( $ip ) ) {
1140 $this->mBlockedby
= wfMsg( 'sorbs' );
1141 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1147 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1149 wfProfileOut( __METHOD__
);
1153 * Whether the given IP is in the SORBS blacklist.
1155 * @param $ip \string IP to check
1156 * @return \bool True if blacklisted.
1158 function inSorbsBlacklist( $ip ) {
1159 global $wgEnableSorbs, $wgSorbsUrl;
1161 return $wgEnableSorbs &&
1162 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1166 * Whether the given IP is in a given DNS blacklist.
1168 * @param $ip \string IP to check
1169 * @param $base \string URL of the DNS blacklist
1170 * @return \bool True if blacklisted.
1172 function inDnsBlacklist( $ip, $base ) {
1173 wfProfileIn( __METHOD__
);
1177 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1178 if( IP
::isIPv4( $ip ) ) {
1180 $host = "$ip.$base";
1183 $ipList = gethostbynamel( $host );
1186 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1189 wfDebug( "Requested $host, not found in $base.\n" );
1193 wfProfileOut( __METHOD__
);
1198 * Is this user subject to rate limiting?
1200 * @return \bool True if rate limited
1202 public function isPingLimitable() {
1203 global $wgRateLimitsExcludedGroups;
1204 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1205 // Deprecated, but kept for backwards-compatibility config
1208 return !$this->isAllowed( 'noratelimit' );
1212 * Primitive rate limits: enforce maximum actions per time period
1213 * to put a brake on flooding.
1215 * @note When using a shared cache like memcached, IP-address
1216 * last-hit counters will be shared across wikis.
1218 * @param $action \string Action to enforce; 'edit' if unspecified
1219 * @return \bool True if a rate limiter was tripped
1221 function pingLimiter( $action = 'edit' ) {
1222 # Call the 'PingLimiter' hook
1224 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1228 global $wgRateLimits;
1229 if( !isset( $wgRateLimits[$action] ) ) {
1233 # Some groups shouldn't trigger the ping limiter, ever
1234 if( !$this->isPingLimitable() )
1237 global $wgMemc, $wgRateLimitLog;
1238 wfProfileIn( __METHOD__
);
1240 $limits = $wgRateLimits[$action];
1242 $id = $this->getId();
1246 if( isset( $limits['anon'] ) && $id == 0 ) {
1247 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1250 if( isset( $limits['user'] ) && $id != 0 ) {
1251 $userLimit = $limits['user'];
1253 if( $this->isNewbie() ) {
1254 if( isset( $limits['newbie'] ) && $id != 0 ) {
1255 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1257 if( isset( $limits['ip'] ) ) {
1258 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1261 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1262 $subnet = $matches[1];
1263 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1266 // Check for group-specific permissions
1267 // If more than one group applies, use the group with the highest limit
1268 foreach ( $this->getGroups() as $group ) {
1269 if ( isset( $limits[$group] ) ) {
1270 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1271 $userLimit = $limits[$group];
1275 // Set the user limit key
1276 if ( $userLimit !== false ) {
1277 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1278 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1282 foreach( $keys as $key => $limit ) {
1283 list( $max, $period ) = $limit;
1284 $summary = "(limit $max in {$period}s)";
1285 $count = $wgMemc->get( $key );
1287 if( $count > $max ) {
1288 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1289 if( $wgRateLimitLog ) {
1290 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1294 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1297 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1298 $wgMemc->add( $key, 1, intval( $period ) );
1300 $wgMemc->incr( $key );
1303 wfProfileOut( __METHOD__
);
1308 * Check if user is blocked
1310 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1311 * @return \bool True if blocked, false otherwise
1313 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1314 wfDebug( "User::isBlocked: enter\n" );
1315 $this->getBlockedStatus( $bFromSlave );
1316 return $this->mBlockedby
!== 0;
1320 * Check if user is blocked from editing a particular article
1322 * @param $title \string Title to check
1323 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1324 * @return \bool True if blocked, false otherwise
1326 function isBlockedFrom( $title, $bFromSlave = false ) {
1327 global $wgBlockAllowsUTEdit;
1328 wfProfileIn( __METHOD__
);
1329 wfDebug( __METHOD__
. ": enter\n" );
1331 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1332 $blocked = $this->isBlocked( $bFromSlave );
1333 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1334 # If a user's name is suppressed, they cannot make edits anywhere
1335 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1336 $title->getNamespace() == NS_USER_TALK
) {
1338 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1341 wfRunHooks( 'UserIsBlockedFrom', array( $this, $title, &$blocked, &$allowUsertalk ) );
1343 wfProfileOut( __METHOD__
);
1348 * If user is blocked, return the name of the user who placed the block
1349 * @return \string name of blocker
1351 function blockedBy() {
1352 $this->getBlockedStatus();
1353 return $this->mBlockedby
;
1357 * If user is blocked, return the specified reason for the block
1358 * @return \string Blocking reason
1360 function blockedFor() {
1361 $this->getBlockedStatus();
1362 return $this->mBlockreason
;
1366 * If user is blocked, return the ID for the block
1367 * @return \int Block ID
1369 function getBlockId() {
1370 $this->getBlockedStatus();
1371 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1375 * Check if user is blocked on all wikis.
1376 * Do not use for actual edit permission checks!
1377 * This is intented for quick UI checks.
1379 * @param $ip \type{\string} IP address, uses current client if none given
1380 * @return \type{\bool} True if blocked, false otherwise
1382 function isBlockedGlobally( $ip = '' ) {
1383 if( $this->mBlockedGlobally
!== null ) {
1384 return $this->mBlockedGlobally
;
1386 // User is already an IP?
1387 if( IP
::isIPAddress( $this->getName() ) ) {
1388 $ip = $this->getName();
1393 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1394 $this->mBlockedGlobally
= (bool)$blocked;
1395 return $this->mBlockedGlobally
;
1399 * Check if user account is locked
1401 * @return \type{\bool} True if locked, false otherwise
1403 function isLocked() {
1404 if( $this->mLocked
!== null ) {
1405 return $this->mLocked
;
1408 $authUser = $wgAuth->getUserInstance( $this );
1409 $this->mLocked
= (bool)$authUser->isLocked();
1410 return $this->mLocked
;
1414 * Check if user account is hidden
1416 * @return \type{\bool} True if hidden, false otherwise
1418 function isHidden() {
1419 if( $this->mHideName
!== null ) {
1420 return $this->mHideName
;
1422 $this->getBlockedStatus();
1423 if( !$this->mHideName
) {
1425 $authUser = $wgAuth->getUserInstance( $this );
1426 $this->mHideName
= (bool)$authUser->isHidden();
1428 return $this->mHideName
;
1432 * Get the user's ID.
1433 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1436 if( $this->mId
=== null and $this->mName
!== null
1437 and User
::isIP( $this->mName
) ) {
1438 // Special case, we know the user is anonymous
1440 } elseif( $this->mId
=== null ) {
1441 // Don't load if this was initialized from an ID
1448 * Set the user and reload all fields according to a given ID
1449 * @param $v \int User ID to reload
1451 function setId( $v ) {
1453 $this->clearInstanceCache( 'id' );
1457 * Get the user name, or the IP of an anonymous user
1458 * @return \string User's name or IP address
1460 function getName() {
1461 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1462 # Special case optimisation
1463 return $this->mName
;
1466 if ( $this->mName
=== false ) {
1468 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1470 return $this->mName
;
1475 * Set the user name.
1477 * This does not reload fields from the database according to the given
1478 * name. Rather, it is used to create a temporary "nonexistent user" for
1479 * later addition to the database. It can also be used to set the IP
1480 * address for an anonymous user to something other than the current
1483 * @note User::newFromName() has rougly the same function, when the named user
1485 * @param $str \string New user name to set
1487 function setName( $str ) {
1489 $this->mName
= $str;
1493 * Get the user's name escaped by underscores.
1494 * @return \string Username escaped by underscores.
1496 function getTitleKey() {
1497 return str_replace( ' ', '_', $this->getName() );
1501 * Check if the user has new messages.
1502 * @return \bool True if the user has new messages
1504 function getNewtalk() {
1507 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1508 if( $this->mNewtalk
=== -1 ) {
1509 $this->mNewtalk
= false; # reset talk page status
1511 # Check memcached separately for anons, who have no
1512 # entire User object stored in there.
1515 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1516 $newtalk = $wgMemc->get( $key );
1517 if( strval( $newtalk ) !== '' ) {
1518 $this->mNewtalk
= (bool)$newtalk;
1520 // Since we are caching this, make sure it is up to date by getting it
1522 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1523 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1526 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1530 return (bool)$this->mNewtalk
;
1534 * Return the talk page(s) this user has new messages on.
1535 * @return \type{\arrayof{\string}} Array of page URLs
1537 function getNewMessageLinks() {
1539 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1542 if( !$this->getNewtalk() )
1544 $up = $this->getUserPage();
1545 $utp = $up->getTalkPage();
1546 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1550 * Internal uncached check for new messages
1553 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1554 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1555 * @param $fromMaster \bool true to fetch from the master, false for a slave
1556 * @return \bool True if the user has new messages
1559 function checkNewtalk( $field, $id, $fromMaster = false ) {
1560 if ( $fromMaster ) {
1561 $db = wfGetDB( DB_MASTER
);
1563 $db = wfGetDB( DB_SLAVE
);
1565 $ok = $db->selectField( 'user_newtalk', $field,
1566 array( $field => $id ), __METHOD__
);
1567 return $ok !== false;
1571 * Add or update the new messages flag
1572 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1573 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1574 * @return \bool True if successful, false otherwise
1577 function updateNewtalk( $field, $id ) {
1578 $dbw = wfGetDB( DB_MASTER
);
1579 $dbw->insert( 'user_newtalk',
1580 array( $field => $id ),
1583 if ( $dbw->affectedRows() ) {
1584 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1587 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1593 * Clear the new messages flag for the given user
1594 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1595 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1596 * @return \bool True if successful, false otherwise
1599 function deleteNewtalk( $field, $id ) {
1600 $dbw = wfGetDB( DB_MASTER
);
1601 $dbw->delete( 'user_newtalk',
1602 array( $field => $id ),
1604 if ( $dbw->affectedRows() ) {
1605 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1608 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1614 * Update the 'You have new messages!' status.
1615 * @param $val \bool Whether the user has new messages
1617 function setNewtalk( $val ) {
1618 if( wfReadOnly() ) {
1623 $this->mNewtalk
= $val;
1625 if( $this->isAnon() ) {
1627 $id = $this->getName();
1630 $id = $this->getId();
1635 $changed = $this->updateNewtalk( $field, $id );
1637 $changed = $this->deleteNewtalk( $field, $id );
1640 if( $this->isAnon() ) {
1641 // Anons have a separate memcached space, since
1642 // user records aren't kept for them.
1643 $key = wfMemcKey( 'newtalk', 'ip', $id );
1644 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1647 $this->invalidateCache();
1652 * Generate a current or new-future timestamp to be stored in the
1653 * user_touched field when we update things.
1654 * @return \string Timestamp in TS_MW format
1656 private static function newTouchedTimestamp() {
1657 global $wgClockSkewFudge;
1658 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1662 * Clear user data from memcached.
1663 * Use after applying fun updates to the database; caller's
1664 * responsibility to update user_touched if appropriate.
1666 * Called implicitly from invalidateCache() and saveSettings().
1668 private function clearSharedCache() {
1672 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1677 * Immediately touch the user data cache for this account.
1678 * Updates user_touched field, and removes account data from memcached
1679 * for reload on the next hit.
1681 function invalidateCache() {
1682 if( wfReadOnly() ) {
1687 $this->mTouched
= self
::newTouchedTimestamp();
1689 $dbw = wfGetDB( DB_MASTER
);
1690 $dbw->update( 'user',
1691 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1692 array( 'user_id' => $this->mId
),
1695 $this->clearSharedCache();
1700 * Validate the cache for this account.
1701 * @param $timestamp \string A timestamp in TS_MW format
1703 function validateCache( $timestamp ) {
1705 return ( $timestamp >= $this->mTouched
);
1709 * Get the user touched timestamp
1711 function getTouched() {
1713 return $this->mTouched
;
1717 * Set the password and reset the random token.
1718 * Calls through to authentication plugin if necessary;
1719 * will have no effect if the auth plugin refuses to
1720 * pass the change through or if the legal password
1723 * As a special case, setting the password to null
1724 * wipes it, so the account cannot be logged in until
1725 * a new password is set, for instance via e-mail.
1727 * @param $str \string New password to set
1728 * @throws PasswordError on failure
1730 function setPassword( $str ) {
1733 if( $str !== null ) {
1734 if( !$wgAuth->allowPasswordChange() ) {
1735 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1738 $valid = $this->isValidPassword( $str );
1739 if( $valid !== true ) {
1740 global $wgMinimalPasswordLength;
1741 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1742 $wgMinimalPasswordLength ) );
1746 if( !$wgAuth->setPassword( $this, $str ) ) {
1747 throw new PasswordError( wfMsg( 'externaldberror' ) );
1750 $this->setInternalPassword( $str );
1756 * Set the password and reset the random token unconditionally.
1758 * @param $str \string New password to set
1760 function setInternalPassword( $str ) {
1764 if( $str === null ) {
1765 // Save an invalid hash...
1766 $this->mPassword
= '';
1768 $this->mPassword
= self
::crypt( $str );
1770 $this->mNewpassword
= '';
1771 $this->mNewpassTime
= null;
1775 * Get the user's current token.
1776 * @return \string Token
1778 function getToken() {
1780 return $this->mToken
;
1784 * Set the random token (used for persistent authentication)
1785 * Called from loadDefaults() among other places.
1787 * @param $token \string If specified, set the token to this value
1790 function setToken( $token = false ) {
1791 global $wgSecretKey, $wgProxyKey;
1794 if ( $wgSecretKey ) {
1795 $key = $wgSecretKey;
1796 } elseif ( $wgProxyKey ) {
1801 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1803 $this->mToken
= $token;
1808 * Set the cookie password
1810 * @param $str \string New cookie password
1813 function setCookiePassword( $str ) {
1815 $this->mCookiePassword
= md5( $str );
1819 * Set the password for a password reminder or new account email
1821 * @param $str \string New password to set
1822 * @param $throttle \bool If true, reset the throttle timestamp to the present
1824 function setNewpassword( $str, $throttle = true ) {
1826 $this->mNewpassword
= self
::crypt( $str );
1828 $this->mNewpassTime
= wfTimestampNow();
1833 * Has password reminder email been sent within the last
1834 * $wgPasswordReminderResendTime hours?
1835 * @return \bool True or false
1837 function isPasswordReminderThrottled() {
1838 global $wgPasswordReminderResendTime;
1840 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1843 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1844 return time() < $expiry;
1848 * Get the user's e-mail address
1849 * @return \string User's email address
1851 function getEmail() {
1853 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1854 return $this->mEmail
;
1858 * Get the timestamp of the user's e-mail authentication
1859 * @return \string TS_MW timestamp
1861 function getEmailAuthenticationTimestamp() {
1863 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1864 return $this->mEmailAuthenticated
;
1868 * Set the user's e-mail address
1869 * @param $str \string New e-mail address
1871 function setEmail( $str ) {
1873 $this->mEmail
= $str;
1874 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1878 * Get the user's real name
1879 * @return \string User's real name
1881 function getRealName() {
1883 return $this->mRealName
;
1887 * Set the user's real name
1888 * @param $str \string New real name
1890 function setRealName( $str ) {
1892 $this->mRealName
= $str;
1896 * Get the user's current setting for a given option.
1898 * @param $oname \string The option to check
1899 * @param $defaultOverride \string A default value returned if the option does not exist
1900 * @return \string User's current value for the option
1901 * @see getBoolOption()
1902 * @see getIntOption()
1904 function getOption( $oname, $defaultOverride = null ) {
1905 $this->loadOptions();
1907 if ( is_null( $this->mOptions
) ) {
1908 if($defaultOverride != '') {
1909 return $defaultOverride;
1911 $this->mOptions
= User
::getDefaultOptions();
1914 if ( array_key_exists( $oname, $this->mOptions
) ) {
1915 return $this->mOptions
[$oname];
1917 return $defaultOverride;
1922 * Get the user's current setting for a given option, as a boolean value.
1924 * @param $oname \string The option to check
1925 * @return \bool User's current value for the option
1928 function getBoolOption( $oname ) {
1929 return (bool)$this->getOption( $oname );
1934 * Get the user's current setting for a given option, as a boolean value.
1936 * @param $oname \string The option to check
1937 * @param $defaultOverride \int A default value returned if the option does not exist
1938 * @return \int User's current value for the option
1941 function getIntOption( $oname, $defaultOverride=0 ) {
1942 $val = $this->getOption( $oname );
1944 $val = $defaultOverride;
1946 return intval( $val );
1950 * Set the given option for a user.
1952 * @param $oname \string The option to set
1953 * @param $val \mixed New value to set
1955 function setOption( $oname, $val ) {
1957 $this->loadOptions();
1959 if ( $oname == 'skin' ) {
1960 # Clear cached skin, so the new one displays immediately in Special:Preferences
1961 unset( $this->mSkin
);
1964 // Explicitly NULL values should refer to defaults
1965 global $wgDefaultUserOptions;
1966 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
1967 $val = $wgDefaultUserOptions[$oname];
1970 $this->mOptions
[$oname] = $val;
1974 * Reset all options to the site defaults
1976 function resetOptions() {
1977 $this->mOptions
= User
::getDefaultOptions();
1981 * Get the user's preferred date format.
1982 * @return \string User's preferred date format
1984 function getDatePreference() {
1985 // Important migration for old data rows
1986 if ( is_null( $this->mDatePreference
) ) {
1988 $value = $this->getOption( 'date' );
1989 $map = $wgLang->getDatePreferenceMigrationMap();
1990 if ( isset( $map[$value] ) ) {
1991 $value = $map[$value];
1993 $this->mDatePreference
= $value;
1995 return $this->mDatePreference
;
1999 * Get the permissions this user has.
2000 * @return \type{\arrayof{\string}} Array of permission names
2002 function getRights() {
2003 if ( is_null( $this->mRights
) ) {
2004 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2005 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2006 // Force reindexation of rights when a hook has unset one of them
2007 $this->mRights
= array_values( $this->mRights
);
2009 return $this->mRights
;
2013 * Get the list of explicit group memberships this user has.
2014 * The implicit * and user groups are not included.
2015 * @return \type{\arrayof{\string}} Array of internal group names
2017 function getGroups() {
2019 return $this->mGroups
;
2023 * Get the list of implicit group memberships this user has.
2024 * This includes all explicit groups, plus 'user' if logged in,
2025 * '*' for all accounts and autopromoted groups
2026 * @param $recache \bool Whether to avoid the cache
2027 * @return \type{\arrayof{\string}} Array of internal group names
2029 function getEffectiveGroups( $recache = false ) {
2030 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2031 $this->mEffectiveGroups
= $this->getGroups();
2032 $this->mEffectiveGroups
[] = '*';
2033 if( $this->getId() ) {
2034 $this->mEffectiveGroups
[] = 'user';
2036 $this->mEffectiveGroups
= array_unique( array_merge(
2037 $this->mEffectiveGroups
,
2038 Autopromote
::getAutopromoteGroups( $this )
2041 # Hook for additional groups
2042 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2045 return $this->mEffectiveGroups
;
2049 * Get the user's edit count.
2050 * @return \int User'e edit count
2052 function getEditCount() {
2053 if( $this->getId() ) {
2054 if ( !isset( $this->mEditCount
) ) {
2055 /* Populate the count, if it has not been populated yet */
2056 $this->mEditCount
= User
::edits( $this->mId
);
2058 return $this->mEditCount
;
2066 * Add the user to the given group.
2067 * This takes immediate effect.
2068 * @param $group \string Name of the group to add
2070 function addGroup( $group ) {
2071 $dbw = wfGetDB( DB_MASTER
);
2072 if( $this->getId() ) {
2073 $dbw->insert( 'user_groups',
2075 'ug_user' => $this->getID(),
2076 'ug_group' => $group,
2079 array( 'IGNORE' ) );
2082 $this->loadGroups();
2083 $this->mGroups
[] = $group;
2084 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2086 $this->invalidateCache();
2090 * Remove the user from the given group.
2091 * This takes immediate effect.
2092 * @param $group \string Name of the group to remove
2094 function removeGroup( $group ) {
2096 $dbw = wfGetDB( DB_MASTER
);
2097 $dbw->delete( 'user_groups',
2099 'ug_user' => $this->getID(),
2100 'ug_group' => $group,
2102 'User::removeGroup' );
2104 $this->loadGroups();
2105 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2106 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2108 $this->invalidateCache();
2112 * Get whether the user is logged in
2113 * @return \bool True or false
2115 function isLoggedIn() {
2116 return $this->getID() != 0;
2120 * Get whether the user is anonymous
2121 * @return \bool True or false
2124 return !$this->isLoggedIn();
2128 * Get whether the user is a bot
2129 * @return \bool True or false
2133 wfDeprecated( __METHOD__
);
2134 return $this->isAllowed( 'bot' );
2138 * Check if user is allowed to access a feature / make an action
2139 * @param $action \string action to be checked
2140 * @return \bool True if action is allowed, else false
2142 function isAllowed( $action = '' ) {
2143 if ( $action === '' )
2144 return true; // In the spirit of DWIM
2145 # Patrolling may not be enabled
2146 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2147 global $wgUseRCPatrol, $wgUseNPPatrol;
2148 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2151 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2152 # by misconfiguration: 0 == 'foo'
2153 return in_array( $action, $this->getRights(), true );
2157 * Check whether to enable recent changes patrol features for this user
2158 * @return \bool True or false
2160 public function useRCPatrol() {
2161 global $wgUseRCPatrol;
2162 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2166 * Check whether to enable new pages patrol features for this user
2167 * @return \bool True or false
2169 public function useNPPatrol() {
2170 global $wgUseRCPatrol, $wgUseNPPatrol;
2171 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2175 * Get the current skin, loading it if required, and setting a title
2176 * @param $t Title: the title to use in the skin
2177 * @return Skin The current skin
2178 * @todo FIXME : need to check the old failback system [AV]
2180 function &getSkin( $t = null ) {
2181 if ( !isset( $this->mSkin
) ) {
2182 wfProfileIn( __METHOD__
);
2184 global $wgHiddenPrefs;
2185 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2188 $userSkin = $this->getOption( 'skin' );
2189 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2191 # if we're not allowing users to override, then use the default
2192 global $wgDefaultSkin;
2193 $userSkin = $wgDefaultSkin;
2196 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2197 wfProfileOut( __METHOD__
);
2199 if( $t ||
!$this->mSkin
->getTitle() ) {
2202 $t = $wgOut->getTitle();
2204 $this->mSkin
->setTitle( $t );
2206 return $this->mSkin
;
2210 * Check the watched status of an article.
2211 * @param $title \type{Title} Title of the article to look at
2212 * @return \bool True if article is watched
2214 function isWatched( $title ) {
2215 $wl = WatchedItem
::fromUserTitle( $this, $title );
2216 return $wl->isWatched();
2221 * @param $title \type{Title} Title of the article to look at
2223 function addWatch( $title ) {
2224 $wl = WatchedItem
::fromUserTitle( $this, $title );
2226 $this->invalidateCache();
2230 * Stop watching an article.
2231 * @param $title \type{Title} Title of the article to look at
2233 function removeWatch( $title ) {
2234 $wl = WatchedItem
::fromUserTitle( $this, $title );
2236 $this->invalidateCache();
2240 * Clear the user's notification timestamp for the given title.
2241 * If e-notif e-mails are on, they will receive notification mails on
2242 * the next change of the page if it's watched etc.
2243 * @param $title \type{Title} Title of the article to look at
2245 function clearNotification( &$title ) {
2246 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2248 # Do nothing if the database is locked to writes
2249 if( wfReadOnly() ) {
2253 if( $title->getNamespace() == NS_USER_TALK
&&
2254 $title->getText() == $this->getName() ) {
2255 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2257 $this->setNewtalk( false );
2260 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2264 if( $this->isAnon() ) {
2265 // Nothing else to do...
2269 // Only update the timestamp if the page is being watched.
2270 // The query to find out if it is watched is cached both in memcached and per-invocation,
2271 // and when it does have to be executed, it can be on a slave
2272 // If this is the user's newtalk page, we always update the timestamp
2273 if( $title->getNamespace() == NS_USER_TALK
&&
2274 $title->getText() == $wgUser->getName() )
2277 } elseif ( $this->getId() == $wgUser->getId() ) {
2278 $watched = $title->userIsWatching();
2283 // If the page is watched by the user (or may be watched), update the timestamp on any
2284 // any matching rows
2286 $dbw = wfGetDB( DB_MASTER
);
2287 $dbw->update( 'watchlist',
2289 'wl_notificationtimestamp' => NULL
2290 ), array( /* WHERE */
2291 'wl_title' => $title->getDBkey(),
2292 'wl_namespace' => $title->getNamespace(),
2293 'wl_user' => $this->getID()
2300 * Resets all of the given user's page-change notification timestamps.
2301 * If e-notif e-mails are on, they will receive notification mails on
2302 * the next change of any watched page.
2304 * @param $currentUser \int User ID
2306 function clearAllNotifications( $currentUser ) {
2307 global $wgUseEnotif, $wgShowUpdatedMarker;
2308 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2309 $this->setNewtalk( false );
2312 if( $currentUser != 0 ) {
2313 $dbw = wfGetDB( DB_MASTER
);
2314 $dbw->update( 'watchlist',
2316 'wl_notificationtimestamp' => NULL
2317 ), array( /* WHERE */
2318 'wl_user' => $currentUser
2321 # We also need to clear here the "you have new message" notification for the own user_talk page
2322 # This is cleared one page view later in Article::viewUpdates();
2327 * Set this user's options from an encoded string
2328 * @param $str \string Encoded options to import
2331 function decodeOptions( $str ) {
2335 $this->mOptionsLoaded
= true;
2336 $this->mOptionOverrides
= array();
2338 $this->mOptions
= array();
2339 $a = explode( "\n", $str );
2340 foreach ( $a as $s ) {
2342 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2343 $this->mOptions
[$m[1]] = $m[2];
2344 $this->mOptionOverrides
[$m[1]] = $m[2];
2350 * Set a cookie on the user's client. Wrapper for
2351 * WebResponse::setCookie
2352 * @param $name \string Name of the cookie to set
2353 * @param $value \string Value to set
2354 * @param $exp \int Expiration time, as a UNIX time value;
2355 * if 0 or not specified, use the default $wgCookieExpiration
2357 protected function setCookie( $name, $value, $exp = 0 ) {
2359 $wgRequest->response()->setcookie( $name, $value, $exp );
2363 * Clear a cookie on the user's client
2364 * @param $name \string Name of the cookie to clear
2366 protected function clearCookie( $name ) {
2367 $this->setCookie( $name, '', time() - 86400 );
2371 * Set the default cookies for this session on the user's client.
2373 function setCookies() {
2375 if ( 0 == $this->mId
) return;
2377 'wsUserID' => $this->mId
,
2378 'wsToken' => $this->mToken
,
2379 'wsUserName' => $this->getName()
2382 'UserID' => $this->mId
,
2383 'UserName' => $this->getName(),
2385 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2386 $cookies['Token'] = $this->mToken
;
2388 $cookies['Token'] = false;
2391 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2392 #check for null, since the hook could cause a null value
2393 if ( !is_null( $session ) && isset( $_SESSION ) ){
2394 $_SESSION = $session +
$_SESSION;
2396 foreach ( $cookies as $name => $value ) {
2397 if ( $value === false ) {
2398 $this->clearCookie( $name );
2400 $this->setCookie( $name, $value );
2406 * Log this user out.
2409 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2415 * Clear the user's cookies and session, and reset the instance cache.
2419 function doLogout() {
2420 $this->clearInstanceCache( 'defaults' );
2422 $_SESSION['wsUserID'] = 0;
2424 $this->clearCookie( 'UserID' );
2425 $this->clearCookie( 'Token' );
2427 # Remember when user logged out, to prevent seeing cached pages
2428 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2432 * Save this user's settings into the database.
2433 * @todo Only rarely do all these fields need to be set!
2435 function saveSettings() {
2437 if ( wfReadOnly() ) { return; }
2438 if ( 0 == $this->mId
) { return; }
2440 $this->mTouched
= self
::newTouchedTimestamp();
2442 $dbw = wfGetDB( DB_MASTER
);
2443 $dbw->update( 'user',
2445 'user_name' => $this->mName
,
2446 'user_password' => $this->mPassword
,
2447 'user_newpassword' => $this->mNewpassword
,
2448 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2449 'user_real_name' => $this->mRealName
,
2450 'user_email' => $this->mEmail
,
2451 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2452 'user_options' => '',
2453 'user_touched' => $dbw->timestamp( $this->mTouched
),
2454 'user_token' => $this->mToken
,
2455 'user_email_token' => $this->mEmailToken
,
2456 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2457 ), array( /* WHERE */
2458 'user_id' => $this->mId
2462 $this->saveOptions();
2464 wfRunHooks( 'UserSaveSettings', array( $this ) );
2465 $this->clearSharedCache();
2466 $this->getUserPage()->invalidateCache();
2470 * If only this user's username is known, and it exists, return the user ID.
2472 function idForName() {
2473 $s = trim( $this->getName() );
2474 if ( $s === '' ) return 0;
2476 $dbr = wfGetDB( DB_SLAVE
);
2477 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2478 if ( $id === false ) {
2485 * Add a user to the database, return the user object
2487 * @param $name \string Username to add
2488 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2489 * - password The user's password. Password logins will be disabled if this is omitted.
2490 * - newpassword A temporary password mailed to the user
2491 * - email The user's email address
2492 * - email_authenticated The email authentication timestamp
2493 * - real_name The user's real name
2494 * - options An associative array of non-default options
2495 * - token Random authentication token. Do not set.
2496 * - registration Registration timestamp. Do not set.
2498 * @return \type{User} A new User object, or null if the username already exists
2500 static function createNew( $name, $params = array() ) {
2503 if ( isset( $params['options'] ) ) {
2504 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2505 unset( $params['options'] );
2507 $dbw = wfGetDB( DB_MASTER
);
2508 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2510 'user_id' => $seqVal,
2511 'user_name' => $name,
2512 'user_password' => $user->mPassword
,
2513 'user_newpassword' => $user->mNewpassword
,
2514 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2515 'user_email' => $user->mEmail
,
2516 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2517 'user_real_name' => $user->mRealName
,
2518 'user_options' => '',
2519 'user_token' => $user->mToken
,
2520 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2521 'user_editcount' => 0,
2523 foreach ( $params as $name => $value ) {
2524 $fields["user_$name"] = $value;
2526 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2527 if ( $dbw->affectedRows() ) {
2528 $newUser = User
::newFromId( $dbw->insertId() );
2536 * Add this existing user object to the database
2538 function addToDatabase() {
2540 $dbw = wfGetDB( DB_MASTER
);
2541 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2542 $dbw->insert( 'user',
2544 'user_id' => $seqVal,
2545 'user_name' => $this->mName
,
2546 'user_password' => $this->mPassword
,
2547 'user_newpassword' => $this->mNewpassword
,
2548 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2549 'user_email' => $this->mEmail
,
2550 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2551 'user_real_name' => $this->mRealName
,
2552 'user_options' => '',
2553 'user_token' => $this->mToken
,
2554 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2555 'user_editcount' => 0,
2558 $this->mId
= $dbw->insertId();
2560 // Clear instance cache other than user table data, which is already accurate
2561 $this->clearInstanceCache();
2563 $this->saveOptions();
2567 * If this (non-anonymous) user is blocked, block any IP address
2568 * they've successfully logged in from.
2570 function spreadBlock() {
2571 wfDebug( __METHOD__
. "()\n" );
2573 if ( $this->mId
== 0 ) {
2577 $userblock = Block
::newFromDB( '', $this->mId
);
2578 if ( !$userblock ) {
2582 $userblock->doAutoblock( wfGetIP() );
2586 * Generate a string which will be different for any combination of
2587 * user options which would produce different parser output.
2588 * This will be used as part of the hash key for the parser cache,
2589 * so users will the same options can share the same cached data
2592 * Extensions which require it should install 'PageRenderingHash' hook,
2593 * which will give them a chance to modify this key based on their own
2596 * @return \string Page rendering hash
2598 function getPageRenderingHash() {
2599 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2601 return $this->mHash
;
2604 // stubthreshold is only included below for completeness,
2605 // it will always be 0 when this function is called by parsercache.
2607 $confstr = $this->getOption( 'math' );
2608 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2609 if ( $wgUseDynamicDates ) {
2610 $confstr .= '!' . $this->getDatePreference();
2612 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2613 $confstr .= '!' . $wgLang->getCode();
2614 $confstr .= '!' . $this->getOption( 'thumbsize' );
2615 // add in language specific options, if any
2616 $extra = $wgContLang->getExtraHashOptions();
2619 $confstr .= $wgRenderHashAppend;
2621 // Give a chance for extensions to modify the hash, if they have
2622 // extra options or other effects on the parser cache.
2623 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2625 // Make it a valid memcached key fragment
2626 $confstr = str_replace( ' ', '_', $confstr );
2627 $this->mHash
= $confstr;
2632 * Get whether the user is explicitly blocked from account creation.
2633 * @return \bool True if blocked
2635 function isBlockedFromCreateAccount() {
2636 $this->getBlockedStatus();
2637 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2641 * Get whether the user is blocked from using Special:Emailuser.
2642 * @return \bool True if blocked
2644 function isBlockedFromEmailuser() {
2645 $this->getBlockedStatus();
2646 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2650 * Get whether the user is allowed to create an account.
2651 * @return \bool True if allowed
2653 function isAllowedToCreateAccount() {
2654 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2660 function setLoaded( $loaded ) {
2661 wfDeprecated( __METHOD__
);
2665 * Get this user's personal page title.
2667 * @return \type{Title} User's personal page title
2669 function getUserPage() {
2670 return Title
::makeTitle( NS_USER
, $this->getName() );
2674 * Get this user's talk page title.
2676 * @return \type{Title} User's talk page title
2678 function getTalkPage() {
2679 $title = $this->getUserPage();
2680 return $title->getTalkPage();
2684 * Get the maximum valid user ID.
2685 * @return \int User ID
2688 function getMaxID() {
2689 static $res; // cache
2691 if ( isset( $res ) )
2694 $dbr = wfGetDB( DB_SLAVE
);
2695 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2700 * Determine whether the user is a newbie. Newbies are either
2701 * anonymous IPs, or the most recently created accounts.
2702 * @return \bool True if the user is a newbie
2704 function isNewbie() {
2705 return !$this->isAllowed( 'autoconfirmed' );
2709 * Check to see if the given clear-text password is one of the accepted passwords
2710 * @param $password \string user password.
2711 * @return \bool True if the given password is correct, otherwise False.
2713 function checkPassword( $password ) {
2717 // Even though we stop people from creating passwords that
2718 // are shorter than this, doesn't mean people wont be able
2719 // to. Certain authentication plugins do NOT want to save
2720 // domain passwords in a mysql database, so we should
2721 // check this (incase $wgAuth->strict() is false).
2722 if( $this->isValidPassword( $password ) !== true ) {
2726 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2728 } elseif( $wgAuth->strict() ) {
2729 /* Auth plugin doesn't allow local authentication */
2731 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2732 /* Auth plugin doesn't allow local authentication for this user name */
2735 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2737 } elseif ( function_exists( 'iconv' ) ) {
2738 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2739 # Check for this with iconv
2740 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2741 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2749 * Check if the given clear-text password matches the temporary password
2750 * sent by e-mail for password reset operations.
2751 * @return \bool True if matches, false otherwise
2753 function checkTemporaryPassword( $plaintext ) {
2754 global $wgNewPasswordExpiry;
2755 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2757 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2758 return ( time() < $expiry );
2765 * Initialize (if necessary) and return a session token value
2766 * which can be used in edit forms to show that the user's
2767 * login credentials aren't being hijacked with a foreign form
2770 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2771 * @return \string The new edit token
2773 function editToken( $salt = '' ) {
2774 if ( $this->isAnon() ) {
2775 return EDIT_TOKEN_SUFFIX
;
2777 if( !isset( $_SESSION['wsEditToken'] ) ) {
2778 $token = $this->generateToken();
2779 $_SESSION['wsEditToken'] = $token;
2781 $token = $_SESSION['wsEditToken'];
2783 if( is_array( $salt ) ) {
2784 $salt = implode( '|', $salt );
2786 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2791 * Generate a looking random token for various uses.
2793 * @param $salt \string Optional salt value
2794 * @return \string The new random token
2796 function generateToken( $salt = '' ) {
2797 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2798 return md5( $token . $salt );
2802 * Check given value against the token value stored in the session.
2803 * A match should confirm that the form was submitted from the
2804 * user's own login session, not a form submission from a third-party
2807 * @param $val \string Input value to compare
2808 * @param $salt \string Optional function-specific data for hashing
2809 * @return \bool Whether the token matches
2811 function matchEditToken( $val, $salt = '' ) {
2812 $sessionToken = $this->editToken( $salt );
2813 if ( $val != $sessionToken ) {
2814 wfDebug( "User::matchEditToken: broken session data\n" );
2816 return $val == $sessionToken;
2820 * Check given value against the token value stored in the session,
2821 * ignoring the suffix.
2823 * @param $val \string Input value to compare
2824 * @param $salt \string Optional function-specific data for hashing
2825 * @return \bool Whether the token matches
2827 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2828 $sessionToken = $this->editToken( $salt );
2829 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2833 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2834 * mail to the user's given address.
2836 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2838 function sendConfirmationMail() {
2840 $expiration = null; // gets passed-by-ref and defined in next line.
2841 $token = $this->confirmationToken( $expiration );
2842 $url = $this->confirmationTokenUrl( $token );
2843 $invalidateURL = $this->invalidationTokenUrl( $token );
2844 $this->saveSettings();
2846 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2847 wfMsg( 'confirmemail_body',
2851 $wgLang->timeanddate( $expiration, false ),
2853 $wgLang->date( $expiration, false ),
2854 $wgLang->time( $expiration, false ) ) );
2858 * Send an e-mail to this user's account. Does not check for
2859 * confirmed status or validity.
2861 * @param $subject \string Message subject
2862 * @param $body \string Message body
2863 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2864 * @param $replyto \string Reply-To address
2865 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2867 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2868 if( is_null( $from ) ) {
2869 global $wgPasswordSender;
2870 $from = $wgPasswordSender;
2873 $to = new MailAddress( $this );
2874 $sender = new MailAddress( $from );
2875 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2879 * Generate, store, and return a new e-mail confirmation code.
2880 * A hash (unsalted, since it's used as a key) is stored.
2882 * @note Call saveSettings() after calling this function to commit
2883 * this change to the database.
2885 * @param[out] &$expiration \mixed Accepts the expiration time
2886 * @return \string New token
2889 function confirmationToken( &$expiration ) {
2891 $expires = $now +
7 * 24 * 60 * 60;
2892 $expiration = wfTimestamp( TS_MW
, $expires );
2893 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2894 $hash = md5( $token );
2896 $this->mEmailToken
= $hash;
2897 $this->mEmailTokenExpires
= $expiration;
2902 * Return a URL the user can use to confirm their email address.
2903 * @param $token \string Accepts the email confirmation token
2904 * @return \string New token URL
2907 function confirmationTokenUrl( $token ) {
2908 return $this->getTokenUrl( 'ConfirmEmail', $token );
2912 * Return a URL the user can use to invalidate their email address.
2913 * @param $token \string Accepts the email confirmation token
2914 * @return \string New token URL
2917 function invalidationTokenUrl( $token ) {
2918 return $this->getTokenUrl( 'Invalidateemail', $token );
2922 * Internal function to format the e-mail validation/invalidation URLs.
2923 * This uses $wgArticlePath directly as a quickie hack to use the
2924 * hardcoded English names of the Special: pages, for ASCII safety.
2926 * @note Since these URLs get dropped directly into emails, using the
2927 * short English names avoids insanely long URL-encoded links, which
2928 * also sometimes can get corrupted in some browsers/mailers
2929 * (bug 6957 with Gmail and Internet Explorer).
2931 * @param $page \string Special page
2932 * @param $token \string Token
2933 * @return \string Formatted URL
2935 protected function getTokenUrl( $page, $token ) {
2936 global $wgArticlePath;
2940 "Special:$page/$token",
2945 * Mark the e-mail address confirmed.
2947 * @note Call saveSettings() after calling this function to commit the change.
2949 function confirmEmail() {
2950 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2951 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
2956 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2957 * address if it was already confirmed.
2959 * @note Call saveSettings() after calling this function to commit the change.
2961 function invalidateEmail() {
2963 $this->mEmailToken
= null;
2964 $this->mEmailTokenExpires
= null;
2965 $this->setEmailAuthenticationTimestamp( null );
2966 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
2971 * Set the e-mail authentication timestamp.
2972 * @param $timestamp \string TS_MW timestamp
2974 function setEmailAuthenticationTimestamp( $timestamp ) {
2976 $this->mEmailAuthenticated
= $timestamp;
2977 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2981 * Is this user allowed to send e-mails within limits of current
2982 * site configuration?
2983 * @return \bool True if allowed
2985 function canSendEmail() {
2986 global $wgEnableEmail, $wgEnableUserEmail, $wgUser;
2987 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$wgUser->isAllowed( 'sendemail' ) ) {
2990 $canSend = $this->isEmailConfirmed();
2991 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
2996 * Is this user allowed to receive e-mails within limits of current
2997 * site configuration?
2998 * @return \bool True if allowed
3000 function canReceiveEmail() {
3001 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3005 * Is this user's e-mail address valid-looking and confirmed within
3006 * limits of the current site configuration?
3008 * @note If $wgEmailAuthentication is on, this may require the user to have
3009 * confirmed their address by returning a code or using a password
3010 * sent to the address from the wiki.
3012 * @return \bool True if confirmed
3014 function isEmailConfirmed() {
3015 global $wgEmailAuthentication;
3018 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3019 if( $this->isAnon() )
3021 if( !self
::isValidEmailAddr( $this->mEmail
) )
3023 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3032 * Check whether there is an outstanding request for e-mail confirmation.
3033 * @return \bool True if pending
3035 function isEmailConfirmationPending() {
3036 global $wgEmailAuthentication;
3037 return $wgEmailAuthentication &&
3038 !$this->isEmailConfirmed() &&
3039 $this->mEmailToken
&&
3040 $this->mEmailTokenExpires
> wfTimestamp();
3044 * Get the timestamp of account creation.
3046 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3047 * non-existent/anonymous user accounts.
3049 public function getRegistration() {
3050 return $this->getId() > 0
3051 ?
$this->mRegistration
3056 * Get the timestamp of the first edit
3058 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3059 * non-existent/anonymous user accounts.
3061 public function getFirstEditTimestamp() {
3062 if( $this->getId() == 0 ) return false; // anons
3063 $dbr = wfGetDB( DB_SLAVE
);
3064 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3065 array( 'rev_user' => $this->getId() ),
3067 array( 'ORDER BY' => 'rev_timestamp ASC' )
3069 if( !$time ) return false; // no edits
3070 return wfTimestamp( TS_MW
, $time );
3074 * Get the permissions associated with a given list of groups
3076 * @param $groups \type{\arrayof{\string}} List of internal group names
3077 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3079 static function getGroupPermissions( $groups ) {
3080 global $wgGroupPermissions, $wgRevokePermissions;
3082 // grant every granted permission first
3083 foreach( $groups as $group ) {
3084 if( isset( $wgGroupPermissions[$group] ) ) {
3085 $rights = array_merge( $rights,
3086 // array_filter removes empty items
3087 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3090 // now revoke the revoked permissions
3091 foreach( $groups as $group ) {
3092 if( isset( $wgRevokePermissions[$group] ) ) {
3093 $rights = array_diff( $rights,
3094 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3097 return array_unique( $rights );
3101 * Get all the groups who have a given permission
3103 * @param $role \string Role to check
3104 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3106 static function getGroupsWithPermission( $role ) {
3107 global $wgGroupPermissions;
3108 $allowedGroups = array();
3109 foreach ( $wgGroupPermissions as $group => $rights ) {
3110 if ( isset( $rights[$role] ) && $rights[$role] ) {
3111 $allowedGroups[] = $group;
3114 return $allowedGroups;
3118 * Get the localized descriptive name for a group, if it exists
3120 * @param $group \string Internal group name
3121 * @return \string Localized descriptive group name
3123 static function getGroupName( $group ) {
3124 global $wgMessageCache;
3125 $wgMessageCache->loadAllMessages();
3126 $key = "group-$group";
3127 $name = wfMsg( $key );
3128 return $name == '' ||
wfEmptyMsg( $key, $name )
3134 * Get the localized descriptive name for a member of a group, if it exists
3136 * @param $group \string Internal group name
3137 * @return \string Localized name for group member
3139 static function getGroupMember( $group ) {
3140 global $wgMessageCache;
3141 $wgMessageCache->loadAllMessages();
3142 $key = "group-$group-member";
3143 $name = wfMsg( $key );
3144 return $name == '' ||
wfEmptyMsg( $key, $name )
3150 * Return the set of defined explicit groups.
3151 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3152 * are not included, as they are defined automatically, not in the database.
3153 * @return \type{\arrayof{\string}} Array of internal group names
3155 static function getAllGroups() {
3156 global $wgGroupPermissions, $wgRevokePermissions;
3158 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3159 self
::getImplicitGroups()
3164 * Get a list of all available permissions.
3165 * @return \type{\arrayof{\string}} Array of permission names
3167 static function getAllRights() {
3168 if ( self
::$mAllRights === false ) {
3169 global $wgAvailableRights;
3170 if ( count( $wgAvailableRights ) ) {
3171 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3173 self
::$mAllRights = self
::$mCoreRights;
3175 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3177 return self
::$mAllRights;
3181 * Get a list of implicit groups
3182 * @return \type{\arrayof{\string}} Array of internal group names
3184 public static function getImplicitGroups() {
3185 global $wgImplicitGroups;
3186 $groups = $wgImplicitGroups;
3187 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3192 * Get the title of a page describing a particular group
3194 * @param $group \string Internal group name
3195 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3197 static function getGroupPage( $group ) {
3198 global $wgMessageCache;
3199 $wgMessageCache->loadAllMessages();
3200 $page = wfMsgForContent( 'grouppage-' . $group );
3201 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3202 $title = Title
::newFromText( $page );
3203 if( is_object( $title ) )
3210 * Create a link to the group in HTML, if available;
3211 * else return the group name.
3213 * @param $group \string Internal name of the group
3214 * @param $text \string The text of the link
3215 * @return \string HTML link to the group
3217 static function makeGroupLinkHTML( $group, $text = '' ) {
3219 $text = self
::getGroupName( $group );
3221 $title = self
::getGroupPage( $group );
3224 $sk = $wgUser->getSkin();
3225 return $sk->link( $title, htmlspecialchars( $text ) );
3232 * Create a link to the group in Wikitext, if available;
3233 * else return the group name.
3235 * @param $group \string Internal name of the group
3236 * @param $text \string The text of the link
3237 * @return \string Wikilink to the group
3239 static function makeGroupLinkWiki( $group, $text = '' ) {
3241 $text = self
::getGroupName( $group );
3243 $title = self
::getGroupPage( $group );
3245 $page = $title->getPrefixedText();
3246 return "[[$page|$text]]";
3253 * Returns an array of the groups that a particular group can add/remove.
3255 * @param $group String: the group to check for whether it can add/remove
3256 * @return Array array( 'add' => array( addablegroups ),
3257 * 'remove' => array( removablegroups ),
3258 * 'add-self' => array( addablegroups to self),
3259 * 'remove-self' => array( removable groups from self) )
3261 static function changeableByGroup( $group ) {
3262 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3264 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3265 if( empty( $wgAddGroups[$group] ) ) {
3266 // Don't add anything to $groups
3267 } elseif( $wgAddGroups[$group] === true ) {
3268 // You get everything
3269 $groups['add'] = self
::getAllGroups();
3270 } elseif( is_array( $wgAddGroups[$group] ) ) {
3271 $groups['add'] = $wgAddGroups[$group];
3274 // Same thing for remove
3275 if( empty( $wgRemoveGroups[$group] ) ) {
3276 } elseif( $wgRemoveGroups[$group] === true ) {
3277 $groups['remove'] = self
::getAllGroups();
3278 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3279 $groups['remove'] = $wgRemoveGroups[$group];
3282 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3283 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3284 foreach( $wgGroupsAddToSelf as $key => $value ) {
3285 if( is_int( $key ) ) {
3286 $wgGroupsAddToSelf['user'][] = $value;
3291 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3292 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3293 if( is_int( $key ) ) {
3294 $wgGroupsRemoveFromSelf['user'][] = $value;
3299 // Now figure out what groups the user can add to him/herself
3300 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3301 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3302 // No idea WHY this would be used, but it's there
3303 $groups['add-self'] = User
::getAllGroups();
3304 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3305 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3308 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3309 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3310 $groups['remove-self'] = User
::getAllGroups();
3311 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3312 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3319 * Returns an array of groups that this user can add and remove
3320 * @return Array array( 'add' => array( addablegroups ),
3321 * 'remove' => array( removablegroups ),
3322 * 'add-self' => array( addablegroups to self),
3323 * 'remove-self' => array( removable groups from self) )
3325 function changeableGroups() {
3326 if( $this->isAllowed( 'userrights' ) ) {
3327 // This group gives the right to modify everything (reverse-
3328 // compatibility with old "userrights lets you change
3330 // Using array_merge to make the groups reindexed
3331 $all = array_merge( User
::getAllGroups() );
3335 'add-self' => array(),
3336 'remove-self' => array()
3340 // Okay, it's not so simple, we will have to go through the arrays
3343 'remove' => array(),
3344 'add-self' => array(),
3345 'remove-self' => array()
3347 $addergroups = $this->getEffectiveGroups();
3349 foreach( $addergroups as $addergroup ) {
3350 $groups = array_merge_recursive(
3351 $groups, $this->changeableByGroup( $addergroup )
3353 $groups['add'] = array_unique( $groups['add'] );
3354 $groups['remove'] = array_unique( $groups['remove'] );
3355 $groups['add-self'] = array_unique( $groups['add-self'] );
3356 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3362 * Increment the user's edit-count field.
3363 * Will have no effect for anonymous users.
3365 function incEditCount() {
3366 if( !$this->isAnon() ) {
3367 $dbw = wfGetDB( DB_MASTER
);
3368 $dbw->update( 'user',
3369 array( 'user_editcount=user_editcount+1' ),
3370 array( 'user_id' => $this->getId() ),
3373 // Lazy initialization check...
3374 if( $dbw->affectedRows() == 0 ) {
3375 // Pull from a slave to be less cruel to servers
3376 // Accuracy isn't the point anyway here
3377 $dbr = wfGetDB( DB_SLAVE
);
3378 $count = $dbr->selectField( 'revision',
3380 array( 'rev_user' => $this->getId() ),
3383 // Now here's a goddamn hack...
3384 if( $dbr !== $dbw ) {
3385 // If we actually have a slave server, the count is
3386 // at least one behind because the current transaction
3387 // has not been committed and replicated.
3390 // But if DB_SLAVE is selecting the master, then the
3391 // count we just read includes the revision that was
3392 // just added in the working transaction.
3395 $dbw->update( 'user',
3396 array( 'user_editcount' => $count ),
3397 array( 'user_id' => $this->getId() ),
3401 // edit count in user cache too
3402 $this->invalidateCache();
3406 * Get the description of a given right
3408 * @param $right \string Right to query
3409 * @return \string Localized description of the right
3411 static function getRightDescription( $right ) {
3412 global $wgMessageCache;
3413 $wgMessageCache->loadAllMessages();
3414 $key = "right-$right";
3415 $name = wfMsg( $key );
3416 return $name == '' ||
wfEmptyMsg( $key, $name )
3422 * Make an old-style password hash
3424 * @param $password \string Plain-text password
3425 * @param $userId \string User ID
3426 * @return \string Password hash
3428 static function oldCrypt( $password, $userId ) {
3429 global $wgPasswordSalt;
3430 if ( $wgPasswordSalt ) {
3431 return md5( $userId . '-' . md5( $password ) );
3433 return md5( $password );
3438 * Make a new-style password hash
3440 * @param $password \string Plain-text password
3441 * @param $salt \string Optional salt, may be random or the user ID.
3442 * If unspecified or false, will generate one automatically
3443 * @return \string Password hash
3445 static function crypt( $password, $salt = false ) {
3446 global $wgPasswordSalt;
3449 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3453 if( $wgPasswordSalt ) {
3454 if ( $salt === false ) {
3455 $salt = substr( wfGenerateToken(), 0, 8 );
3457 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3459 return ':A:' . md5( $password );
3464 * Compare a password hash with a plain-text password. Requires the user
3465 * ID if there's a chance that the hash is an old-style hash.
3467 * @param $hash \string Password hash
3468 * @param $password \string Plain-text password to compare
3469 * @param $userId \string User ID for old-style password salt
3472 static function comparePasswords( $hash, $password, $userId = false ) {
3474 $type = substr( $hash, 0, 3 );
3477 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3481 if ( $type == ':A:' ) {
3483 return md5( $password ) === substr( $hash, 3 );
3484 } elseif ( $type == ':B:' ) {
3486 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3487 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3490 return self
::oldCrypt( $password, $userId ) === $hash;
3495 * Add a newuser log entry for this user
3496 * @param $byEmail Boolean: account made by email?
3498 public function addNewUserLogEntry( $byEmail = false ) {
3499 global $wgUser, $wgContLang, $wgNewUserLog;
3500 if( empty( $wgNewUserLog ) ) {
3501 return true; // disabled
3503 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3504 if( $this->getName() == $wgUser->getName() ) {
3508 $action = 'create2';
3510 ?
wfMsgForContent( 'newuserlog-byemail' )
3513 $log = new LogPage( 'newusers' );
3516 $this->getUserPage(),
3518 array( $this->getId() )
3524 * Add an autocreate newuser log entry for this user
3525 * Used by things like CentralAuth and perhaps other authplugins.
3527 public function addNewUserLogEntryAutoCreate() {
3528 global $wgNewUserLog;
3529 if( empty( $wgNewUserLog ) ) {
3530 return true; // disabled
3532 $log = new LogPage( 'newusers', false );
3533 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3537 protected function loadOptions() {
3539 if ( $this->mOptionsLoaded ||
!$this->getId() )
3542 $this->mOptions
= self
::getDefaultOptions();
3544 // Maybe load from the object
3545 if ( !is_null( $this->mOptionOverrides
) ) {
3546 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3547 foreach( $this->mOptionOverrides
as $key => $value ) {
3548 $this->mOptions
[$key] = $value;
3551 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3552 // Load from database
3553 $dbr = wfGetDB( DB_SLAVE
);
3555 $res = $dbr->select(
3558 array( 'up_user' => $this->getId() ),
3562 while( $row = $dbr->fetchObject( $res ) ) {
3563 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3564 $this->mOptions
[$row->up_property
] = $row->up_value
;
3568 $this->mOptionsLoaded
= true;
3570 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3573 protected function saveOptions() {
3574 global $wgAllowPrefChange;
3576 $extuser = ExternalUser
::newFromUser( $this );
3578 $this->loadOptions();
3579 $dbw = wfGetDB( DB_MASTER
);
3581 $insert_rows = array();
3583 $saveOptions = $this->mOptions
;
3585 // Allow hooks to abort, for instance to save to a global profile.
3586 // Reset options to default state before saving.
3587 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3590 foreach( $saveOptions as $key => $value ) {
3591 # Don't bother storing default values
3592 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3593 !( $value === false ||
is_null($value) ) ) ||
3594 $value != self
::getDefaultOption( $key ) ) {
3595 $insert_rows[] = array(
3596 'up_user' => $this->getId(),
3597 'up_property' => $key,
3598 'up_value' => $value,
3601 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3602 switch ( $wgAllowPrefChange[$key] ) {
3608 $extuser->setPref( $key, $value );
3614 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3615 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3620 * Provide an array of HTML 5 attributes to put on an input element
3621 * intended for the user to enter a new password. This may include
3622 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3624 * Do *not* use this when asking the user to enter his current password!
3625 * Regardless of configuration, users may have invalid passwords for whatever
3626 * reason (e.g., they were set before requirements were tightened up).
3627 * Only use it when asking for a new password, like on account creation or
3630 * Obviously, you still need to do server-side checking.
3632 * @return array Array of HTML attributes suitable for feeding to
3633 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3634 * That will potentially output invalid XHTML 1.0 Transitional, and will
3635 * get confused by the boolean attribute syntax used.)
3637 public static function passwordChangeInputAttribs() {
3638 global $wgMinimalPasswordLength;
3640 if ( $wgMinimalPasswordLength == 0 ) {
3644 # Note that the pattern requirement will always be satisfied if the
3645 # input is empty, so we need required in all cases.
3646 $ret = array( 'required' );
3648 # We can't actually do this right now, because Opera 9.6 will print out
3649 # the entered password visibly in its error message! When other
3650 # browsers add support for this attribute, or Opera fixes its support,
3651 # we can add support with a version check to avoid doing this on Opera
3652 # versions where it will be a problem. Reported to Opera as
3653 # DSK-262266, but they don't have a public bug tracker for us to follow.
3655 if ( $wgMinimalPasswordLength > 1 ) {
3656 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3657 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3658 $wgMinimalPasswordLength );