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 != $wgContLang->ucfirst( $name ) ) {
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 # Force usernames to capital
674 $name = $wgContLang->ucfirst( $name );
676 # Reject names containing '#'; these will be cleaned up
677 # with title normalisation, but then it's too late to
679 if( strpos( $name, '#' ) !== false )
682 # Clean up name according to title rules
683 $t = ( $validate === 'valid' ) ?
684 Title
::newFromText( $name ) : Title
::makeTitle( NS_USER
, $name );
685 # Check for invalid titles
686 if( is_null( $t ) ) {
690 # Reject various classes of invalid names
691 $name = $t->getText();
693 $name = $wgAuth->getCanonicalName( $t->getText() );
695 switch ( $validate ) {
699 if ( !User
::isValidUserName( $name ) ) {
704 if ( !User
::isUsableName( $name ) ) {
709 if ( !User
::isCreatableName( $name ) ) {
714 throw new MWException( 'Invalid parameter value for $validate in ' . __METHOD__
);
720 * Count the number of edits of a user
721 * @todo It should not be static and some day should be merged as proper member function / deprecated -- domas
723 * @param $uid \int User ID to check
724 * @return \int The user's edit count
726 static function edits( $uid ) {
727 wfProfileIn( __METHOD__
);
728 $dbr = wfGetDB( DB_SLAVE
);
729 // check if the user_editcount field has been initialized
730 $field = $dbr->selectField(
731 'user', 'user_editcount',
732 array( 'user_id' => $uid ),
736 if( $field === null ) { // it has not been initialized. do so.
737 $dbw = wfGetDB( DB_MASTER
);
738 $count = $dbr->selectField(
739 'revision', 'count(*)',
740 array( 'rev_user' => $uid ),
745 array( 'user_editcount' => $count ),
746 array( 'user_id' => $uid ),
752 wfProfileOut( __METHOD__
);
757 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
758 * @todo hash random numbers to improve security, like generateToken()
760 * @return \string New random password
762 static function randomPassword() {
763 global $wgMinimalPasswordLength;
764 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
765 $l = strlen( $pwchars ) - 1;
767 $pwlength = max( 7, $wgMinimalPasswordLength );
768 $digit = mt_rand( 0, $pwlength - 1 );
770 for ( $i = 0; $i < $pwlength; $i++
) {
771 $np .= $i == $digit ?
chr( mt_rand( 48, 57 ) ) : $pwchars{ mt_rand( 0, $l ) };
777 * Set cached properties to default.
779 * @note This no longer clears uncached lazy-initialised properties;
780 * the constructor does that instead.
783 function loadDefaults( $name = false ) {
784 wfProfileIn( __METHOD__
);
786 global $wgCookiePrefix;
789 $this->mName
= $name;
790 $this->mRealName
= '';
791 $this->mPassword
= $this->mNewpassword
= '';
792 $this->mNewpassTime
= null;
794 $this->mOptionOverrides
= null;
795 $this->mOptionsLoaded
= false;
797 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
798 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
800 $this->mTouched
= '0'; # Allow any pages to be cached
803 $this->setToken(); # Random
804 $this->mEmailAuthenticated
= null;
805 $this->mEmailToken
= '';
806 $this->mEmailTokenExpires
= null;
807 $this->mRegistration
= wfTimestamp( TS_MW
);
808 $this->mGroups
= array();
810 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
812 wfProfileOut( __METHOD__
);
816 * @deprecated Use wfSetupSession().
818 function SetupSession() {
819 wfDeprecated( __METHOD__
);
824 * Load user data from the session or login cookie. If there are no valid
825 * credentials, initialises the user as an anonymous user.
826 * @return \bool True if the user is logged in, false otherwise.
828 private function loadFromSession() {
829 global $wgMemc, $wgCookiePrefix;
832 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
833 if ( $result !== null ) {
837 if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
838 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
839 if( isset( $_SESSION['wsUserID'] ) && $sId != $_SESSION['wsUserID'] ) {
840 $this->loadDefaults(); // Possible collision!
841 wfDebugLog( 'loginSessions', "Session user ID ({$_SESSION['wsUserID']}) and
842 cookie user ID ($sId) don't match!" );
845 $_SESSION['wsUserID'] = $sId;
846 } else if ( isset( $_SESSION['wsUserID'] ) ) {
847 if ( $_SESSION['wsUserID'] != 0 ) {
848 $sId = $_SESSION['wsUserID'];
850 $this->loadDefaults();
854 $this->loadDefaults();
858 if ( isset( $_SESSION['wsUserName'] ) ) {
859 $sName = $_SESSION['wsUserName'];
860 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
861 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
862 $_SESSION['wsUserName'] = $sName;
864 $this->loadDefaults();
868 $passwordCorrect = FALSE;
870 if ( !$this->loadFromId() ) {
871 # Not a valid ID, loadFromId has switched the object to anon for us
875 if ( isset( $_SESSION['wsToken'] ) ) {
876 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
878 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
879 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
882 # No session or persistent login cookie
883 $this->loadDefaults();
887 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
888 $_SESSION['wsToken'] = $this->mToken
;
889 wfDebug( "Logged in from $from\n" );
892 # Invalid credentials
893 wfDebug( "Can't log in from $from, invalid credentials\n" );
894 $this->loadDefaults();
900 * Load user and user_group data from the database.
901 * $this::mId must be set, this is how the user is identified.
903 * @return \bool True if the user exists, false if the user is anonymous
906 function loadFromDatabase() {
908 $this->mId
= intval( $this->mId
);
910 /** Anonymous user */
912 $this->loadDefaults();
916 $dbr = wfGetDB( DB_MASTER
);
917 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
919 wfRunHooks( 'UserLoadFromDatabase', array( $this, &$s ) );
921 if ( $s !== false ) {
922 # Initialise user table data
923 $this->loadFromRow( $s );
924 $this->mGroups
= null; // deferred
925 $this->getEditCount(); // revalidation for nulls
930 $this->loadDefaults();
936 * Initialize this object from a row from the user table.
938 * @param $row \type{\arrayof{\mixed}} Row from the user table to load.
940 function loadFromRow( $row ) {
941 $this->mDataLoaded
= true;
943 if ( isset( $row->user_id
) ) {
944 $this->mId
= intval( $row->user_id
);
946 $this->mName
= $row->user_name
;
947 $this->mRealName
= $row->user_real_name
;
948 $this->mPassword
= $row->user_password
;
949 $this->mNewpassword
= $row->user_newpassword
;
950 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
951 $this->mEmail
= $row->user_email
;
952 $this->decodeOptions( $row->user_options
);
953 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
954 $this->mToken
= $row->user_token
;
955 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
956 $this->mEmailToken
= $row->user_email_token
;
957 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
958 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
959 $this->mEditCount
= $row->user_editcount
;
963 * Load the groups from the database if they aren't already loaded.
966 function loadGroups() {
967 if ( is_null( $this->mGroups
) ) {
968 $dbr = wfGetDB( DB_MASTER
);
969 $res = $dbr->select( 'user_groups',
971 array( 'ug_user' => $this->mId
),
973 $this->mGroups
= array();
974 while( $row = $dbr->fetchObject( $res ) ) {
975 $this->mGroups
[] = $row->ug_group
;
981 * Clear various cached data stored in this object.
982 * @param $reloadFrom \string Reload user and user_groups table data from a
983 * given source. May be "name", "id", "defaults", "session", or false for
986 function clearInstanceCache( $reloadFrom = false ) {
987 $this->mNewtalk
= -1;
988 $this->mDatePreference
= null;
989 $this->mBlockedby
= -1; # Unset
990 $this->mHash
= false;
992 $this->mRights
= null;
993 $this->mEffectiveGroups
= null;
994 $this->mOptions
= null;
997 $this->mDataLoaded
= false;
998 $this->mFrom
= $reloadFrom;
1003 * Combine the language default options with any site-specific options
1004 * and add the default language variants.
1006 * @return \type{\arrayof{\string}} Array of options
1008 static function getDefaultOptions() {
1009 global $wgNamespacesToBeSearchedDefault;
1011 * Site defaults will override the global/language defaults
1013 global $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1014 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
1017 * default language setting
1019 $variant = $wgContLang->getPreferredVariant( false );
1020 $defOpt['variant'] = $variant;
1021 $defOpt['language'] = $variant;
1022 foreach( SearchEngine
::searchableNamespaces() as $nsnum => $nsname ) {
1023 $defOpt['searchNs'.$nsnum] = !empty( $wgNamespacesToBeSearchedDefault[$nsnum] );
1025 $defOpt['skin'] = $wgDefaultSkin;
1031 * Get a given default option value.
1033 * @param $opt \string Name of option to retrieve
1034 * @return \string Default option value
1036 public static function getDefaultOption( $opt ) {
1037 $defOpts = self
::getDefaultOptions();
1038 if( isset( $defOpts[$opt] ) ) {
1039 return $defOpts[$opt];
1046 * Get a list of user toggle names
1047 * @return \type{\arrayof{\string}} Array of user toggle names
1049 static function getToggles() {
1050 global $wgContLang, $wgUseRCPatrol;
1051 $extraToggles = array();
1052 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
1053 if( $wgUseRCPatrol ) {
1054 $extraToggles[] = 'hidepatrolled';
1055 $extraToggles[] = 'newpageshidepatrolled';
1056 $extraToggles[] = 'watchlisthidepatrolled';
1058 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
1063 * Get blocking information
1065 * @param $bFromSlave \bool Whether to check the slave database first. To
1066 * improve performance, non-critical checks are done
1067 * against slaves. Check when actually saving should be
1068 * done against master.
1070 function getBlockedStatus( $bFromSlave = true ) {
1071 global $wgEnableSorbs, $wgProxyWhitelist, $wgUser;
1073 if ( -1 != $this->mBlockedby
) {
1074 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1078 wfProfileIn( __METHOD__
);
1079 wfDebug( __METHOD__
.": checking...\n" );
1081 // Initialize data...
1082 // Otherwise something ends up stomping on $this->mBlockedby when
1083 // things get lazy-loaded later, causing false positive block hits
1084 // due to -1 !== 0. Probably session-related... Nothing should be
1085 // overwriting mBlockedby, surely?
1088 $this->mBlockedby
= 0;
1089 $this->mHideName
= 0;
1090 $this->mAllowUsertalk
= 0;
1092 # Check if we are looking at an IP or a logged-in user
1093 if ( $this->isIP( $this->getName() ) ) {
1094 $ip = $this->getName();
1096 # Check if we are looking at the current user
1097 # If we don't, and the user is logged in, we don't know about
1098 # his IP / autoblock status, so ignore autoblock of current user's IP
1099 if ( $this->getID() != $wgUser->getID() ) {
1102 # Get IP of current user
1107 if ( $this->isAllowed( 'ipblock-exempt' ) ) {
1108 # Exempt from all types of IP-block
1113 $this->mBlock
= new Block();
1114 $this->mBlock
->fromMaster( !$bFromSlave );
1115 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1116 wfDebug( __METHOD__
. ": Found block.\n" );
1117 $this->mBlockedby
= $this->mBlock
->mBy
;
1118 $this->mBlockreason
= $this->mBlock
->mReason
;
1119 $this->mHideName
= $this->mBlock
->mHideName
;
1120 $this->mAllowUsertalk
= $this->mBlock
->mAllowUsertalk
;
1121 if ( $this->isLoggedIn() && $wgUser->getID() == $this->getID() ) {
1122 $this->spreadBlock();
1125 // Bug 13611: don't remove mBlock here, to allow account creation blocks to
1126 // apply to users. Note that the existence of $this->mBlock is not used to
1127 // check for edit blocks, $this->mBlockedby is instead.
1131 if ( !$this->isAllowed( 'proxyunbannable' ) && !in_array( $ip, $wgProxyWhitelist ) ) {
1133 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1134 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1135 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1139 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1140 if ( $this->inSorbsBlacklist( $ip ) ) {
1141 $this->mBlockedby
= wfMsg( 'sorbs' );
1142 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1148 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1150 wfProfileOut( __METHOD__
);
1154 * Whether the given IP is in the SORBS blacklist.
1156 * @param $ip \string IP to check
1157 * @return \bool True if blacklisted.
1159 function inSorbsBlacklist( $ip ) {
1160 global $wgEnableSorbs, $wgSorbsUrl;
1162 return $wgEnableSorbs &&
1163 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1167 * Whether the given IP is in a given DNS blacklist.
1169 * @param $ip \string IP to check
1170 * @param $base \string URL of the DNS blacklist
1171 * @return \bool True if blacklisted.
1173 function inDnsBlacklist( $ip, $base ) {
1174 wfProfileIn( __METHOD__
);
1178 // FIXME: IPv6 ??? (http://bugs.php.net/bug.php?id=33170)
1179 if( IP
::isIPv4( $ip ) ) {
1181 $host = "$ip.$base";
1184 $ipList = gethostbynamel( $host );
1187 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1190 wfDebug( "Requested $host, not found in $base.\n" );
1194 wfProfileOut( __METHOD__
);
1199 * Is this user subject to rate limiting?
1201 * @return \bool True if rate limited
1203 public function isPingLimitable() {
1204 global $wgRateLimitsExcludedGroups;
1205 if( array_intersect( $this->getEffectiveGroups(), $wgRateLimitsExcludedGroups ) ) {
1206 // Deprecated, but kept for backwards-compatibility config
1209 return !$this->isAllowed( 'noratelimit' );
1213 * Primitive rate limits: enforce maximum actions per time period
1214 * to put a brake on flooding.
1216 * @note When using a shared cache like memcached, IP-address
1217 * last-hit counters will be shared across wikis.
1219 * @param $action \string Action to enforce; 'edit' if unspecified
1220 * @return \bool True if a rate limiter was tripped
1222 function pingLimiter( $action = 'edit' ) {
1223 # Call the 'PingLimiter' hook
1225 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1229 global $wgRateLimits;
1230 if( !isset( $wgRateLimits[$action] ) ) {
1234 # Some groups shouldn't trigger the ping limiter, ever
1235 if( !$this->isPingLimitable() )
1238 global $wgMemc, $wgRateLimitLog;
1239 wfProfileIn( __METHOD__
);
1241 $limits = $wgRateLimits[$action];
1243 $id = $this->getId();
1247 if( isset( $limits['anon'] ) && $id == 0 ) {
1248 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1251 if( isset( $limits['user'] ) && $id != 0 ) {
1252 $userLimit = $limits['user'];
1254 if( $this->isNewbie() ) {
1255 if( isset( $limits['newbie'] ) && $id != 0 ) {
1256 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1258 if( isset( $limits['ip'] ) ) {
1259 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1262 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1263 $subnet = $matches[1];
1264 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1267 // Check for group-specific permissions
1268 // If more than one group applies, use the group with the highest limit
1269 foreach ( $this->getGroups() as $group ) {
1270 if ( isset( $limits[$group] ) ) {
1271 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1272 $userLimit = $limits[$group];
1276 // Set the user limit key
1277 if ( $userLimit !== false ) {
1278 wfDebug( __METHOD__
. ": effective user limit: $userLimit\n" );
1279 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1283 foreach( $keys as $key => $limit ) {
1284 list( $max, $period ) = $limit;
1285 $summary = "(limit $max in {$period}s)";
1286 $count = $wgMemc->get( $key );
1288 if( $count > $max ) {
1289 wfDebug( __METHOD__
. ": tripped! $key at $count $summary\n" );
1290 if( $wgRateLimitLog ) {
1291 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1295 wfDebug( __METHOD__
. ": ok. $key at $count $summary\n" );
1298 wfDebug( __METHOD__
. ": adding record for $key $summary\n" );
1299 $wgMemc->add( $key, 1, intval( $period ) );
1301 $wgMemc->incr( $key );
1304 wfProfileOut( __METHOD__
);
1309 * Check if user is blocked
1311 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1312 * @return \bool True if blocked, false otherwise
1314 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1315 wfDebug( "User::isBlocked: enter\n" );
1316 $this->getBlockedStatus( $bFromSlave );
1317 return $this->mBlockedby
!== 0;
1321 * Check if user is blocked from editing a particular article
1323 * @param $title \string Title to check
1324 * @param $bFromSlave \bool Whether to check the slave database instead of the master
1325 * @return \bool True if blocked, false otherwise
1327 function isBlockedFrom( $title, $bFromSlave = false ) {
1328 global $wgBlockAllowsUTEdit;
1329 wfProfileIn( __METHOD__
);
1330 wfDebug( __METHOD__
. ": enter\n" );
1332 wfDebug( __METHOD__
. ": asking isBlocked()\n" );
1333 $blocked = $this->isBlocked( $bFromSlave );
1334 $allowUsertalk = ( $wgBlockAllowsUTEdit ?
$this->mAllowUsertalk
: false );
1335 # If a user's name is suppressed, they cannot make edits anywhere
1336 if ( !$this->mHideName
&& $allowUsertalk && $title->getText() === $this->getName() &&
1337 $title->getNamespace() == NS_USER_TALK
) {
1339 wfDebug( __METHOD__
. ": self-talk page, ignoring any blocks\n" );
1341 wfProfileOut( __METHOD__
);
1346 * If user is blocked, return the name of the user who placed the block
1347 * @return \string name of blocker
1349 function blockedBy() {
1350 $this->getBlockedStatus();
1351 return $this->mBlockedby
;
1355 * If user is blocked, return the specified reason for the block
1356 * @return \string Blocking reason
1358 function blockedFor() {
1359 $this->getBlockedStatus();
1360 return $this->mBlockreason
;
1364 * If user is blocked, return the ID for the block
1365 * @return \int Block ID
1367 function getBlockId() {
1368 $this->getBlockedStatus();
1369 return ( $this->mBlock ?
$this->mBlock
->mId
: false );
1373 * Check if user is blocked on all wikis.
1374 * Do not use for actual edit permission checks!
1375 * This is intented for quick UI checks.
1377 * @param $ip \type{\string} IP address, uses current client if none given
1378 * @return \type{\bool} True if blocked, false otherwise
1380 function isBlockedGlobally( $ip = '' ) {
1381 if( $this->mBlockedGlobally
!== null ) {
1382 return $this->mBlockedGlobally
;
1384 // User is already an IP?
1385 if( IP
::isIPAddress( $this->getName() ) ) {
1386 $ip = $this->getName();
1391 wfRunHooks( 'UserIsBlockedGlobally', array( &$this, $ip, &$blocked ) );
1392 $this->mBlockedGlobally
= (bool)$blocked;
1393 return $this->mBlockedGlobally
;
1397 * Check if user account is locked
1399 * @return \type{\bool} True if locked, false otherwise
1401 function isLocked() {
1402 if( $this->mLocked
!== null ) {
1403 return $this->mLocked
;
1406 $authUser = $wgAuth->getUserInstance( $this );
1407 $this->mLocked
= (bool)$authUser->isLocked();
1408 return $this->mLocked
;
1412 * Check if user account is hidden
1414 * @return \type{\bool} True if hidden, false otherwise
1416 function isHidden() {
1417 if( $this->mHideName
!== null ) {
1418 return $this->mHideName
;
1420 $this->getBlockedStatus();
1421 if( !$this->mHideName
) {
1423 $authUser = $wgAuth->getUserInstance( $this );
1424 $this->mHideName
= (bool)$authUser->isHidden();
1426 return $this->mHideName
;
1430 * Get the user's ID.
1431 * @return \int The user's ID; 0 if the user is anonymous or nonexistent
1434 if( $this->mId
=== null and $this->mName
!== null
1435 and User
::isIP( $this->mName
) ) {
1436 // Special case, we know the user is anonymous
1438 } elseif( $this->mId
=== null ) {
1439 // Don't load if this was initialized from an ID
1446 * Set the user and reload all fields according to a given ID
1447 * @param $v \int User ID to reload
1449 function setId( $v ) {
1451 $this->clearInstanceCache( 'id' );
1455 * Get the user name, or the IP of an anonymous user
1456 * @return \string User's name or IP address
1458 function getName() {
1459 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1460 # Special case optimisation
1461 return $this->mName
;
1464 if ( $this->mName
=== false ) {
1466 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1468 return $this->mName
;
1473 * Set the user name.
1475 * This does not reload fields from the database according to the given
1476 * name. Rather, it is used to create a temporary "nonexistent user" for
1477 * later addition to the database. It can also be used to set the IP
1478 * address for an anonymous user to something other than the current
1481 * @note User::newFromName() has rougly the same function, when the named user
1483 * @param $str \string New user name to set
1485 function setName( $str ) {
1487 $this->mName
= $str;
1491 * Get the user's name escaped by underscores.
1492 * @return \string Username escaped by underscores.
1494 function getTitleKey() {
1495 return str_replace( ' ', '_', $this->getName() );
1499 * Check if the user has new messages.
1500 * @return \bool True if the user has new messages
1502 function getNewtalk() {
1505 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1506 if( $this->mNewtalk
=== -1 ) {
1507 $this->mNewtalk
= false; # reset talk page status
1509 # Check memcached separately for anons, who have no
1510 # entire User object stored in there.
1513 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1514 $newtalk = $wgMemc->get( $key );
1515 if( strval( $newtalk ) !== '' ) {
1516 $this->mNewtalk
= (bool)$newtalk;
1518 // Since we are caching this, make sure it is up to date by getting it
1520 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1521 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1524 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1528 return (bool)$this->mNewtalk
;
1532 * Return the talk page(s) this user has new messages on.
1533 * @return \type{\arrayof{\string}} Array of page URLs
1535 function getNewMessageLinks() {
1537 if( !wfRunHooks( 'UserRetrieveNewTalks', array( &$this, &$talks ) ) )
1540 if( !$this->getNewtalk() )
1542 $up = $this->getUserPage();
1543 $utp = $up->getTalkPage();
1544 return array( array( 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL() ) );
1548 * Internal uncached check for new messages
1551 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1552 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1553 * @param $fromMaster \bool true to fetch from the master, false for a slave
1554 * @return \bool True if the user has new messages
1557 function checkNewtalk( $field, $id, $fromMaster = false ) {
1558 if ( $fromMaster ) {
1559 $db = wfGetDB( DB_MASTER
);
1561 $db = wfGetDB( DB_SLAVE
);
1563 $ok = $db->selectField( 'user_newtalk', $field,
1564 array( $field => $id ), __METHOD__
);
1565 return $ok !== false;
1569 * Add or update the new messages flag
1570 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1571 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1572 * @return \bool True if successful, false otherwise
1575 function updateNewtalk( $field, $id ) {
1576 $dbw = wfGetDB( DB_MASTER
);
1577 $dbw->insert( 'user_newtalk',
1578 array( $field => $id ),
1581 if ( $dbw->affectedRows() ) {
1582 wfDebug( __METHOD__
. ": set on ($field, $id)\n" );
1585 wfDebug( __METHOD__
. " already set ($field, $id)\n" );
1591 * Clear the new messages flag for the given user
1592 * @param $field \string 'user_ip' for anonymous users, 'user_id' otherwise
1593 * @param $id \types{\string,\int} User's IP address for anonymous users, User ID otherwise
1594 * @return \bool True if successful, false otherwise
1597 function deleteNewtalk( $field, $id ) {
1598 $dbw = wfGetDB( DB_MASTER
);
1599 $dbw->delete( 'user_newtalk',
1600 array( $field => $id ),
1602 if ( $dbw->affectedRows() ) {
1603 wfDebug( __METHOD__
. ": killed on ($field, $id)\n" );
1606 wfDebug( __METHOD__
. ": already gone ($field, $id)\n" );
1612 * Update the 'You have new messages!' status.
1613 * @param $val \bool Whether the user has new messages
1615 function setNewtalk( $val ) {
1616 if( wfReadOnly() ) {
1621 $this->mNewtalk
= $val;
1623 if( $this->isAnon() ) {
1625 $id = $this->getName();
1628 $id = $this->getId();
1633 $changed = $this->updateNewtalk( $field, $id );
1635 $changed = $this->deleteNewtalk( $field, $id );
1638 if( $this->isAnon() ) {
1639 // Anons have a separate memcached space, since
1640 // user records aren't kept for them.
1641 $key = wfMemcKey( 'newtalk', 'ip', $id );
1642 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1645 $this->invalidateCache();
1650 * Generate a current or new-future timestamp to be stored in the
1651 * user_touched field when we update things.
1652 * @return \string Timestamp in TS_MW format
1654 private static function newTouchedTimestamp() {
1655 global $wgClockSkewFudge;
1656 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1660 * Clear user data from memcached.
1661 * Use after applying fun updates to the database; caller's
1662 * responsibility to update user_touched if appropriate.
1664 * Called implicitly from invalidateCache() and saveSettings().
1666 private function clearSharedCache() {
1670 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1675 * Immediately touch the user data cache for this account.
1676 * Updates user_touched field, and removes account data from memcached
1677 * for reload on the next hit.
1679 function invalidateCache() {
1680 if( wfReadOnly() ) {
1685 $this->mTouched
= self
::newTouchedTimestamp();
1687 $dbw = wfGetDB( DB_MASTER
);
1688 $dbw->update( 'user',
1689 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1690 array( 'user_id' => $this->mId
),
1693 $this->clearSharedCache();
1698 * Validate the cache for this account.
1699 * @param $timestamp \string A timestamp in TS_MW format
1701 function validateCache( $timestamp ) {
1703 return ( $timestamp >= $this->mTouched
);
1707 * Get the user touched timestamp
1709 function getTouched() {
1711 return $this->mTouched
;
1715 * Set the password and reset the random token.
1716 * Calls through to authentication plugin if necessary;
1717 * will have no effect if the auth plugin refuses to
1718 * pass the change through or if the legal password
1721 * As a special case, setting the password to null
1722 * wipes it, so the account cannot be logged in until
1723 * a new password is set, for instance via e-mail.
1725 * @param $str \string New password to set
1726 * @throws PasswordError on failure
1728 function setPassword( $str ) {
1731 if( $str !== null ) {
1732 if( !$wgAuth->allowPasswordChange() ) {
1733 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1736 $valid = $this->isValidPassword( $str );
1737 if( $valid !== true ) {
1738 global $wgMinimalPasswordLength;
1739 throw new PasswordError( wfMsgExt( $valid, array( 'parsemag' ),
1740 $wgMinimalPasswordLength ) );
1744 if( !$wgAuth->setPassword( $this, $str ) ) {
1745 throw new PasswordError( wfMsg( 'externaldberror' ) );
1748 $this->setInternalPassword( $str );
1754 * Set the password and reset the random token unconditionally.
1756 * @param $str \string New password to set
1758 function setInternalPassword( $str ) {
1762 if( $str === null ) {
1763 // Save an invalid hash...
1764 $this->mPassword
= '';
1766 $this->mPassword
= self
::crypt( $str );
1768 $this->mNewpassword
= '';
1769 $this->mNewpassTime
= null;
1773 * Get the user's current token.
1774 * @return \string Token
1776 function getToken() {
1778 return $this->mToken
;
1782 * Set the random token (used for persistent authentication)
1783 * Called from loadDefaults() among other places.
1785 * @param $token \string If specified, set the token to this value
1788 function setToken( $token = false ) {
1789 global $wgSecretKey, $wgProxyKey;
1792 if ( $wgSecretKey ) {
1793 $key = $wgSecretKey;
1794 } elseif ( $wgProxyKey ) {
1799 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1801 $this->mToken
= $token;
1806 * Set the cookie password
1808 * @param $str \string New cookie password
1811 function setCookiePassword( $str ) {
1813 $this->mCookiePassword
= md5( $str );
1817 * Set the password for a password reminder or new account email
1819 * @param $str \string New password to set
1820 * @param $throttle \bool If true, reset the throttle timestamp to the present
1822 function setNewpassword( $str, $throttle = true ) {
1824 $this->mNewpassword
= self
::crypt( $str );
1826 $this->mNewpassTime
= wfTimestampNow();
1831 * Has password reminder email been sent within the last
1832 * $wgPasswordReminderResendTime hours?
1833 * @return \bool True or false
1835 function isPasswordReminderThrottled() {
1836 global $wgPasswordReminderResendTime;
1838 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1841 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1842 return time() < $expiry;
1846 * Get the user's e-mail address
1847 * @return \string User's email address
1849 function getEmail() {
1851 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1852 return $this->mEmail
;
1856 * Get the timestamp of the user's e-mail authentication
1857 * @return \string TS_MW timestamp
1859 function getEmailAuthenticationTimestamp() {
1861 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1862 return $this->mEmailAuthenticated
;
1866 * Set the user's e-mail address
1867 * @param $str \string New e-mail address
1869 function setEmail( $str ) {
1871 $this->mEmail
= $str;
1872 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1876 * Get the user's real name
1877 * @return \string User's real name
1879 function getRealName() {
1881 return $this->mRealName
;
1885 * Set the user's real name
1886 * @param $str \string New real name
1888 function setRealName( $str ) {
1890 $this->mRealName
= $str;
1894 * Get the user's current setting for a given option.
1896 * @param $oname \string The option to check
1897 * @param $defaultOverride \string A default value returned if the option does not exist
1898 * @return \string User's current value for the option
1899 * @see getBoolOption()
1900 * @see getIntOption()
1902 function getOption( $oname, $defaultOverride = null ) {
1903 $this->loadOptions();
1905 if ( is_null( $this->mOptions
) ) {
1906 if($defaultOverride != '') {
1907 return $defaultOverride;
1909 $this->mOptions
= User
::getDefaultOptions();
1912 if ( array_key_exists( $oname, $this->mOptions
) ) {
1913 return $this->mOptions
[$oname];
1915 return $defaultOverride;
1920 * Get the user's current setting for a given option, as a boolean value.
1922 * @param $oname \string The option to check
1923 * @return \bool User's current value for the option
1926 function getBoolOption( $oname ) {
1927 return (bool)$this->getOption( $oname );
1932 * Get the user's current setting for a given option, as a boolean value.
1934 * @param $oname \string The option to check
1935 * @param $defaultOverride \int A default value returned if the option does not exist
1936 * @return \int User's current value for the option
1939 function getIntOption( $oname, $defaultOverride=0 ) {
1940 $val = $this->getOption( $oname );
1942 $val = $defaultOverride;
1944 return intval( $val );
1948 * Set the given option for a user.
1950 * @param $oname \string The option to set
1951 * @param $val \mixed New value to set
1953 function setOption( $oname, $val ) {
1955 $this->loadOptions();
1957 if ( $oname == 'skin' ) {
1958 # Clear cached skin, so the new one displays immediately in Special:Preferences
1959 unset( $this->mSkin
);
1962 // Explicitly NULL values should refer to defaults
1963 global $wgDefaultUserOptions;
1964 if( is_null( $val ) && isset( $wgDefaultUserOptions[$oname] ) ) {
1965 $val = $wgDefaultUserOptions[$oname];
1968 $this->mOptions
[$oname] = $val;
1972 * Reset all options to the site defaults
1974 function resetOptions() {
1975 $this->mOptions
= User
::getDefaultOptions();
1979 * Get the user's preferred date format.
1980 * @return \string User's preferred date format
1982 function getDatePreference() {
1983 // Important migration for old data rows
1984 if ( is_null( $this->mDatePreference
) ) {
1986 $value = $this->getOption( 'date' );
1987 $map = $wgLang->getDatePreferenceMigrationMap();
1988 if ( isset( $map[$value] ) ) {
1989 $value = $map[$value];
1991 $this->mDatePreference
= $value;
1993 return $this->mDatePreference
;
1997 * Get the permissions this user has.
1998 * @return \type{\arrayof{\string}} Array of permission names
2000 function getRights() {
2001 if ( is_null( $this->mRights
) ) {
2002 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
2003 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
2004 // Force reindexation of rights when a hook has unset one of them
2005 $this->mRights
= array_values( $this->mRights
);
2007 return $this->mRights
;
2011 * Get the list of explicit group memberships this user has.
2012 * The implicit * and user groups are not included.
2013 * @return \type{\arrayof{\string}} Array of internal group names
2015 function getGroups() {
2017 return $this->mGroups
;
2021 * Get the list of implicit group memberships this user has.
2022 * This includes all explicit groups, plus 'user' if logged in,
2023 * '*' for all accounts and autopromoted groups
2024 * @param $recache \bool Whether to avoid the cache
2025 * @return \type{\arrayof{\string}} Array of internal group names
2027 function getEffectiveGroups( $recache = false ) {
2028 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
2029 $this->mEffectiveGroups
= $this->getGroups();
2030 $this->mEffectiveGroups
[] = '*';
2031 if( $this->getId() ) {
2032 $this->mEffectiveGroups
[] = 'user';
2034 $this->mEffectiveGroups
= array_unique( array_merge(
2035 $this->mEffectiveGroups
,
2036 Autopromote
::getAutopromoteGroups( $this )
2039 # Hook for additional groups
2040 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
2043 return $this->mEffectiveGroups
;
2047 * Get the user's edit count.
2048 * @return \int User'e edit count
2050 function getEditCount() {
2051 if( $this->getId() ) {
2052 if ( !isset( $this->mEditCount
) ) {
2053 /* Populate the count, if it has not been populated yet */
2054 $this->mEditCount
= User
::edits( $this->mId
);
2056 return $this->mEditCount
;
2064 * Add the user to the given group.
2065 * This takes immediate effect.
2066 * @param $group \string Name of the group to add
2068 function addGroup( $group ) {
2069 $dbw = wfGetDB( DB_MASTER
);
2070 if( $this->getId() ) {
2071 $dbw->insert( 'user_groups',
2073 'ug_user' => $this->getID(),
2074 'ug_group' => $group,
2077 array( 'IGNORE' ) );
2080 $this->loadGroups();
2081 $this->mGroups
[] = $group;
2082 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2084 $this->invalidateCache();
2088 * Remove the user from the given group.
2089 * This takes immediate effect.
2090 * @param $group \string Name of the group to remove
2092 function removeGroup( $group ) {
2094 $dbw = wfGetDB( DB_MASTER
);
2095 $dbw->delete( 'user_groups',
2097 'ug_user' => $this->getID(),
2098 'ug_group' => $group,
2100 'User::removeGroup' );
2102 $this->loadGroups();
2103 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
2104 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
2106 $this->invalidateCache();
2110 * Get whether the user is logged in
2111 * @return \bool True or false
2113 function isLoggedIn() {
2114 return $this->getID() != 0;
2118 * Get whether the user is anonymous
2119 * @return \bool True or false
2122 return !$this->isLoggedIn();
2126 * Get whether the user is a bot
2127 * @return \bool True or false
2131 wfDeprecated( __METHOD__
);
2132 return $this->isAllowed( 'bot' );
2136 * Check if user is allowed to access a feature / make an action
2137 * @param $action \string action to be checked
2138 * @return \bool True if action is allowed, else false
2140 function isAllowed( $action = '' ) {
2141 if ( $action === '' )
2142 return true; // In the spirit of DWIM
2143 # Patrolling may not be enabled
2144 if( $action === 'patrol' ||
$action === 'autopatrol' ) {
2145 global $wgUseRCPatrol, $wgUseNPPatrol;
2146 if( !$wgUseRCPatrol && !$wgUseNPPatrol )
2149 # Use strict parameter to avoid matching numeric 0 accidentally inserted
2150 # by misconfiguration: 0 == 'foo'
2151 return in_array( $action, $this->getRights(), true );
2155 * Check whether to enable recent changes patrol features for this user
2156 * @return \bool True or false
2158 public function useRCPatrol() {
2159 global $wgUseRCPatrol;
2160 return( $wgUseRCPatrol && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2164 * Check whether to enable new pages patrol features for this user
2165 * @return \bool True or false
2167 public function useNPPatrol() {
2168 global $wgUseRCPatrol, $wgUseNPPatrol;
2169 return( ( $wgUseRCPatrol ||
$wgUseNPPatrol ) && ( $this->isAllowed( 'patrol' ) ||
$this->isAllowed( 'patrolmarks' ) ) );
2173 * Get the current skin, loading it if required, and setting a title
2174 * @param $t Title: the title to use in the skin
2175 * @return Skin The current skin
2176 * @todo FIXME : need to check the old failback system [AV]
2178 function &getSkin( $t = null ) {
2179 if ( !isset( $this->mSkin
) ) {
2180 wfProfileIn( __METHOD__
);
2182 global $wgHiddenPrefs;
2183 if( !in_array( 'skin', $wgHiddenPrefs ) ) {
2186 $userSkin = $this->getOption( 'skin' );
2187 $userSkin = $wgRequest->getVal( 'useskin', $userSkin );
2189 # if we're not allowing users to override, then use the default
2190 global $wgDefaultSkin;
2191 $userSkin = $wgDefaultSkin;
2194 $this->mSkin
=& Skin
::newFromKey( $userSkin );
2195 wfProfileOut( __METHOD__
);
2197 if( $t ||
!$this->mSkin
->getTitle() ) {
2200 $t = $wgOut->getTitle();
2202 $this->mSkin
->setTitle( $t );
2204 return $this->mSkin
;
2208 * Check the watched status of an article.
2209 * @param $title \type{Title} Title of the article to look at
2210 * @return \bool True if article is watched
2212 function isWatched( $title ) {
2213 $wl = WatchedItem
::fromUserTitle( $this, $title );
2214 return $wl->isWatched();
2219 * @param $title \type{Title} Title of the article to look at
2221 function addWatch( $title ) {
2222 $wl = WatchedItem
::fromUserTitle( $this, $title );
2224 $this->invalidateCache();
2228 * Stop watching an article.
2229 * @param $title \type{Title} Title of the article to look at
2231 function removeWatch( $title ) {
2232 $wl = WatchedItem
::fromUserTitle( $this, $title );
2234 $this->invalidateCache();
2238 * Clear the user's notification timestamp for the given title.
2239 * If e-notif e-mails are on, they will receive notification mails on
2240 * the next change of the page if it's watched etc.
2241 * @param $title \type{Title} Title of the article to look at
2243 function clearNotification( &$title ) {
2244 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
2246 # Do nothing if the database is locked to writes
2247 if( wfReadOnly() ) {
2251 if( $title->getNamespace() == NS_USER_TALK
&&
2252 $title->getText() == $this->getName() ) {
2253 if( !wfRunHooks( 'UserClearNewTalkNotification', array( &$this ) ) )
2255 $this->setNewtalk( false );
2258 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2262 if( $this->isAnon() ) {
2263 // Nothing else to do...
2267 // Only update the timestamp if the page is being watched.
2268 // The query to find out if it is watched is cached both in memcached and per-invocation,
2269 // and when it does have to be executed, it can be on a slave
2270 // If this is the user's newtalk page, we always update the timestamp
2271 if( $title->getNamespace() == NS_USER_TALK
&&
2272 $title->getText() == $wgUser->getName() )
2275 } elseif ( $this->getId() == $wgUser->getId() ) {
2276 $watched = $title->userIsWatching();
2281 // If the page is watched by the user (or may be watched), update the timestamp on any
2282 // any matching rows
2284 $dbw = wfGetDB( DB_MASTER
);
2285 $dbw->update( 'watchlist',
2287 'wl_notificationtimestamp' => NULL
2288 ), array( /* WHERE */
2289 'wl_title' => $title->getDBkey(),
2290 'wl_namespace' => $title->getNamespace(),
2291 'wl_user' => $this->getID()
2298 * Resets all of the given user's page-change notification timestamps.
2299 * If e-notif e-mails are on, they will receive notification mails on
2300 * the next change of any watched page.
2302 * @param $currentUser \int User ID
2304 function clearAllNotifications( $currentUser ) {
2305 global $wgUseEnotif, $wgShowUpdatedMarker;
2306 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2307 $this->setNewtalk( false );
2310 if( $currentUser != 0 ) {
2311 $dbw = wfGetDB( DB_MASTER
);
2312 $dbw->update( 'watchlist',
2314 'wl_notificationtimestamp' => NULL
2315 ), array( /* WHERE */
2316 'wl_user' => $currentUser
2319 # We also need to clear here the "you have new message" notification for the own user_talk page
2320 # This is cleared one page view later in Article::viewUpdates();
2325 * Set this user's options from an encoded string
2326 * @param $str \string Encoded options to import
2329 function decodeOptions( $str ) {
2333 $this->mOptionsLoaded
= true;
2334 $this->mOptionOverrides
= array();
2336 $this->mOptions
= array();
2337 $a = explode( "\n", $str );
2338 foreach ( $a as $s ) {
2340 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2341 $this->mOptions
[$m[1]] = $m[2];
2342 $this->mOptionOverrides
[$m[1]] = $m[2];
2348 * Set a cookie on the user's client. Wrapper for
2349 * WebResponse::setCookie
2350 * @param $name \string Name of the cookie to set
2351 * @param $value \string Value to set
2352 * @param $exp \int Expiration time, as a UNIX time value;
2353 * if 0 or not specified, use the default $wgCookieExpiration
2355 protected function setCookie( $name, $value, $exp = 0 ) {
2357 $wgRequest->response()->setcookie( $name, $value, $exp );
2361 * Clear a cookie on the user's client
2362 * @param $name \string Name of the cookie to clear
2364 protected function clearCookie( $name ) {
2365 $this->setCookie( $name, '', time() - 86400 );
2369 * Set the default cookies for this session on the user's client.
2371 function setCookies() {
2373 if ( 0 == $this->mId
) return;
2375 'wsUserID' => $this->mId
,
2376 'wsToken' => $this->mToken
,
2377 'wsUserName' => $this->getName()
2380 'UserID' => $this->mId
,
2381 'UserName' => $this->getName(),
2383 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2384 $cookies['Token'] = $this->mToken
;
2386 $cookies['Token'] = false;
2389 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2390 #check for null, since the hook could cause a null value
2391 if ( !is_null( $session ) && isset( $_SESSION ) ){
2392 $_SESSION = $session +
$_SESSION;
2394 foreach ( $cookies as $name => $value ) {
2395 if ( $value === false ) {
2396 $this->clearCookie( $name );
2398 $this->setCookie( $name, $value );
2404 * Log this user out.
2407 if( wfRunHooks( 'UserLogout', array( &$this ) ) ) {
2413 * Clear the user's cookies and session, and reset the instance cache.
2417 function doLogout() {
2418 $this->clearInstanceCache( 'defaults' );
2420 $_SESSION['wsUserID'] = 0;
2422 $this->clearCookie( 'UserID' );
2423 $this->clearCookie( 'Token' );
2425 # Remember when user logged out, to prevent seeing cached pages
2426 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2430 * Save this user's settings into the database.
2431 * @todo Only rarely do all these fields need to be set!
2433 function saveSettings() {
2435 if ( wfReadOnly() ) { return; }
2436 if ( 0 == $this->mId
) { return; }
2438 $this->mTouched
= self
::newTouchedTimestamp();
2440 $dbw = wfGetDB( DB_MASTER
);
2441 $dbw->update( 'user',
2443 'user_name' => $this->mName
,
2444 'user_password' => $this->mPassword
,
2445 'user_newpassword' => $this->mNewpassword
,
2446 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2447 'user_real_name' => $this->mRealName
,
2448 'user_email' => $this->mEmail
,
2449 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2450 'user_options' => '',
2451 'user_touched' => $dbw->timestamp( $this->mTouched
),
2452 'user_token' => $this->mToken
,
2453 'user_email_token' => $this->mEmailToken
,
2454 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2455 ), array( /* WHERE */
2456 'user_id' => $this->mId
2460 $this->saveOptions();
2462 wfRunHooks( 'UserSaveSettings', array( $this ) );
2463 $this->clearSharedCache();
2464 $this->getUserPage()->invalidateCache();
2468 * If only this user's username is known, and it exists, return the user ID.
2470 function idForName() {
2471 $s = trim( $this->getName() );
2472 if ( $s === '' ) return 0;
2474 $dbr = wfGetDB( DB_SLAVE
);
2475 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2476 if ( $id === false ) {
2483 * Add a user to the database, return the user object
2485 * @param $name \string Username to add
2486 * @param $params \type{\arrayof{\string}} Non-default parameters to save to the database:
2487 * - password The user's password. Password logins will be disabled if this is omitted.
2488 * - newpassword A temporary password mailed to the user
2489 * - email The user's email address
2490 * - email_authenticated The email authentication timestamp
2491 * - real_name The user's real name
2492 * - options An associative array of non-default options
2493 * - token Random authentication token. Do not set.
2494 * - registration Registration timestamp. Do not set.
2496 * @return \type{User} A new User object, or null if the username already exists
2498 static function createNew( $name, $params = array() ) {
2501 if ( isset( $params['options'] ) ) {
2502 $user->mOptions
= $params['options'] +
(array)$user->mOptions
;
2503 unset( $params['options'] );
2505 $dbw = wfGetDB( DB_MASTER
);
2506 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2508 'user_id' => $seqVal,
2509 'user_name' => $name,
2510 'user_password' => $user->mPassword
,
2511 'user_newpassword' => $user->mNewpassword
,
2512 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2513 'user_email' => $user->mEmail
,
2514 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2515 'user_real_name' => $user->mRealName
,
2516 'user_options' => '',
2517 'user_token' => $user->mToken
,
2518 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2519 'user_editcount' => 0,
2521 foreach ( $params as $name => $value ) {
2522 $fields["user_$name"] = $value;
2524 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2525 if ( $dbw->affectedRows() ) {
2526 $newUser = User
::newFromId( $dbw->insertId() );
2534 * Add this existing user object to the database
2536 function addToDatabase() {
2538 $dbw = wfGetDB( DB_MASTER
);
2539 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2540 $dbw->insert( 'user',
2542 'user_id' => $seqVal,
2543 'user_name' => $this->mName
,
2544 'user_password' => $this->mPassword
,
2545 'user_newpassword' => $this->mNewpassword
,
2546 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2547 'user_email' => $this->mEmail
,
2548 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2549 'user_real_name' => $this->mRealName
,
2550 'user_options' => '',
2551 'user_token' => $this->mToken
,
2552 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2553 'user_editcount' => 0,
2556 $this->mId
= $dbw->insertId();
2558 // Clear instance cache other than user table data, which is already accurate
2559 $this->clearInstanceCache();
2561 $this->saveOptions();
2565 * If this (non-anonymous) user is blocked, block any IP address
2566 * they've successfully logged in from.
2568 function spreadBlock() {
2569 wfDebug( __METHOD__
. "()\n" );
2571 if ( $this->mId
== 0 ) {
2575 $userblock = Block
::newFromDB( '', $this->mId
);
2576 if ( !$userblock ) {
2580 $userblock->doAutoblock( wfGetIP() );
2584 * Generate a string which will be different for any combination of
2585 * user options which would produce different parser output.
2586 * This will be used as part of the hash key for the parser cache,
2587 * so users will the same options can share the same cached data
2590 * Extensions which require it should install 'PageRenderingHash' hook,
2591 * which will give them a chance to modify this key based on their own
2594 * @return \string Page rendering hash
2596 function getPageRenderingHash() {
2597 global $wgUseDynamicDates, $wgRenderHashAppend, $wgLang, $wgContLang;
2599 return $this->mHash
;
2602 // stubthreshold is only included below for completeness,
2603 // it will always be 0 when this function is called by parsercache.
2605 $confstr = $this->getOption( 'math' );
2606 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2607 if ( $wgUseDynamicDates ) {
2608 $confstr .= '!' . $this->getDatePreference();
2610 $confstr .= '!' . ( $this->getOption( 'numberheadings' ) ?
'1' : '' );
2611 $confstr .= '!' . $wgLang->getCode();
2612 $confstr .= '!' . $this->getOption( 'thumbsize' );
2613 // add in language specific options, if any
2614 $extra = $wgContLang->getExtraHashOptions();
2617 $confstr .= $wgRenderHashAppend;
2619 // Give a chance for extensions to modify the hash, if they have
2620 // extra options or other effects on the parser cache.
2621 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2623 // Make it a valid memcached key fragment
2624 $confstr = str_replace( ' ', '_', $confstr );
2625 $this->mHash
= $confstr;
2630 * Get whether the user is explicitly blocked from account creation.
2631 * @return \bool True if blocked
2633 function isBlockedFromCreateAccount() {
2634 $this->getBlockedStatus();
2635 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2639 * Get whether the user is blocked from using Special:Emailuser.
2640 * @return \bool True if blocked
2642 function isBlockedFromEmailuser() {
2643 $this->getBlockedStatus();
2644 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2648 * Get whether the user is allowed to create an account.
2649 * @return \bool True if allowed
2651 function isAllowedToCreateAccount() {
2652 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2658 function setLoaded( $loaded ) {
2659 wfDeprecated( __METHOD__
);
2663 * Get this user's personal page title.
2665 * @return \type{Title} User's personal page title
2667 function getUserPage() {
2668 return Title
::makeTitle( NS_USER
, $this->getName() );
2672 * Get this user's talk page title.
2674 * @return \type{Title} User's talk page title
2676 function getTalkPage() {
2677 $title = $this->getUserPage();
2678 return $title->getTalkPage();
2682 * Get the maximum valid user ID.
2683 * @return \int User ID
2686 function getMaxID() {
2687 static $res; // cache
2689 if ( isset( $res ) )
2692 $dbr = wfGetDB( DB_SLAVE
);
2693 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2698 * Determine whether the user is a newbie. Newbies are either
2699 * anonymous IPs, or the most recently created accounts.
2700 * @return \bool True if the user is a newbie
2702 function isNewbie() {
2703 return !$this->isAllowed( 'autoconfirmed' );
2707 * Check to see if the given clear-text password is one of the accepted passwords
2708 * @param $password \string user password.
2709 * @return \bool True if the given password is correct, otherwise False.
2711 function checkPassword( $password ) {
2715 // Even though we stop people from creating passwords that
2716 // are shorter than this, doesn't mean people wont be able
2717 // to. Certain authentication plugins do NOT want to save
2718 // domain passwords in a mysql database, so we should
2719 // check this (incase $wgAuth->strict() is false).
2720 if( $this->isValidPassword( $password ) !== true ) {
2724 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2726 } elseif( $wgAuth->strict() ) {
2727 /* Auth plugin doesn't allow local authentication */
2729 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2730 /* Auth plugin doesn't allow local authentication for this user name */
2733 if ( self
::comparePasswords( $this->mPassword
, $password, $this->mId
) ) {
2735 } elseif ( function_exists( 'iconv' ) ) {
2736 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2737 # Check for this with iconv
2738 $cp1252Password = iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password );
2739 if ( self
::comparePasswords( $this->mPassword
, $cp1252Password, $this->mId
) ) {
2747 * Check if the given clear-text password matches the temporary password
2748 * sent by e-mail for password reset operations.
2749 * @return \bool True if matches, false otherwise
2751 function checkTemporaryPassword( $plaintext ) {
2752 global $wgNewPasswordExpiry;
2753 if( self
::comparePasswords( $this->mNewpassword
, $plaintext, $this->getId() ) ) {
2755 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgNewPasswordExpiry;
2756 return ( time() < $expiry );
2763 * Initialize (if necessary) and return a session token value
2764 * which can be used in edit forms to show that the user's
2765 * login credentials aren't being hijacked with a foreign form
2768 * @param $salt \types{\string,\arrayof{\string}} Optional function-specific data for hashing
2769 * @return \string The new edit token
2771 function editToken( $salt = '' ) {
2772 if ( $this->isAnon() ) {
2773 return EDIT_TOKEN_SUFFIX
;
2775 if( !isset( $_SESSION['wsEditToken'] ) ) {
2776 $token = $this->generateToken();
2777 $_SESSION['wsEditToken'] = $token;
2779 $token = $_SESSION['wsEditToken'];
2781 if( is_array( $salt ) ) {
2782 $salt = implode( '|', $salt );
2784 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2789 * Generate a looking random token for various uses.
2791 * @param $salt \string Optional salt value
2792 * @return \string The new random token
2794 function generateToken( $salt = '' ) {
2795 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2796 return md5( $token . $salt );
2800 * Check given value against the token value stored in the session.
2801 * A match should confirm that the form was submitted from the
2802 * user's own login session, not a form submission from a third-party
2805 * @param $val \string Input value to compare
2806 * @param $salt \string Optional function-specific data for hashing
2807 * @return \bool Whether the token matches
2809 function matchEditToken( $val, $salt = '' ) {
2810 $sessionToken = $this->editToken( $salt );
2811 if ( $val != $sessionToken ) {
2812 wfDebug( "User::matchEditToken: broken session data\n" );
2814 return $val == $sessionToken;
2818 * Check given value against the token value stored in the session,
2819 * ignoring the suffix.
2821 * @param $val \string Input value to compare
2822 * @param $salt \string Optional function-specific data for hashing
2823 * @return \bool Whether the token matches
2825 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2826 $sessionToken = $this->editToken( $salt );
2827 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2831 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2832 * mail to the user's given address.
2834 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure.
2836 function sendConfirmationMail() {
2838 $expiration = null; // gets passed-by-ref and defined in next line.
2839 $token = $this->confirmationToken( $expiration );
2840 $url = $this->confirmationTokenUrl( $token );
2841 $invalidateURL = $this->invalidationTokenUrl( $token );
2842 $this->saveSettings();
2844 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2845 wfMsg( 'confirmemail_body',
2849 $wgLang->timeanddate( $expiration, false ),
2851 $wgLang->date( $expiration, false ),
2852 $wgLang->time( $expiration, false ) ) );
2856 * Send an e-mail to this user's account. Does not check for
2857 * confirmed status or validity.
2859 * @param $subject \string Message subject
2860 * @param $body \string Message body
2861 * @param $from \string Optional From address; if unspecified, default $wgPasswordSender will be used
2862 * @param $replyto \string Reply-To address
2863 * @return \types{\bool,\type{WikiError}} True on success, a WikiError object on failure
2865 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2866 if( is_null( $from ) ) {
2867 global $wgPasswordSender;
2868 $from = $wgPasswordSender;
2871 $to = new MailAddress( $this );
2872 $sender = new MailAddress( $from );
2873 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2877 * Generate, store, and return a new e-mail confirmation code.
2878 * A hash (unsalted, since it's used as a key) is stored.
2880 * @note Call saveSettings() after calling this function to commit
2881 * this change to the database.
2883 * @param[out] &$expiration \mixed Accepts the expiration time
2884 * @return \string New token
2887 function confirmationToken( &$expiration ) {
2889 $expires = $now +
7 * 24 * 60 * 60;
2890 $expiration = wfTimestamp( TS_MW
, $expires );
2891 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2892 $hash = md5( $token );
2894 $this->mEmailToken
= $hash;
2895 $this->mEmailTokenExpires
= $expiration;
2900 * Return a URL the user can use to confirm their email address.
2901 * @param $token \string Accepts the email confirmation token
2902 * @return \string New token URL
2905 function confirmationTokenUrl( $token ) {
2906 return $this->getTokenUrl( 'ConfirmEmail', $token );
2910 * Return a URL the user can use to invalidate their email address.
2911 * @param $token \string Accepts the email confirmation token
2912 * @return \string New token URL
2915 function invalidationTokenUrl( $token ) {
2916 return $this->getTokenUrl( 'Invalidateemail', $token );
2920 * Internal function to format the e-mail validation/invalidation URLs.
2921 * This uses $wgArticlePath directly as a quickie hack to use the
2922 * hardcoded English names of the Special: pages, for ASCII safety.
2924 * @note Since these URLs get dropped directly into emails, using the
2925 * short English names avoids insanely long URL-encoded links, which
2926 * also sometimes can get corrupted in some browsers/mailers
2927 * (bug 6957 with Gmail and Internet Explorer).
2929 * @param $page \string Special page
2930 * @param $token \string Token
2931 * @return \string Formatted URL
2933 protected function getTokenUrl( $page, $token ) {
2934 global $wgArticlePath;
2938 "Special:$page/$token",
2943 * Mark the e-mail address confirmed.
2945 * @note Call saveSettings() after calling this function to commit the change.
2947 function confirmEmail() {
2948 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2949 wfRunHooks( 'ConfirmEmailComplete', array( $this ) );
2954 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
2955 * address if it was already confirmed.
2957 * @note Call saveSettings() after calling this function to commit the change.
2959 function invalidateEmail() {
2961 $this->mEmailToken
= null;
2962 $this->mEmailTokenExpires
= null;
2963 $this->setEmailAuthenticationTimestamp( null );
2964 wfRunHooks( 'InvalidateEmailComplete', array( $this ) );
2969 * Set the e-mail authentication timestamp.
2970 * @param $timestamp \string TS_MW timestamp
2972 function setEmailAuthenticationTimestamp( $timestamp ) {
2974 $this->mEmailAuthenticated
= $timestamp;
2975 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2979 * Is this user allowed to send e-mails within limits of current
2980 * site configuration?
2981 * @return \bool True if allowed
2983 function canSendEmail() {
2984 global $wgEnableEmail, $wgEnableUserEmail, $wgUser;
2985 if( !$wgEnableEmail ||
!$wgEnableUserEmail ||
!$wgUser->isAllowed( 'sendemail' ) ) {
2988 $canSend = $this->isEmailConfirmed();
2989 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
2994 * Is this user allowed to receive e-mails within limits of current
2995 * site configuration?
2996 * @return \bool True if allowed
2998 function canReceiveEmail() {
2999 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
3003 * Is this user's e-mail address valid-looking and confirmed within
3004 * limits of the current site configuration?
3006 * @note If $wgEmailAuthentication is on, this may require the user to have
3007 * confirmed their address by returning a code or using a password
3008 * sent to the address from the wiki.
3010 * @return \bool True if confirmed
3012 function isEmailConfirmed() {
3013 global $wgEmailAuthentication;
3016 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
3017 if( $this->isAnon() )
3019 if( !self
::isValidEmailAddr( $this->mEmail
) )
3021 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
3030 * Check whether there is an outstanding request for e-mail confirmation.
3031 * @return \bool True if pending
3033 function isEmailConfirmationPending() {
3034 global $wgEmailAuthentication;
3035 return $wgEmailAuthentication &&
3036 !$this->isEmailConfirmed() &&
3037 $this->mEmailToken
&&
3038 $this->mEmailTokenExpires
> wfTimestamp();
3042 * Get the timestamp of account creation.
3044 * @return \types{\string,\bool} string Timestamp of account creation, or false for
3045 * non-existent/anonymous user accounts.
3047 public function getRegistration() {
3048 return $this->getId() > 0
3049 ?
$this->mRegistration
3054 * Get the timestamp of the first edit
3056 * @return \types{\string,\bool} string Timestamp of first edit, or false for
3057 * non-existent/anonymous user accounts.
3059 public function getFirstEditTimestamp() {
3060 if( $this->getId() == 0 ) return false; // anons
3061 $dbr = wfGetDB( DB_SLAVE
);
3062 $time = $dbr->selectField( 'revision', 'rev_timestamp',
3063 array( 'rev_user' => $this->getId() ),
3065 array( 'ORDER BY' => 'rev_timestamp ASC' )
3067 if( !$time ) return false; // no edits
3068 return wfTimestamp( TS_MW
, $time );
3072 * Get the permissions associated with a given list of groups
3074 * @param $groups \type{\arrayof{\string}} List of internal group names
3075 * @return \type{\arrayof{\string}} List of permission key names for given groups combined
3077 static function getGroupPermissions( $groups ) {
3078 global $wgGroupPermissions, $wgRevokePermissions;
3080 // grant every granted permission first
3081 foreach( $groups as $group ) {
3082 if( isset( $wgGroupPermissions[$group] ) ) {
3083 $rights = array_merge( $rights,
3084 // array_filter removes empty items
3085 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
3088 // now revoke the revoked permissions
3089 foreach( $groups as $group ) {
3090 if( isset( $wgRevokePermissions[$group] ) ) {
3091 $rights = array_diff( $rights,
3092 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
3095 return array_unique( $rights );
3099 * Get all the groups who have a given permission
3101 * @param $role \string Role to check
3102 * @return \type{\arrayof{\string}} List of internal group names with the given permission
3104 static function getGroupsWithPermission( $role ) {
3105 global $wgGroupPermissions;
3106 $allowedGroups = array();
3107 foreach ( $wgGroupPermissions as $group => $rights ) {
3108 if ( isset( $rights[$role] ) && $rights[$role] ) {
3109 $allowedGroups[] = $group;
3112 return $allowedGroups;
3116 * Get the localized descriptive name for a group, if it exists
3118 * @param $group \string Internal group name
3119 * @return \string Localized descriptive group name
3121 static function getGroupName( $group ) {
3122 global $wgMessageCache;
3123 $wgMessageCache->loadAllMessages();
3124 $key = "group-$group";
3125 $name = wfMsg( $key );
3126 return $name == '' ||
wfEmptyMsg( $key, $name )
3132 * Get the localized descriptive name for a member of a group, if it exists
3134 * @param $group \string Internal group name
3135 * @return \string Localized name for group member
3137 static function getGroupMember( $group ) {
3138 global $wgMessageCache;
3139 $wgMessageCache->loadAllMessages();
3140 $key = "group-$group-member";
3141 $name = wfMsg( $key );
3142 return $name == '' ||
wfEmptyMsg( $key, $name )
3148 * Return the set of defined explicit groups.
3149 * The implicit groups (by default *, 'user' and 'autoconfirmed')
3150 * are not included, as they are defined automatically, not in the database.
3151 * @return \type{\arrayof{\string}} Array of internal group names
3153 static function getAllGroups() {
3154 global $wgGroupPermissions, $wgRevokePermissions;
3156 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
3157 self
::getImplicitGroups()
3162 * Get a list of all available permissions.
3163 * @return \type{\arrayof{\string}} Array of permission names
3165 static function getAllRights() {
3166 if ( self
::$mAllRights === false ) {
3167 global $wgAvailableRights;
3168 if ( count( $wgAvailableRights ) ) {
3169 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
3171 self
::$mAllRights = self
::$mCoreRights;
3173 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
3175 return self
::$mAllRights;
3179 * Get a list of implicit groups
3180 * @return \type{\arrayof{\string}} Array of internal group names
3182 public static function getImplicitGroups() {
3183 global $wgImplicitGroups;
3184 $groups = $wgImplicitGroups;
3185 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
3190 * Get the title of a page describing a particular group
3192 * @param $group \string Internal group name
3193 * @return \types{\type{Title},\bool} Title of the page if it exists, false otherwise
3195 static function getGroupPage( $group ) {
3196 global $wgMessageCache;
3197 $wgMessageCache->loadAllMessages();
3198 $page = wfMsgForContent( 'grouppage-' . $group );
3199 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
3200 $title = Title
::newFromText( $page );
3201 if( is_object( $title ) )
3208 * Create a link to the group in HTML, if available;
3209 * else return the group name.
3211 * @param $group \string Internal name of the group
3212 * @param $text \string The text of the link
3213 * @return \string HTML link to the group
3215 static function makeGroupLinkHTML( $group, $text = '' ) {
3217 $text = self
::getGroupName( $group );
3219 $title = self
::getGroupPage( $group );
3222 $sk = $wgUser->getSkin();
3223 return $sk->link( $title, htmlspecialchars( $text ) );
3230 * Create a link to the group in Wikitext, if available;
3231 * else return the group name.
3233 * @param $group \string Internal name of the group
3234 * @param $text \string The text of the link
3235 * @return \string Wikilink to the group
3237 static function makeGroupLinkWiki( $group, $text = '' ) {
3239 $text = self
::getGroupName( $group );
3241 $title = self
::getGroupPage( $group );
3243 $page = $title->getPrefixedText();
3244 return "[[$page|$text]]";
3251 * Returns an array of the groups that a particular group can add/remove.
3253 * @param $group String: the group to check for whether it can add/remove
3254 * @return Array array( 'add' => array( addablegroups ),
3255 * 'remove' => array( removablegroups ),
3256 * 'add-self' => array( addablegroups to self),
3257 * 'remove-self' => array( removable groups from self) )
3259 static function changeableByGroup( $group ) {
3260 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
3262 $groups = array( 'add' => array(), 'remove' => array(), 'add-self' => array(), 'remove-self' => array() );
3263 if( empty( $wgAddGroups[$group] ) ) {
3264 // Don't add anything to $groups
3265 } elseif( $wgAddGroups[$group] === true ) {
3266 // You get everything
3267 $groups['add'] = self
::getAllGroups();
3268 } elseif( is_array( $wgAddGroups[$group] ) ) {
3269 $groups['add'] = $wgAddGroups[$group];
3272 // Same thing for remove
3273 if( empty( $wgRemoveGroups[$group] ) ) {
3274 } elseif( $wgRemoveGroups[$group] === true ) {
3275 $groups['remove'] = self
::getAllGroups();
3276 } elseif( is_array( $wgRemoveGroups[$group] ) ) {
3277 $groups['remove'] = $wgRemoveGroups[$group];
3280 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
3281 if( empty( $wgGroupsAddToSelf['user']) ||
$wgGroupsAddToSelf['user'] !== true ) {
3282 foreach( $wgGroupsAddToSelf as $key => $value ) {
3283 if( is_int( $key ) ) {
3284 $wgGroupsAddToSelf['user'][] = $value;
3289 if( empty( $wgGroupsRemoveFromSelf['user']) ||
$wgGroupsRemoveFromSelf['user'] !== true ) {
3290 foreach( $wgGroupsRemoveFromSelf as $key => $value ) {
3291 if( is_int( $key ) ) {
3292 $wgGroupsRemoveFromSelf['user'][] = $value;
3297 // Now figure out what groups the user can add to him/herself
3298 if( empty( $wgGroupsAddToSelf[$group] ) ) {
3299 } elseif( $wgGroupsAddToSelf[$group] === true ) {
3300 // No idea WHY this would be used, but it's there
3301 $groups['add-self'] = User
::getAllGroups();
3302 } elseif( is_array( $wgGroupsAddToSelf[$group] ) ) {
3303 $groups['add-self'] = $wgGroupsAddToSelf[$group];
3306 if( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
3307 } elseif( $wgGroupsRemoveFromSelf[$group] === true ) {
3308 $groups['remove-self'] = User
::getAllGroups();
3309 } elseif( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
3310 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
3317 * Returns an array of groups that this user can add and remove
3318 * @return Array array( 'add' => array( addablegroups ),
3319 * 'remove' => array( removablegroups ),
3320 * 'add-self' => array( addablegroups to self),
3321 * 'remove-self' => array( removable groups from self) )
3323 function changeableGroups() {
3324 if( $this->isAllowed( 'userrights' ) ) {
3325 // This group gives the right to modify everything (reverse-
3326 // compatibility with old "userrights lets you change
3328 // Using array_merge to make the groups reindexed
3329 $all = array_merge( User
::getAllGroups() );
3333 'add-self' => array(),
3334 'remove-self' => array()
3338 // Okay, it's not so simple, we will have to go through the arrays
3341 'remove' => array(),
3342 'add-self' => array(),
3343 'remove-self' => array()
3345 $addergroups = $this->getEffectiveGroups();
3347 foreach( $addergroups as $addergroup ) {
3348 $groups = array_merge_recursive(
3349 $groups, $this->changeableByGroup( $addergroup )
3351 $groups['add'] = array_unique( $groups['add'] );
3352 $groups['remove'] = array_unique( $groups['remove'] );
3353 $groups['add-self'] = array_unique( $groups['add-self'] );
3354 $groups['remove-self'] = array_unique( $groups['remove-self'] );
3360 * Increment the user's edit-count field.
3361 * Will have no effect for anonymous users.
3363 function incEditCount() {
3364 if( !$this->isAnon() ) {
3365 $dbw = wfGetDB( DB_MASTER
);
3366 $dbw->update( 'user',
3367 array( 'user_editcount=user_editcount+1' ),
3368 array( 'user_id' => $this->getId() ),
3371 // Lazy initialization check...
3372 if( $dbw->affectedRows() == 0 ) {
3373 // Pull from a slave to be less cruel to servers
3374 // Accuracy isn't the point anyway here
3375 $dbr = wfGetDB( DB_SLAVE
);
3376 $count = $dbr->selectField( 'revision',
3378 array( 'rev_user' => $this->getId() ),
3381 // Now here's a goddamn hack...
3382 if( $dbr !== $dbw ) {
3383 // If we actually have a slave server, the count is
3384 // at least one behind because the current transaction
3385 // has not been committed and replicated.
3388 // But if DB_SLAVE is selecting the master, then the
3389 // count we just read includes the revision that was
3390 // just added in the working transaction.
3393 $dbw->update( 'user',
3394 array( 'user_editcount' => $count ),
3395 array( 'user_id' => $this->getId() ),
3399 // edit count in user cache too
3400 $this->invalidateCache();
3404 * Get the description of a given right
3406 * @param $right \string Right to query
3407 * @return \string Localized description of the right
3409 static function getRightDescription( $right ) {
3410 global $wgMessageCache;
3411 $wgMessageCache->loadAllMessages();
3412 $key = "right-$right";
3413 $name = wfMsg( $key );
3414 return $name == '' ||
wfEmptyMsg( $key, $name )
3420 * Make an old-style password hash
3422 * @param $password \string Plain-text password
3423 * @param $userId \string User ID
3424 * @return \string Password hash
3426 static function oldCrypt( $password, $userId ) {
3427 global $wgPasswordSalt;
3428 if ( $wgPasswordSalt ) {
3429 return md5( $userId . '-' . md5( $password ) );
3431 return md5( $password );
3436 * Make a new-style password hash
3438 * @param $password \string Plain-text password
3439 * @param $salt \string Optional salt, may be random or the user ID.
3440 * If unspecified or false, will generate one automatically
3441 * @return \string Password hash
3443 static function crypt( $password, $salt = false ) {
3444 global $wgPasswordSalt;
3447 if( !wfRunHooks( 'UserCryptPassword', array( &$password, &$salt, &$wgPasswordSalt, &$hash ) ) ) {
3451 if( $wgPasswordSalt ) {
3452 if ( $salt === false ) {
3453 $salt = substr( wfGenerateToken(), 0, 8 );
3455 return ':B:' . $salt . ':' . md5( $salt . '-' . md5( $password ) );
3457 return ':A:' . md5( $password );
3462 * Compare a password hash with a plain-text password. Requires the user
3463 * ID if there's a chance that the hash is an old-style hash.
3465 * @param $hash \string Password hash
3466 * @param $password \string Plain-text password to compare
3467 * @param $userId \string User ID for old-style password salt
3470 static function comparePasswords( $hash, $password, $userId = false ) {
3472 $type = substr( $hash, 0, 3 );
3475 if( !wfRunHooks( 'UserComparePasswords', array( &$hash, &$password, &$userId, &$result ) ) ) {
3479 if ( $type == ':A:' ) {
3481 return md5( $password ) === substr( $hash, 3 );
3482 } elseif ( $type == ':B:' ) {
3484 list( $salt, $realHash ) = explode( ':', substr( $hash, 3 ), 2 );
3485 return md5( $salt.'-'.md5( $password ) ) == $realHash;
3488 return self
::oldCrypt( $password, $userId ) === $hash;
3493 * Add a newuser log entry for this user
3494 * @param $byEmail Boolean: account made by email?
3496 public function addNewUserLogEntry( $byEmail = false ) {
3497 global $wgUser, $wgContLang, $wgNewUserLog;
3498 if( empty( $wgNewUserLog ) ) {
3499 return true; // disabled
3501 $talk = $wgContLang->getFormattedNsText( NS_TALK
);
3502 if( $this->getName() == $wgUser->getName() ) {
3506 $action = 'create2';
3508 ?
wfMsgForContent( 'newuserlog-byemail' )
3511 $log = new LogPage( 'newusers' );
3514 $this->getUserPage(),
3516 array( $this->getId() )
3522 * Add an autocreate newuser log entry for this user
3523 * Used by things like CentralAuth and perhaps other authplugins.
3525 public function addNewUserLogEntryAutoCreate() {
3526 global $wgNewUserLog;
3527 if( empty( $wgNewUserLog ) ) {
3528 return true; // disabled
3530 $log = new LogPage( 'newusers', false );
3531 $log->addEntry( 'autocreate', $this->getUserPage(), '', array( $this->getId() ) );
3535 protected function loadOptions() {
3537 if ( $this->mOptionsLoaded ||
!$this->getId() )
3540 $this->mOptions
= self
::getDefaultOptions();
3542 // Maybe load from the object
3543 if ( !is_null( $this->mOptionOverrides
) ) {
3544 wfDebug( "Loading options for user " . $this->getId() . " from override cache.\n" );
3545 foreach( $this->mOptionOverrides
as $key => $value ) {
3546 $this->mOptions
[$key] = $value;
3549 wfDebug( "Loading options for user " . $this->getId() . " from database.\n" );
3550 // Load from database
3551 $dbr = wfGetDB( DB_SLAVE
);
3553 $res = $dbr->select(
3556 array( 'up_user' => $this->getId() ),
3560 while( $row = $dbr->fetchObject( $res ) ) {
3561 $this->mOptionOverrides
[$row->up_property
] = $row->up_value
;
3562 $this->mOptions
[$row->up_property
] = $row->up_value
;
3566 $this->mOptionsLoaded
= true;
3568 wfRunHooks( 'UserLoadOptions', array( $this, &$this->mOptions
) );
3571 protected function saveOptions() {
3572 global $wgAllowPrefChange;
3574 $extuser = ExternalUser
::newFromUser( $this );
3576 $this->loadOptions();
3577 $dbw = wfGetDB( DB_MASTER
);
3579 $insert_rows = array();
3581 $saveOptions = $this->mOptions
;
3583 // Allow hooks to abort, for instance to save to a global profile.
3584 // Reset options to default state before saving.
3585 if( !wfRunHooks( 'UserSaveOptions', array( $this, &$saveOptions ) ) )
3588 foreach( $saveOptions as $key => $value ) {
3589 # Don't bother storing default values
3590 if ( ( is_null( self
::getDefaultOption( $key ) ) &&
3591 !( $value === false ||
is_null($value) ) ) ||
3592 $value != self
::getDefaultOption( $key ) ) {
3593 $insert_rows[] = array(
3594 'up_user' => $this->getId(),
3595 'up_property' => $key,
3596 'up_value' => $value,
3599 if ( $extuser && isset( $wgAllowPrefChange[$key] ) ) {
3600 switch ( $wgAllowPrefChange[$key] ) {
3606 $extuser->setPref( $key, $value );
3612 $dbw->delete( 'user_properties', array( 'up_user' => $this->getId() ), __METHOD__
);
3613 $dbw->insert( 'user_properties', $insert_rows, __METHOD__
);
3618 * Provide an array of HTML 5 attributes to put on an input element
3619 * intended for the user to enter a new password. This may include
3620 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
3622 * Do *not* use this when asking the user to enter his current password!
3623 * Regardless of configuration, users may have invalid passwords for whatever
3624 * reason (e.g., they were set before requirements were tightened up).
3625 * Only use it when asking for a new password, like on account creation or
3628 * Obviously, you still need to do server-side checking.
3630 * @return array Array of HTML attributes suitable for feeding to
3631 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
3632 * That will potentially output invalid XHTML 1.0 Transitional, and will
3633 * get confused by the boolean attribute syntax used.)
3635 public static function passwordChangeInputAttribs() {
3636 global $wgMinimalPasswordLength;
3638 if ( $wgMinimalPasswordLength == 0 ) {
3642 # Note that the pattern requirement will always be satisfied if the
3643 # input is empty, so we need required in all cases.
3644 $ret = array( 'required' );
3646 # We can't actually do this right now, because Opera 9.6 will print out
3647 # the entered password visibly in its error message! When other
3648 # browsers add support for this attribute, or Opera fixes its support,
3649 # we can add support with a version check to avoid doing this on Opera
3650 # versions where it will be a problem. Reported to Opera as
3651 # DSK-262266, but they don't have a public bug tracker for us to follow.
3653 if ( $wgMinimalPasswordLength > 1 ) {
3654 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
3655 $ret['title'] = wfMsgExt( 'passwordtooshort', 'parsemag',
3656 $wgMinimalPasswordLength );