bd1c9d90a37d7802e1bf99b4582edf50eeeb2c62
7 # Number of characters in user_token field
8 define( 'USER_TOKEN_LENGTH', 32 );
10 # Serialized record version
11 define( 'MW_USER_VERSION', 6 );
13 # Some punctuation to prevent editing from broken text-mangling proxies.
14 define( 'EDIT_TOKEN_SUFFIX', '+\\' );
17 * Thrown by User::setPassword() on error
20 class PasswordError
extends MWException
{
25 * The User object encapsulates all of the user-specific settings (user_id,
26 * name, rights, password, email address, options, last login time). Client
27 * classes use the getXXX() functions to access these fields. These functions
28 * do all the work of determining whether the user is logged in,
29 * whether the requested option can be satisfied from cookies or
30 * whether a database query is needed. Most of the settings needed
31 * for rendering normal pages are set in the cookie to minimize use
37 * A list of default user toggles, i.e. boolean user preferences that are
38 * displayed by Special:Preferences as checkboxes. This list can be
39 * extended via the UserToggles hook or $wgContLang->getExtraUserToggles().
41 static public $mToggles = array(
51 'editsectiononrightclick',
63 'enotifwatchlistpages',
64 'enotifusertalkpages',
67 'shownumberswatching',
83 * List of member variables which are saved to the shared cache (memcached).
84 * Any operation which changes the corresponding database fields must
85 * call a cache-clearing function.
87 static $mCacheVars = array(
99 'mEmailAuthenticated',
101 'mEmailTokenExpires',
110 * Each of these should have a corresponding message of the form "right-$right"
112 static $mCoreRights = array(
152 static $mAllRights = false;
155 * The cache variable declarations
157 var $mId, $mName, $mRealName, $mPassword, $mNewpassword, $mNewpassTime,
158 $mEmail, $mOptions, $mTouched, $mToken, $mEmailAuthenticated,
159 $mEmailToken, $mEmailTokenExpires, $mRegistration, $mGroups;
162 * Whether the cache variables have been loaded
167 * Initialisation data source if mDataLoaded==false. May be one of:
168 * defaults anonymous user initialised from class defaults
169 * name initialise from mName
170 * id initialise from mId
171 * session log in from cookies or session if possible
173 * Use the User::newFrom*() family of functions to set this.
178 * Lazy-initialised variables, invalidated with clearInstanceCache
180 var $mNewtalk, $mDatePreference, $mBlockedby, $mHash, $mSkin, $mRights,
181 $mBlockreason, $mBlock, $mEffectiveGroups;
184 * Lightweight constructor for anonymous user
185 * Use the User::newFrom* factory functions for other kinds of users
188 $this->clearInstanceCache( 'defaults' );
192 * Load the user table data for this object from the source given by mFrom
195 if ( $this->mDataLoaded
) {
198 wfProfileIn( __METHOD__
);
200 # Set it now to avoid infinite recursion in accessors
201 $this->mDataLoaded
= true;
203 switch ( $this->mFrom
) {
205 $this->loadDefaults();
208 $this->mId
= self
::idFromName( $this->mName
);
210 # Nonexistent user placeholder object
211 $this->loadDefaults( $this->mName
);
220 $this->loadFromSession();
223 throw new MWException( "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
225 wfProfileOut( __METHOD__
);
229 * Load user table data given mId
230 * @return false if the ID does not exist, true otherwise
233 function loadFromId() {
235 if ( $this->mId
== 0 ) {
236 $this->loadDefaults();
241 $key = wfMemcKey( 'user', 'id', $this->mId
);
242 $data = $wgMemc->get( $key );
243 if ( !is_array( $data ) ||
$data['mVersion'] < MW_USER_VERSION
) {
244 # Object is expired, load from DB
249 wfDebug( "Cache miss for user {$this->mId}\n" );
251 if ( !$this->loadFromDatabase() ) {
252 # Can't load from ID, user is anonymous
255 $this->saveToCache();
257 wfDebug( "Got user {$this->mId} from cache\n" );
259 foreach ( self
::$mCacheVars as $name ) {
260 $this->$name = $data[$name];
267 * Save user data to the shared cache
269 function saveToCache() {
272 if ( $this->isAnon() ) {
273 // Anonymous users are uncached
277 foreach ( self
::$mCacheVars as $name ) {
278 $data[$name] = $this->$name;
280 $data['mVersion'] = MW_USER_VERSION
;
281 $key = wfMemcKey( 'user', 'id', $this->mId
);
283 $wgMemc->set( $key, $data );
287 * Static factory method for creation from username.
289 * This is slightly less efficient than newFromId(), so use newFromId() if
290 * you have both an ID and a name handy.
292 * @param string $name Username, validated by Title:newFromText()
293 * @param mixed $validate Validate username. Takes the same parameters as
294 * User::getCanonicalName(), except that true is accepted as an alias
295 * for 'valid', for BC.
297 * @return User object, or null if the username is invalid. If the username
298 * is not present in the database, the result will be a user object with
299 * a name, zero user ID and default settings.
302 static function newFromName( $name, $validate = 'valid' ) {
303 if ( $validate === true ) {
306 $name = self
::getCanonicalName( $name, $validate );
307 if ( $name === false ) {
310 # Create unloaded user object
318 static function newFromId( $id ) {
326 * Factory method to fetch whichever user has a given email confirmation code.
327 * This code is generated when an account is created or its e-mail address
330 * If the code is invalid or has expired, returns NULL.
332 * @param string $code
336 static function newFromConfirmationCode( $code ) {
337 $dbr = wfGetDB( DB_SLAVE
);
338 $id = $dbr->selectField( 'user', 'user_id', array(
339 'user_email_token' => md5( $code ),
340 'user_email_token_expires > ' . $dbr->addQuotes( $dbr->timestamp() ),
342 if( $id !== false ) {
343 return User
::newFromId( $id );
350 * Create a new user object using data from session or cookies. If the
351 * login credentials are invalid, the result is an anonymous user.
356 static function newFromSession() {
358 $user->mFrom
= 'session';
363 * Create a new user object from a user row.
364 * The row should have all fields from the user table in it.
366 static function newFromRow( $row ) {
368 $user->loadFromRow( $row );
373 * Get username given an id.
374 * @param integer $id Database user id
375 * @return string Nickname of a user
378 static function whoIs( $id ) {
379 $dbr = wfGetDB( DB_SLAVE
);
380 return $dbr->selectField( 'user', 'user_name', array( 'user_id' => $id ), 'User::whoIs' );
384 * Get the real name of a user given their identifier
386 * @param int $id Database user id
387 * @return string Real name of a user
389 static function whoIsReal( $id ) {
390 $dbr = wfGetDB( DB_SLAVE
);
391 return $dbr->selectField( 'user', 'user_real_name', array( 'user_id' => $id ), __METHOD__
);
395 * Get database id given a user name
396 * @param string $name Nickname of a user
397 * @return integer|null Database user id (null: if non existent
400 static function idFromName( $name ) {
401 $nt = Title
::newFromText( $name );
402 if( is_null( $nt ) ) {
406 $dbr = wfGetDB( DB_SLAVE
);
407 $s = $dbr->selectRow( 'user', array( 'user_id' ), array( 'user_name' => $nt->getText() ), __METHOD__
);
409 if ( $s === false ) {
417 * Does the string match an anonymous IPv4 address?
419 * This function exists for username validation, in order to reject
420 * usernames which are similar in form to IP addresses. Strings such
421 * as 300.300.300.300 will return true because it looks like an IP
422 * address, despite not being strictly valid.
424 * We match \d{1,3}\.\d{1,3}\.\d{1,3}\.xxx as an anonymous IP
425 * address because the usemod software would "cloak" anonymous IP
426 * addresses like this, if we allowed accounts like this to be created
427 * new users could get the old edits of these anonymous users.
430 * @param string $name Nickname of a user
433 static function isIP( $name ) {
434 return preg_match('/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/',$name) || User
::isIPv6($name);
435 /*return preg_match("/^
436 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
437 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
438 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))\.
439 (?:[01]?\d{1,2}|2(:?[0-4]\d|5[0-5]))
444 * Check if $name is an IPv6 IP.
446 static function isIPv6($name) {
448 * if it has any non-valid characters, it can't be a valid IPv6
451 if (preg_match("/[^:a-fA-F0-9]/", $name))
454 $parts = explode(":", $name);
455 if (count($parts) < 3)
457 foreach ($parts as $part) {
458 if (!preg_match("/^[0-9a-fA-F]{0,4}$/", $part))
465 * Is the input a valid username?
467 * Checks if the input is a valid username, we don't want an empty string,
468 * an IP address, anything that containins slashes (would mess up subpages),
469 * is longer than the maximum allowed username size or doesn't begin with
472 * @param string $name
476 static function isValidUserName( $name ) {
477 global $wgContLang, $wgMaxNameChars;
480 || User
::isIP( $name )
481 ||
strpos( $name, '/' ) !== false
482 ||
strlen( $name ) > $wgMaxNameChars
483 ||
$name != $wgContLang->ucfirst( $name ) ) {
484 wfDebugLog( 'username', __METHOD__
.
485 ": '$name' invalid due to empty, IP, slash, length, or lowercase" );
489 // Ensure that the name can't be misresolved as a different title,
490 // such as with extra namespace keys at the start.
491 $parsed = Title
::newFromText( $name );
492 if( is_null( $parsed )
493 ||
$parsed->getNamespace()
494 ||
strcmp( $name, $parsed->getPrefixedText() ) ) {
495 wfDebugLog( 'username', __METHOD__
.
496 ": '$name' invalid due to ambiguous prefixes" );
500 // Check an additional blacklist of troublemaker characters.
501 // Should these be merged into the title char list?
502 $unicodeBlacklist = '/[' .
503 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
504 '\x{00a0}' . # non-breaking space
505 '\x{2000}-\x{200f}' . # various whitespace
506 '\x{2028}-\x{202f}' . # breaks and control chars
507 '\x{3000}' . # ideographic space
508 '\x{e000}-\x{f8ff}' . # private use
510 if( preg_match( $unicodeBlacklist, $name ) ) {
511 wfDebugLog( 'username', __METHOD__
.
512 ": '$name' invalid due to blacklisted characters" );
520 * Usernames which fail to pass this function will be blocked
521 * from user login and new account registrations, but may be used
522 * internally by batch processes.
524 * If an account already exists in this form, login will be blocked
525 * by a failure to pass this function.
527 * @param string $name
530 static function isUsableName( $name ) {
531 global $wgReservedUsernames;
533 // Must be a valid username, obviously ;)
534 self
::isValidUserName( $name ) &&
536 // Certain names may be reserved for batch processes.
537 !in_array( $name, $wgReservedUsernames );
541 * Usernames which fail to pass this function will be blocked
542 * from new account registrations, but may be used internally
543 * either by batch processes or by user accounts which have
544 * already been created.
546 * Additional character blacklisting may be added here
547 * rather than in isValidUserName() to avoid disrupting
550 * @param string $name
553 static function isCreatableName( $name ) {
555 self
::isUsableName( $name ) &&
557 // Registration-time character blacklisting...
558 strpos( $name, '@' ) === false;
562 * Is the input a valid password for this user?
564 * @param string $password Desired password
567 function isValidPassword( $password ) {
568 global $wgMinimalPasswordLength, $wgContLang;
571 if( !wfRunHooks( 'isValidPassword', array( $password, &$result, $this ) ) )
573 if( $result === false )
576 // Password needs to be long enough, and can't be the same as the username
577 return strlen( $password ) >= $wgMinimalPasswordLength
578 && $wgContLang->lc( $password ) !== $wgContLang->lc( $this->mName
);
582 * Does a string look like an email address?
584 * There used to be a regular expression here, it got removed because it
585 * rejected valid addresses. Actually just check if there is '@' somewhere
586 * in the given address.
588 * @todo Check for RFC 2822 compilance (bug 959)
590 * @param string $addr email address
593 public static function isValidEmailAddr( $addr ) {
595 if( !wfRunHooks( 'isValidEmailAddr', array( $addr, &$result ) ) ) {
599 return strpos( $addr, '@' ) !== false;
603 * Given unvalidated user input, return a canonical username, or false if
604 * the username is invalid.
605 * @param string $name
606 * @param mixed $validate Type of validation to use:
607 * false No validation
608 * 'valid' Valid for batch processes
609 * 'usable' Valid for batch processes and login
610 * 'creatable' Valid for batch processes, login and account creation
612 static function getCanonicalName( $name, $validate = 'valid' ) {
613 # Force usernames to capital
615 $name = $wgContLang->ucfirst( $name );
617 # Reject names containing '#'; these will be cleaned up
618 # with title normalisation, but then it's too late to
620 if( strpos( $name, '#' ) !== false )
623 # Clean up name according to title rules
624 $t = Title
::newFromText( $name );
625 if( is_null( $t ) ) {
629 # Reject various classes of invalid names
630 $name = $t->getText();
632 $name = $wgAuth->getCanonicalName( $t->getText() );
634 switch ( $validate ) {
638 if ( !User
::isValidUserName( $name ) ) {
643 if ( !User
::isUsableName( $name ) ) {
648 if ( !User
::isCreatableName( $name ) ) {
653 throw new MWException( 'Invalid parameter value for $validate in '.__METHOD__
);
659 * Count the number of edits of a user
661 * It should not be static and some day should be merged as proper member function / deprecated -- domas
663 * @param int $uid The user ID to check
667 static function edits( $uid ) {
668 wfProfileIn( __METHOD__
);
669 $dbr = wfGetDB( DB_SLAVE
);
670 // check if the user_editcount field has been initialized
671 $field = $dbr->selectField(
672 'user', 'user_editcount',
673 array( 'user_id' => $uid ),
677 if( $field === null ) { // it has not been initialized. do so.
678 $dbw = wfGetDB( DB_MASTER
);
679 $count = $dbr->selectField(
680 'revision', 'count(*)',
681 array( 'rev_user' => $uid ),
686 array( 'user_editcount' => $count ),
687 array( 'user_id' => $uid ),
693 wfProfileOut( __METHOD__
);
698 * Return a random password. Sourced from mt_rand, so it's not particularly secure.
699 * @todo hash random numbers to improve security, like generateToken()
704 static function randomPassword() {
705 global $wgMinimalPasswordLength;
706 $pwchars = 'ABCDEFGHJKLMNPQRSTUVWXYZabcdefghjkmnpqrstuvwxyz';
707 $l = strlen( $pwchars ) - 1;
709 $pwlength = max( 7, $wgMinimalPasswordLength );
710 $digit = mt_rand(0, $pwlength - 1);
712 for ( $i = 0; $i < $pwlength; $i++
) {
713 $np .= $i == $digit ?
chr( mt_rand(48, 57) ) : $pwchars{ mt_rand(0, $l)};
719 * Set cached properties to default. Note: this no longer clears
720 * uncached lazy-initialised properties. The constructor does that instead.
724 function loadDefaults( $name = false ) {
725 wfProfileIn( __METHOD__
);
727 global $wgCookiePrefix;
730 $this->mName
= $name;
731 $this->mRealName
= '';
732 $this->mPassword
= $this->mNewpassword
= '';
733 $this->mNewpassTime
= null;
735 $this->mOptions
= null; # Defer init
737 if ( isset( $_COOKIE[$wgCookiePrefix.'LoggedOut'] ) ) {
738 $this->mTouched
= wfTimestamp( TS_MW
, $_COOKIE[$wgCookiePrefix.'LoggedOut'] );
740 $this->mTouched
= '0'; # Allow any pages to be cached
743 $this->setToken(); # Random
744 $this->mEmailAuthenticated
= null;
745 $this->mEmailToken
= '';
746 $this->mEmailTokenExpires
= null;
747 $this->mRegistration
= wfTimestamp( TS_MW
);
748 $this->mGroups
= array();
750 wfRunHooks( 'UserLoadDefaults', array( $this, $name ) );
752 wfProfileOut( __METHOD__
);
756 * Initialise php session
757 * @deprecated use wfSetupSession()
759 function SetupSession() {
760 wfDeprecated( __METHOD__
);
765 * Load user data from the session or login cookie. If there are no valid
766 * credentials, initialises the user as an anon.
767 * @return true if the user is logged in, false otherwise
769 private function loadFromSession() {
770 global $wgMemc, $wgCookiePrefix;
773 wfRunHooks( 'UserLoadFromSession', array( $this, &$result ) );
774 if ( $result !== null ) {
778 if ( isset( $_SESSION['wsUserID'] ) ) {
779 if ( 0 != $_SESSION['wsUserID'] ) {
780 $sId = $_SESSION['wsUserID'];
782 $this->loadDefaults();
785 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserID"] ) ) {
786 $sId = intval( $_COOKIE["{$wgCookiePrefix}UserID"] );
787 $_SESSION['wsUserID'] = $sId;
789 $this->loadDefaults();
792 if ( isset( $_SESSION['wsUserName'] ) ) {
793 $sName = $_SESSION['wsUserName'];
794 } else if ( isset( $_COOKIE["{$wgCookiePrefix}UserName"] ) ) {
795 $sName = $_COOKIE["{$wgCookiePrefix}UserName"];
796 $_SESSION['wsUserName'] = $sName;
798 $this->loadDefaults();
802 $passwordCorrect = FALSE;
804 if ( !$this->loadFromId() ) {
805 # Not a valid ID, loadFromId has switched the object to anon for us
809 if ( isset( $_SESSION['wsToken'] ) ) {
810 $passwordCorrect = $_SESSION['wsToken'] == $this->mToken
;
812 } else if ( isset( $_COOKIE["{$wgCookiePrefix}Token"] ) ) {
813 $passwordCorrect = $this->mToken
== $_COOKIE["{$wgCookiePrefix}Token"];
816 # No session or persistent login cookie
817 $this->loadDefaults();
821 if ( ( $sName == $this->mName
) && $passwordCorrect ) {
822 $_SESSION['wsToken'] = $this->mToken
;
823 wfDebug( "Logged in from $from\n" );
826 # Invalid credentials
827 wfDebug( "Can't log in from $from, invalid credentials\n" );
828 $this->loadDefaults();
834 * Load user and user_group data from the database
835 * $this->mId must be set, this is how the user is identified.
837 * @return true if the user exists, false if the user is anonymous
840 function loadFromDatabase() {
842 $this->mId
= intval( $this->mId
);
844 /** Anonymous user */
846 $this->loadDefaults();
850 $dbr = wfGetDB( DB_MASTER
);
851 $s = $dbr->selectRow( 'user', '*', array( 'user_id' => $this->mId
), __METHOD__
);
853 if ( $s !== false ) {
854 # Initialise user table data
855 $this->loadFromRow( $s );
856 $this->mGroups
= null; // deferred
857 $this->getEditCount(); // revalidation for nulls
862 $this->loadDefaults();
868 * Initialise the user object from a row from the user table
870 function loadFromRow( $row ) {
871 $this->mDataLoaded
= true;
873 if ( isset( $row->user_id
) ) {
874 $this->mId
= $row->user_id
;
876 $this->mName
= $row->user_name
;
877 $this->mRealName
= $row->user_real_name
;
878 $this->mPassword
= $row->user_password
;
879 $this->mNewpassword
= $row->user_newpassword
;
880 $this->mNewpassTime
= wfTimestampOrNull( TS_MW
, $row->user_newpass_time
);
881 $this->mEmail
= $row->user_email
;
882 $this->decodeOptions( $row->user_options
);
883 $this->mTouched
= wfTimestamp(TS_MW
,$row->user_touched
);
884 $this->mToken
= $row->user_token
;
885 $this->mEmailAuthenticated
= wfTimestampOrNull( TS_MW
, $row->user_email_authenticated
);
886 $this->mEmailToken
= $row->user_email_token
;
887 $this->mEmailTokenExpires
= wfTimestampOrNull( TS_MW
, $row->user_email_token_expires
);
888 $this->mRegistration
= wfTimestampOrNull( TS_MW
, $row->user_registration
);
889 $this->mEditCount
= $row->user_editcount
;
893 * Load the groups from the database if they aren't already loaded
896 function loadGroups() {
897 if ( is_null( $this->mGroups
) ) {
898 $dbr = wfGetDB( DB_MASTER
);
899 $res = $dbr->select( 'user_groups',
901 array( 'ug_user' => $this->mId
),
903 $this->mGroups
= array();
904 while( $row = $dbr->fetchObject( $res ) ) {
905 $this->mGroups
[] = $row->ug_group
;
911 * Clear various cached data stored in this object.
912 * @param string $reloadFrom Reload user and user_groups table data from a
913 * given source. May be "name", "id", "defaults", "session" or false for
916 function clearInstanceCache( $reloadFrom = false ) {
917 $this->mNewtalk
= -1;
918 $this->mDatePreference
= null;
919 $this->mBlockedby
= -1; # Unset
920 $this->mHash
= false;
922 $this->mRights
= null;
923 $this->mEffectiveGroups
= null;
926 $this->mDataLoaded
= false;
927 $this->mFrom
= $reloadFrom;
932 * Combine the language default options with any site-specific options
933 * and add the default language variants.
934 * Not really private cause it's called by Language class
939 static function getDefaultOptions() {
940 global $wgNamespacesToBeSearchedDefault;
942 * Site defaults will override the global/language defaults
944 global $wgDefaultUserOptions, $wgContLang;
945 $defOpt = $wgDefaultUserOptions +
$wgContLang->getDefaultUserOptionOverrides();
948 * default language setting
950 $variant = $wgContLang->getPreferredVariant( false );
951 $defOpt['variant'] = $variant;
952 $defOpt['language'] = $variant;
954 foreach( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
955 $defOpt['searchNs'.$nsnum] = $val;
961 * Get a given default option value.
968 function getDefaultOption( $opt ) {
969 $defOpts = User
::getDefaultOptions();
970 if( isset( $defOpts[$opt] ) ) {
971 return $defOpts[$opt];
978 * Get a list of user toggle names
981 static function getToggles() {
983 $extraToggles = array();
984 wfRunHooks( 'UserToggles', array( &$extraToggles ) );
985 return array_merge( self
::$mToggles, $extraToggles, $wgContLang->getExtraUserToggles() );
990 * Get blocking information
992 * @param bool $bFromSlave Specify whether to check slave or master. To improve performance,
993 * non-critical checks are done against slaves. Check when actually saving should be done against
996 function getBlockedStatus( $bFromSlave = true ) {
997 global $wgEnableSorbs, $wgProxyWhitelist;
999 if ( -1 != $this->mBlockedby
) {
1000 wfDebug( "User::getBlockedStatus: already loaded.\n" );
1004 wfProfileIn( __METHOD__
);
1005 wfDebug( __METHOD__
.": checking...\n" );
1007 // Initialize data...
1008 // Otherwise something ends up stomping on $this->mBlockedby when
1009 // things get lazy-loaded later, causing false positive block hits
1010 // due to -1 !== 0. Probably session-related... Nothing should be
1011 // overwriting mBlockedby, surely?
1014 $this->mBlockedby
= 0;
1015 $this->mHideName
= 0;
1018 if ($this->isAllowed( 'ipblock-exempt' ) ) {
1019 # Exempt from all types of IP-block
1024 $this->mBlock
= new Block();
1025 $this->mBlock
->fromMaster( !$bFromSlave );
1026 if ( $this->mBlock
->load( $ip , $this->mId
) ) {
1027 wfDebug( __METHOD__
.": Found block.\n" );
1028 $this->mBlockedby
= $this->mBlock
->mBy
;
1029 $this->mBlockreason
= $this->mBlock
->mReason
;
1030 $this->mHideName
= $this->mBlock
->mHideName
;
1031 if ( $this->isLoggedIn() ) {
1032 $this->spreadBlock();
1035 $this->mBlock
= null;
1036 wfDebug( __METHOD__
.": No block.\n" );
1040 if ( !$this->isAllowed('proxyunbannable') && !in_array( $ip, $wgProxyWhitelist ) ) {
1042 if ( wfIsLocallyBlockedProxy( $ip ) ) {
1043 $this->mBlockedby
= wfMsg( 'proxyblocker' );
1044 $this->mBlockreason
= wfMsg( 'proxyblockreason' );
1048 if ( !$this->mBlockedby
&& $wgEnableSorbs && !$this->getID() ) {
1049 if ( $this->inSorbsBlacklist( $ip ) ) {
1050 $this->mBlockedby
= wfMsg( 'sorbs' );
1051 $this->mBlockreason
= wfMsg( 'sorbsreason' );
1057 wfRunHooks( 'GetBlockedStatus', array( &$this ) );
1059 wfProfileOut( __METHOD__
);
1062 function inSorbsBlacklist( $ip ) {
1063 global $wgEnableSorbs, $wgSorbsUrl;
1065 return $wgEnableSorbs &&
1066 $this->inDnsBlacklist( $ip, $wgSorbsUrl );
1069 function inDnsBlacklist( $ip, $base ) {
1070 wfProfileIn( __METHOD__
);
1076 if ( preg_match( '/^(\d{1,3})\.(\d{1,3})\.(\d{1,3})\.(\d{1,3})$/', $ip, $m ) ) {
1078 for ( $i=4; $i>=1; $i-- ) {
1079 $host .= $m[$i] . '.';
1084 $ipList = gethostbynamel( $host );
1087 wfDebug( "Hostname $host is {$ipList[0]}, it's a proxy says $base!\n" );
1090 wfDebug( "Requested $host, not found in $base.\n" );
1094 wfProfileOut( __METHOD__
);
1099 * Is this user subject to rate limiting?
1103 public function isPingLimitable() {
1104 global $wgRateLimitsExcludedGroups;
1105 if ( array_intersect($this->getEffectiveGroups(), $wgRateLimitsExcludedGroups) == array() ||
1106 !$this->isAllowed('noratelimit') ) {
1115 * Primitive rate limits: enforce maximum actions per time period
1116 * to put a brake on flooding.
1118 * Note: when using a shared cache like memcached, IP-address
1119 * last-hit counters will be shared across wikis.
1121 * @return bool true if a rate limiter was tripped
1124 function pingLimiter( $action='edit' ) {
1126 # Call the 'PingLimiter' hook
1128 if( !wfRunHooks( 'PingLimiter', array( &$this, $action, $result ) ) ) {
1132 global $wgRateLimits;
1133 if( !isset( $wgRateLimits[$action] ) ) {
1137 # Some groups shouldn't trigger the ping limiter, ever
1138 if( !$this->isPingLimitable() )
1141 global $wgMemc, $wgRateLimitLog;
1142 wfProfileIn( __METHOD__
);
1144 $limits = $wgRateLimits[$action];
1146 $id = $this->getId();
1150 if( isset( $limits['anon'] ) && $id == 0 ) {
1151 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1154 if( isset( $limits['user'] ) && $id != 0 ) {
1155 $userLimit = $limits['user'];
1157 if( $this->isNewbie() ) {
1158 if( isset( $limits['newbie'] ) && $id != 0 ) {
1159 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1161 if( isset( $limits['ip'] ) ) {
1162 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1165 if( isset( $limits['subnet'] ) && preg_match( '/^(\d+\.\d+\.\d+)\.\d+$/', $ip, $matches ) ) {
1166 $subnet = $matches[1];
1167 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1170 // Check for group-specific permissions
1171 // If more than one group applies, use the group with the highest limit
1172 foreach ( $this->getGroups() as $group ) {
1173 if ( isset( $limits[$group] ) ) {
1174 if ( $userLimit === false ||
$limits[$group] > $userLimit ) {
1175 $userLimit = $limits[$group];
1179 // Set the user limit key
1180 if ( $userLimit !== false ) {
1181 wfDebug( __METHOD__
.": effective user limit: $userLimit\n" );
1182 $keys[ wfMemcKey( 'limiter', $action, 'user', $id ) ] = $userLimit;
1186 foreach( $keys as $key => $limit ) {
1187 list( $max, $period ) = $limit;
1188 $summary = "(limit $max in {$period}s)";
1189 $count = $wgMemc->get( $key );
1191 if( $count > $max ) {
1192 wfDebug( __METHOD__
.": tripped! $key at $count $summary\n" );
1193 if( $wgRateLimitLog ) {
1194 @error_log
( wfTimestamp( TS_MW
) . ' ' . wfWikiID() . ': ' . $this->getName() . " tripped $key at $count $summary\n", 3, $wgRateLimitLog );
1198 wfDebug( __METHOD__
.": ok. $key at $count $summary\n" );
1201 wfDebug( __METHOD__
.": adding record for $key $summary\n" );
1202 $wgMemc->add( $key, 1, intval( $period ) );
1204 $wgMemc->incr( $key );
1207 wfProfileOut( __METHOD__
);
1212 * Check if user is blocked
1213 * @return bool True if blocked, false otherwise
1215 function isBlocked( $bFromSlave = true ) { // hacked from false due to horrible probs on site
1216 wfDebug( "User::isBlocked: enter\n" );
1217 $this->getBlockedStatus( $bFromSlave );
1218 return $this->mBlockedby
!== 0;
1222 * Check if user is blocked from editing a particular article
1224 function isBlockedFrom( $title, $bFromSlave = false ) {
1225 global $wgBlockAllowsUTEdit;
1226 wfProfileIn( __METHOD__
);
1227 wfDebug( __METHOD__
.": enter\n" );
1229 wfDebug( __METHOD__
.": asking isBlocked()\n" );
1230 $blocked = $this->isBlocked( $bFromSlave );
1231 # If a user's name is suppressed, they cannot make edits anywhere
1232 if ( !$this->mHideName
&& $wgBlockAllowsUTEdit && $title->getText() === $this->getName() &&
1233 $title->getNamespace() == NS_USER_TALK
) {
1235 wfDebug( __METHOD__
.": self-talk page, ignoring any blocks\n" );
1237 wfProfileOut( __METHOD__
);
1242 * Get name of blocker
1243 * @return string name of blocker
1245 function blockedBy() {
1246 $this->getBlockedStatus();
1247 return $this->mBlockedby
;
1251 * Get blocking reason
1252 * @return string Blocking reason
1254 function blockedFor() {
1255 $this->getBlockedStatus();
1256 return $this->mBlockreason
;
1260 * Get the user ID. Returns 0 if the user is anonymous or nonexistent.
1263 if( $this->mId
=== null and $this->mName
!== null
1264 and User
::isIP( $this->mName
) ) {
1265 // Special case, we know the user is anonymous
1267 } elseif( $this->mId
=== null ) {
1268 // Don't load if this was initialized from an ID
1275 * Set the user and reload all fields according to that ID
1277 function setId( $v ) {
1279 $this->clearInstanceCache( 'id' );
1283 * Get the user name, or the IP for anons
1285 function getName() {
1286 if ( !$this->mDataLoaded
&& $this->mFrom
== 'name' ) {
1287 # Special case optimisation
1288 return $this->mName
;
1291 if ( $this->mName
=== false ) {
1293 $this->mName
= IP
::sanitizeIP( wfGetIP() );
1295 return $this->mName
;
1300 * Set the user name.
1302 * This does not reload fields from the database according to the given
1303 * name. Rather, it is used to create a temporary "nonexistent user" for
1304 * later addition to the database. It can also be used to set the IP
1305 * address for an anonymous user to something other than the current
1308 * User::newFromName() has rougly the same function, when the named user
1311 function setName( $str ) {
1313 $this->mName
= $str;
1317 * Return the title dbkey form of the name, for eg user pages.
1321 function getTitleKey() {
1322 return str_replace( ' ', '_', $this->getName() );
1325 function getNewtalk() {
1328 # Load the newtalk status if it is unloaded (mNewtalk=-1)
1329 if( $this->mNewtalk
=== -1 ) {
1330 $this->mNewtalk
= false; # reset talk page status
1332 # Check memcached separately for anons, who have no
1333 # entire User object stored in there.
1336 $key = wfMemcKey( 'newtalk', 'ip', $this->getName() );
1337 $newtalk = $wgMemc->get( $key );
1338 if( strval( $newtalk ) !== '' ) {
1339 $this->mNewtalk
= (bool)$newtalk;
1341 // Since we are caching this, make sure it is up to date by getting it
1343 $this->mNewtalk
= $this->checkNewtalk( 'user_ip', $this->getName(), true );
1344 $wgMemc->set( $key, (int)$this->mNewtalk
, 1800 );
1347 $this->mNewtalk
= $this->checkNewtalk( 'user_id', $this->mId
);
1351 return (bool)$this->mNewtalk
;
1355 * Return the talk page(s) this user has new messages on.
1357 function getNewMessageLinks() {
1359 if (!wfRunHooks('UserRetrieveNewTalks', array(&$this, &$talks)))
1362 if (!$this->getNewtalk())
1364 $up = $this->getUserPage();
1365 $utp = $up->getTalkPage();
1366 return array(array("wiki" => wfWikiID(), "link" => $utp->getLocalURL()));
1371 * Perform a user_newtalk check, uncached.
1372 * Use getNewtalk for a cached check.
1374 * @param string $field
1376 * @param bool $fromMaster True to fetch from the master, false for a slave
1380 function checkNewtalk( $field, $id, $fromMaster = false ) {
1381 if ( $fromMaster ) {
1382 $db = wfGetDB( DB_MASTER
);
1384 $db = wfGetDB( DB_SLAVE
);
1386 $ok = $db->selectField( 'user_newtalk', $field,
1387 array( $field => $id ), __METHOD__
);
1388 return $ok !== false;
1393 * @param string $field
1397 function updateNewtalk( $field, $id ) {
1398 $dbw = wfGetDB( DB_MASTER
);
1399 $dbw->insert( 'user_newtalk',
1400 array( $field => $id ),
1403 if ( $dbw->affectedRows() ) {
1404 wfDebug( __METHOD__
.": set on ($field, $id)\n" );
1407 wfDebug( __METHOD__
." already set ($field, $id)\n" );
1413 * Clear the new messages flag for the given user
1414 * @param string $field
1418 function deleteNewtalk( $field, $id ) {
1419 $dbw = wfGetDB( DB_MASTER
);
1420 $dbw->delete( 'user_newtalk',
1421 array( $field => $id ),
1423 if ( $dbw->affectedRows() ) {
1424 wfDebug( __METHOD__
.": killed on ($field, $id)\n" );
1427 wfDebug( __METHOD__
.": already gone ($field, $id)\n" );
1433 * Update the 'You have new messages!' status.
1436 function setNewtalk( $val ) {
1437 if( wfReadOnly() ) {
1442 $this->mNewtalk
= $val;
1444 if( $this->isAnon() ) {
1446 $id = $this->getName();
1449 $id = $this->getId();
1454 $changed = $this->updateNewtalk( $field, $id );
1456 $changed = $this->deleteNewtalk( $field, $id );
1459 if( $this->isAnon() ) {
1460 // Anons have a separate memcached space, since
1461 // user records aren't kept for them.
1462 $key = wfMemcKey( 'newtalk', 'ip', $id );
1463 $wgMemc->set( $key, $val ?
1 : 0, 1800 );
1466 $this->invalidateCache();
1471 * Generate a current or new-future timestamp to be stored in the
1472 * user_touched field when we update things.
1474 private static function newTouchedTimestamp() {
1475 global $wgClockSkewFudge;
1476 return wfTimestamp( TS_MW
, time() +
$wgClockSkewFudge );
1480 * Clear user data from memcached.
1481 * Use after applying fun updates to the database; caller's
1482 * responsibility to update user_touched if appropriate.
1484 * Called implicitly from invalidateCache() and saveSettings().
1486 private function clearSharedCache() {
1489 $wgMemc->delete( wfMemcKey( 'user', 'id', $this->mId
) );
1494 * Immediately touch the user data cache for this account.
1495 * Updates user_touched field, and removes account data from memcached
1496 * for reload on the next hit.
1498 function invalidateCache() {
1501 $this->mTouched
= self
::newTouchedTimestamp();
1503 $dbw = wfGetDB( DB_MASTER
);
1504 $dbw->update( 'user',
1505 array( 'user_touched' => $dbw->timestamp( $this->mTouched
) ),
1506 array( 'user_id' => $this->mId
),
1509 $this->clearSharedCache();
1513 function validateCache( $timestamp ) {
1515 return ($timestamp >= $this->mTouched
);
1519 * Encrypt a password.
1520 * It can eventually salt a password.
1521 * @see User::addSalt()
1522 * @param string $p clear Password.
1523 * @return string Encrypted password.
1525 function encryptPassword( $p ) {
1527 return wfEncryptPassword( $this->mId
, $p );
1531 * Set the password and reset the random token
1532 * Calls through to authentication plugin if necessary;
1533 * will have no effect if the auth plugin refuses to
1534 * pass the change through or if the legal password
1537 * As a special case, setting the password to null
1538 * wipes it, so the account cannot be logged in until
1539 * a new password is set, for instance via e-mail.
1541 * @param string $str
1542 * @throws PasswordError on failure
1544 function setPassword( $str ) {
1547 if( $str !== null ) {
1548 if( !$wgAuth->allowPasswordChange() ) {
1549 throw new PasswordError( wfMsg( 'password-change-forbidden' ) );
1552 if( !$this->isValidPassword( $str ) ) {
1553 global $wgMinimalPasswordLength;
1554 throw new PasswordError( wfMsg( 'passwordtooshort',
1555 $wgMinimalPasswordLength ) );
1559 if( !$wgAuth->setPassword( $this, $str ) ) {
1560 throw new PasswordError( wfMsg( 'externaldberror' ) );
1563 $this->setInternalPassword( $str );
1569 * Set the password and reset the random token no matter
1572 * @param string $str
1574 function setInternalPassword( $str ) {
1578 if( $str === null ) {
1579 // Save an invalid hash...
1580 $this->mPassword
= '';
1582 $this->mPassword
= $this->encryptPassword( $str );
1584 $this->mNewpassword
= '';
1585 $this->mNewpassTime
= null;
1588 function getToken() {
1590 return $this->mToken
;
1594 * Set the random token (used for persistent authentication)
1595 * Called from loadDefaults() among other places.
1598 function setToken( $token = false ) {
1599 global $wgSecretKey, $wgProxyKey;
1602 if ( $wgSecretKey ) {
1603 $key = $wgSecretKey;
1604 } elseif ( $wgProxyKey ) {
1609 $this->mToken
= md5( $key . mt_rand( 0, 0x7fffffff ) . wfWikiID() . $this->mId
);
1611 $this->mToken
= $token;
1615 function setCookiePassword( $str ) {
1617 $this->mCookiePassword
= md5( $str );
1621 * Set the password for a password reminder or new account email
1622 * Sets the user_newpass_time field if $throttle is true
1624 function setNewpassword( $str, $throttle = true ) {
1626 $this->mNewpassword
= $this->encryptPassword( $str );
1628 $this->mNewpassTime
= wfTimestampNow();
1633 * Returns true if a password reminder email has already been sent within
1634 * the last $wgPasswordReminderResendTime hours
1636 function isPasswordReminderThrottled() {
1637 global $wgPasswordReminderResendTime;
1639 if ( !$this->mNewpassTime ||
!$wgPasswordReminderResendTime ) {
1642 $expiry = wfTimestamp( TS_UNIX
, $this->mNewpassTime
) +
$wgPasswordReminderResendTime * 3600;
1643 return time() < $expiry;
1646 function getEmail() {
1648 wfRunHooks( 'UserGetEmail', array( $this, &$this->mEmail
) );
1649 return $this->mEmail
;
1652 function getEmailAuthenticationTimestamp() {
1654 wfRunHooks( 'UserGetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
1655 return $this->mEmailAuthenticated
;
1658 function setEmail( $str ) {
1660 $this->mEmail
= $str;
1661 wfRunHooks( 'UserSetEmail', array( $this, &$this->mEmail
) );
1664 function getRealName() {
1666 return $this->mRealName
;
1669 function setRealName( $str ) {
1671 $this->mRealName
= $str;
1675 * @param string $oname The option to check
1676 * @param string $defaultOverride A default value returned if the option does not exist
1679 function getOption( $oname, $defaultOverride = '' ) {
1682 if ( is_null( $this->mOptions
) ) {
1683 if($defaultOverride != '') {
1684 return $defaultOverride;
1686 $this->mOptions
= User
::getDefaultOptions();
1689 if ( array_key_exists( $oname, $this->mOptions
) ) {
1690 return trim( $this->mOptions
[$oname] );
1692 return $defaultOverride;
1697 * Get the user's date preference, including some important migration for
1700 function getDatePreference() {
1701 if ( is_null( $this->mDatePreference
) ) {
1703 $value = $this->getOption( 'date' );
1704 $map = $wgLang->getDatePreferenceMigrationMap();
1705 if ( isset( $map[$value] ) ) {
1706 $value = $map[$value];
1708 $this->mDatePreference
= $value;
1710 return $this->mDatePreference
;
1714 * @param string $oname The option to check
1715 * @return bool False if the option is not selected, true if it is
1717 function getBoolOption( $oname ) {
1718 return (bool)$this->getOption( $oname );
1722 * Get an option as an integer value from the source string.
1723 * @param string $oname The option to check
1724 * @param int $default Optional value to return if option is unset/blank.
1727 function getIntOption( $oname, $default=0 ) {
1728 $val = $this->getOption( $oname );
1732 return intval( $val );
1735 function setOption( $oname, $val ) {
1737 if ( is_null( $this->mOptions
) ) {
1738 $this->mOptions
= User
::getDefaultOptions();
1740 if ( $oname == 'skin' ) {
1741 # Clear cached skin, so the new one displays immediately in Special:Preferences
1742 unset( $this->mSkin
);
1744 // Filter out any newlines that may have passed through input validation.
1745 // Newlines are used to separate items in the options blob.
1747 $val = str_replace( "\r\n", "\n", $val );
1748 $val = str_replace( "\r", "\n", $val );
1749 $val = str_replace( "\n", " ", $val );
1751 // Explicitly NULL values should refer to defaults
1752 global $wgDefaultUserOptions;
1753 if( is_null($val) && isset($wgDefaultUserOptions[$oname]) ) {
1754 $val = $wgDefaultUserOptions[$oname];
1756 $this->mOptions
[$oname] = $val;
1759 function getRights() {
1760 if ( is_null( $this->mRights
) ) {
1761 $this->mRights
= self
::getGroupPermissions( $this->getEffectiveGroups() );
1762 wfRunHooks( 'UserGetRights', array( $this, &$this->mRights
) );
1763 // Force reindexation of rights when a hook has unset one of them
1764 $this->mRights
= array_values( $this->mRights
);
1766 return $this->mRights
;
1770 * Get the list of explicit group memberships this user has.
1771 * The implicit * and user groups are not included.
1772 * @return array of strings
1774 function getGroups() {
1776 return $this->mGroups
;
1780 * Get the list of implicit group memberships this user has.
1781 * This includes all explicit groups, plus 'user' if logged in,
1782 * '*' for all accounts and autopromoted groups
1783 * @param boolean $recache Don't use the cache
1784 * @return array of strings
1786 function getEffectiveGroups( $recache = false ) {
1787 if ( $recache ||
is_null( $this->mEffectiveGroups
) ) {
1788 $this->mEffectiveGroups
= $this->getGroups();
1789 $this->mEffectiveGroups
[] = '*';
1790 if( $this->getId() ) {
1791 $this->mEffectiveGroups
[] = 'user';
1793 $this->mEffectiveGroups
= array_unique( array_merge(
1794 $this->mEffectiveGroups
,
1795 Autopromote
::getAutopromoteGroups( $this )
1798 # Hook for additional groups
1799 wfRunHooks( 'UserEffectiveGroups', array( &$this, &$this->mEffectiveGroups
) );
1802 return $this->mEffectiveGroups
;
1805 /* Return the edit count for the user. This is where User::edits should have been */
1806 function getEditCount() {
1808 if ( !isset( $this->mEditCount
) ) {
1809 /* Populate the count, if it has not been populated yet */
1810 $this->mEditCount
= User
::edits($this->mId
);
1812 return $this->mEditCount
;
1820 * Add the user to the given group.
1821 * This takes immediate effect.
1822 * @param string $group
1824 function addGroup( $group ) {
1825 $dbw = wfGetDB( DB_MASTER
);
1826 if( $this->getId() ) {
1827 $dbw->insert( 'user_groups',
1829 'ug_user' => $this->getID(),
1830 'ug_group' => $group,
1833 array( 'IGNORE' ) );
1836 $this->loadGroups();
1837 $this->mGroups
[] = $group;
1838 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
1840 $this->invalidateCache();
1844 * Remove the user from the given group.
1845 * This takes immediate effect.
1846 * @param string $group
1848 function removeGroup( $group ) {
1850 $dbw = wfGetDB( DB_MASTER
);
1851 $dbw->delete( 'user_groups',
1853 'ug_user' => $this->getID(),
1854 'ug_group' => $group,
1856 'User::removeGroup' );
1858 $this->loadGroups();
1859 $this->mGroups
= array_diff( $this->mGroups
, array( $group ) );
1860 $this->mRights
= User
::getGroupPermissions( $this->getEffectiveGroups( true ) );
1862 $this->invalidateCache();
1867 * A more legible check for non-anonymousness.
1868 * Returns true if the user is not an anonymous visitor.
1872 function isLoggedIn() {
1873 return $this->getID() != 0;
1877 * A more legible check for anonymousness.
1878 * Returns true if the user is an anonymous visitor.
1883 return !$this->isLoggedIn();
1887 * Whether the user is a bot
1891 wfDeprecated( __METHOD__
);
1892 return $this->isAllowed( 'bot' );
1896 * Check if user is allowed to access a feature / make an action
1897 * @param string $action Action to be checked
1898 * @return boolean True: action is allowed, False: action should not be allowed
1900 function isAllowed($action='') {
1901 if ( $action === '' )
1902 // In the spirit of DWIM
1905 return in_array( $action, $this->getRights() );
1909 * Check whether to enable recent changes patrol features for this user
1912 public function useRCPatrol() {
1913 global $wgUseRCPatrol;
1914 return( $wgUseRCPatrol && ($this->isAllowed('patrol') ||
$this->isAllowed('patrolmarks')) );
1918 * Check whether to enable recent changes patrol features for this user
1921 public function useNPPatrol() {
1922 global $wgUseRCPatrol, $wgUseNPPatrol;
1923 return( ($wgUseRCPatrol ||
$wgUseNPPatrol) && ($this->isAllowed('patrol') ||
$this->isAllowed('patrolmarks')) );
1927 * Load a skin if it doesn't exist or return it
1928 * @todo FIXME : need to check the old failback system [AV]
1930 function &getSkin() {
1932 if ( ! isset( $this->mSkin
) ) {
1933 wfProfileIn( __METHOD__
);
1936 $userSkin = $this->getOption( 'skin' );
1937 $userSkin = $wgRequest->getVal('useskin', $userSkin);
1939 $this->mSkin
=& Skin
::newFromKey( $userSkin );
1940 wfProfileOut( __METHOD__
);
1942 return $this->mSkin
;
1946 * @param string $title Article title to look at
1950 * Check watched status of an article
1951 * @return bool True if article is watched
1953 function isWatched( $title ) {
1954 $wl = WatchedItem
::fromUserTitle( $this, $title );
1955 return $wl->isWatched();
1961 function addWatch( $title ) {
1962 $wl = WatchedItem
::fromUserTitle( $this, $title );
1964 $this->invalidateCache();
1968 * Stop watching an article
1970 function removeWatch( $title ) {
1971 $wl = WatchedItem
::fromUserTitle( $this, $title );
1973 $this->invalidateCache();
1977 * Clear the user's notification timestamp for the given title.
1978 * If e-notif e-mails are on, they will receive notification mails on
1979 * the next change of the page if it's watched etc.
1981 function clearNotification( &$title ) {
1982 global $wgUser, $wgUseEnotif, $wgShowUpdatedMarker;
1984 # Do nothing if the database is locked to writes
1985 if( wfReadOnly() ) {
1989 if ($title->getNamespace() == NS_USER_TALK
&&
1990 $title->getText() == $this->getName() ) {
1991 if (!wfRunHooks('UserClearNewTalkNotification', array(&$this)))
1993 $this->setNewtalk( false );
1996 if( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2000 if( $this->isAnon() ) {
2001 // Nothing else to do...
2005 // Only update the timestamp if the page is being watched.
2006 // The query to find out if it is watched is cached both in memcached and per-invocation,
2007 // and when it does have to be executed, it can be on a slave
2008 // If this is the user's newtalk page, we always update the timestamp
2009 if ($title->getNamespace() == NS_USER_TALK
&&
2010 $title->getText() == $wgUser->getName())
2013 } elseif ( $this->getId() == $wgUser->getId() ) {
2014 $watched = $title->userIsWatching();
2019 // If the page is watched by the user (or may be watched), update the timestamp on any
2020 // any matching rows
2022 $dbw = wfGetDB( DB_MASTER
);
2023 $dbw->update( 'watchlist',
2025 'wl_notificationtimestamp' => NULL
2026 ), array( /* WHERE */
2027 'wl_title' => $title->getDBkey(),
2028 'wl_namespace' => $title->getNamespace(),
2029 'wl_user' => $this->getID()
2030 ), 'User::clearLastVisited'
2038 * Resets all of the given user's page-change notification timestamps.
2039 * If e-notif e-mails are on, they will receive notification mails on
2040 * the next change of any watched page.
2042 * @param int $currentUser user ID number
2045 function clearAllNotifications( $currentUser ) {
2046 global $wgUseEnotif, $wgShowUpdatedMarker;
2047 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
2048 $this->setNewtalk( false );
2051 if( $currentUser != 0 ) {
2052 $dbw = wfGetDB( DB_MASTER
);
2053 $dbw->update( 'watchlist',
2055 'wl_notificationtimestamp' => NULL
2056 ), array( /* WHERE */
2057 'wl_user' => $currentUser
2060 # We also need to clear here the "you have new message" notification for the own user_talk page
2061 # This is cleared one page view later in Article::viewUpdates();
2067 * @return string Encoding options
2069 function encodeOptions() {
2071 if ( is_null( $this->mOptions
) ) {
2072 $this->mOptions
= User
::getDefaultOptions();
2075 foreach ( $this->mOptions
as $oname => $oval ) {
2076 array_push( $a, $oname.'='.$oval );
2078 $s = implode( "\n", $a );
2085 function decodeOptions( $str ) {
2086 $this->mOptions
= array();
2087 $a = explode( "\n", $str );
2088 foreach ( $a as $s ) {
2090 if ( preg_match( "/^(.[^=]*)=(.*)$/", $s, $m ) ) {
2091 $this->mOptions
[$m[1]] = $m[2];
2096 protected function setCookie( $name, $value, $exp=0 ) {
2097 global $wgCookiePrefix,$wgCookieDomain,$wgCookieSecure,$wgCookieExpiration, $wgCookieHttpOnly;
2099 $exp = time() +
$wgCookieExpiration;
2101 $httpOnlySafe = wfHttpOnlySafe();
2102 wfDebugLog( 'cookie',
2103 'setcookie: "' . implode( '", "',
2105 $wgCookiePrefix . $name,
2111 $httpOnlySafe && $wgCookieHttpOnly ) ) . '"' );
2112 if( $httpOnlySafe && isset( $wgCookieHttpOnly ) ) {
2113 setcookie( $wgCookiePrefix . $name,
2119 $wgCookieHttpOnly );
2121 // setcookie() fails on PHP 5.1 if you give it future-compat paramters.
2123 setcookie( $wgCookiePrefix . $name,
2132 protected function clearCookie( $name ) {
2133 $this->setCookie( $name, '', time() - 86400 );
2136 function setCookies() {
2138 if ( 0 == $this->mId
) return;
2140 'wsUserID' => $this->mId
,
2141 'wsToken' => $this->mToken
,
2142 'wsUserName' => $this->getName()
2145 'UserID' => $this->mId
,
2146 'UserName' => $this->getName(),
2148 if ( 1 == $this->getOption( 'rememberpassword' ) ) {
2149 $cookies['Token'] = $this->mToken
;
2151 $cookies['Token'] = false;
2154 wfRunHooks( 'UserSetCookies', array( $this, &$session, &$cookies ) );
2155 $_SESSION = $session +
$_SESSION;
2156 foreach ( $cookies as $name => $value ) {
2157 if ( $value === false ) {
2158 $this->clearCookie( $name );
2160 $this->setCookie( $name, $value );
2170 if( wfRunHooks( 'UserLogout', array(&$this) ) ) {
2176 * Really logout user
2177 * Clears the cookies and session, resets the instance cache
2179 function doLogout() {
2180 $this->clearInstanceCache( 'defaults' );
2182 $_SESSION['wsUserID'] = 0;
2184 $this->clearCookie( 'UserID' );
2185 $this->clearCookie( 'Token' );
2187 # Remember when user logged out, to prevent seeing cached pages
2188 $this->setCookie( 'LoggedOut', wfTimestampNow(), time() +
86400 );
2192 * Save object settings into database
2193 * @todo Only rarely do all these fields need to be set!
2195 function saveSettings() {
2197 if ( wfReadOnly() ) { return; }
2198 if ( 0 == $this->mId
) { return; }
2200 $this->mTouched
= self
::newTouchedTimestamp();
2202 $dbw = wfGetDB( DB_MASTER
);
2203 $dbw->update( 'user',
2205 'user_name' => $this->mName
,
2206 'user_password' => $this->mPassword
,
2207 'user_newpassword' => $this->mNewpassword
,
2208 'user_newpass_time' => $dbw->timestampOrNull( $this->mNewpassTime
),
2209 'user_real_name' => $this->mRealName
,
2210 'user_email' => $this->mEmail
,
2211 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2212 'user_options' => $this->encodeOptions(),
2213 'user_touched' => $dbw->timestamp($this->mTouched
),
2214 'user_token' => $this->mToken
,
2215 'user_email_token' => $this->mEmailToken
,
2216 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires
),
2217 ), array( /* WHERE */
2218 'user_id' => $this->mId
2221 wfRunHooks( 'UserSaveSettings', array( $this ) );
2222 $this->clearSharedCache();
2226 * Checks if a user with the given name exists, returns the ID.
2228 function idForName() {
2229 $s = trim( $this->getName() );
2230 if ( $s === '' ) return 0;
2232 $dbr = wfGetDB( DB_SLAVE
);
2233 $id = $dbr->selectField( 'user', 'user_id', array( 'user_name' => $s ), __METHOD__
);
2234 if ( $id === false ) {
2241 * Add a user to the database, return the user object
2243 * @param string $name The user's name
2244 * @param array $params Associative array of non-default parameters to save to the database:
2245 * password The user's password. Password logins will be disabled if this is omitted.
2246 * newpassword A temporary password mailed to the user
2247 * email The user's email address
2248 * email_authenticated The email authentication timestamp
2249 * real_name The user's real name
2250 * options An associative array of non-default options
2251 * token Random authentication token. Do not set.
2252 * registration Registration timestamp. Do not set.
2254 * @return User object, or null if the username already exists
2256 static function createNew( $name, $params = array() ) {
2259 if ( isset( $params['options'] ) ) {
2260 $user->mOptions
= $params['options'] +
$user->mOptions
;
2261 unset( $params['options'] );
2263 $dbw = wfGetDB( DB_MASTER
);
2264 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2266 'user_id' => $seqVal,
2267 'user_name' => $name,
2268 'user_password' => $user->mPassword
,
2269 'user_newpassword' => $user->mNewpassword
,
2270 'user_newpass_time' => $dbw->timestamp( $user->mNewpassTime
),
2271 'user_email' => $user->mEmail
,
2272 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated
),
2273 'user_real_name' => $user->mRealName
,
2274 'user_options' => $user->encodeOptions(),
2275 'user_token' => $user->mToken
,
2276 'user_registration' => $dbw->timestamp( $user->mRegistration
),
2277 'user_editcount' => 0,
2279 foreach ( $params as $name => $value ) {
2280 $fields["user_$name"] = $value;
2282 $dbw->insert( 'user', $fields, __METHOD__
, array( 'IGNORE' ) );
2283 if ( $dbw->affectedRows() ) {
2284 $newUser = User
::newFromId( $dbw->insertId() );
2292 * Add an existing user object to the database
2294 function addToDatabase() {
2296 $dbw = wfGetDB( DB_MASTER
);
2297 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
2298 $dbw->insert( 'user',
2300 'user_id' => $seqVal,
2301 'user_name' => $this->mName
,
2302 'user_password' => $this->mPassword
,
2303 'user_newpassword' => $this->mNewpassword
,
2304 'user_newpass_time' => $dbw->timestamp( $this->mNewpassTime
),
2305 'user_email' => $this->mEmail
,
2306 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated
),
2307 'user_real_name' => $this->mRealName
,
2308 'user_options' => $this->encodeOptions(),
2309 'user_token' => $this->mToken
,
2310 'user_registration' => $dbw->timestamp( $this->mRegistration
),
2311 'user_editcount' => 0,
2314 $this->mId
= $dbw->insertId();
2316 # Clear instance cache other than user table data, which is already accurate
2317 $this->clearInstanceCache();
2321 * If the (non-anonymous) user is blocked, this function will block any IP address
2322 * that they successfully log on from.
2324 function spreadBlock() {
2325 wfDebug( __METHOD__
."()\n" );
2327 if ( $this->mId
== 0 ) {
2331 $userblock = Block
::newFromDB( '', $this->mId
);
2332 if ( !$userblock ) {
2336 $userblock->doAutoblock( wfGetIp() );
2341 * Generate a string which will be different for any combination of
2342 * user options which would produce different parser output.
2343 * This will be used as part of the hash key for the parser cache,
2344 * so users will the same options can share the same cached data
2347 * Extensions which require it should install 'PageRenderingHash' hook,
2348 * which will give them a chance to modify this key based on their own
2353 function getPageRenderingHash() {
2354 global $wgContLang, $wgUseDynamicDates, $wgLang;
2356 return $this->mHash
;
2359 // stubthreshold is only included below for completeness,
2360 // it will always be 0 when this function is called by parsercache.
2362 $confstr = $this->getOption( 'math' );
2363 $confstr .= '!' . $this->getOption( 'stubthreshold' );
2364 if ( $wgUseDynamicDates ) {
2365 $confstr .= '!' . $this->getDatePreference();
2367 $confstr .= '!' . ($this->getOption( 'numberheadings' ) ?
'1' : '');
2368 $confstr .= '!' . $wgLang->getCode();
2369 $confstr .= '!' . $this->getOption( 'thumbsize' );
2370 // add in language specific options, if any
2371 $extra = $wgContLang->getExtraHashOptions();
2374 // Give a chance for extensions to modify the hash, if they have
2375 // extra options or other effects on the parser cache.
2376 wfRunHooks( 'PageRenderingHash', array( &$confstr ) );
2378 // Make it a valid memcached key fragment
2379 $confstr = str_replace( ' ', '_', $confstr );
2380 $this->mHash
= $confstr;
2384 function isBlockedFromCreateAccount() {
2385 $this->getBlockedStatus();
2386 return $this->mBlock
&& $this->mBlock
->mCreateAccount
;
2390 * Determine if the user is blocked from using Special:Emailuser.
2395 function isBlockedFromEmailuser() {
2396 $this->getBlockedStatus();
2397 return $this->mBlock
&& $this->mBlock
->mBlockEmail
;
2400 function isAllowedToCreateAccount() {
2401 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
2407 function setLoaded( $loaded ) {
2408 wfDeprecated( __METHOD__
);
2412 * Get this user's personal page title.
2417 function getUserPage() {
2418 return Title
::makeTitle( NS_USER
, $this->getName() );
2422 * Get this user's talk page title.
2427 function getTalkPage() {
2428 $title = $this->getUserPage();
2429 return $title->getTalkPage();
2435 function getMaxID() {
2436 static $res; // cache
2438 if ( isset( $res ) )
2441 $dbr = wfGetDB( DB_SLAVE
);
2442 return $res = $dbr->selectField( 'user', 'max(user_id)', false, 'User::getMaxID' );
2447 * Determine whether the user is a newbie. Newbies are either
2448 * anonymous IPs, or the most recently created accounts.
2449 * @return bool True if it is a newbie.
2451 function isNewbie() {
2452 return !$this->isAllowed( 'autoconfirmed' );
2456 * Is the user active? We check to see if they've made at least
2457 * X number of edits in the last Y days.
2459 * @return bool true if the user is active, false if not
2461 public function isActiveEditor() {
2462 global $wgActiveUserEditCount, $wgActiveUserDays;
2463 $dbr = wfGetDB( DB_SLAVE
);
2465 // Stolen without shame from RC
2466 $cutoff_unixtime = time() - ( $wgActiveUserDays * 86400 );
2467 $cutoff_unixtime = $cutoff_unixtime - ( $cutoff_unixtime %
86400 );
2468 $oldTime = $dbr->addQuotes( $dbr->timestamp( $cutoff_unixtime ) );
2470 $res = $dbr->select( 'revision', '1',
2471 array( 'rev_user_text' => $this->getName(), "rev_timestamp > $oldTime"),
2473 array('LIMIT' => $wgActiveUserEditCount ) );
2475 $count = $dbr->numRows($res);
2476 $dbr->freeResult($res);
2478 return $count == $wgActiveUserEditCount;
2482 * Check to see if the given clear-text password is one of the accepted passwords
2483 * @param string $password User password.
2484 * @return bool True if the given password is correct otherwise False.
2486 function checkPassword( $password ) {
2490 // Even though we stop people from creating passwords that
2491 // are shorter than this, doesn't mean people wont be able
2492 // to. Certain authentication plugins do NOT want to save
2493 // domain passwords in a mysql database, so we should
2494 // check this (incase $wgAuth->strict() is false).
2495 if( !$this->isValidPassword( $password ) ) {
2499 if( $wgAuth->authenticate( $this->getName(), $password ) ) {
2501 } elseif( $wgAuth->strict() ) {
2502 /* Auth plugin doesn't allow local authentication */
2504 } elseif( $wgAuth->strictUserAuth( $this->getName() ) ) {
2505 /* Auth plugin doesn't allow local authentication for this user name */
2508 $ep = $this->encryptPassword( $password );
2509 if ( 0 == strcmp( $ep, $this->mPassword
) ) {
2511 } elseif ( function_exists( 'iconv' ) ) {
2512 # Some wikis were converted from ISO 8859-1 to UTF-8, the passwords can't be converted
2513 # Check for this with iconv
2514 $cp1252hash = $this->encryptPassword( iconv( 'UTF-8', 'WINDOWS-1252//TRANSLIT', $password ) );
2515 if ( 0 == strcmp( $cp1252hash, $this->mPassword
) ) {
2523 * Check if the given clear-text password matches the temporary password
2524 * sent by e-mail for password reset operations.
2527 function checkTemporaryPassword( $plaintext ) {
2528 $hash = $this->encryptPassword( $plaintext );
2529 return $hash === $this->mNewpassword
;
2533 * Initialize (if necessary) and return a session token value
2534 * which can be used in edit forms to show that the user's
2535 * login credentials aren't being hijacked with a foreign form
2538 * @param mixed $salt - Optional function-specific data for hash.
2539 * Use a string or an array of strings.
2543 function editToken( $salt = '' ) {
2544 if ( $this->isAnon() ) {
2545 return EDIT_TOKEN_SUFFIX
;
2547 if( !isset( $_SESSION['wsEditToken'] ) ) {
2548 $token = $this->generateToken();
2549 $_SESSION['wsEditToken'] = $token;
2551 $token = $_SESSION['wsEditToken'];
2553 if( is_array( $salt ) ) {
2554 $salt = implode( '|', $salt );
2556 return md5( $token . $salt ) . EDIT_TOKEN_SUFFIX
;
2561 * Generate a hex-y looking random token for various uses.
2562 * Could be made more cryptographically sure if someone cares.
2565 function generateToken( $salt = '' ) {
2566 $token = dechex( mt_rand() ) . dechex( mt_rand() );
2567 return md5( $token . $salt );
2571 * Check given value against the token value stored in the session.
2572 * A match should confirm that the form was submitted from the
2573 * user's own login session, not a form submission from a third-party
2576 * @param string $val - the input value to compare
2577 * @param string $salt - Optional function-specific data for hash
2581 function matchEditToken( $val, $salt = '' ) {
2582 $sessionToken = $this->editToken( $salt );
2583 if ( $val != $sessionToken ) {
2584 wfDebug( "User::matchEditToken: broken session data\n" );
2586 return $val == $sessionToken;
2590 * Check whether the edit token is fine except for the suffix
2592 function matchEditTokenNoSuffix( $val, $salt = '' ) {
2593 $sessionToken = $this->editToken( $salt );
2594 return substr( $sessionToken, 0, 32 ) == substr( $val, 0, 32 );
2598 * Generate a new e-mail confirmation token and send a confirmation/invalidation
2599 * mail to the user's given address.
2601 * Calls saveSettings() internally; as it has side effects, not committing changes
2602 * would be pretty silly.
2604 * @return mixed True on success, a WikiError object on failure.
2606 function sendConfirmationMail() {
2608 $expiration = null; // gets passed-by-ref and defined in next line.
2609 $token = $this->confirmationToken( $expiration );
2610 $url = $this->confirmationTokenUrl( $token );
2611 $invalidateURL = $this->invalidationTokenUrl( $token );
2612 $this->saveSettings();
2614 return $this->sendMail( wfMsg( 'confirmemail_subject' ),
2615 wfMsg( 'confirmemail_body',
2619 $wgLang->timeanddate( $expiration, false ),
2624 * Send an e-mail to this user's account. Does not check for
2625 * confirmed status or validity.
2627 * @param string $subject
2628 * @param string $body
2629 * @param string $from Optional from address; default $wgPasswordSender will be used otherwise.
2630 * @return mixed True on success, a WikiError object on failure.
2632 function sendMail( $subject, $body, $from = null, $replyto = null ) {
2633 if( is_null( $from ) ) {
2634 global $wgPasswordSender;
2635 $from = $wgPasswordSender;
2638 $to = new MailAddress( $this );
2639 $sender = new MailAddress( $from );
2640 return UserMailer
::send( $to, $sender, $subject, $body, $replyto );
2644 * Generate, store, and return a new e-mail confirmation code.
2645 * A hash (unsalted since it's used as a key) is stored.
2647 * Call saveSettings() after calling this function to commit
2648 * this change to the database.
2650 * @param &$expiration mixed output: accepts the expiration time
2654 function confirmationToken( &$expiration ) {
2656 $expires = $now +
7 * 24 * 60 * 60;
2657 $expiration = wfTimestamp( TS_MW
, $expires );
2658 $token = $this->generateToken( $this->mId
. $this->mEmail
. $expires );
2659 $hash = md5( $token );
2661 $this->mEmailToken
= $hash;
2662 $this->mEmailTokenExpires
= $expiration;
2667 * Return a URL the user can use to confirm their email address.
2668 * @param $token: accepts the email confirmation token
2672 function confirmationTokenUrl( $token ) {
2673 return $this->getTokenUrl( 'ConfirmEmail', $token );
2676 * Return a URL the user can use to invalidate their email address.
2677 * @param $token: accepts the email confirmation token
2681 function invalidationTokenUrl( $token ) {
2682 return $this->getTokenUrl( 'Invalidateemail', $token );
2686 * Internal function to format the e-mail validation/invalidation URLs.
2687 * This uses $wgArticlePath directly as a quickie hack to use the
2688 * hardcoded English names of the Special: pages, for ASCII safety.
2690 * Since these URLs get dropped directly into emails, using the
2691 * short English names avoids insanely long URL-encoded links, which
2692 * also sometimes can get corrupted in some browsers/mailers
2693 * (bug 6957 with Gmail and Internet Explorer).
2695 protected function getTokenUrl( $page, $token ) {
2696 global $wgArticlePath;
2700 "Special:$page/$token",
2705 * Mark the e-mail address confirmed.
2707 * Call saveSettings() after calling this function to commit the change.
2709 function confirmEmail() {
2710 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
2715 * Invalidate the user's email confirmation, unauthenticate the email
2716 * if it was already confirmed.
2718 * Call saveSettings() after calling this function to commit the change.
2720 function invalidateEmail() {
2722 $this->mEmailToken
= null;
2723 $this->mEmailTokenExpires
= null;
2724 $this->setEmailAuthenticationTimestamp( null );
2728 function setEmailAuthenticationTimestamp( $timestamp ) {
2730 $this->mEmailAuthenticated
= $timestamp;
2731 wfRunHooks( 'UserSetEmailAuthenticationTimestamp', array( $this, &$this->mEmailAuthenticated
) );
2735 * Is this user allowed to send e-mails within limits of current
2736 * site configuration?
2739 function canSendEmail() {
2740 $canSend = $this->isEmailConfirmed();
2741 wfRunHooks( 'UserCanSendEmail', array( &$this, &$canSend ) );
2746 * Is this user allowed to receive e-mails within limits of current
2747 * site configuration?
2750 function canReceiveEmail() {
2751 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
2755 * Is this user's e-mail address valid-looking and confirmed within
2756 * limits of the current site configuration?
2758 * If $wgEmailAuthentication is on, this may require the user to have
2759 * confirmed their address by returning a code or using a password
2760 * sent to the address from the wiki.
2764 function isEmailConfirmed() {
2765 global $wgEmailAuthentication;
2768 if( wfRunHooks( 'EmailConfirmed', array( &$this, &$confirmed ) ) ) {
2769 if( $this->isAnon() )
2771 if( !self
::isValidEmailAddr( $this->mEmail
) )
2773 if( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() )
2782 * Return true if there is an outstanding request for e-mail confirmation.
2785 function isEmailConfirmationPending() {
2786 global $wgEmailAuthentication;
2787 return $wgEmailAuthentication &&
2788 !$this->isEmailConfirmed() &&
2789 $this->mEmailToken
&&
2790 $this->mEmailTokenExpires
> wfTimestamp();
2794 * Get the timestamp of account creation, or false for
2795 * non-existent/anonymous user accounts
2799 public function getRegistration() {
2800 return $this->mId
> 0
2801 ?
$this->mRegistration
2806 * @param array $groups list of groups
2807 * @return array list of permission key names for given groups combined
2809 static function getGroupPermissions( $groups ) {
2810 global $wgGroupPermissions;
2812 foreach( $groups as $group ) {
2813 if( isset( $wgGroupPermissions[$group] ) ) {
2814 $rights = array_merge( $rights,
2815 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
2822 * @param string $group key name
2823 * @return string localized descriptive name for group, if provided
2825 static function getGroupName( $group ) {
2826 global $wgMessageCache;
2827 $wgMessageCache->loadAllMessages();
2828 $key = "group-$group";
2829 $name = wfMsg( $key );
2830 return $name == '' ||
wfEmptyMsg( $key, $name )
2836 * @param string $group key name
2837 * @return string localized descriptive name for member of a group, if provided
2839 static function getGroupMember( $group ) {
2840 global $wgMessageCache;
2841 $wgMessageCache->loadAllMessages();
2842 $key = "group-$group-member";
2843 $name = wfMsg( $key );
2844 return $name == '' ||
wfEmptyMsg( $key, $name )
2850 * Return the set of defined explicit groups.
2851 * The implicit groups (by default *, 'user' and 'autoconfirmed')
2852 * are not included, as they are defined automatically,
2853 * not in the database.
2856 static function getAllGroups() {
2857 global $wgGroupPermissions;
2859 array_keys( $wgGroupPermissions ),
2860 self
::getImplicitGroups()
2865 * Get a list of all available permissions
2867 static function getAllRights() {
2868 if ( self
::$mAllRights === false ) {
2869 global $wgAvailableRights;
2870 if ( count( $wgAvailableRights ) ) {
2871 self
::$mAllRights = array_unique( array_merge( self
::$mCoreRights, $wgAvailableRights ) );
2873 self
::$mAllRights = self
::$mCoreRights;
2875 wfRunHooks( 'UserGetAllRights', array( &self
::$mAllRights ) );
2877 return self
::$mAllRights;
2881 * Get a list of implicit groups
2885 public static function getImplicitGroups() {
2886 global $wgImplicitGroups;
2887 $groups = $wgImplicitGroups;
2888 wfRunHooks( 'UserGetImplicitGroups', array( &$groups ) ); #deprecated, use $wgImplictGroups instead
2893 * Get the title of a page describing a particular group
2895 * @param $group Name of the group
2898 static function getGroupPage( $group ) {
2899 global $wgMessageCache;
2900 $wgMessageCache->loadAllMessages();
2901 $page = wfMsgForContent( 'grouppage-' . $group );
2902 if( !wfEmptyMsg( 'grouppage-' . $group, $page ) ) {
2903 $title = Title
::newFromText( $page );
2904 if( is_object( $title ) )
2911 * Create a link to the group in HTML, if available
2913 * @param $group Name of the group
2914 * @param $text The text of the link
2917 static function makeGroupLinkHTML( $group, $text = '' ) {
2919 $text = self
::getGroupName( $group );
2921 $title = self
::getGroupPage( $group );
2924 $sk = $wgUser->getSkin();
2925 return $sk->makeLinkObj( $title, htmlspecialchars( $text ) );
2932 * Create a link to the group in Wikitext, if available
2934 * @param $group Name of the group
2935 * @param $text The text of the link (by default, the name of the group)
2938 static function makeGroupLinkWiki( $group, $text = '' ) {
2940 $text = self
::getGroupName( $group );
2942 $title = self
::getGroupPage( $group );
2944 $page = $title->getPrefixedText();
2945 return "[[$page|$text]]";
2952 * Increment the user's edit-count field.
2953 * Will have no effect for anonymous users.
2955 function incEditCount() {
2956 if( !$this->isAnon() ) {
2957 $dbw = wfGetDB( DB_MASTER
);
2958 $dbw->update( 'user',
2959 array( 'user_editcount=user_editcount+1' ),
2960 array( 'user_id' => $this->getId() ),
2963 // Lazy initialization check...
2964 if( $dbw->affectedRows() == 0 ) {
2965 // Pull from a slave to be less cruel to servers
2966 // Accuracy isn't the point anyway here
2967 $dbr = wfGetDB( DB_SLAVE
);
2968 $count = $dbr->selectField( 'revision',
2970 array( 'rev_user' => $this->getId() ),
2973 // Now here's a goddamn hack...
2974 if( $dbr !== $dbw ) {
2975 // If we actually have a slave server, the count is
2976 // at least one behind because the current transaction
2977 // has not been committed and replicated.
2980 // But if DB_SLAVE is selecting the master, then the
2981 // count we just read includes the revision that was
2982 // just added in the working transaction.
2985 $dbw->update( 'user',
2986 array( 'user_editcount' => $count ),
2987 array( 'user_id' => $this->getId() ),
2991 // edit count in user cache too
2992 $this->invalidateCache();
2995 static function getRightDescription( $right ) {
2996 global $wgMessageCache;
2997 $wgMessageCache->loadAllMessages();
2998 $key = "right-$right";
2999 $name = wfMsg( $key );
3000 return $name == '' ||
wfEmptyMsg( $key, $name )