Merge "Minor adjustments to align with WikimediaUI color palette"
[lhc/web/wiklou.git] / includes / user / User.php
1 <?php
2 /**
3 * Implements the User class for the %MediaWiki software.
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
19 *
20 * @file
21 */
22
23 use MediaWiki\MediaWikiServices;
24 use MediaWiki\Session\SessionManager;
25 use MediaWiki\Session\Token;
26 use MediaWiki\Auth\AuthManager;
27 use MediaWiki\Auth\AuthenticationResponse;
28 use MediaWiki\Auth\AuthenticationRequest;
29 use Wikimedia\ScopedCallback;
30
31 /**
32 * String Some punctuation to prevent editing from broken text-mangling proxies.
33 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
34 * @ingroup Constants
35 */
36 define( 'EDIT_TOKEN_SUFFIX', Token::SUFFIX );
37
38 /**
39 * The User object encapsulates all of the user-specific settings (user_id,
40 * name, rights, email address, options, last login time). Client
41 * classes use the getXXX() functions to access these fields. These functions
42 * do all the work of determining whether the user is logged in,
43 * whether the requested option can be satisfied from cookies or
44 * whether a database query is needed. Most of the settings needed
45 * for rendering normal pages are set in the cookie to minimize use
46 * of the database.
47 */
48 class User implements IDBAccessObject {
49 /**
50 * @const int Number of characters in user_token field.
51 */
52 const TOKEN_LENGTH = 32;
53
54 /**
55 * @const string An invalid value for user_token
56 */
57 const INVALID_TOKEN = '*** INVALID ***';
58
59 /**
60 * Global constant made accessible as class constants so that autoloader
61 * magic can be used.
62 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
63 */
64 const EDIT_TOKEN_SUFFIX = EDIT_TOKEN_SUFFIX;
65
66 /**
67 * @const int Serialized record version.
68 */
69 const VERSION = 10;
70
71 /**
72 * Exclude user options that are set to their default value.
73 * @since 1.25
74 */
75 const GETOPTIONS_EXCLUDE_DEFAULTS = 1;
76
77 /**
78 * @since 1.27
79 */
80 const CHECK_USER_RIGHTS = true;
81
82 /**
83 * @since 1.27
84 */
85 const IGNORE_USER_RIGHTS = false;
86
87 /**
88 * Array of Strings List of member variables which are saved to the
89 * shared cache (memcached). Any operation which changes the
90 * corresponding database fields must call a cache-clearing function.
91 * @showinitializer
92 */
93 protected static $mCacheVars = [
94 // user table
95 'mId',
96 'mName',
97 'mRealName',
98 'mEmail',
99 'mTouched',
100 'mToken',
101 'mEmailAuthenticated',
102 'mEmailToken',
103 'mEmailTokenExpires',
104 'mRegistration',
105 'mEditCount',
106 // user_groups table
107 'mGroups',
108 // user_properties table
109 'mOptionOverrides',
110 ];
111
112 /**
113 * Array of Strings Core rights.
114 * Each of these should have a corresponding message of the form
115 * "right-$right".
116 * @showinitializer
117 */
118 protected static $mCoreRights = [
119 'apihighlimits',
120 'applychangetags',
121 'autoconfirmed',
122 'autocreateaccount',
123 'autopatrol',
124 'bigdelete',
125 'block',
126 'blockemail',
127 'bot',
128 'browsearchive',
129 'changetags',
130 'createaccount',
131 'createpage',
132 'createtalk',
133 'delete',
134 'deletechangetags',
135 'deletedhistory',
136 'deletedtext',
137 'deletelogentry',
138 'deleterevision',
139 'edit',
140 'editcontentmodel',
141 'editinterface',
142 'editprotected',
143 'editmyoptions',
144 'editmyprivateinfo',
145 'editmyusercss',
146 'editmyuserjs',
147 'editmywatchlist',
148 'editsemiprotected',
149 'editusercssjs', # deprecated
150 'editusercss',
151 'edituserjs',
152 'hideuser',
153 'import',
154 'importupload',
155 'ipblock-exempt',
156 'managechangetags',
157 'markbotedits',
158 'mergehistory',
159 'minoredit',
160 'move',
161 'movefile',
162 'move-categorypages',
163 'move-rootuserpages',
164 'move-subpages',
165 'nominornewtalk',
166 'noratelimit',
167 'override-export-depth',
168 'pagelang',
169 'patrol',
170 'patrolmarks',
171 'protect',
172 'purge',
173 'read',
174 'reupload',
175 'reupload-own',
176 'reupload-shared',
177 'rollback',
178 'sendemail',
179 'siteadmin',
180 'suppressionlog',
181 'suppressredirect',
182 'suppressrevision',
183 'unblockself',
184 'undelete',
185 'unwatchedpages',
186 'upload',
187 'upload_by_url',
188 'userrights',
189 'userrights-interwiki',
190 'viewmyprivateinfo',
191 'viewmywatchlist',
192 'viewsuppressed',
193 'writeapi',
194 ];
195
196 /**
197 * String Cached results of getAllRights()
198 */
199 protected static $mAllRights = false;
200
201 /** Cache variables */
202 // @{
203 /** @var int */
204 public $mId;
205 /** @var string */
206 public $mName;
207 /** @var string */
208 public $mRealName;
209
210 /** @var string */
211 public $mEmail;
212 /** @var string TS_MW timestamp from the DB */
213 public $mTouched;
214 /** @var string TS_MW timestamp from cache */
215 protected $mQuickTouched;
216 /** @var string */
217 protected $mToken;
218 /** @var string */
219 public $mEmailAuthenticated;
220 /** @var string */
221 protected $mEmailToken;
222 /** @var string */
223 protected $mEmailTokenExpires;
224 /** @var string */
225 protected $mRegistration;
226 /** @var int */
227 protected $mEditCount;
228 /** @var array */
229 public $mGroups;
230 /** @var array */
231 protected $mOptionOverrides;
232 // @}
233
234 /**
235 * Bool Whether the cache variables have been loaded.
236 */
237 // @{
238 public $mOptionsLoaded;
239
240 /**
241 * Array with already loaded items or true if all items have been loaded.
242 */
243 protected $mLoadedItems = [];
244 // @}
245
246 /**
247 * String Initialization data source if mLoadedItems!==true. May be one of:
248 * - 'defaults' anonymous user initialised from class defaults
249 * - 'name' initialise from mName
250 * - 'id' initialise from mId
251 * - 'session' log in from session if possible
252 *
253 * Use the User::newFrom*() family of functions to set this.
254 */
255 public $mFrom;
256
257 /**
258 * Lazy-initialized variables, invalidated with clearInstanceCache
259 */
260 protected $mNewtalk;
261 /** @var string */
262 protected $mDatePreference;
263 /** @var string */
264 public $mBlockedby;
265 /** @var string */
266 protected $mHash;
267 /** @var array */
268 public $mRights;
269 /** @var string */
270 protected $mBlockreason;
271 /** @var array */
272 protected $mEffectiveGroups;
273 /** @var array */
274 protected $mImplicitGroups;
275 /** @var array */
276 protected $mFormerGroups;
277 /** @var Block */
278 protected $mGlobalBlock;
279 /** @var bool */
280 protected $mLocked;
281 /** @var bool */
282 public $mHideName;
283 /** @var array */
284 public $mOptions;
285
286 /**
287 * @var WebRequest
288 */
289 private $mRequest;
290
291 /** @var Block */
292 public $mBlock;
293
294 /** @var bool */
295 protected $mAllowUsertalk;
296
297 /** @var Block */
298 private $mBlockedFromCreateAccount = false;
299
300 /** @var integer User::READ_* constant bitfield used to load data */
301 protected $queryFlagsUsed = self::READ_NORMAL;
302
303 /** @var string Indicates type of block (used for eventlogging)
304 * Permitted values: 'cookie-block', 'proxy-block', 'openproxy-block', 'xff-block'
305 */
306 public $blockTrigger = false;
307
308 public static $idCacheByName = [];
309
310 /**
311 * Lightweight constructor for an anonymous user.
312 * Use the User::newFrom* factory functions for other kinds of users.
313 *
314 * @see newFromName()
315 * @see newFromId()
316 * @see newFromConfirmationCode()
317 * @see newFromSession()
318 * @see newFromRow()
319 */
320 public function __construct() {
321 $this->clearInstanceCache( 'defaults' );
322 }
323
324 /**
325 * @return string
326 */
327 public function __toString() {
328 return (string)$this->getName();
329 }
330
331 /**
332 * Test if it's safe to load this User object.
333 *
334 * You should typically check this before using $wgUser or
335 * RequestContext::getUser in a method that might be called before the
336 * system has been fully initialized. If the object is unsafe, you should
337 * use an anonymous user:
338 * \code
339 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
340 * \endcode
341 *
342 * @since 1.27
343 * @return bool
344 */
345 public function isSafeToLoad() {
346 global $wgFullyInitialised;
347
348 // The user is safe to load if:
349 // * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
350 // * mLoadedItems === true (already loaded)
351 // * mFrom !== 'session' (sessions not involved at all)
352
353 return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
354 $this->mLoadedItems === true || $this->mFrom !== 'session';
355 }
356
357 /**
358 * Load the user table data for this object from the source given by mFrom.
359 *
360 * @param integer $flags User::READ_* constant bitfield
361 */
362 public function load( $flags = self::READ_NORMAL ) {
363 global $wgFullyInitialised;
364
365 if ( $this->mLoadedItems === true ) {
366 return;
367 }
368
369 // Set it now to avoid infinite recursion in accessors
370 $oldLoadedItems = $this->mLoadedItems;
371 $this->mLoadedItems = true;
372 $this->queryFlagsUsed = $flags;
373
374 // If this is called too early, things are likely to break.
375 if ( !$wgFullyInitialised && $this->mFrom === 'session' ) {
376 \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
377 ->warning( 'User::loadFromSession called before the end of Setup.php', [
378 'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
379 ] );
380 $this->loadDefaults();
381 $this->mLoadedItems = $oldLoadedItems;
382 return;
383 }
384
385 switch ( $this->mFrom ) {
386 case 'defaults':
387 $this->loadDefaults();
388 break;
389 case 'name':
390 // Make sure this thread sees its own changes
391 if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
392 $flags |= self::READ_LATEST;
393 $this->queryFlagsUsed = $flags;
394 }
395
396 $this->mId = self::idFromName( $this->mName, $flags );
397 if ( !$this->mId ) {
398 // Nonexistent user placeholder object
399 $this->loadDefaults( $this->mName );
400 } else {
401 $this->loadFromId( $flags );
402 }
403 break;
404 case 'id':
405 $this->loadFromId( $flags );
406 break;
407 case 'session':
408 if ( !$this->loadFromSession() ) {
409 // Loading from session failed. Load defaults.
410 $this->loadDefaults();
411 }
412 Hooks::run( 'UserLoadAfterLoadFromSession', [ $this ] );
413 break;
414 default:
415 throw new UnexpectedValueException(
416 "Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
417 }
418 }
419
420 /**
421 * Load user table data, given mId has already been set.
422 * @param integer $flags User::READ_* constant bitfield
423 * @return bool False if the ID does not exist, true otherwise
424 */
425 public function loadFromId( $flags = self::READ_NORMAL ) {
426 if ( $this->mId == 0 ) {
427 // Anonymous users are not in the database (don't need cache)
428 $this->loadDefaults();
429 return false;
430 }
431
432 // Try cache (unless this needs data from the master DB).
433 // NOTE: if this thread called saveSettings(), the cache was cleared.
434 $latest = DBAccessObjectUtils::hasFlags( $flags, self::READ_LATEST );
435 if ( $latest ) {
436 if ( !$this->loadFromDatabase( $flags ) ) {
437 // Can't load from ID
438 return false;
439 }
440 } else {
441 $this->loadFromCache();
442 }
443
444 $this->mLoadedItems = true;
445 $this->queryFlagsUsed = $flags;
446
447 return true;
448 }
449
450 /**
451 * @since 1.27
452 * @param string $wikiId
453 * @param integer $userId
454 */
455 public static function purge( $wikiId, $userId ) {
456 $cache = ObjectCache::getMainWANInstance();
457 $key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
458 $cache->delete( $key );
459 }
460
461 /**
462 * @since 1.27
463 * @param WANObjectCache $cache
464 * @return string
465 */
466 protected function getCacheKey( WANObjectCache $cache ) {
467 return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId );
468 }
469
470 /**
471 * Load user data from shared cache, given mId has already been set.
472 *
473 * @return bool True
474 * @since 1.25
475 */
476 protected function loadFromCache() {
477 $cache = ObjectCache::getMainWANInstance();
478 $data = $cache->getWithSetCallback(
479 $this->getCacheKey( $cache ),
480 $cache::TTL_HOUR,
481 function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
482 $setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
483 wfDebug( "User: cache miss for user {$this->mId}\n" );
484
485 $this->loadFromDatabase( self::READ_NORMAL );
486 $this->loadGroups();
487 $this->loadOptions();
488
489 $data = [];
490 foreach ( self::$mCacheVars as $name ) {
491 $data[$name] = $this->$name;
492 }
493
494 $ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX, $this->mTouched ), $ttl );
495
496 return $data;
497
498 },
499 [ 'pcTTL' => $cache::TTL_PROC_LONG, 'version' => self::VERSION ]
500 );
501
502 // Restore from cache
503 foreach ( self::$mCacheVars as $name ) {
504 $this->$name = $data[$name];
505 }
506
507 return true;
508 }
509
510 /** @name newFrom*() static factory methods */
511 // @{
512
513 /**
514 * Static factory method for creation from username.
515 *
516 * This is slightly less efficient than newFromId(), so use newFromId() if
517 * you have both an ID and a name handy.
518 *
519 * @param string $name Username, validated by Title::newFromText()
520 * @param string|bool $validate Validate username. Takes the same parameters as
521 * User::getCanonicalName(), except that true is accepted as an alias
522 * for 'valid', for BC.
523 *
524 * @return User|bool User object, or false if the username is invalid
525 * (e.g. if it contains illegal characters or is an IP address). If the
526 * username is not present in the database, the result will be a user object
527 * with a name, zero user ID and default settings.
528 */
529 public static function newFromName( $name, $validate = 'valid' ) {
530 if ( $validate === true ) {
531 $validate = 'valid';
532 }
533 $name = self::getCanonicalName( $name, $validate );
534 if ( $name === false ) {
535 return false;
536 } else {
537 // Create unloaded user object
538 $u = new User;
539 $u->mName = $name;
540 $u->mFrom = 'name';
541 $u->setItemLoaded( 'name' );
542 return $u;
543 }
544 }
545
546 /**
547 * Static factory method for creation from a given user ID.
548 *
549 * @param int $id Valid user ID
550 * @return User The corresponding User object
551 */
552 public static function newFromId( $id ) {
553 $u = new User;
554 $u->mId = $id;
555 $u->mFrom = 'id';
556 $u->setItemLoaded( 'id' );
557 return $u;
558 }
559
560 /**
561 * Factory method to fetch whichever user has a given email confirmation code.
562 * This code is generated when an account is created or its e-mail address
563 * has changed.
564 *
565 * If the code is invalid or has expired, returns NULL.
566 *
567 * @param string $code Confirmation code
568 * @param int $flags User::READ_* bitfield
569 * @return User|null
570 */
571 public static function newFromConfirmationCode( $code, $flags = 0 ) {
572 $db = ( $flags & self::READ_LATEST ) == self::READ_LATEST
573 ? wfGetDB( DB_MASTER )
574 : wfGetDB( DB_REPLICA );
575
576 $id = $db->selectField(
577 'user',
578 'user_id',
579 [
580 'user_email_token' => md5( $code ),
581 'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
582 ]
583 );
584
585 return $id ? User::newFromId( $id ) : null;
586 }
587
588 /**
589 * Create a new user object using data from session. If the login
590 * credentials are invalid, the result is an anonymous user.
591 *
592 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
593 * @return User
594 */
595 public static function newFromSession( WebRequest $request = null ) {
596 $user = new User;
597 $user->mFrom = 'session';
598 $user->mRequest = $request;
599 return $user;
600 }
601
602 /**
603 * Create a new user object from a user row.
604 * The row should have the following fields from the user table in it:
605 * - either user_name or user_id to load further data if needed (or both)
606 * - user_real_name
607 * - all other fields (email, etc.)
608 * It is useless to provide the remaining fields if either user_id,
609 * user_name and user_real_name are not provided because the whole row
610 * will be loaded once more from the database when accessing them.
611 *
612 * @param stdClass $row A row from the user table
613 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
614 * @return User
615 */
616 public static function newFromRow( $row, $data = null ) {
617 $user = new User;
618 $user->loadFromRow( $row, $data );
619 return $user;
620 }
621
622 /**
623 * Static factory method for creation of a "system" user from username.
624 *
625 * A "system" user is an account that's used to attribute logged actions
626 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
627 * might include the 'Maintenance script' or 'Conversion script' accounts
628 * used by various scripts in the maintenance/ directory or accounts such
629 * as 'MediaWiki message delivery' used by the MassMessage extension.
630 *
631 * This can optionally create the user if it doesn't exist, and "steal" the
632 * account if it does exist.
633 *
634 * "Stealing" an existing user is intended to make it impossible for normal
635 * authentication processes to use the account, effectively disabling the
636 * account for normal use:
637 * - Email is invalidated, to prevent account recovery by emailing a
638 * temporary password and to disassociate the account from the existing
639 * human.
640 * - The token is set to a magic invalid value, to kill existing sessions
641 * and to prevent $this->setToken() calls from resetting the token to a
642 * valid value.
643 * - SessionManager is instructed to prevent new sessions for the user, to
644 * do things like deauthorizing OAuth consumers.
645 * - AuthManager is instructed to revoke access, to invalidate or remove
646 * passwords and other credentials.
647 *
648 * @param string $name Username
649 * @param array $options Options are:
650 * - validate: As for User::getCanonicalName(), default 'valid'
651 * - create: Whether to create the user if it doesn't already exist, default true
652 * - steal: Whether to "disable" the account for normal use if it already
653 * exists, default false
654 * @return User|null
655 * @since 1.27
656 */
657 public static function newSystemUser( $name, $options = [] ) {
658 $options += [
659 'validate' => 'valid',
660 'create' => true,
661 'steal' => false,
662 ];
663
664 $name = self::getCanonicalName( $name, $options['validate'] );
665 if ( $name === false ) {
666 return null;
667 }
668
669 $fields = self::selectFields();
670
671 $dbw = wfGetDB( DB_MASTER );
672 $row = $dbw->selectRow(
673 'user',
674 $fields,
675 [ 'user_name' => $name ],
676 __METHOD__
677 );
678 if ( !$row ) {
679 // No user. Create it?
680 return $options['create'] ? self::createNew( $name, [ 'token' => self::INVALID_TOKEN ] ) : null;
681 }
682 $user = self::newFromRow( $row );
683
684 // A user is considered to exist as a non-system user if it can
685 // authenticate, or has an email set, or has a non-invalid token.
686 if ( $user->mEmail || $user->mToken !== self::INVALID_TOKEN ||
687 AuthManager::singleton()->userCanAuthenticate( $name )
688 ) {
689 // User exists. Steal it?
690 if ( !$options['steal'] ) {
691 return null;
692 }
693
694 AuthManager::singleton()->revokeAccessForUser( $name );
695
696 $user->invalidateEmail();
697 $user->mToken = self::INVALID_TOKEN;
698 $user->saveSettings();
699 SessionManager::singleton()->preventSessionsForUser( $user->getName() );
700 }
701
702 return $user;
703 }
704
705 // @}
706
707 /**
708 * Get the username corresponding to a given user ID
709 * @param int $id User ID
710 * @return string|bool The corresponding username
711 */
712 public static function whoIs( $id ) {
713 return UserCache::singleton()->getProp( $id, 'name' );
714 }
715
716 /**
717 * Get the real name of a user given their user ID
718 *
719 * @param int $id User ID
720 * @return string|bool The corresponding user's real name
721 */
722 public static function whoIsReal( $id ) {
723 return UserCache::singleton()->getProp( $id, 'real_name' );
724 }
725
726 /**
727 * Get database id given a user name
728 * @param string $name Username
729 * @param integer $flags User::READ_* constant bitfield
730 * @return int|null The corresponding user's ID, or null if user is nonexistent
731 */
732 public static function idFromName( $name, $flags = self::READ_NORMAL ) {
733 $nt = Title::makeTitleSafe( NS_USER, $name );
734 if ( is_null( $nt ) ) {
735 // Illegal name
736 return null;
737 }
738
739 if ( !( $flags & self::READ_LATEST ) && isset( self::$idCacheByName[$name] ) ) {
740 return self::$idCacheByName[$name];
741 }
742
743 list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
744 $db = wfGetDB( $index );
745
746 $s = $db->selectRow(
747 'user',
748 [ 'user_id' ],
749 [ 'user_name' => $nt->getText() ],
750 __METHOD__,
751 $options
752 );
753
754 if ( $s === false ) {
755 $result = null;
756 } else {
757 $result = $s->user_id;
758 }
759
760 self::$idCacheByName[$name] = $result;
761
762 if ( count( self::$idCacheByName ) > 1000 ) {
763 self::$idCacheByName = [];
764 }
765
766 return $result;
767 }
768
769 /**
770 * Reset the cache used in idFromName(). For use in tests.
771 */
772 public static function resetIdByNameCache() {
773 self::$idCacheByName = [];
774 }
775
776 /**
777 * Does the string match an anonymous IP address?
778 *
779 * This function exists for username validation, in order to reject
780 * usernames which are similar in form to IP addresses. Strings such
781 * as 300.300.300.300 will return true because it looks like an IP
782 * address, despite not being strictly valid.
783 *
784 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
785 * address because the usemod software would "cloak" anonymous IP
786 * addresses like this, if we allowed accounts like this to be created
787 * new users could get the old edits of these anonymous users.
788 *
789 * @param string $name Name to match
790 * @return bool
791 */
792 public static function isIP( $name ) {
793 return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
794 || IP::isIPv6( $name );
795 }
796
797 /**
798 * Is the input a valid username?
799 *
800 * Checks if the input is a valid username, we don't want an empty string,
801 * an IP address, anything that contains slashes (would mess up subpages),
802 * is longer than the maximum allowed username size or doesn't begin with
803 * a capital letter.
804 *
805 * @param string $name Name to match
806 * @return bool
807 */
808 public static function isValidUserName( $name ) {
809 global $wgContLang, $wgMaxNameChars;
810
811 if ( $name == ''
812 || User::isIP( $name )
813 || strpos( $name, '/' ) !== false
814 || strlen( $name ) > $wgMaxNameChars
815 || $name != $wgContLang->ucfirst( $name )
816 ) {
817 return false;
818 }
819
820 // Ensure that the name can't be misresolved as a different title,
821 // such as with extra namespace keys at the start.
822 $parsed = Title::newFromText( $name );
823 if ( is_null( $parsed )
824 || $parsed->getNamespace()
825 || strcmp( $name, $parsed->getPrefixedText() ) ) {
826 return false;
827 }
828
829 // Check an additional blacklist of troublemaker characters.
830 // Should these be merged into the title char list?
831 $unicodeBlacklist = '/[' .
832 '\x{0080}-\x{009f}' . # iso-8859-1 control chars
833 '\x{00a0}' . # non-breaking space
834 '\x{2000}-\x{200f}' . # various whitespace
835 '\x{2028}-\x{202f}' . # breaks and control chars
836 '\x{3000}' . # ideographic space
837 '\x{e000}-\x{f8ff}' . # private use
838 ']/u';
839 if ( preg_match( $unicodeBlacklist, $name ) ) {
840 return false;
841 }
842
843 return true;
844 }
845
846 /**
847 * Usernames which fail to pass this function will be blocked
848 * from user login and new account registrations, but may be used
849 * internally by batch processes.
850 *
851 * If an account already exists in this form, login will be blocked
852 * by a failure to pass this function.
853 *
854 * @param string $name Name to match
855 * @return bool
856 */
857 public static function isUsableName( $name ) {
858 global $wgReservedUsernames;
859 // Must be a valid username, obviously ;)
860 if ( !self::isValidUserName( $name ) ) {
861 return false;
862 }
863
864 static $reservedUsernames = false;
865 if ( !$reservedUsernames ) {
866 $reservedUsernames = $wgReservedUsernames;
867 Hooks::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
868 }
869
870 // Certain names may be reserved for batch processes.
871 foreach ( $reservedUsernames as $reserved ) {
872 if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
873 $reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
874 }
875 if ( $reserved == $name ) {
876 return false;
877 }
878 }
879 return true;
880 }
881
882 /**
883 * Return the users who are members of the given group(s). In case of multiple groups,
884 * users who are members of at least one of them are returned.
885 *
886 * @param string|array $groups A single group name or an array of group names
887 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
888 * records; larger values are ignored.
889 * @param int $after ID the user to start after
890 * @return UserArrayFromResult
891 */
892 public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
893 if ( $groups === [] ) {
894 return UserArrayFromResult::newFromIDs( [] );
895 }
896
897 $groups = array_unique( (array)$groups );
898 $limit = min( 5000, $limit );
899
900 $conds = [ 'ug_group' => $groups ];
901 if ( $after !== null ) {
902 $conds[] = 'ug_user > ' . (int)$after;
903 }
904
905 $dbr = wfGetDB( DB_REPLICA );
906 $ids = $dbr->selectFieldValues(
907 'user_groups',
908 'ug_user',
909 $conds,
910 __METHOD__,
911 [
912 'DISTINCT' => true,
913 'ORDER BY' => 'ug_user',
914 'LIMIT' => $limit,
915 ]
916 ) ?: [];
917 return UserArray::newFromIDs( $ids );
918 }
919
920 /**
921 * Usernames which fail to pass this function will be blocked
922 * from new account registrations, but may be used internally
923 * either by batch processes or by user accounts which have
924 * already been created.
925 *
926 * Additional blacklisting may be added here rather than in
927 * isValidUserName() to avoid disrupting existing accounts.
928 *
929 * @param string $name String to match
930 * @return bool
931 */
932 public static function isCreatableName( $name ) {
933 global $wgInvalidUsernameCharacters;
934
935 // Ensure that the username isn't longer than 235 bytes, so that
936 // (at least for the builtin skins) user javascript and css files
937 // will work. (bug 23080)
938 if ( strlen( $name ) > 235 ) {
939 wfDebugLog( 'username', __METHOD__ .
940 ": '$name' invalid due to length" );
941 return false;
942 }
943
944 // Preg yells if you try to give it an empty string
945 if ( $wgInvalidUsernameCharacters !== '' ) {
946 if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
947 wfDebugLog( 'username', __METHOD__ .
948 ": '$name' invalid due to wgInvalidUsernameCharacters" );
949 return false;
950 }
951 }
952
953 return self::isUsableName( $name );
954 }
955
956 /**
957 * Is the input a valid password for this user?
958 *
959 * @param string $password Desired password
960 * @return bool
961 */
962 public function isValidPassword( $password ) {
963 // simple boolean wrapper for getPasswordValidity
964 return $this->getPasswordValidity( $password ) === true;
965 }
966
967 /**
968 * Given unvalidated password input, return error message on failure.
969 *
970 * @param string $password Desired password
971 * @return bool|string|array True on success, string or array of error message on failure
972 */
973 public function getPasswordValidity( $password ) {
974 $result = $this->checkPasswordValidity( $password );
975 if ( $result->isGood() ) {
976 return true;
977 } else {
978 $messages = [];
979 foreach ( $result->getErrorsByType( 'error' ) as $error ) {
980 $messages[] = $error['message'];
981 }
982 foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
983 $messages[] = $warning['message'];
984 }
985 if ( count( $messages ) === 1 ) {
986 return $messages[0];
987 }
988 return $messages;
989 }
990 }
991
992 /**
993 * Check if this is a valid password for this user
994 *
995 * Create a Status object based on the password's validity.
996 * The Status should be set to fatal if the user should not
997 * be allowed to log in, and should have any errors that
998 * would block changing the password.
999 *
1000 * If the return value of this is not OK, the password
1001 * should not be checked. If the return value is not Good,
1002 * the password can be checked, but the user should not be
1003 * able to set their password to this.
1004 *
1005 * @param string $password Desired password
1006 * @return Status
1007 * @since 1.23
1008 */
1009 public function checkPasswordValidity( $password ) {
1010 global $wgPasswordPolicy;
1011
1012 $upp = new UserPasswordPolicy(
1013 $wgPasswordPolicy['policies'],
1014 $wgPasswordPolicy['checks']
1015 );
1016
1017 $status = Status::newGood();
1018 $result = false; // init $result to false for the internal checks
1019
1020 if ( !Hooks::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1021 $status->error( $result );
1022 return $status;
1023 }
1024
1025 if ( $result === false ) {
1026 $status->merge( $upp->checkUserPassword( $this, $password ) );
1027 return $status;
1028 } elseif ( $result === true ) {
1029 return $status;
1030 } else {
1031 $status->error( $result );
1032 return $status; // the isValidPassword hook set a string $result and returned true
1033 }
1034 }
1035
1036 /**
1037 * Given unvalidated user input, return a canonical username, or false if
1038 * the username is invalid.
1039 * @param string $name User input
1040 * @param string|bool $validate Type of validation to use:
1041 * - false No validation
1042 * - 'valid' Valid for batch processes
1043 * - 'usable' Valid for batch processes and login
1044 * - 'creatable' Valid for batch processes, login and account creation
1045 *
1046 * @throws InvalidArgumentException
1047 * @return bool|string
1048 */
1049 public static function getCanonicalName( $name, $validate = 'valid' ) {
1050 // Force usernames to capital
1051 global $wgContLang;
1052 $name = $wgContLang->ucfirst( $name );
1053
1054 # Reject names containing '#'; these will be cleaned up
1055 # with title normalisation, but then it's too late to
1056 # check elsewhere
1057 if ( strpos( $name, '#' ) !== false ) {
1058 return false;
1059 }
1060
1061 // Clean up name according to title rules,
1062 // but only when validation is requested (bug 12654)
1063 $t = ( $validate !== false ) ?
1064 Title::newFromText( $name, NS_USER ) : Title::makeTitle( NS_USER, $name );
1065 // Check for invalid titles
1066 if ( is_null( $t ) || $t->getNamespace() !== NS_USER || $t->isExternal() ) {
1067 return false;
1068 }
1069
1070 // Reject various classes of invalid names
1071 $name = AuthManager::callLegacyAuthPlugin(
1072 'getCanonicalName', [ $t->getText() ], $t->getText()
1073 );
1074
1075 switch ( $validate ) {
1076 case false:
1077 break;
1078 case 'valid':
1079 if ( !User::isValidUserName( $name ) ) {
1080 $name = false;
1081 }
1082 break;
1083 case 'usable':
1084 if ( !User::isUsableName( $name ) ) {
1085 $name = false;
1086 }
1087 break;
1088 case 'creatable':
1089 if ( !User::isCreatableName( $name ) ) {
1090 $name = false;
1091 }
1092 break;
1093 default:
1094 throw new InvalidArgumentException(
1095 'Invalid parameter value for $validate in ' . __METHOD__ );
1096 }
1097 return $name;
1098 }
1099
1100 /**
1101 * Return a random password.
1102 *
1103 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1104 * @return string New random password
1105 */
1106 public static function randomPassword() {
1107 global $wgMinimalPasswordLength;
1108 return PasswordFactory::generateRandomPasswordString( $wgMinimalPasswordLength );
1109 }
1110
1111 /**
1112 * Set cached properties to default.
1113 *
1114 * @note This no longer clears uncached lazy-initialised properties;
1115 * the constructor does that instead.
1116 *
1117 * @param string|bool $name
1118 */
1119 public function loadDefaults( $name = false ) {
1120 $this->mId = 0;
1121 $this->mName = $name;
1122 $this->mRealName = '';
1123 $this->mEmail = '';
1124 $this->mOptionOverrides = null;
1125 $this->mOptionsLoaded = false;
1126
1127 $loggedOut = $this->mRequest && !defined( 'MW_NO_SESSION' )
1128 ? $this->mRequest->getSession()->getLoggedOutTimestamp() : 0;
1129 if ( $loggedOut !== 0 ) {
1130 $this->mTouched = wfTimestamp( TS_MW, $loggedOut );
1131 } else {
1132 $this->mTouched = '1'; # Allow any pages to be cached
1133 }
1134
1135 $this->mToken = null; // Don't run cryptographic functions till we need a token
1136 $this->mEmailAuthenticated = null;
1137 $this->mEmailToken = '';
1138 $this->mEmailTokenExpires = null;
1139 $this->mRegistration = wfTimestamp( TS_MW );
1140 $this->mGroups = [];
1141
1142 Hooks::run( 'UserLoadDefaults', [ $this, $name ] );
1143 }
1144
1145 /**
1146 * Return whether an item has been loaded.
1147 *
1148 * @param string $item Item to check. Current possibilities:
1149 * - id
1150 * - name
1151 * - realname
1152 * @param string $all 'all' to check if the whole object has been loaded
1153 * or any other string to check if only the item is available (e.g.
1154 * for optimisation)
1155 * @return bool
1156 */
1157 public function isItemLoaded( $item, $all = 'all' ) {
1158 return ( $this->mLoadedItems === true && $all === 'all' ) ||
1159 ( isset( $this->mLoadedItems[$item] ) && $this->mLoadedItems[$item] === true );
1160 }
1161
1162 /**
1163 * Set that an item has been loaded
1164 *
1165 * @param string $item
1166 */
1167 protected function setItemLoaded( $item ) {
1168 if ( is_array( $this->mLoadedItems ) ) {
1169 $this->mLoadedItems[$item] = true;
1170 }
1171 }
1172
1173 /**
1174 * Load user data from the session.
1175 *
1176 * @return bool True if the user is logged in, false otherwise.
1177 */
1178 private function loadFromSession() {
1179 // Deprecated hook
1180 $result = null;
1181 Hooks::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1182 if ( $result !== null ) {
1183 return $result;
1184 }
1185
1186 // MediaWiki\Session\Session already did the necessary authentication of the user
1187 // returned here, so just use it if applicable.
1188 $session = $this->getRequest()->getSession();
1189 $user = $session->getUser();
1190 if ( $user->isLoggedIn() ) {
1191 $this->loadFromUserObject( $user );
1192
1193 // If this user is autoblocked, set a cookie to track the Block. This has to be done on
1194 // every session load, because an autoblocked editor might not edit again from the same
1195 // IP address after being blocked.
1196 $config = RequestContext::getMain()->getConfig();
1197 if ( $config->get( 'CookieSetOnAutoblock' ) === true ) {
1198 $block = $this->getBlock();
1199 $shouldSetCookie = $this->getRequest()->getCookie( 'BlockID' ) === null
1200 && $block
1201 && $block->getType() === Block::TYPE_USER
1202 && $block->isAutoblocking();
1203 if ( $shouldSetCookie ) {
1204 wfDebug( __METHOD__ . ': User is autoblocked, setting cookie to track' );
1205 $block->setCookie( $this->getRequest()->response() );
1206 }
1207 }
1208
1209 // Other code expects these to be set in the session, so set them.
1210 $session->set( 'wsUserID', $this->getId() );
1211 $session->set( 'wsUserName', $this->getName() );
1212 $session->set( 'wsToken', $this->getToken() );
1213 return true;
1214 }
1215 return false;
1216 }
1217
1218 /**
1219 * Load user and user_group data from the database.
1220 * $this->mId must be set, this is how the user is identified.
1221 *
1222 * @param integer $flags User::READ_* constant bitfield
1223 * @return bool True if the user exists, false if the user is anonymous
1224 */
1225 public function loadFromDatabase( $flags = self::READ_LATEST ) {
1226 // Paranoia
1227 $this->mId = intval( $this->mId );
1228
1229 if ( !$this->mId ) {
1230 // Anonymous users are not in the database
1231 $this->loadDefaults();
1232 return false;
1233 }
1234
1235 list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
1236 $db = wfGetDB( $index );
1237
1238 $s = $db->selectRow(
1239 'user',
1240 self::selectFields(),
1241 [ 'user_id' => $this->mId ],
1242 __METHOD__,
1243 $options
1244 );
1245
1246 $this->queryFlagsUsed = $flags;
1247 Hooks::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1248
1249 if ( $s !== false ) {
1250 // Initialise user table data
1251 $this->loadFromRow( $s );
1252 $this->mGroups = null; // deferred
1253 $this->getEditCount(); // revalidation for nulls
1254 return true;
1255 } else {
1256 // Invalid user_id
1257 $this->mId = 0;
1258 $this->loadDefaults();
1259 return false;
1260 }
1261 }
1262
1263 /**
1264 * Initialize this object from a row from the user table.
1265 *
1266 * @param stdClass $row Row from the user table to load.
1267 * @param array $data Further user data to load into the object
1268 *
1269 * user_groups Array with groups out of the user_groups table
1270 * user_properties Array with properties out of the user_properties table
1271 */
1272 protected function loadFromRow( $row, $data = null ) {
1273 $all = true;
1274
1275 $this->mGroups = null; // deferred
1276
1277 if ( isset( $row->user_name ) ) {
1278 $this->mName = $row->user_name;
1279 $this->mFrom = 'name';
1280 $this->setItemLoaded( 'name' );
1281 } else {
1282 $all = false;
1283 }
1284
1285 if ( isset( $row->user_real_name ) ) {
1286 $this->mRealName = $row->user_real_name;
1287 $this->setItemLoaded( 'realname' );
1288 } else {
1289 $all = false;
1290 }
1291
1292 if ( isset( $row->user_id ) ) {
1293 $this->mId = intval( $row->user_id );
1294 $this->mFrom = 'id';
1295 $this->setItemLoaded( 'id' );
1296 } else {
1297 $all = false;
1298 }
1299
1300 if ( isset( $row->user_id ) && isset( $row->user_name ) ) {
1301 self::$idCacheByName[$row->user_name] = $row->user_id;
1302 }
1303
1304 if ( isset( $row->user_editcount ) ) {
1305 $this->mEditCount = $row->user_editcount;
1306 } else {
1307 $all = false;
1308 }
1309
1310 if ( isset( $row->user_touched ) ) {
1311 $this->mTouched = wfTimestamp( TS_MW, $row->user_touched );
1312 } else {
1313 $all = false;
1314 }
1315
1316 if ( isset( $row->user_token ) ) {
1317 // The definition for the column is binary(32), so trim the NULs
1318 // that appends. The previous definition was char(32), so trim
1319 // spaces too.
1320 $this->mToken = rtrim( $row->user_token, " \0" );
1321 if ( $this->mToken === '' ) {
1322 $this->mToken = null;
1323 }
1324 } else {
1325 $all = false;
1326 }
1327
1328 if ( isset( $row->user_email ) ) {
1329 $this->mEmail = $row->user_email;
1330 $this->mEmailAuthenticated = wfTimestampOrNull( TS_MW, $row->user_email_authenticated );
1331 $this->mEmailToken = $row->user_email_token;
1332 $this->mEmailTokenExpires = wfTimestampOrNull( TS_MW, $row->user_email_token_expires );
1333 $this->mRegistration = wfTimestampOrNull( TS_MW, $row->user_registration );
1334 } else {
1335 $all = false;
1336 }
1337
1338 if ( $all ) {
1339 $this->mLoadedItems = true;
1340 }
1341
1342 if ( is_array( $data ) ) {
1343 if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1344 $this->mGroups = $data['user_groups'];
1345 }
1346 if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1347 $this->loadOptions( $data['user_properties'] );
1348 }
1349 }
1350 }
1351
1352 /**
1353 * Load the data for this user object from another user object.
1354 *
1355 * @param User $user
1356 */
1357 protected function loadFromUserObject( $user ) {
1358 $user->load();
1359 foreach ( self::$mCacheVars as $var ) {
1360 $this->$var = $user->$var;
1361 }
1362 }
1363
1364 /**
1365 * Load the groups from the database if they aren't already loaded.
1366 */
1367 private function loadGroups() {
1368 if ( is_null( $this->mGroups ) ) {
1369 $db = ( $this->queryFlagsUsed & self::READ_LATEST )
1370 ? wfGetDB( DB_MASTER )
1371 : wfGetDB( DB_REPLICA );
1372 $res = $db->select( 'user_groups',
1373 [ 'ug_group' ],
1374 [ 'ug_user' => $this->mId ],
1375 __METHOD__ );
1376 $this->mGroups = [];
1377 foreach ( $res as $row ) {
1378 $this->mGroups[] = $row->ug_group;
1379 }
1380 }
1381 }
1382
1383 /**
1384 * Add the user to the group if he/she meets given criteria.
1385 *
1386 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1387 * possible to remove manually via Special:UserRights. In such case it
1388 * will not be re-added automatically. The user will also not lose the
1389 * group if they no longer meet the criteria.
1390 *
1391 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1392 *
1393 * @return array Array of groups the user has been promoted to.
1394 *
1395 * @see $wgAutopromoteOnce
1396 */
1397 public function addAutopromoteOnceGroups( $event ) {
1398 global $wgAutopromoteOnceLogInRC;
1399
1400 if ( wfReadOnly() || !$this->getId() ) {
1401 return [];
1402 }
1403
1404 $toPromote = Autopromote::getAutopromoteOnceGroups( $this, $event );
1405 if ( !count( $toPromote ) ) {
1406 return [];
1407 }
1408
1409 if ( !$this->checkAndSetTouched() ) {
1410 return []; // raced out (bug T48834)
1411 }
1412
1413 $oldGroups = $this->getGroups(); // previous groups
1414 foreach ( $toPromote as $group ) {
1415 $this->addGroup( $group );
1416 }
1417 // update groups in external authentication database
1418 Hooks::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false ] );
1419 AuthManager::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1420
1421 $newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1422
1423 $logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1424 $logEntry->setPerformer( $this );
1425 $logEntry->setTarget( $this->getUserPage() );
1426 $logEntry->setParameters( [
1427 '4::oldgroups' => $oldGroups,
1428 '5::newgroups' => $newGroups,
1429 ] );
1430 $logid = $logEntry->insert();
1431 if ( $wgAutopromoteOnceLogInRC ) {
1432 $logEntry->publish( $logid );
1433 }
1434
1435 return $toPromote;
1436 }
1437
1438 /**
1439 * Builds update conditions. Additional conditions may be added to $conditions to
1440 * protected against race conditions using a compare-and-set (CAS) mechanism
1441 * based on comparing $this->mTouched with the user_touched field.
1442 *
1443 * @param Database $db
1444 * @param array $conditions WHERE conditions for use with Database::update
1445 * @return array WHERE conditions for use with Database::update
1446 */
1447 protected function makeUpdateConditions( Database $db, array $conditions ) {
1448 if ( $this->mTouched ) {
1449 // CAS check: only update if the row wasn't changed sicne it was loaded.
1450 $conditions['user_touched'] = $db->timestamp( $this->mTouched );
1451 }
1452
1453 return $conditions;
1454 }
1455
1456 /**
1457 * Bump user_touched if it didn't change since this object was loaded
1458 *
1459 * On success, the mTouched field is updated.
1460 * The user serialization cache is always cleared.
1461 *
1462 * @return bool Whether user_touched was actually updated
1463 * @since 1.26
1464 */
1465 protected function checkAndSetTouched() {
1466 $this->load();
1467
1468 if ( !$this->mId ) {
1469 return false; // anon
1470 }
1471
1472 // Get a new user_touched that is higher than the old one
1473 $newTouched = $this->newTouchedTimestamp();
1474
1475 $dbw = wfGetDB( DB_MASTER );
1476 $dbw->update( 'user',
1477 [ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1478 $this->makeUpdateConditions( $dbw, [
1479 'user_id' => $this->mId,
1480 ] ),
1481 __METHOD__
1482 );
1483 $success = ( $dbw->affectedRows() > 0 );
1484
1485 if ( $success ) {
1486 $this->mTouched = $newTouched;
1487 $this->clearSharedCache();
1488 } else {
1489 // Clears on failure too since that is desired if the cache is stale
1490 $this->clearSharedCache( 'refresh' );
1491 }
1492
1493 return $success;
1494 }
1495
1496 /**
1497 * Clear various cached data stored in this object. The cache of the user table
1498 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1499 *
1500 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1501 * given source. May be "name", "id", "defaults", "session", or false for no reload.
1502 */
1503 public function clearInstanceCache( $reloadFrom = false ) {
1504 $this->mNewtalk = -1;
1505 $this->mDatePreference = null;
1506 $this->mBlockedby = -1; # Unset
1507 $this->mHash = false;
1508 $this->mRights = null;
1509 $this->mEffectiveGroups = null;
1510 $this->mImplicitGroups = null;
1511 $this->mGroups = null;
1512 $this->mOptions = null;
1513 $this->mOptionsLoaded = false;
1514 $this->mEditCount = null;
1515
1516 if ( $reloadFrom ) {
1517 $this->mLoadedItems = [];
1518 $this->mFrom = $reloadFrom;
1519 }
1520 }
1521
1522 /**
1523 * Combine the language default options with any site-specific options
1524 * and add the default language variants.
1525 *
1526 * @return array Array of String options
1527 */
1528 public static function getDefaultOptions() {
1529 global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1530
1531 static $defOpt = null;
1532 static $defOptLang = null;
1533
1534 if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1535 // $wgContLang does not change (and should not change) mid-request,
1536 // but the unit tests change it anyway, and expect this method to
1537 // return values relevant to the current $wgContLang.
1538 return $defOpt;
1539 }
1540
1541 $defOpt = $wgDefaultUserOptions;
1542 // Default language setting
1543 $defOptLang = $wgContLang->getCode();
1544 $defOpt['language'] = $defOptLang;
1545 foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
1546 $defOpt[$langCode == $wgContLang->getCode() ? 'variant' : "variant-$langCode"] = $langCode;
1547 }
1548
1549 // NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1550 // since extensions may change the set of searchable namespaces depending
1551 // on user groups/permissions.
1552 foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1553 $defOpt['searchNs' . $nsnum] = (boolean)$val;
1554 }
1555 $defOpt['skin'] = Skin::normalizeKey( $wgDefaultSkin );
1556
1557 Hooks::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1558
1559 return $defOpt;
1560 }
1561
1562 /**
1563 * Get a given default option value.
1564 *
1565 * @param string $opt Name of option to retrieve
1566 * @return string Default option value
1567 */
1568 public static function getDefaultOption( $opt ) {
1569 $defOpts = self::getDefaultOptions();
1570 if ( isset( $defOpts[$opt] ) ) {
1571 return $defOpts[$opt];
1572 } else {
1573 return null;
1574 }
1575 }
1576
1577 /**
1578 * Get blocking information
1579 * @param bool $bFromSlave Whether to check the replica DB first.
1580 * To improve performance, non-critical checks are done against replica DBs.
1581 * Check when actually saving should be done against master.
1582 */
1583 private function getBlockedStatus( $bFromSlave = true ) {
1584 global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1585
1586 if ( -1 != $this->mBlockedby ) {
1587 return;
1588 }
1589
1590 wfDebug( __METHOD__ . ": checking...\n" );
1591
1592 // Initialize data...
1593 // Otherwise something ends up stomping on $this->mBlockedby when
1594 // things get lazy-loaded later, causing false positive block hits
1595 // due to -1 !== 0. Probably session-related... Nothing should be
1596 // overwriting mBlockedby, surely?
1597 $this->load();
1598
1599 # We only need to worry about passing the IP address to the Block generator if the
1600 # user is not immune to autoblocks/hardblocks, and they are the current user so we
1601 # know which IP address they're actually coming from
1602 $ip = null;
1603 if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1604 // $wgUser->getName() only works after the end of Setup.php. Until
1605 // then, assume it's a logged-out user.
1606 $globalUserName = $wgUser->isSafeToLoad()
1607 ? $wgUser->getName()
1608 : IP::sanitizeIP( $wgUser->getRequest()->getIP() );
1609 if ( $this->getName() === $globalUserName ) {
1610 $ip = $this->getRequest()->getIP();
1611 }
1612 }
1613
1614 // User/IP blocking
1615 $block = Block::newFromTarget( $this, $ip, !$bFromSlave );
1616
1617 // If no block has been found, check for a cookie indicating that the user is blocked.
1618 $blockCookieVal = (int)$this->getRequest()->getCookie( 'BlockID' );
1619 if ( !$block instanceof Block && $blockCookieVal > 0 ) {
1620 // Load the Block from the ID in the cookie.
1621 $tmpBlock = Block::newFromID( $blockCookieVal );
1622 if ( $tmpBlock instanceof Block ) {
1623 // Check the validity of the block.
1624 $blockIsValid = $tmpBlock->getType() == Block::TYPE_USER
1625 && !$tmpBlock->isExpired()
1626 && $tmpBlock->isAutoblocking();
1627 $config = RequestContext::getMain()->getConfig();
1628 $useBlockCookie = ( $config->get( 'CookieSetOnAutoblock' ) === true );
1629 if ( $blockIsValid && $useBlockCookie ) {
1630 // Use the block.
1631 $block = $tmpBlock;
1632 $this->blockTrigger = 'cookie-block';
1633 } else {
1634 // If the block is not valid, clear the block cookie (but don't delete it,
1635 // because it needs to be cleared from LocalStorage as well and an empty string
1636 // value is checked for in the mediawiki.user.blockcookie module).
1637 $tmpBlock->setCookie( $this->getRequest()->response(), true );
1638 }
1639 }
1640 }
1641
1642 // Proxy blocking
1643 if ( !$block instanceof Block && $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1644 // Local list
1645 if ( self::isLocallyBlockedProxy( $ip ) ) {
1646 $block = new Block( [
1647 'byText' => wfMessage( 'proxyblocker' )->text(),
1648 'reason' => wfMessage( 'proxyblockreason' )->text(),
1649 'address' => $ip,
1650 'systemBlock' => 'proxy',
1651 ] );
1652 $this->blockTrigger = 'proxy-block';
1653 } elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1654 $block = new Block( [
1655 'byText' => wfMessage( 'sorbs' )->text(),
1656 'reason' => wfMessage( 'sorbsreason' )->text(),
1657 'address' => $ip,
1658 'systemBlock' => 'dnsbl',
1659 ] );
1660 $this->blockTrigger = 'openproxy-block';
1661 }
1662 }
1663
1664 // (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1665 if ( !$block instanceof Block
1666 && $wgApplyIpBlocksToXff
1667 && $ip !== null
1668 && !in_array( $ip, $wgProxyWhitelist )
1669 ) {
1670 $xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1671 $xff = array_map( 'trim', explode( ',', $xff ) );
1672 $xff = array_diff( $xff, [ $ip ] );
1673 $xffblocks = Block::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1674 $block = Block::chooseBlock( $xffblocks, $xff );
1675 if ( $block instanceof Block ) {
1676 # Mangle the reason to alert the user that the block
1677 # originated from matching the X-Forwarded-For header.
1678 $block->mReason = wfMessage( 'xffblockreason', $block->mReason )->text();
1679 $this->blockTrigger = 'xff-block';
1680 }
1681 }
1682
1683 if ( $block instanceof Block ) {
1684 wfDebug( __METHOD__ . ": Found block.\n" );
1685 $this->mBlock = $block;
1686 $this->mBlockedby = $block->getByName();
1687 $this->mBlockreason = $block->mReason;
1688 $this->mHideName = $block->mHideName;
1689 $this->mAllowUsertalk = !$block->prevents( 'editownusertalk' );
1690 } else {
1691 $this->mBlockedby = '';
1692 $this->mHideName = 0;
1693 $this->mAllowUsertalk = false;
1694 $this->blockTrigger = false;
1695 }
1696
1697 // Extensions
1698 Hooks::run( 'GetBlockedStatus', [ &$this ] );
1699 }
1700
1701 /**
1702 * Whether the given IP is in a DNS blacklist.
1703 *
1704 * @param string $ip IP to check
1705 * @param bool $checkWhitelist Whether to check the whitelist first
1706 * @return bool True if blacklisted.
1707 */
1708 public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1709 global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1710
1711 if ( !$wgEnableDnsBlacklist ) {
1712 return false;
1713 }
1714
1715 if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1716 return false;
1717 }
1718
1719 return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1720 }
1721
1722 /**
1723 * Whether the given IP is in a given DNS blacklist.
1724 *
1725 * @param string $ip IP to check
1726 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1727 * @return bool True if blacklisted.
1728 */
1729 public function inDnsBlacklist( $ip, $bases ) {
1730 $found = false;
1731 // @todo FIXME: IPv6 ??? (https://bugs.php.net/bug.php?id=33170)
1732 if ( IP::isIPv4( $ip ) ) {
1733 // Reverse IP, bug 21255
1734 $ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1735
1736 foreach ( (array)$bases as $base ) {
1737 // Make hostname
1738 // If we have an access key, use that too (ProjectHoneypot, etc.)
1739 $basename = $base;
1740 if ( is_array( $base ) ) {
1741 if ( count( $base ) >= 2 ) {
1742 // Access key is 1, base URL is 0
1743 $host = "{$base[1]}.$ipReversed.{$base[0]}";
1744 } else {
1745 $host = "$ipReversed.{$base[0]}";
1746 }
1747 $basename = $base[0];
1748 } else {
1749 $host = "$ipReversed.$base";
1750 }
1751
1752 // Send query
1753 $ipList = gethostbynamel( $host );
1754
1755 if ( $ipList ) {
1756 wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1757 $found = true;
1758 break;
1759 } else {
1760 wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1761 }
1762 }
1763 }
1764
1765 return $found;
1766 }
1767
1768 /**
1769 * Check if an IP address is in the local proxy list
1770 *
1771 * @param string $ip
1772 *
1773 * @return bool
1774 */
1775 public static function isLocallyBlockedProxy( $ip ) {
1776 global $wgProxyList;
1777
1778 if ( !$wgProxyList ) {
1779 return false;
1780 }
1781
1782 if ( !is_array( $wgProxyList ) ) {
1783 // Load from the specified file
1784 $wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1785 }
1786
1787 if ( !is_array( $wgProxyList ) ) {
1788 $ret = false;
1789 } elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1790 $ret = true;
1791 } elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1792 // Old-style flipped proxy list
1793 $ret = true;
1794 } else {
1795 $ret = false;
1796 }
1797 return $ret;
1798 }
1799
1800 /**
1801 * Is this user subject to rate limiting?
1802 *
1803 * @return bool True if rate limited
1804 */
1805 public function isPingLimitable() {
1806 global $wgRateLimitsExcludedIPs;
1807 if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1808 // No other good way currently to disable rate limits
1809 // for specific IPs. :P
1810 // But this is a crappy hack and should die.
1811 return false;
1812 }
1813 return !$this->isAllowed( 'noratelimit' );
1814 }
1815
1816 /**
1817 * Primitive rate limits: enforce maximum actions per time period
1818 * to put a brake on flooding.
1819 *
1820 * The method generates both a generic profiling point and a per action one
1821 * (suffix being "-$action".
1822 *
1823 * @note When using a shared cache like memcached, IP-address
1824 * last-hit counters will be shared across wikis.
1825 *
1826 * @param string $action Action to enforce; 'edit' if unspecified
1827 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1828 * @return bool True if a rate limiter was tripped
1829 */
1830 public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1831 // Call the 'PingLimiter' hook
1832 $result = false;
1833 if ( !Hooks::run( 'PingLimiter', [ &$this, $action, &$result, $incrBy ] ) ) {
1834 return $result;
1835 }
1836
1837 global $wgRateLimits;
1838 if ( !isset( $wgRateLimits[$action] ) ) {
1839 return false;
1840 }
1841
1842 $limits = array_merge(
1843 [ '&can-bypass' => true ],
1844 $wgRateLimits[$action]
1845 );
1846
1847 // Some groups shouldn't trigger the ping limiter, ever
1848 if ( $limits['&can-bypass'] && !$this->isPingLimitable() ) {
1849 return false;
1850 }
1851
1852 $keys = [];
1853 $id = $this->getId();
1854 $userLimit = false;
1855 $isNewbie = $this->isNewbie();
1856
1857 if ( $id == 0 ) {
1858 // limits for anons
1859 if ( isset( $limits['anon'] ) ) {
1860 $keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1861 }
1862 } else {
1863 // limits for logged-in users
1864 if ( isset( $limits['user'] ) ) {
1865 $userLimit = $limits['user'];
1866 }
1867 // limits for newbie logged-in users
1868 if ( $isNewbie && isset( $limits['newbie'] ) ) {
1869 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1870 }
1871 }
1872
1873 // limits for anons and for newbie logged-in users
1874 if ( $isNewbie ) {
1875 // ip-based limits
1876 if ( isset( $limits['ip'] ) ) {
1877 $ip = $this->getRequest()->getIP();
1878 $keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1879 }
1880 // subnet-based limits
1881 if ( isset( $limits['subnet'] ) ) {
1882 $ip = $this->getRequest()->getIP();
1883 $subnet = IP::getSubnet( $ip );
1884 if ( $subnet !== false ) {
1885 $keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1886 }
1887 }
1888 }
1889
1890 // Check for group-specific permissions
1891 // If more than one group applies, use the group with the highest limit ratio (max/period)
1892 foreach ( $this->getGroups() as $group ) {
1893 if ( isset( $limits[$group] ) ) {
1894 if ( $userLimit === false
1895 || $limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1896 ) {
1897 $userLimit = $limits[$group];
1898 }
1899 }
1900 }
1901
1902 // Set the user limit key
1903 if ( $userLimit !== false ) {
1904 list( $max, $period ) = $userLimit;
1905 wfDebug( __METHOD__ . ": effective user limit: $max in {$period}s\n" );
1906 $keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1907 }
1908
1909 // ip-based limits for all ping-limitable users
1910 if ( isset( $limits['ip-all'] ) ) {
1911 $ip = $this->getRequest()->getIP();
1912 // ignore if user limit is more permissive
1913 if ( $isNewbie || $userLimit === false
1914 || $limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
1915 $keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
1916 }
1917 }
1918
1919 // subnet-based limits for all ping-limitable users
1920 if ( isset( $limits['subnet-all'] ) ) {
1921 $ip = $this->getRequest()->getIP();
1922 $subnet = IP::getSubnet( $ip );
1923 if ( $subnet !== false ) {
1924 // ignore if user limit is more permissive
1925 if ( $isNewbie || $userLimit === false
1926 || $limits['ip-all'][0] / $limits['ip-all'][1]
1927 > $userLimit[0] / $userLimit[1] ) {
1928 $keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
1929 }
1930 }
1931 }
1932
1933 $cache = ObjectCache::getLocalClusterInstance();
1934
1935 $triggered = false;
1936 foreach ( $keys as $key => $limit ) {
1937 list( $max, $period ) = $limit;
1938 $summary = "(limit $max in {$period}s)";
1939 $count = $cache->get( $key );
1940 // Already pinged?
1941 if ( $count ) {
1942 if ( $count >= $max ) {
1943 wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1944 "(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1945 $triggered = true;
1946 } else {
1947 wfDebug( __METHOD__ . ": ok. $key at $count $summary\n" );
1948 }
1949 } else {
1950 wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
1951 if ( $incrBy > 0 ) {
1952 $cache->add( $key, 0, intval( $period ) ); // first ping
1953 }
1954 }
1955 if ( $incrBy > 0 ) {
1956 $cache->incr( $key, $incrBy );
1957 }
1958 }
1959
1960 return $triggered;
1961 }
1962
1963 /**
1964 * Check if user is blocked
1965 *
1966 * @param bool $bFromSlave Whether to check the replica DB instead of
1967 * the master. Hacked from false due to horrible probs on site.
1968 * @return bool True if blocked, false otherwise
1969 */
1970 public function isBlocked( $bFromSlave = true ) {
1971 return $this->getBlock( $bFromSlave ) instanceof Block && $this->getBlock()->prevents( 'edit' );
1972 }
1973
1974 /**
1975 * Get the block affecting the user, or null if the user is not blocked
1976 *
1977 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1978 * @return Block|null
1979 */
1980 public function getBlock( $bFromSlave = true ) {
1981 $this->getBlockedStatus( $bFromSlave );
1982 return $this->mBlock instanceof Block ? $this->mBlock : null;
1983 }
1984
1985 /**
1986 * Check if user is blocked from editing a particular article
1987 *
1988 * @param Title $title Title to check
1989 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1990 * @return bool
1991 */
1992 public function isBlockedFrom( $title, $bFromSlave = false ) {
1993 global $wgBlockAllowsUTEdit;
1994
1995 $blocked = $this->isBlocked( $bFromSlave );
1996 $allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false );
1997 // If a user's name is suppressed, they cannot make edits anywhere
1998 if ( !$this->mHideName && $allowUsertalk && $title->getText() === $this->getName()
1999 && $title->getNamespace() == NS_USER_TALK ) {
2000 $blocked = false;
2001 wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" );
2002 }
2003
2004 Hooks::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
2005
2006 return $blocked;
2007 }
2008
2009 /**
2010 * If user is blocked, return the name of the user who placed the block
2011 * @return string Name of blocker
2012 */
2013 public function blockedBy() {
2014 $this->getBlockedStatus();
2015 return $this->mBlockedby;
2016 }
2017
2018 /**
2019 * If user is blocked, return the specified reason for the block
2020 * @return string Blocking reason
2021 */
2022 public function blockedFor() {
2023 $this->getBlockedStatus();
2024 return $this->mBlockreason;
2025 }
2026
2027 /**
2028 * If user is blocked, return the ID for the block
2029 * @return int Block ID
2030 */
2031 public function getBlockId() {
2032 $this->getBlockedStatus();
2033 return ( $this->mBlock ? $this->mBlock->getId() : false );
2034 }
2035
2036 /**
2037 * Check if user is blocked on all wikis.
2038 * Do not use for actual edit permission checks!
2039 * This is intended for quick UI checks.
2040 *
2041 * @param string $ip IP address, uses current client if none given
2042 * @return bool True if blocked, false otherwise
2043 */
2044 public function isBlockedGlobally( $ip = '' ) {
2045 return $this->getGlobalBlock( $ip ) instanceof Block;
2046 }
2047
2048 /**
2049 * Check if user is blocked on all wikis.
2050 * Do not use for actual edit permission checks!
2051 * This is intended for quick UI checks.
2052 *
2053 * @param string $ip IP address, uses current client if none given
2054 * @return Block|null Block object if blocked, null otherwise
2055 * @throws FatalError
2056 * @throws MWException
2057 */
2058 public function getGlobalBlock( $ip = '' ) {
2059 if ( $this->mGlobalBlock !== null ) {
2060 return $this->mGlobalBlock ?: null;
2061 }
2062 // User is already an IP?
2063 if ( IP::isIPAddress( $this->getName() ) ) {
2064 $ip = $this->getName();
2065 } elseif ( !$ip ) {
2066 $ip = $this->getRequest()->getIP();
2067 }
2068 $blocked = false;
2069 $block = null;
2070 Hooks::run( 'UserIsBlockedGlobally', [ &$this, $ip, &$blocked, &$block ] );
2071
2072 if ( $blocked && $block === null ) {
2073 // back-compat: UserIsBlockedGlobally didn't have $block param first
2074 $block = new Block( [
2075 'address' => $ip,
2076 'systemBlock' => 'global-block'
2077 ] );
2078 }
2079
2080 $this->mGlobalBlock = $blocked ? $block : false;
2081 return $this->mGlobalBlock ?: null;
2082 }
2083
2084 /**
2085 * Check if user account is locked
2086 *
2087 * @return bool True if locked, false otherwise
2088 */
2089 public function isLocked() {
2090 if ( $this->mLocked !== null ) {
2091 return $this->mLocked;
2092 }
2093 $authUser = AuthManager::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2094 $this->mLocked = $authUser && $authUser->isLocked();
2095 Hooks::run( 'UserIsLocked', [ $this, &$this->mLocked ] );
2096 return $this->mLocked;
2097 }
2098
2099 /**
2100 * Check if user account is hidden
2101 *
2102 * @return bool True if hidden, false otherwise
2103 */
2104 public function isHidden() {
2105 if ( $this->mHideName !== null ) {
2106 return $this->mHideName;
2107 }
2108 $this->getBlockedStatus();
2109 if ( !$this->mHideName ) {
2110 $authUser = AuthManager::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2111 $this->mHideName = $authUser && $authUser->isHidden();
2112 Hooks::run( 'UserIsHidden', [ $this, &$this->mHideName ] );
2113 }
2114 return $this->mHideName;
2115 }
2116
2117 /**
2118 * Get the user's ID.
2119 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2120 */
2121 public function getId() {
2122 if ( $this->mId === null && $this->mName !== null && User::isIP( $this->mName ) ) {
2123 // Special case, we know the user is anonymous
2124 return 0;
2125 } elseif ( !$this->isItemLoaded( 'id' ) ) {
2126 // Don't load if this was initialized from an ID
2127 $this->load();
2128 }
2129
2130 return (int)$this->mId;
2131 }
2132
2133 /**
2134 * Set the user and reload all fields according to a given ID
2135 * @param int $v User ID to reload
2136 */
2137 public function setId( $v ) {
2138 $this->mId = $v;
2139 $this->clearInstanceCache( 'id' );
2140 }
2141
2142 /**
2143 * Get the user name, or the IP of an anonymous user
2144 * @return string User's name or IP address
2145 */
2146 public function getName() {
2147 if ( $this->isItemLoaded( 'name', 'only' ) ) {
2148 // Special case optimisation
2149 return $this->mName;
2150 } else {
2151 $this->load();
2152 if ( $this->mName === false ) {
2153 // Clean up IPs
2154 $this->mName = IP::sanitizeIP( $this->getRequest()->getIP() );
2155 }
2156 return $this->mName;
2157 }
2158 }
2159
2160 /**
2161 * Set the user name.
2162 *
2163 * This does not reload fields from the database according to the given
2164 * name. Rather, it is used to create a temporary "nonexistent user" for
2165 * later addition to the database. It can also be used to set the IP
2166 * address for an anonymous user to something other than the current
2167 * remote IP.
2168 *
2169 * @note User::newFromName() has roughly the same function, when the named user
2170 * does not exist.
2171 * @param string $str New user name to set
2172 */
2173 public function setName( $str ) {
2174 $this->load();
2175 $this->mName = $str;
2176 }
2177
2178 /**
2179 * Get the user's name escaped by underscores.
2180 * @return string Username escaped by underscores.
2181 */
2182 public function getTitleKey() {
2183 return str_replace( ' ', '_', $this->getName() );
2184 }
2185
2186 /**
2187 * Check if the user has new messages.
2188 * @return bool True if the user has new messages
2189 */
2190 public function getNewtalk() {
2191 $this->load();
2192
2193 // Load the newtalk status if it is unloaded (mNewtalk=-1)
2194 if ( $this->mNewtalk === -1 ) {
2195 $this->mNewtalk = false; # reset talk page status
2196
2197 // Check memcached separately for anons, who have no
2198 // entire User object stored in there.
2199 if ( !$this->mId ) {
2200 global $wgDisableAnonTalk;
2201 if ( $wgDisableAnonTalk ) {
2202 // Anon newtalk disabled by configuration.
2203 $this->mNewtalk = false;
2204 } else {
2205 $this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName() );
2206 }
2207 } else {
2208 $this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
2209 }
2210 }
2211
2212 return (bool)$this->mNewtalk;
2213 }
2214
2215 /**
2216 * Return the data needed to construct links for new talk page message
2217 * alerts. If there are new messages, this will return an associative array
2218 * with the following data:
2219 * wiki: The database name of the wiki
2220 * link: Root-relative link to the user's talk page
2221 * rev: The last talk page revision that the user has seen or null. This
2222 * is useful for building diff links.
2223 * If there are no new messages, it returns an empty array.
2224 * @note This function was designed to accomodate multiple talk pages, but
2225 * currently only returns a single link and revision.
2226 * @return array
2227 */
2228 public function getNewMessageLinks() {
2229 $talks = [];
2230 if ( !Hooks::run( 'UserRetrieveNewTalks', [ &$this, &$talks ] ) ) {
2231 return $talks;
2232 } elseif ( !$this->getNewtalk() ) {
2233 return [];
2234 }
2235 $utp = $this->getTalkPage();
2236 $dbr = wfGetDB( DB_REPLICA );
2237 // Get the "last viewed rev" timestamp from the oldest message notification
2238 $timestamp = $dbr->selectField( 'user_newtalk',
2239 'MIN(user_last_timestamp)',
2240 $this->isAnon() ? [ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2241 __METHOD__ );
2242 $rev = $timestamp ? Revision::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2243 return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2244 }
2245
2246 /**
2247 * Get the revision ID for the last talk page revision viewed by the talk
2248 * page owner.
2249 * @return int|null Revision ID or null
2250 */
2251 public function getNewMessageRevisionId() {
2252 $newMessageRevisionId = null;
2253 $newMessageLinks = $this->getNewMessageLinks();
2254 if ( $newMessageLinks ) {
2255 // Note: getNewMessageLinks() never returns more than a single link
2256 // and it is always for the same wiki, but we double-check here in
2257 // case that changes some time in the future.
2258 if ( count( $newMessageLinks ) === 1
2259 && $newMessageLinks[0]['wiki'] === wfWikiID()
2260 && $newMessageLinks[0]['rev']
2261 ) {
2262 /** @var Revision $newMessageRevision */
2263 $newMessageRevision = $newMessageLinks[0]['rev'];
2264 $newMessageRevisionId = $newMessageRevision->getId();
2265 }
2266 }
2267 return $newMessageRevisionId;
2268 }
2269
2270 /**
2271 * Internal uncached check for new messages
2272 *
2273 * @see getNewtalk()
2274 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2275 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2276 * @return bool True if the user has new messages
2277 */
2278 protected function checkNewtalk( $field, $id ) {
2279 $dbr = wfGetDB( DB_REPLICA );
2280
2281 $ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__ );
2282
2283 return $ok !== false;
2284 }
2285
2286 /**
2287 * Add or update the new messages flag
2288 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2289 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2290 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2291 * @return bool True if successful, false otherwise
2292 */
2293 protected function updateNewtalk( $field, $id, $curRev = null ) {
2294 // Get timestamp of the talk page revision prior to the current one
2295 $prevRev = $curRev ? $curRev->getPrevious() : false;
2296 $ts = $prevRev ? $prevRev->getTimestamp() : null;
2297 // Mark the user as having new messages since this revision
2298 $dbw = wfGetDB( DB_MASTER );
2299 $dbw->insert( 'user_newtalk',
2300 [ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2301 __METHOD__,
2302 'IGNORE' );
2303 if ( $dbw->affectedRows() ) {
2304 wfDebug( __METHOD__ . ": set on ($field, $id)\n" );
2305 return true;
2306 } else {
2307 wfDebug( __METHOD__ . " already set ($field, $id)\n" );
2308 return false;
2309 }
2310 }
2311
2312 /**
2313 * Clear the new messages flag for the given user
2314 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2315 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2316 * @return bool True if successful, false otherwise
2317 */
2318 protected function deleteNewtalk( $field, $id ) {
2319 $dbw = wfGetDB( DB_MASTER );
2320 $dbw->delete( 'user_newtalk',
2321 [ $field => $id ],
2322 __METHOD__ );
2323 if ( $dbw->affectedRows() ) {
2324 wfDebug( __METHOD__ . ": killed on ($field, $id)\n" );
2325 return true;
2326 } else {
2327 wfDebug( __METHOD__ . ": already gone ($field, $id)\n" );
2328 return false;
2329 }
2330 }
2331
2332 /**
2333 * Update the 'You have new messages!' status.
2334 * @param bool $val Whether the user has new messages
2335 * @param Revision $curRev New, as yet unseen revision of the user talk
2336 * page. Ignored if null or !$val.
2337 */
2338 public function setNewtalk( $val, $curRev = null ) {
2339 if ( wfReadOnly() ) {
2340 return;
2341 }
2342
2343 $this->load();
2344 $this->mNewtalk = $val;
2345
2346 if ( $this->isAnon() ) {
2347 $field = 'user_ip';
2348 $id = $this->getName();
2349 } else {
2350 $field = 'user_id';
2351 $id = $this->getId();
2352 }
2353
2354 if ( $val ) {
2355 $changed = $this->updateNewtalk( $field, $id, $curRev );
2356 } else {
2357 $changed = $this->deleteNewtalk( $field, $id );
2358 }
2359
2360 if ( $changed ) {
2361 $this->invalidateCache();
2362 }
2363 }
2364
2365 /**
2366 * Generate a current or new-future timestamp to be stored in the
2367 * user_touched field when we update things.
2368 * @return string Timestamp in TS_MW format
2369 */
2370 private function newTouchedTimestamp() {
2371 global $wgClockSkewFudge;
2372
2373 $time = wfTimestamp( TS_MW, time() + $wgClockSkewFudge );
2374 if ( $this->mTouched && $time <= $this->mTouched ) {
2375 $time = wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $this->mTouched ) + 1 );
2376 }
2377
2378 return $time;
2379 }
2380
2381 /**
2382 * Clear user data from memcached
2383 *
2384 * Use after applying updates to the database; caller's
2385 * responsibility to update user_touched if appropriate.
2386 *
2387 * Called implicitly from invalidateCache() and saveSettings().
2388 *
2389 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2390 */
2391 public function clearSharedCache( $mode = 'changed' ) {
2392 if ( !$this->getId() ) {
2393 return;
2394 }
2395
2396 $cache = ObjectCache::getMainWANInstance();
2397 $key = $this->getCacheKey( $cache );
2398 if ( $mode === 'refresh' ) {
2399 $cache->delete( $key, 1 );
2400 } else {
2401 wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle(
2402 function() use ( $cache, $key ) {
2403 $cache->delete( $key );
2404 },
2405 __METHOD__
2406 );
2407 }
2408 }
2409
2410 /**
2411 * Immediately touch the user data cache for this account
2412 *
2413 * Calls touch() and removes account data from memcached
2414 */
2415 public function invalidateCache() {
2416 $this->touch();
2417 $this->clearSharedCache();
2418 }
2419
2420 /**
2421 * Update the "touched" timestamp for the user
2422 *
2423 * This is useful on various login/logout events when making sure that
2424 * a browser or proxy that has multiple tenants does not suffer cache
2425 * pollution where the new user sees the old users content. The value
2426 * of getTouched() is checked when determining 304 vs 200 responses.
2427 * Unlike invalidateCache(), this preserves the User object cache and
2428 * avoids database writes.
2429 *
2430 * @since 1.25
2431 */
2432 public function touch() {
2433 $id = $this->getId();
2434 if ( $id ) {
2435 $key = wfMemcKey( 'user-quicktouched', 'id', $id );
2436 ObjectCache::getMainWANInstance()->touchCheckKey( $key );
2437 $this->mQuickTouched = null;
2438 }
2439 }
2440
2441 /**
2442 * Validate the cache for this account.
2443 * @param string $timestamp A timestamp in TS_MW format
2444 * @return bool
2445 */
2446 public function validateCache( $timestamp ) {
2447 return ( $timestamp >= $this->getTouched() );
2448 }
2449
2450 /**
2451 * Get the user touched timestamp
2452 *
2453 * Use this value only to validate caches via inequalities
2454 * such as in the case of HTTP If-Modified-Since response logic
2455 *
2456 * @return string TS_MW Timestamp
2457 */
2458 public function getTouched() {
2459 $this->load();
2460
2461 if ( $this->mId ) {
2462 if ( $this->mQuickTouched === null ) {
2463 $key = wfMemcKey( 'user-quicktouched', 'id', $this->mId );
2464 $cache = ObjectCache::getMainWANInstance();
2465
2466 $this->mQuickTouched = wfTimestamp( TS_MW, $cache->getCheckKeyTime( $key ) );
2467 }
2468
2469 return max( $this->mTouched, $this->mQuickTouched );
2470 }
2471
2472 return $this->mTouched;
2473 }
2474
2475 /**
2476 * Get the user_touched timestamp field (time of last DB updates)
2477 * @return string TS_MW Timestamp
2478 * @since 1.26
2479 */
2480 public function getDBTouched() {
2481 $this->load();
2482
2483 return $this->mTouched;
2484 }
2485
2486 /**
2487 * @deprecated Removed in 1.27.
2488 * @return Password
2489 * @since 1.24
2490 */
2491 public function getPassword() {
2492 throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2493 }
2494
2495 /**
2496 * @deprecated Removed in 1.27.
2497 * @return Password
2498 * @since 1.24
2499 */
2500 public function getTemporaryPassword() {
2501 throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2502 }
2503
2504 /**
2505 * Set the password and reset the random token.
2506 * Calls through to authentication plugin if necessary;
2507 * will have no effect if the auth plugin refuses to
2508 * pass the change through or if the legal password
2509 * checks fail.
2510 *
2511 * As a special case, setting the password to null
2512 * wipes it, so the account cannot be logged in until
2513 * a new password is set, for instance via e-mail.
2514 *
2515 * @deprecated since 1.27, use AuthManager instead
2516 * @param string $str New password to set
2517 * @throws PasswordError On failure
2518 * @return bool
2519 */
2520 public function setPassword( $str ) {
2521 return $this->setPasswordInternal( $str );
2522 }
2523
2524 /**
2525 * Set the password and reset the random token unconditionally.
2526 *
2527 * @deprecated since 1.27, use AuthManager instead
2528 * @param string|null $str New password to set or null to set an invalid
2529 * password hash meaning that the user will not be able to log in
2530 * through the web interface.
2531 */
2532 public function setInternalPassword( $str ) {
2533 $this->setPasswordInternal( $str );
2534 }
2535
2536 /**
2537 * Actually set the password and such
2538 * @since 1.27 cannot set a password for a user not in the database
2539 * @param string|null $str New password to set or null to set an invalid
2540 * password hash meaning that the user will not be able to log in
2541 * through the web interface.
2542 * @return bool Success
2543 */
2544 private function setPasswordInternal( $str ) {
2545 $manager = AuthManager::singleton();
2546
2547 // If the user doesn't exist yet, fail
2548 if ( !$manager->userExists( $this->getName() ) ) {
2549 throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2550 }
2551
2552 $status = $this->changeAuthenticationData( [
2553 'username' => $this->getName(),
2554 'password' => $str,
2555 'retype' => $str,
2556 ] );
2557 if ( !$status->isGood() ) {
2558 \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
2559 ->info( __METHOD__ . ': Password change rejected: '
2560 . $status->getWikiText( null, null, 'en' ) );
2561 return false;
2562 }
2563
2564 $this->setOption( 'watchlisttoken', false );
2565 SessionManager::singleton()->invalidateSessionsForUser( $this );
2566
2567 return true;
2568 }
2569
2570 /**
2571 * Changes credentials of the user.
2572 *
2573 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2574 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2575 * e.g. when no provider handled the change.
2576 *
2577 * @param array $data A set of authentication data in fieldname => value format. This is the
2578 * same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2579 * @return Status
2580 * @since 1.27
2581 */
2582 public function changeAuthenticationData( array $data ) {
2583 $manager = AuthManager::singleton();
2584 $reqs = $manager->getAuthenticationRequests( AuthManager::ACTION_CHANGE, $this );
2585 $reqs = AuthenticationRequest::loadRequestsFromSubmission( $reqs, $data );
2586
2587 $status = Status::newGood( 'ignored' );
2588 foreach ( $reqs as $req ) {
2589 $status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2590 }
2591 if ( $status->getValue() === 'ignored' ) {
2592 $status->warning( 'authenticationdatachange-ignored' );
2593 }
2594
2595 if ( $status->isGood() ) {
2596 foreach ( $reqs as $req ) {
2597 $manager->changeAuthenticationData( $req );
2598 }
2599 }
2600 return $status;
2601 }
2602
2603 /**
2604 * Get the user's current token.
2605 * @param bool $forceCreation Force the generation of a new token if the
2606 * user doesn't have one (default=true for backwards compatibility).
2607 * @return string|null Token
2608 */
2609 public function getToken( $forceCreation = true ) {
2610 global $wgAuthenticationTokenVersion;
2611
2612 $this->load();
2613 if ( !$this->mToken && $forceCreation ) {
2614 $this->setToken();
2615 }
2616
2617 if ( !$this->mToken ) {
2618 // The user doesn't have a token, return null to indicate that.
2619 return null;
2620 } elseif ( $this->mToken === self::INVALID_TOKEN ) {
2621 // We return a random value here so existing token checks are very
2622 // likely to fail.
2623 return MWCryptRand::generateHex( self::TOKEN_LENGTH );
2624 } elseif ( $wgAuthenticationTokenVersion === null ) {
2625 // $wgAuthenticationTokenVersion not in use, so return the raw secret
2626 return $this->mToken;
2627 } else {
2628 // $wgAuthenticationTokenVersion in use, so hmac it.
2629 $ret = MWCryptHash::hmac( $wgAuthenticationTokenVersion, $this->mToken, false );
2630
2631 // The raw hash can be overly long. Shorten it up.
2632 $len = max( 32, self::TOKEN_LENGTH );
2633 if ( strlen( $ret ) < $len ) {
2634 // Should never happen, even md5 is 128 bits
2635 throw new \UnexpectedValueException( 'Hmac returned less than 128 bits' );
2636 }
2637 return substr( $ret, -$len );
2638 }
2639 }
2640
2641 /**
2642 * Set the random token (used for persistent authentication)
2643 * Called from loadDefaults() among other places.
2644 *
2645 * @param string|bool $token If specified, set the token to this value
2646 */
2647 public function setToken( $token = false ) {
2648 $this->load();
2649 if ( $this->mToken === self::INVALID_TOKEN ) {
2650 \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
2651 ->debug( __METHOD__ . ": Ignoring attempt to set token for system user \"$this\"" );
2652 } elseif ( !$token ) {
2653 $this->mToken = MWCryptRand::generateHex( self::TOKEN_LENGTH );
2654 } else {
2655 $this->mToken = $token;
2656 }
2657 }
2658
2659 /**
2660 * Set the password for a password reminder or new account email
2661 *
2662 * @deprecated Removed in 1.27. Use PasswordReset instead.
2663 * @param string $str New password to set or null to set an invalid
2664 * password hash meaning that the user will not be able to use it
2665 * @param bool $throttle If true, reset the throttle timestamp to the present
2666 */
2667 public function setNewpassword( $str, $throttle = true ) {
2668 throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2669 }
2670
2671 /**
2672 * Has password reminder email been sent within the last
2673 * $wgPasswordReminderResendTime hours?
2674 * @deprecated Removed in 1.27. See above.
2675 * @return bool
2676 */
2677 public function isPasswordReminderThrottled() {
2678 throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2679 }
2680
2681 /**
2682 * Get the user's e-mail address
2683 * @return string User's email address
2684 */
2685 public function getEmail() {
2686 $this->load();
2687 Hooks::run( 'UserGetEmail', [ $this, &$this->mEmail ] );
2688 return $this->mEmail;
2689 }
2690
2691 /**
2692 * Get the timestamp of the user's e-mail authentication
2693 * @return string TS_MW timestamp
2694 */
2695 public function getEmailAuthenticationTimestamp() {
2696 $this->load();
2697 Hooks::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
2698 return $this->mEmailAuthenticated;
2699 }
2700
2701 /**
2702 * Set the user's e-mail address
2703 * @param string $str New e-mail address
2704 */
2705 public function setEmail( $str ) {
2706 $this->load();
2707 if ( $str == $this->mEmail ) {
2708 return;
2709 }
2710 $this->invalidateEmail();
2711 $this->mEmail = $str;
2712 Hooks::run( 'UserSetEmail', [ $this, &$this->mEmail ] );
2713 }
2714
2715 /**
2716 * Set the user's e-mail address and a confirmation mail if needed.
2717 *
2718 * @since 1.20
2719 * @param string $str New e-mail address
2720 * @return Status
2721 */
2722 public function setEmailWithConfirmation( $str ) {
2723 global $wgEnableEmail, $wgEmailAuthentication;
2724
2725 if ( !$wgEnableEmail ) {
2726 return Status::newFatal( 'emaildisabled' );
2727 }
2728
2729 $oldaddr = $this->getEmail();
2730 if ( $str === $oldaddr ) {
2731 return Status::newGood( true );
2732 }
2733
2734 $type = $oldaddr != '' ? 'changed' : 'set';
2735 $notificationResult = null;
2736
2737 if ( $wgEmailAuthentication ) {
2738 // Send the user an email notifying the user of the change in registered
2739 // email address on their previous email address
2740 if ( $type == 'changed' ) {
2741 $change = $str != '' ? 'changed' : 'removed';
2742 $notificationResult = $this->sendMail(
2743 wfMessage( 'notificationemail_subject_' . $change )->text(),
2744 wfMessage( 'notificationemail_body_' . $change,
2745 $this->getRequest()->getIP(),
2746 $this->getName(),
2747 $str )->text()
2748 );
2749 }
2750 }
2751
2752 $this->setEmail( $str );
2753
2754 if ( $str !== '' && $wgEmailAuthentication ) {
2755 // Send a confirmation request to the new address if needed
2756 $result = $this->sendConfirmationMail( $type );
2757
2758 if ( $notificationResult !== null ) {
2759 $result->merge( $notificationResult );
2760 }
2761
2762 if ( $result->isGood() ) {
2763 // Say to the caller that a confirmation and notification mail has been sent
2764 $result->value = 'eauth';
2765 }
2766 } else {
2767 $result = Status::newGood( true );
2768 }
2769
2770 return $result;
2771 }
2772
2773 /**
2774 * Get the user's real name
2775 * @return string User's real name
2776 */
2777 public function getRealName() {
2778 if ( !$this->isItemLoaded( 'realname' ) ) {
2779 $this->load();
2780 }
2781
2782 return $this->mRealName;
2783 }
2784
2785 /**
2786 * Set the user's real name
2787 * @param string $str New real name
2788 */
2789 public function setRealName( $str ) {
2790 $this->load();
2791 $this->mRealName = $str;
2792 }
2793
2794 /**
2795 * Get the user's current setting for a given option.
2796 *
2797 * @param string $oname The option to check
2798 * @param string $defaultOverride A default value returned if the option does not exist
2799 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2800 * @return string|null User's current value for the option
2801 * @see getBoolOption()
2802 * @see getIntOption()
2803 */
2804 public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2805 global $wgHiddenPrefs;
2806 $this->loadOptions();
2807
2808 # We want 'disabled' preferences to always behave as the default value for
2809 # users, even if they have set the option explicitly in their settings (ie they
2810 # set it, and then it was disabled removing their ability to change it). But
2811 # we don't want to erase the preferences in the database in case the preference
2812 # is re-enabled again. So don't touch $mOptions, just override the returned value
2813 if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2814 return self::getDefaultOption( $oname );
2815 }
2816
2817 if ( array_key_exists( $oname, $this->mOptions ) ) {
2818 return $this->mOptions[$oname];
2819 } else {
2820 return $defaultOverride;
2821 }
2822 }
2823
2824 /**
2825 * Get all user's options
2826 *
2827 * @param int $flags Bitwise combination of:
2828 * User::GETOPTIONS_EXCLUDE_DEFAULTS Exclude user options that are set
2829 * to the default value. (Since 1.25)
2830 * @return array
2831 */
2832 public function getOptions( $flags = 0 ) {
2833 global $wgHiddenPrefs;
2834 $this->loadOptions();
2835 $options = $this->mOptions;
2836
2837 # We want 'disabled' preferences to always behave as the default value for
2838 # users, even if they have set the option explicitly in their settings (ie they
2839 # set it, and then it was disabled removing their ability to change it). But
2840 # we don't want to erase the preferences in the database in case the preference
2841 # is re-enabled again. So don't touch $mOptions, just override the returned value
2842 foreach ( $wgHiddenPrefs as $pref ) {
2843 $default = self::getDefaultOption( $pref );
2844 if ( $default !== null ) {
2845 $options[$pref] = $default;
2846 }
2847 }
2848
2849 if ( $flags & self::GETOPTIONS_EXCLUDE_DEFAULTS ) {
2850 $options = array_diff_assoc( $options, self::getDefaultOptions() );
2851 }
2852
2853 return $options;
2854 }
2855
2856 /**
2857 * Get the user's current setting for a given option, as a boolean value.
2858 *
2859 * @param string $oname The option to check
2860 * @return bool User's current value for the option
2861 * @see getOption()
2862 */
2863 public function getBoolOption( $oname ) {
2864 return (bool)$this->getOption( $oname );
2865 }
2866
2867 /**
2868 * Get the user's current setting for a given option, as an integer value.
2869 *
2870 * @param string $oname The option to check
2871 * @param int $defaultOverride A default value returned if the option does not exist
2872 * @return int User's current value for the option
2873 * @see getOption()
2874 */
2875 public function getIntOption( $oname, $defaultOverride = 0 ) {
2876 $val = $this->getOption( $oname );
2877 if ( $val == '' ) {
2878 $val = $defaultOverride;
2879 }
2880 return intval( $val );
2881 }
2882
2883 /**
2884 * Set the given option for a user.
2885 *
2886 * You need to call saveSettings() to actually write to the database.
2887 *
2888 * @param string $oname The option to set
2889 * @param mixed $val New value to set
2890 */
2891 public function setOption( $oname, $val ) {
2892 $this->loadOptions();
2893
2894 // Explicitly NULL values should refer to defaults
2895 if ( is_null( $val ) ) {
2896 $val = self::getDefaultOption( $oname );
2897 }
2898
2899 $this->mOptions[$oname] = $val;
2900 }
2901
2902 /**
2903 * Get a token stored in the preferences (like the watchlist one),
2904 * resetting it if it's empty (and saving changes).
2905 *
2906 * @param string $oname The option name to retrieve the token from
2907 * @return string|bool User's current value for the option, or false if this option is disabled.
2908 * @see resetTokenFromOption()
2909 * @see getOption()
2910 * @deprecated since 1.26 Applications should use the OAuth extension
2911 */
2912 public function getTokenFromOption( $oname ) {
2913 global $wgHiddenPrefs;
2914
2915 $id = $this->getId();
2916 if ( !$id || in_array( $oname, $wgHiddenPrefs ) ) {
2917 return false;
2918 }
2919
2920 $token = $this->getOption( $oname );
2921 if ( !$token ) {
2922 // Default to a value based on the user token to avoid space
2923 // wasted on storing tokens for all users. When this option
2924 // is set manually by the user, only then is it stored.
2925 $token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
2926 }
2927
2928 return $token;
2929 }
2930
2931 /**
2932 * Reset a token stored in the preferences (like the watchlist one).
2933 * *Does not* save user's preferences (similarly to setOption()).
2934 *
2935 * @param string $oname The option name to reset the token in
2936 * @return string|bool New token value, or false if this option is disabled.
2937 * @see getTokenFromOption()
2938 * @see setOption()
2939 */
2940 public function resetTokenFromOption( $oname ) {
2941 global $wgHiddenPrefs;
2942 if ( in_array( $oname, $wgHiddenPrefs ) ) {
2943 return false;
2944 }
2945
2946 $token = MWCryptRand::generateHex( 40 );
2947 $this->setOption( $oname, $token );
2948 return $token;
2949 }
2950
2951 /**
2952 * Return a list of the types of user options currently returned by
2953 * User::getOptionKinds().
2954 *
2955 * Currently, the option kinds are:
2956 * - 'registered' - preferences which are registered in core MediaWiki or
2957 * by extensions using the UserGetDefaultOptions hook.
2958 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2959 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2960 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2961 * be used by user scripts.
2962 * - 'special' - "preferences" that are not accessible via User::getOptions
2963 * or User::setOptions.
2964 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2965 * These are usually legacy options, removed in newer versions.
2966 *
2967 * The API (and possibly others) use this function to determine the possible
2968 * option types for validation purposes, so make sure to update this when a
2969 * new option kind is added.
2970 *
2971 * @see User::getOptionKinds
2972 * @return array Option kinds
2973 */
2974 public static function listOptionKinds() {
2975 return [
2976 'registered',
2977 'registered-multiselect',
2978 'registered-checkmatrix',
2979 'userjs',
2980 'special',
2981 'unused'
2982 ];
2983 }
2984
2985 /**
2986 * Return an associative array mapping preferences keys to the kind of a preference they're
2987 * used for. Different kinds are handled differently when setting or reading preferences.
2988 *
2989 * See User::listOptionKinds for the list of valid option types that can be provided.
2990 *
2991 * @see User::listOptionKinds
2992 * @param IContextSource $context
2993 * @param array $options Assoc. array with options keys to check as keys.
2994 * Defaults to $this->mOptions.
2995 * @return array The key => kind mapping data
2996 */
2997 public function getOptionKinds( IContextSource $context, $options = null ) {
2998 $this->loadOptions();
2999 if ( $options === null ) {
3000 $options = $this->mOptions;
3001 }
3002
3003 $prefs = Preferences::getPreferences( $this, $context );
3004 $mapping = [];
3005
3006 // Pull out the "special" options, so they don't get converted as
3007 // multiselect or checkmatrix.
3008 $specialOptions = array_fill_keys( Preferences::getSaveBlacklist(), true );
3009 foreach ( $specialOptions as $name => $value ) {
3010 unset( $prefs[$name] );
3011 }
3012
3013 // Multiselect and checkmatrix options are stored in the database with
3014 // one key per option, each having a boolean value. Extract those keys.
3015 $multiselectOptions = [];
3016 foreach ( $prefs as $name => $info ) {
3017 if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
3018 ( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
3019 $opts = HTMLFormField::flattenOptions( $info['options'] );
3020 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
3021
3022 foreach ( $opts as $value ) {
3023 $multiselectOptions["$prefix$value"] = true;
3024 }
3025
3026 unset( $prefs[$name] );
3027 }
3028 }
3029 $checkmatrixOptions = [];
3030 foreach ( $prefs as $name => $info ) {
3031 if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
3032 ( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
3033 $columns = HTMLFormField::flattenOptions( $info['columns'] );
3034 $rows = HTMLFormField::flattenOptions( $info['rows'] );
3035 $prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
3036
3037 foreach ( $columns as $column ) {
3038 foreach ( $rows as $row ) {
3039 $checkmatrixOptions["$prefix$column-$row"] = true;
3040 }
3041 }
3042
3043 unset( $prefs[$name] );
3044 }
3045 }
3046
3047 // $value is ignored
3048 foreach ( $options as $key => $value ) {
3049 if ( isset( $prefs[$key] ) ) {
3050 $mapping[$key] = 'registered';
3051 } elseif ( isset( $multiselectOptions[$key] ) ) {
3052 $mapping[$key] = 'registered-multiselect';
3053 } elseif ( isset( $checkmatrixOptions[$key] ) ) {
3054 $mapping[$key] = 'registered-checkmatrix';
3055 } elseif ( isset( $specialOptions[$key] ) ) {
3056 $mapping[$key] = 'special';
3057 } elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3058 $mapping[$key] = 'userjs';
3059 } else {
3060 $mapping[$key] = 'unused';
3061 }
3062 }
3063
3064 return $mapping;
3065 }
3066
3067 /**
3068 * Reset certain (or all) options to the site defaults
3069 *
3070 * The optional parameter determines which kinds of preferences will be reset.
3071 * Supported values are everything that can be reported by getOptionKinds()
3072 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3073 *
3074 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3075 * array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3076 * for backwards-compatibility.
3077 * @param IContextSource|null $context Context source used when $resetKinds
3078 * does not contain 'all', passed to getOptionKinds().
3079 * Defaults to RequestContext::getMain() when null.
3080 */
3081 public function resetOptions(
3082 $resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3083 IContextSource $context = null
3084 ) {
3085 $this->load();
3086 $defaultOptions = self::getDefaultOptions();
3087
3088 if ( !is_array( $resetKinds ) ) {
3089 $resetKinds = [ $resetKinds ];
3090 }
3091
3092 if ( in_array( 'all', $resetKinds ) ) {
3093 $newOptions = $defaultOptions;
3094 } else {
3095 if ( $context === null ) {
3096 $context = RequestContext::getMain();
3097 }
3098
3099 $optionKinds = $this->getOptionKinds( $context );
3100 $resetKinds = array_intersect( $resetKinds, self::listOptionKinds() );
3101 $newOptions = [];
3102
3103 // Use default values for the options that should be deleted, and
3104 // copy old values for the ones that shouldn't.
3105 foreach ( $this->mOptions as $key => $value ) {
3106 if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3107 if ( array_key_exists( $key, $defaultOptions ) ) {
3108 $newOptions[$key] = $defaultOptions[$key];
3109 }
3110 } else {
3111 $newOptions[$key] = $value;
3112 }
3113 }
3114 }
3115
3116 Hooks::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions, $resetKinds ] );
3117
3118 $this->mOptions = $newOptions;
3119 $this->mOptionsLoaded = true;
3120 }
3121
3122 /**
3123 * Get the user's preferred date format.
3124 * @return string User's preferred date format
3125 */
3126 public function getDatePreference() {
3127 // Important migration for old data rows
3128 if ( is_null( $this->mDatePreference ) ) {
3129 global $wgLang;
3130 $value = $this->getOption( 'date' );
3131 $map = $wgLang->getDatePreferenceMigrationMap();
3132 if ( isset( $map[$value] ) ) {
3133 $value = $map[$value];
3134 }
3135 $this->mDatePreference = $value;
3136 }
3137 return $this->mDatePreference;
3138 }
3139
3140 /**
3141 * Determine based on the wiki configuration and the user's options,
3142 * whether this user must be over HTTPS no matter what.
3143 *
3144 * @return bool
3145 */
3146 public function requiresHTTPS() {
3147 global $wgSecureLogin;
3148 if ( !$wgSecureLogin ) {
3149 return false;
3150 } else {
3151 $https = $this->getBoolOption( 'prefershttps' );
3152 Hooks::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3153 if ( $https ) {
3154 $https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3155 }
3156 return $https;
3157 }
3158 }
3159
3160 /**
3161 * Get the user preferred stub threshold
3162 *
3163 * @return int
3164 */
3165 public function getStubThreshold() {
3166 global $wgMaxArticleSize; # Maximum article size, in Kb
3167 $threshold = $this->getIntOption( 'stubthreshold' );
3168 if ( $threshold > $wgMaxArticleSize * 1024 ) {
3169 // If they have set an impossible value, disable the preference
3170 // so we can use the parser cache again.
3171 $threshold = 0;
3172 }
3173 return $threshold;
3174 }
3175
3176 /**
3177 * Get the permissions this user has.
3178 * @return array Array of String permission names
3179 */
3180 public function getRights() {
3181 if ( is_null( $this->mRights ) ) {
3182 $this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() );
3183 Hooks::run( 'UserGetRights', [ $this, &$this->mRights ] );
3184
3185 // Deny any rights denied by the user's session, unless this
3186 // endpoint has no sessions.
3187 if ( !defined( 'MW_NO_SESSION' ) ) {
3188 $allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3189 if ( $allowedRights !== null ) {
3190 $this->mRights = array_intersect( $this->mRights, $allowedRights );
3191 }
3192 }
3193
3194 // Force reindexation of rights when a hook has unset one of them
3195 $this->mRights = array_values( array_unique( $this->mRights ) );
3196
3197 // If block disables login, we should also remove any
3198 // extra rights blocked users might have, in case the
3199 // blocked user has a pre-existing session (T129738).
3200 // This is checked here for cases where people only call
3201 // $user->isAllowed(). It is also checked in Title::checkUserBlock()
3202 // to give a better error message in the common case.
3203 $config = RequestContext::getMain()->getConfig();
3204 if (
3205 $this->isLoggedIn() &&
3206 $config->get( 'BlockDisablesLogin' ) &&
3207 $this->isBlocked()
3208 ) {
3209 $anon = new User;
3210 $this->mRights = array_intersect( $this->mRights, $anon->getRights() );
3211 }
3212 }
3213 return $this->mRights;
3214 }
3215
3216 /**
3217 * Get the list of explicit group memberships this user has.
3218 * The implicit * and user groups are not included.
3219 * @return array Array of String internal group names
3220 */
3221 public function getGroups() {
3222 $this->load();
3223 $this->loadGroups();
3224 return $this->mGroups;
3225 }
3226
3227 /**
3228 * Get the list of implicit group memberships this user has.
3229 * This includes all explicit groups, plus 'user' if logged in,
3230 * '*' for all accounts, and autopromoted groups
3231 * @param bool $recache Whether to avoid the cache
3232 * @return array Array of String internal group names
3233 */
3234 public function getEffectiveGroups( $recache = false ) {
3235 if ( $recache || is_null( $this->mEffectiveGroups ) ) {
3236 $this->mEffectiveGroups = array_unique( array_merge(
3237 $this->getGroups(), // explicit groups
3238 $this->getAutomaticGroups( $recache ) // implicit groups
3239 ) );
3240 // Hook for additional groups
3241 Hooks::run( 'UserEffectiveGroups', [ &$this, &$this->mEffectiveGroups ] );
3242 // Force reindexation of groups when a hook has unset one of them
3243 $this->mEffectiveGroups = array_values( array_unique( $this->mEffectiveGroups ) );
3244 }
3245 return $this->mEffectiveGroups;
3246 }
3247
3248 /**
3249 * Get the list of implicit group memberships this user has.
3250 * This includes 'user' if logged in, '*' for all accounts,
3251 * and autopromoted groups
3252 * @param bool $recache Whether to avoid the cache
3253 * @return array Array of String internal group names
3254 */
3255 public function getAutomaticGroups( $recache = false ) {
3256 if ( $recache || is_null( $this->mImplicitGroups ) ) {
3257 $this->mImplicitGroups = [ '*' ];
3258 if ( $this->getId() ) {
3259 $this->mImplicitGroups[] = 'user';
3260
3261 $this->mImplicitGroups = array_unique( array_merge(
3262 $this->mImplicitGroups,
3263 Autopromote::getAutopromoteGroups( $this )
3264 ) );
3265 }
3266 if ( $recache ) {
3267 // Assure data consistency with rights/groups,
3268 // as getEffectiveGroups() depends on this function
3269 $this->mEffectiveGroups = null;
3270 }
3271 }
3272 return $this->mImplicitGroups;
3273 }
3274
3275 /**
3276 * Returns the groups the user has belonged to.
3277 *
3278 * The user may still belong to the returned groups. Compare with getGroups().
3279 *
3280 * The function will not return groups the user had belonged to before MW 1.17
3281 *
3282 * @return array Names of the groups the user has belonged to.
3283 */
3284 public function getFormerGroups() {
3285 $this->load();
3286
3287 if ( is_null( $this->mFormerGroups ) ) {
3288 $db = ( $this->queryFlagsUsed & self::READ_LATEST )
3289 ? wfGetDB( DB_MASTER )
3290 : wfGetDB( DB_REPLICA );
3291 $res = $db->select( 'user_former_groups',
3292 [ 'ufg_group' ],
3293 [ 'ufg_user' => $this->mId ],
3294 __METHOD__ );
3295 $this->mFormerGroups = [];
3296 foreach ( $res as $row ) {
3297 $this->mFormerGroups[] = $row->ufg_group;
3298 }
3299 }
3300
3301 return $this->mFormerGroups;
3302 }
3303
3304 /**
3305 * Get the user's edit count.
3306 * @return int|null Null for anonymous users
3307 */
3308 public function getEditCount() {
3309 if ( !$this->getId() ) {
3310 return null;
3311 }
3312
3313 if ( $this->mEditCount === null ) {
3314 /* Populate the count, if it has not been populated yet */
3315 $dbr = wfGetDB( DB_REPLICA );
3316 // check if the user_editcount field has been initialized
3317 $count = $dbr->selectField(
3318 'user', 'user_editcount',
3319 [ 'user_id' => $this->mId ],
3320 __METHOD__
3321 );
3322
3323 if ( $count === null ) {
3324 // it has not been initialized. do so.
3325 $count = $this->initEditCount();
3326 }
3327 $this->mEditCount = $count;
3328 }
3329 return (int)$this->mEditCount;
3330 }
3331
3332 /**
3333 * Add the user to the given group.
3334 * This takes immediate effect.
3335 * @param string $group Name of the group to add
3336 * @return bool
3337 */
3338 public function addGroup( $group ) {
3339 $this->load();
3340
3341 if ( !Hooks::run( 'UserAddGroup', [ $this, &$group ] ) ) {
3342 return false;
3343 }
3344
3345 $dbw = wfGetDB( DB_MASTER );
3346 if ( $this->getId() ) {
3347 $dbw->insert( 'user_groups',
3348 [
3349 'ug_user' => $this->getId(),
3350 'ug_group' => $group,
3351 ],
3352 __METHOD__,
3353 [ 'IGNORE' ] );
3354 }
3355
3356 $this->loadGroups();
3357 $this->mGroups[] = $group;
3358 // In case loadGroups was not called before, we now have the right twice.
3359 // Get rid of the duplicate.
3360 $this->mGroups = array_unique( $this->mGroups );
3361
3362 // Refresh the groups caches, and clear the rights cache so it will be
3363 // refreshed on the next call to $this->getRights().
3364 $this->getEffectiveGroups( true );
3365 $this->mRights = null;
3366
3367 $this->invalidateCache();
3368
3369 return true;
3370 }
3371
3372 /**
3373 * Remove the user from the given group.
3374 * This takes immediate effect.
3375 * @param string $group Name of the group to remove
3376 * @return bool
3377 */
3378 public function removeGroup( $group ) {
3379 $this->load();
3380 if ( !Hooks::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3381 return false;
3382 }
3383
3384 $dbw = wfGetDB( DB_MASTER );
3385 $dbw->delete( 'user_groups',
3386 [
3387 'ug_user' => $this->getId(),
3388 'ug_group' => $group,
3389 ], __METHOD__
3390 );
3391 // Remember that the user was in this group
3392 $dbw->insert( 'user_former_groups',
3393 [
3394 'ufg_user' => $this->getId(),
3395 'ufg_group' => $group,
3396 ],
3397 __METHOD__,
3398 [ 'IGNORE' ]
3399 );
3400
3401 $this->loadGroups();
3402 $this->mGroups = array_diff( $this->mGroups, [ $group ] );
3403
3404 // Refresh the groups caches, and clear the rights cache so it will be
3405 // refreshed on the next call to $this->getRights().
3406 $this->getEffectiveGroups( true );
3407 $this->mRights = null;
3408
3409 $this->invalidateCache();
3410
3411 return true;
3412 }
3413
3414 /**
3415 * Get whether the user is logged in
3416 * @return bool
3417 */
3418 public function isLoggedIn() {
3419 return $this->getId() != 0;
3420 }
3421
3422 /**
3423 * Get whether the user is anonymous
3424 * @return bool
3425 */
3426 public function isAnon() {
3427 return !$this->isLoggedIn();
3428 }
3429
3430 /**
3431 * @return bool Whether this user is flagged as being a bot role account
3432 * @since 1.28
3433 */
3434 public function isBot() {
3435 if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3436 return true;
3437 }
3438
3439 $isBot = false;
3440 Hooks::run( "UserIsBot", [ $this, &$isBot ] );
3441
3442 return $isBot;
3443 }
3444
3445 /**
3446 * Check if user is allowed to access a feature / make an action
3447 *
3448 * @param string ... Permissions to test
3449 * @return bool True if user is allowed to perform *any* of the given actions
3450 */
3451 public function isAllowedAny() {
3452 $permissions = func_get_args();
3453 foreach ( $permissions as $permission ) {
3454 if ( $this->isAllowed( $permission ) ) {
3455 return true;
3456 }
3457 }
3458 return false;
3459 }
3460
3461 /**
3462 *
3463 * @param string ... Permissions to test
3464 * @return bool True if the user is allowed to perform *all* of the given actions
3465 */
3466 public function isAllowedAll() {
3467 $permissions = func_get_args();
3468 foreach ( $permissions as $permission ) {
3469 if ( !$this->isAllowed( $permission ) ) {
3470 return false;
3471 }
3472 }
3473 return true;
3474 }
3475
3476 /**
3477 * Internal mechanics of testing a permission
3478 * @param string $action
3479 * @return bool
3480 */
3481 public function isAllowed( $action = '' ) {
3482 if ( $action === '' ) {
3483 return true; // In the spirit of DWIM
3484 }
3485 // Use strict parameter to avoid matching numeric 0 accidentally inserted
3486 // by misconfiguration: 0 == 'foo'
3487 return in_array( $action, $this->getRights(), true );
3488 }
3489
3490 /**
3491 * Check whether to enable recent changes patrol features for this user
3492 * @return bool True or false
3493 */
3494 public function useRCPatrol() {
3495 global $wgUseRCPatrol;
3496 return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3497 }
3498
3499 /**
3500 * Check whether to enable new pages patrol features for this user
3501 * @return bool True or false
3502 */
3503 public function useNPPatrol() {
3504 global $wgUseRCPatrol, $wgUseNPPatrol;
3505 return (
3506 ( $wgUseRCPatrol || $wgUseNPPatrol )
3507 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3508 );
3509 }
3510
3511 /**
3512 * Check whether to enable new files patrol features for this user
3513 * @return bool True or false
3514 */
3515 public function useFilePatrol() {
3516 global $wgUseRCPatrol, $wgUseFilePatrol;
3517 return (
3518 ( $wgUseRCPatrol || $wgUseFilePatrol )
3519 && ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3520 );
3521 }
3522
3523 /**
3524 * Get the WebRequest object to use with this object
3525 *
3526 * @return WebRequest
3527 */
3528 public function getRequest() {
3529 if ( $this->mRequest ) {
3530 return $this->mRequest;
3531 } else {
3532 global $wgRequest;
3533 return $wgRequest;
3534 }
3535 }
3536
3537 /**
3538 * Check the watched status of an article.
3539 * @since 1.22 $checkRights parameter added
3540 * @param Title $title Title of the article to look at
3541 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3542 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3543 * @return bool
3544 */
3545 public function isWatched( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
3546 if ( $title->isWatchable() && ( !$checkRights || $this->isAllowed( 'viewmywatchlist' ) ) ) {
3547 return MediaWikiServices::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3548 }
3549 return false;
3550 }
3551
3552 /**
3553 * Watch an article.
3554 * @since 1.22 $checkRights parameter added
3555 * @param Title $title Title of the article to look at
3556 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3557 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3558 */
3559 public function addWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
3560 if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
3561 MediaWikiServices::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3562 $this,
3563 [ $title->getSubjectPage(), $title->getTalkPage() ]
3564 );
3565 }
3566 $this->invalidateCache();
3567 }
3568
3569 /**
3570 * Stop watching an article.
3571 * @since 1.22 $checkRights parameter added
3572 * @param Title $title Title of the article to look at
3573 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3574 * Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3575 */
3576 public function removeWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
3577 if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
3578 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
3579 $store->removeWatch( $this, $title->getSubjectPage() );
3580 $store->removeWatch( $this, $title->getTalkPage() );
3581 }
3582 $this->invalidateCache();
3583 }
3584
3585 /**
3586 * Clear the user's notification timestamp for the given title.
3587 * If e-notif e-mails are on, they will receive notification mails on
3588 * the next change of the page if it's watched etc.
3589 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3590 * @param Title $title Title of the article to look at
3591 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3592 */
3593 public function clearNotification( &$title, $oldid = 0 ) {
3594 global $wgUseEnotif, $wgShowUpdatedMarker;
3595
3596 // Do nothing if the database is locked to writes
3597 if ( wfReadOnly() ) {
3598 return;
3599 }
3600
3601 // Do nothing if not allowed to edit the watchlist
3602 if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3603 return;
3604 }
3605
3606 // If we're working on user's talk page, we should update the talk page message indicator
3607 if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3608 if ( !Hooks::run( 'UserClearNewTalkNotification', [ &$this, $oldid ] ) ) {
3609 return;
3610 }
3611
3612 // Try to update the DB post-send and only if needed...
3613 DeferredUpdates::addCallableUpdate( function() use ( $title, $oldid ) {
3614 if ( !$this->getNewtalk() ) {
3615 return; // no notifications to clear
3616 }
3617
3618 // Delete the last notifications (they stack up)
3619 $this->setNewtalk( false );
3620
3621 // If there is a new, unseen, revision, use its timestamp
3622 $nextid = $oldid
3623 ? $title->getNextRevisionID( $oldid, Title::GAID_FOR_UPDATE )
3624 : null;
3625 if ( $nextid ) {
3626 $this->setNewtalk( true, Revision::newFromId( $nextid ) );
3627 }
3628 } );
3629 }
3630
3631 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3632 return;
3633 }
3634
3635 if ( $this->isAnon() ) {
3636 // Nothing else to do...
3637 return;
3638 }
3639
3640 // Only update the timestamp if the page is being watched.
3641 // The query to find out if it is watched is cached both in memcached and per-invocation,
3642 // and when it does have to be executed, it can be on a replica DB
3643 // If this is the user's newtalk page, we always update the timestamp
3644 $force = '';
3645 if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3646 $force = 'force';
3647 }
3648
3649 MediaWikiServices::getInstance()->getWatchedItemStore()
3650 ->resetNotificationTimestamp( $this, $title, $force, $oldid );
3651 }
3652
3653 /**
3654 * Resets all of the given user's page-change notification timestamps.
3655 * If e-notif e-mails are on, they will receive notification mails on
3656 * the next change of any watched page.
3657 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3658 */
3659 public function clearAllNotifications() {
3660 global $wgUseEnotif, $wgShowUpdatedMarker;
3661 // Do nothing if not allowed to edit the watchlist
3662 if ( wfReadOnly() || !$this->isAllowed( 'editmywatchlist' ) ) {
3663 return;
3664 }
3665
3666 if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3667 $this->setNewtalk( false );
3668 return;
3669 }
3670
3671 $id = $this->getId();
3672 if ( !$id ) {
3673 return;
3674 }
3675
3676 $dbw = wfGetDB( DB_MASTER );
3677 $asOfTimes = array_unique( $dbw->selectFieldValues(
3678 'watchlist',
3679 'wl_notificationtimestamp',
3680 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3681 __METHOD__,
3682 [ 'ORDER BY' => 'wl_notificationtimestamp DESC', 'LIMIT' => 500 ]
3683 ) );
3684 if ( !$asOfTimes ) {
3685 return;
3686 }
3687 // Immediately update the most recent touched rows, which hopefully covers what
3688 // the user sees on the watchlist page before pressing "mark all pages visited"....
3689 $dbw->update(
3690 'watchlist',
3691 [ 'wl_notificationtimestamp' => null ],
3692 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimes ],
3693 __METHOD__
3694 );
3695 // ...and finish the older ones in a post-send update with lag checks...
3696 DeferredUpdates::addUpdate( new AutoCommitUpdate(
3697 $dbw,
3698 __METHOD__,
3699 function () use ( $dbw, $id ) {
3700 global $wgUpdateRowsPerQuery;
3701
3702 $lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
3703 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
3704 $asOfTimes = array_unique( $dbw->selectFieldValues(
3705 'watchlist',
3706 'wl_notificationtimestamp',
3707 [ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3708 __METHOD__
3709 ) );
3710 foreach ( array_chunk( $asOfTimes, $wgUpdateRowsPerQuery ) as $asOfTimeBatch ) {
3711 $dbw->update(
3712 'watchlist',
3713 [ 'wl_notificationtimestamp' => null ],
3714 [ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimeBatch ],
3715 __METHOD__
3716 );
3717 $lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
3718 }
3719 }
3720 ) );
3721 // We also need to clear here the "you have new message" notification for the own
3722 // user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3723 }
3724
3725 /**
3726 * Set a cookie on the user's client. Wrapper for
3727 * WebResponse::setCookie
3728 * @deprecated since 1.27
3729 * @param string $name Name of the cookie to set
3730 * @param string $value Value to set
3731 * @param int $exp Expiration time, as a UNIX time value;
3732 * if 0 or not specified, use the default $wgCookieExpiration
3733 * @param bool $secure
3734 * true: Force setting the secure attribute when setting the cookie
3735 * false: Force NOT setting the secure attribute when setting the cookie
3736 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3737 * @param array $params Array of options sent passed to WebResponse::setcookie()
3738 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3739 * is passed.
3740 */
3741 protected function setCookie(
3742 $name, $value, $exp = 0, $secure = null, $params = [], $request = null
3743 ) {
3744 wfDeprecated( __METHOD__, '1.27' );
3745 if ( $request === null ) {
3746 $request = $this->getRequest();
3747 }
3748 $params['secure'] = $secure;
3749 $request->response()->setCookie( $name, $value, $exp, $params );
3750 }
3751
3752 /**
3753 * Clear a cookie on the user's client
3754 * @deprecated since 1.27
3755 * @param string $name Name of the cookie to clear
3756 * @param bool $secure
3757 * true: Force setting the secure attribute when setting the cookie
3758 * false: Force NOT setting the secure attribute when setting the cookie
3759 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3760 * @param array $params Array of options sent passed to WebResponse::setcookie()
3761 */
3762 protected function clearCookie( $name, $secure = null, $params = [] ) {
3763 wfDeprecated( __METHOD__, '1.27' );
3764 $this->setCookie( $name, '', time() - 86400, $secure, $params );
3765 }
3766
3767 /**
3768 * Set an extended login cookie on the user's client. The expiry of the cookie
3769 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3770 * variable.
3771 *
3772 * @see User::setCookie
3773 *
3774 * @deprecated since 1.27
3775 * @param string $name Name of the cookie to set
3776 * @param string $value Value to set
3777 * @param bool $secure
3778 * true: Force setting the secure attribute when setting the cookie
3779 * false: Force NOT setting the secure attribute when setting the cookie
3780 * null (default): Use the default ($wgCookieSecure) to set the secure attribute
3781 */
3782 protected function setExtendedLoginCookie( $name, $value, $secure ) {
3783 global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3784
3785 wfDeprecated( __METHOD__, '1.27' );
3786
3787 $exp = time();
3788 $exp += $wgExtendedLoginCookieExpiration !== null
3789 ? $wgExtendedLoginCookieExpiration
3790 : $wgCookieExpiration;
3791
3792 $this->setCookie( $name, $value, $exp, $secure );
3793 }
3794
3795 /**
3796 * Persist this user's session (e.g. set cookies)
3797 *
3798 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3799 * is passed.
3800 * @param bool $secure Whether to force secure/insecure cookies or use default
3801 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3802 */
3803 public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3804 $this->load();
3805 if ( 0 == $this->mId ) {
3806 return;
3807 }
3808
3809 $session = $this->getRequest()->getSession();
3810 if ( $request && $session->getRequest() !== $request ) {
3811 $session = $session->sessionWithRequest( $request );
3812 }
3813 $delay = $session->delaySave();
3814
3815 if ( !$session->getUser()->equals( $this ) ) {
3816 if ( !$session->canSetUser() ) {
3817 \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
3818 ->warning( __METHOD__ .
3819 ": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3820 );
3821 return;
3822 }
3823 $session->setUser( $this );
3824 }
3825
3826 $session->setRememberUser( $rememberMe );
3827 if ( $secure !== null ) {
3828 $session->setForceHTTPS( $secure );
3829 }
3830
3831 $session->persist();
3832
3833 ScopedCallback::consume( $delay );
3834 }
3835
3836 /**
3837 * Log this user out.
3838 */
3839 public function logout() {
3840 if ( Hooks::run( 'UserLogout', [ &$this ] ) ) {
3841 $this->doLogout();
3842 }
3843 }
3844
3845 /**
3846 * Clear the user's session, and reset the instance cache.
3847 * @see logout()
3848 */
3849 public function doLogout() {
3850 $session = $this->getRequest()->getSession();
3851 if ( !$session->canSetUser() ) {
3852 \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
3853 ->warning( __METHOD__ . ": Cannot log out of an immutable session" );
3854 $error = 'immutable';
3855 } elseif ( !$session->getUser()->equals( $this ) ) {
3856 \MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
3857 ->warning( __METHOD__ .
3858 ": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3859 );
3860 // But we still may as well make this user object anon
3861 $this->clearInstanceCache( 'defaults' );
3862 $error = 'wronguser';
3863 } else {
3864 $this->clearInstanceCache( 'defaults' );
3865 $delay = $session->delaySave();
3866 $session->unpersist(); // Clear cookies (T127436)
3867 $session->setLoggedOutTimestamp( time() );
3868 $session->setUser( new User );
3869 $session->set( 'wsUserID', 0 ); // Other code expects this
3870 $session->resetAllTokens();
3871 ScopedCallback::consume( $delay );
3872 $error = false;
3873 }
3874 \MediaWiki\Logger\LoggerFactory::getInstance( 'authevents' )->info( 'Logout', [
3875 'event' => 'logout',
3876 'successful' => $error === false,
3877 'status' => $error ?: 'success',
3878 ] );
3879 }
3880
3881 /**
3882 * Save this user's settings into the database.
3883 * @todo Only rarely do all these fields need to be set!
3884 */
3885 public function saveSettings() {
3886 if ( wfReadOnly() ) {
3887 // @TODO: caller should deal with this instead!
3888 // This should really just be an exception.
3889 MWExceptionHandler::logException( new DBExpectedError(
3890 null,
3891 "Could not update user with ID '{$this->mId}'; DB is read-only."
3892 ) );
3893 return;
3894 }
3895
3896 $this->load();
3897 if ( 0 == $this->mId ) {
3898 return; // anon
3899 }
3900
3901 // Get a new user_touched that is higher than the old one.
3902 // This will be used for a CAS check as a last-resort safety
3903 // check against race conditions and replica DB lag.
3904 $newTouched = $this->newTouchedTimestamp();
3905
3906 $dbw = wfGetDB( DB_MASTER );
3907 $dbw->update( 'user',
3908 [ /* SET */
3909 'user_name' => $this->mName,
3910 'user_real_name' => $this->mRealName,
3911 'user_email' => $this->mEmail,
3912 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
3913 'user_touched' => $dbw->timestamp( $newTouched ),
3914 'user_token' => strval( $this->mToken ),
3915 'user_email_token' => $this->mEmailToken,
3916 'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
3917 ], $this->makeUpdateConditions( $dbw, [ /* WHERE */
3918 'user_id' => $this->mId,
3919 ] ), __METHOD__
3920 );
3921
3922 if ( !$dbw->affectedRows() ) {
3923 // Maybe the problem was a missed cache update; clear it to be safe
3924 $this->clearSharedCache( 'refresh' );
3925 // User was changed in the meantime or loaded with stale data
3926 $from = ( $this->queryFlagsUsed & self::READ_LATEST ) ? 'master' : 'replica';
3927 throw new MWException(
3928 "CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3929 " the version of the user to be saved is older than the current version."
3930 );
3931 }
3932
3933 $this->mTouched = $newTouched;
3934 $this->saveOptions();
3935
3936 Hooks::run( 'UserSaveSettings', [ $this ] );
3937 $this->clearSharedCache();
3938 $this->getUserPage()->invalidateCache();
3939 }
3940
3941 /**
3942 * If only this user's username is known, and it exists, return the user ID.
3943 *
3944 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3945 * @return int
3946 */
3947 public function idForName( $flags = 0 ) {
3948 $s = trim( $this->getName() );
3949 if ( $s === '' ) {
3950 return 0;
3951 }
3952
3953 $db = ( ( $flags & self::READ_LATEST ) == self::READ_LATEST )
3954 ? wfGetDB( DB_MASTER )
3955 : wfGetDB( DB_REPLICA );
3956
3957 $options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
3958 ? [ 'LOCK IN SHARE MODE' ]
3959 : [];
3960
3961 $id = $db->selectField( 'user',
3962 'user_id', [ 'user_name' => $s ], __METHOD__, $options );
3963
3964 return (int)$id;
3965 }
3966
3967 /**
3968 * Add a user to the database, return the user object
3969 *
3970 * @param string $name Username to add
3971 * @param array $params Array of Strings Non-default parameters to save to
3972 * the database as user_* fields:
3973 * - email: The user's email address.
3974 * - email_authenticated: The email authentication timestamp.
3975 * - real_name: The user's real name.
3976 * - options: An associative array of non-default options.
3977 * - token: Random authentication token. Do not set.
3978 * - registration: Registration timestamp. Do not set.
3979 *
3980 * @return User|null User object, or null if the username already exists.
3981 */
3982 public static function createNew( $name, $params = [] ) {
3983 foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
3984 if ( isset( $params[$field] ) ) {
3985 wfDeprecated( __METHOD__ . " with param '$field'", '1.27' );
3986 unset( $params[$field] );
3987 }
3988 }
3989
3990 $user = new User;
3991 $user->load();
3992 $user->setToken(); // init token
3993 if ( isset( $params['options'] ) ) {
3994 $user->mOptions = $params['options'] + (array)$user->mOptions;
3995 unset( $params['options'] );
3996 }
3997 $dbw = wfGetDB( DB_MASTER );
3998 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3999
4000 $noPass = PasswordFactory::newInvalidPassword()->toString();
4001
4002 $fields = [
4003 'user_id' => $seqVal,
4004 'user_name' => $name,
4005 'user_password' => $noPass,
4006 'user_newpassword' => $noPass,
4007 'user_email' => $user->mEmail,
4008 'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
4009 'user_real_name' => $user->mRealName,
4010 'user_token' => strval( $user->mToken ),
4011 'user_registration' => $dbw->timestamp( $user->mRegistration ),
4012 'user_editcount' => 0,
4013 'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
4014 ];
4015 foreach ( $params as $name => $value ) {
4016 $fields["user_$name"] = $value;
4017 }
4018 $dbw->insert( 'user', $fields, __METHOD__, [ 'IGNORE' ] );
4019 if ( $dbw->affectedRows() ) {
4020 $newUser = User::newFromId( $dbw->insertId() );
4021 } else {
4022 $newUser = null;
4023 }
4024 return $newUser;
4025 }
4026
4027 /**
4028 * Add this existing user object to the database. If the user already
4029 * exists, a fatal status object is returned, and the user object is
4030 * initialised with the data from the database.
4031 *
4032 * Previously, this function generated a DB error due to a key conflict
4033 * if the user already existed. Many extension callers use this function
4034 * in code along the lines of:
4035 *
4036 * $user = User::newFromName( $name );
4037 * if ( !$user->isLoggedIn() ) {
4038 * $user->addToDatabase();
4039 * }
4040 * // do something with $user...
4041 *
4042 * However, this was vulnerable to a race condition (bug 16020). By
4043 * initialising the user object if the user exists, we aim to support this
4044 * calling sequence as far as possible.
4045 *
4046 * Note that if the user exists, this function will acquire a write lock,
4047 * so it is still advisable to make the call conditional on isLoggedIn(),
4048 * and to commit the transaction after calling.
4049 *
4050 * @throws MWException
4051 * @return Status
4052 */
4053 public function addToDatabase() {
4054 $this->load();
4055 if ( !$this->mToken ) {
4056 $this->setToken(); // init token
4057 }
4058
4059 $this->mTouched = $this->newTouchedTimestamp();
4060
4061 $noPass = PasswordFactory::newInvalidPassword()->toString();
4062
4063 $dbw = wfGetDB( DB_MASTER );
4064 $seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
4065 $dbw->insert( 'user',
4066 [
4067 'user_id' => $seqVal,
4068 'user_name' => $this->mName,
4069 'user_password' => $noPass,
4070 'user_newpassword' => $noPass,
4071 'user_email' => $this->mEmail,
4072 'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
4073 'user_real_name' => $this->mRealName,
4074 'user_token' => strval( $this->mToken ),
4075 'user_registration' => $dbw->timestamp( $this->mRegistration ),
4076 'user_editcount' => 0,
4077 'user_touched' => $dbw->timestamp( $this->mTouched ),
4078 ], __METHOD__,
4079 [ 'IGNORE' ]
4080 );
4081 if ( !$dbw->affectedRows() ) {
4082 // Use locking reads to bypass any REPEATABLE-READ snapshot.
4083 $this->mId = $dbw->selectField(
4084 'user',
4085 'user_id',
4086 [ 'user_name' => $this->mName ],
4087 __METHOD__,
4088 [ 'LOCK IN SHARE MODE' ]
4089 );
4090 $loaded = false;
4091 if ( $this->mId ) {
4092 if ( $this->loadFromDatabase( self::READ_LOCKING ) ) {
4093 $loaded = true;
4094 }
4095 }
4096 if ( !$loaded ) {
4097 throw new MWException( __METHOD__ . ": hit a key conflict attempting " .
4098 "to insert user '{$this->mName}' row, but it was not present in select!" );
4099 }
4100 return Status::newFatal( 'userexists' );
4101 }
4102 $this->mId = $dbw->insertId();
4103 self::$idCacheByName[$this->mName] = $this->mId;
4104
4105 // Clear instance cache other than user table data, which is already accurate
4106 $this->clearInstanceCache();
4107
4108 $this->saveOptions();
4109 return Status::newGood();
4110 }
4111
4112 /**
4113 * If this user is logged-in and blocked,
4114 * block any IP address they've successfully logged in from.
4115 * @return bool A block was spread
4116 */
4117 public function spreadAnyEditBlock() {
4118 if ( $this->isLoggedIn() && $this->isBlocked() ) {
4119 return $this->spreadBlock();
4120 }
4121
4122 return false;
4123 }
4124
4125 /**
4126 * If this (non-anonymous) user is blocked,
4127 * block the IP address they've successfully logged in from.
4128 * @return bool A block was spread
4129 */
4130 protected function spreadBlock() {
4131 wfDebug( __METHOD__ . "()\n" );
4132 $this->load();
4133 if ( $this->mId == 0 ) {
4134 return false;
4135 }
4136
4137 $userblock = Block::newFromTarget( $this->getName() );
4138 if ( !$userblock ) {
4139 return false;
4140 }
4141
4142 return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4143 }
4144
4145 /**
4146 * Get whether the user is explicitly blocked from account creation.
4147 * @return bool|Block
4148 */
4149 public function isBlockedFromCreateAccount() {
4150 $this->getBlockedStatus();
4151 if ( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ) {
4152 return $this->mBlock;
4153 }
4154
4155 # bug 13611: if the IP address the user is trying to create an account from is
4156 # blocked with createaccount disabled, prevent new account creation there even
4157 # when the user is logged in
4158 if ( $this->mBlockedFromCreateAccount === false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4159 $this->mBlockedFromCreateAccount = Block::newFromTarget( null, $this->getRequest()->getIP() );
4160 }
4161 return $this->mBlockedFromCreateAccount instanceof Block
4162 && $this->mBlockedFromCreateAccount->prevents( 'createaccount' )
4163 ? $this->mBlockedFromCreateAccount
4164 : false;
4165 }
4166
4167 /**
4168 * Get whether the user is blocked from using Special:Emailuser.
4169 * @return bool
4170 */
4171 public function isBlockedFromEmailuser() {
4172 $this->getBlockedStatus();
4173 return $this->mBlock && $this->mBlock->prevents( 'sendemail' );
4174 }
4175
4176 /**
4177 * Get whether the user is allowed to create an account.
4178 * @return bool
4179 */
4180 public function isAllowedToCreateAccount() {
4181 return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4182 }
4183
4184 /**
4185 * Get this user's personal page title.
4186 *
4187 * @return Title User's personal page title
4188 */
4189 public function getUserPage() {
4190 return Title::makeTitle( NS_USER, $this->getName() );
4191 }
4192
4193 /**
4194 * Get this user's talk page title.
4195 *
4196 * @return Title User's talk page title
4197 */
4198 public function getTalkPage() {
4199 $title = $this->getUserPage();
4200 return $title->getTalkPage();
4201 }
4202
4203 /**
4204 * Determine whether the user is a newbie. Newbies are either
4205 * anonymous IPs, or the most recently created accounts.
4206 * @return bool
4207 */
4208 public function isNewbie() {
4209 return !$this->isAllowed( 'autoconfirmed' );
4210 }
4211
4212 /**
4213 * Check to see if the given clear-text password is one of the accepted passwords
4214 * @deprecated since 1.27, use AuthManager instead
4215 * @param string $password User password
4216 * @return bool True if the given password is correct, otherwise False
4217 */
4218 public function checkPassword( $password ) {
4219 $manager = AuthManager::singleton();
4220 $reqs = AuthenticationRequest::loadRequestsFromSubmission(
4221 $manager->getAuthenticationRequests( AuthManager::ACTION_LOGIN ),
4222 [
4223 'username' => $this->getName(),
4224 'password' => $password,
4225 ]
4226 );
4227 $res = AuthManager::singleton()->beginAuthentication( $reqs, 'null:' );
4228 switch ( $res->status ) {
4229 case AuthenticationResponse::PASS:
4230 return true;
4231 case AuthenticationResponse::FAIL:
4232 // Hope it's not a PreAuthenticationProvider that failed...
4233 \MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
4234 ->info( __METHOD__ . ': Authentication failed: ' . $res->message->plain() );
4235 return false;
4236 default:
4237 throw new BadMethodCallException(
4238 'AuthManager returned a response unsupported by ' . __METHOD__
4239 );
4240 }
4241 }
4242
4243 /**
4244 * Check if the given clear-text password matches the temporary password
4245 * sent by e-mail for password reset operations.
4246 *
4247 * @deprecated since 1.27, use AuthManager instead
4248 * @param string $plaintext
4249 * @return bool True if matches, false otherwise
4250 */
4251 public function checkTemporaryPassword( $plaintext ) {
4252 // Can't check the temporary password individually.
4253 return $this->checkPassword( $plaintext );
4254 }
4255
4256 /**
4257 * Initialize (if necessary) and return a session token value
4258 * which can be used in edit forms to show that the user's
4259 * login credentials aren't being hijacked with a foreign form
4260 * submission.
4261 *
4262 * @since 1.27
4263 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4264 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4265 * @return MediaWiki\Session\Token The new edit token
4266 */
4267 public function getEditTokenObject( $salt = '', $request = null ) {
4268 if ( $this->isAnon() ) {
4269 return new LoggedOutEditToken();
4270 }
4271
4272 if ( !$request ) {
4273 $request = $this->getRequest();
4274 }
4275 return $request->getSession()->getToken( $salt );
4276 }
4277
4278 /**
4279 * Initialize (if necessary) and return a session token value
4280 * which can be used in edit forms to show that the user's
4281 * login credentials aren't being hijacked with a foreign form
4282 * submission.
4283 *
4284 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4285 *
4286 * @since 1.19
4287 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4288 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4289 * @return string The new edit token
4290 */
4291 public function getEditToken( $salt = '', $request = null ) {
4292 return $this->getEditTokenObject( $salt, $request )->toString();
4293 }
4294
4295 /**
4296 * Get the embedded timestamp from a token.
4297 * @deprecated since 1.27, use \MediaWiki\Session\Token::getTimestamp instead.
4298 * @param string $val Input token
4299 * @return int|null
4300 */
4301 public static function getEditTokenTimestamp( $val ) {
4302 wfDeprecated( __METHOD__, '1.27' );
4303 return MediaWiki\Session\Token::getTimestamp( $val );
4304 }
4305
4306 /**
4307 * Check given value against the token value stored in the session.
4308 * A match should confirm that the form was submitted from the
4309 * user's own login session, not a form submission from a third-party
4310 * site.
4311 *
4312 * @param string $val Input value to compare
4313 * @param string $salt Optional function-specific data for hashing
4314 * @param WebRequest|null $request Object to use or null to use $wgRequest
4315 * @param int $maxage Fail tokens older than this, in seconds
4316 * @return bool Whether the token matches
4317 */
4318 public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4319 return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4320 }
4321
4322 /**
4323 * Check given value against the token value stored in the session,
4324 * ignoring the suffix.
4325 *
4326 * @param string $val Input value to compare
4327 * @param string $salt Optional function-specific data for hashing
4328 * @param WebRequest|null $request Object to use or null to use $wgRequest
4329 * @param int $maxage Fail tokens older than this, in seconds
4330 * @return bool Whether the token matches
4331 */
4332 public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4333 $val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token::SUFFIX;
4334 return $this->matchEditToken( $val, $salt, $request, $maxage );
4335 }
4336
4337 /**
4338 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4339 * mail to the user's given address.
4340 *
4341 * @param string $type Message to send, either "created", "changed" or "set"
4342 * @return Status
4343 */
4344 public function sendConfirmationMail( $type = 'created' ) {
4345 global $wgLang;
4346 $expiration = null; // gets passed-by-ref and defined in next line.
4347 $token = $this->confirmationToken( $expiration );
4348 $url = $this->confirmationTokenUrl( $token );
4349 $invalidateURL = $this->invalidationTokenUrl( $token );
4350 $this->saveSettings();
4351
4352 if ( $type == 'created' || $type === false ) {
4353 $message = 'confirmemail_body';
4354 } elseif ( $type === true ) {
4355 $message = 'confirmemail_body_changed';
4356 } else {
4357 // Messages: confirmemail_body_changed, confirmemail_body_set
4358 $message = 'confirmemail_body_' . $type;
4359 }
4360
4361 return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4362 wfMessage( $message,
4363 $this->getRequest()->getIP(),
4364 $this->getName(),
4365 $url,
4366 $wgLang->userTimeAndDate( $expiration, $this ),
4367 $invalidateURL,
4368 $wgLang->userDate( $expiration, $this ),
4369 $wgLang->userTime( $expiration, $this ) )->text() );
4370 }
4371
4372 /**
4373 * Send an e-mail to this user's account. Does not check for
4374 * confirmed status or validity.
4375 *
4376 * @param string $subject Message subject
4377 * @param string $body Message body
4378 * @param User|null $from Optional sending user; if unspecified, default
4379 * $wgPasswordSender will be used.
4380 * @param string $replyto Reply-To address
4381 * @return Status
4382 */
4383 public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4384 global $wgPasswordSender;
4385
4386 if ( $from instanceof User ) {
4387 $sender = MailAddress::newFromUser( $from );
4388 } else {
4389 $sender = new MailAddress( $wgPasswordSender,
4390 wfMessage( 'emailsender' )->inContentLanguage()->text() );
4391 }
4392 $to = MailAddress::newFromUser( $this );
4393
4394 return UserMailer::send( $to, $sender, $subject, $body, [
4395 'replyTo' => $replyto,
4396 ] );
4397 }
4398
4399 /**
4400 * Generate, store, and return a new e-mail confirmation code.
4401 * A hash (unsalted, since it's used as a key) is stored.
4402 *
4403 * @note Call saveSettings() after calling this function to commit
4404 * this change to the database.
4405 *
4406 * @param string &$expiration Accepts the expiration time
4407 * @return string New token
4408 */
4409 protected function confirmationToken( &$expiration ) {
4410 global $wgUserEmailConfirmationTokenExpiry;
4411 $now = time();
4412 $expires = $now + $wgUserEmailConfirmationTokenExpiry;
4413 $expiration = wfTimestamp( TS_MW, $expires );
4414 $this->load();
4415 $token = MWCryptRand::generateHex( 32 );
4416 $hash = md5( $token );
4417 $this->mEmailToken = $hash;
4418 $this->mEmailTokenExpires = $expiration;
4419 return $token;
4420 }
4421
4422 /**
4423 * Return a URL the user can use to confirm their email address.
4424 * @param string $token Accepts the email confirmation token
4425 * @return string New token URL
4426 */
4427 protected function confirmationTokenUrl( $token ) {
4428 return $this->getTokenUrl( 'ConfirmEmail', $token );
4429 }
4430
4431 /**
4432 * Return a URL the user can use to invalidate their email address.
4433 * @param string $token Accepts the email confirmation token
4434 * @return string New token URL
4435 */
4436 protected function invalidationTokenUrl( $token ) {
4437 return $this->getTokenUrl( 'InvalidateEmail', $token );
4438 }
4439
4440 /**
4441 * Internal function to format the e-mail validation/invalidation URLs.
4442 * This uses a quickie hack to use the
4443 * hardcoded English names of the Special: pages, for ASCII safety.
4444 *
4445 * @note Since these URLs get dropped directly into emails, using the
4446 * short English names avoids insanely long URL-encoded links, which
4447 * also sometimes can get corrupted in some browsers/mailers
4448 * (bug 6957 with Gmail and Internet Explorer).
4449 *
4450 * @param string $page Special page
4451 * @param string $token Token
4452 * @return string Formatted URL
4453 */
4454 protected function getTokenUrl( $page, $token ) {
4455 // Hack to bypass localization of 'Special:'
4456 $title = Title::makeTitle( NS_MAIN, "Special:$page/$token" );
4457 return $title->getCanonicalURL();
4458 }
4459
4460 /**
4461 * Mark the e-mail address confirmed.
4462 *
4463 * @note Call saveSettings() after calling this function to commit the change.
4464 *
4465 * @return bool
4466 */
4467 public function confirmEmail() {
4468 // Check if it's already confirmed, so we don't touch the database
4469 // and fire the ConfirmEmailComplete hook on redundant confirmations.
4470 if ( !$this->isEmailConfirmed() ) {
4471 $this->setEmailAuthenticationTimestamp( wfTimestampNow() );
4472 Hooks::run( 'ConfirmEmailComplete', [ $this ] );
4473 }
4474 return true;
4475 }
4476
4477 /**
4478 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4479 * address if it was already confirmed.
4480 *
4481 * @note Call saveSettings() after calling this function to commit the change.
4482 * @return bool Returns true
4483 */
4484 public function invalidateEmail() {
4485 $this->load();
4486 $this->mEmailToken = null;
4487 $this->mEmailTokenExpires = null;
4488 $this->setEmailAuthenticationTimestamp( null );
4489 $this->mEmail = '';
4490 Hooks::run( 'InvalidateEmailComplete', [ $this ] );
4491 return true;
4492 }
4493
4494 /**
4495 * Set the e-mail authentication timestamp.
4496 * @param string $timestamp TS_MW timestamp
4497 */
4498 public function setEmailAuthenticationTimestamp( $timestamp ) {
4499 $this->load();
4500 $this->mEmailAuthenticated = $timestamp;
4501 Hooks::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
4502 }
4503
4504 /**
4505 * Is this user allowed to send e-mails within limits of current
4506 * site configuration?
4507 * @return bool
4508 */
4509 public function canSendEmail() {
4510 global $wgEnableEmail, $wgEnableUserEmail;
4511 if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
4512 return false;
4513 }
4514 $canSend = $this->isEmailConfirmed();
4515 Hooks::run( 'UserCanSendEmail', [ &$this, &$canSend ] );
4516 return $canSend;
4517 }
4518
4519 /**
4520 * Is this user allowed to receive e-mails within limits of current
4521 * site configuration?
4522 * @return bool
4523 */
4524 public function canReceiveEmail() {
4525 return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4526 }
4527
4528 /**
4529 * Is this user's e-mail address valid-looking and confirmed within
4530 * limits of the current site configuration?
4531 *
4532 * @note If $wgEmailAuthentication is on, this may require the user to have
4533 * confirmed their address by returning a code or using a password
4534 * sent to the address from the wiki.
4535 *
4536 * @return bool
4537 */
4538 public function isEmailConfirmed() {
4539 global $wgEmailAuthentication;
4540 $this->load();
4541 $confirmed = true;
4542 if ( Hooks::run( 'EmailConfirmed', [ &$this, &$confirmed ] ) ) {
4543 if ( $this->isAnon() ) {
4544 return false;
4545 }
4546 if ( !Sanitizer::validateEmail( $this->mEmail ) ) {
4547 return false;
4548 }
4549 if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4550 return false;
4551 }
4552 return true;
4553 } else {
4554 return $confirmed;
4555 }
4556 }
4557
4558 /**
4559 * Check whether there is an outstanding request for e-mail confirmation.
4560 * @return bool
4561 */
4562 public function isEmailConfirmationPending() {
4563 global $wgEmailAuthentication;
4564 return $wgEmailAuthentication &&
4565 !$this->isEmailConfirmed() &&
4566 $this->mEmailToken &&
4567 $this->mEmailTokenExpires > wfTimestamp();
4568 }
4569
4570 /**
4571 * Get the timestamp of account creation.
4572 *
4573 * @return string|bool|null Timestamp of account creation, false for
4574 * non-existent/anonymous user accounts, or null if existing account
4575 * but information is not in database.
4576 */
4577 public function getRegistration() {
4578 if ( $this->isAnon() ) {
4579 return false;
4580 }
4581 $this->load();
4582 return $this->mRegistration;
4583 }
4584
4585 /**
4586 * Get the timestamp of the first edit
4587 *
4588 * @return string|bool Timestamp of first edit, or false for
4589 * non-existent/anonymous user accounts.
4590 */
4591 public function getFirstEditTimestamp() {
4592 if ( $this->getId() == 0 ) {
4593 return false; // anons
4594 }
4595 $dbr = wfGetDB( DB_REPLICA );
4596 $time = $dbr->selectField( 'revision', 'rev_timestamp',
4597 [ 'rev_user' => $this->getId() ],
4598 __METHOD__,
4599 [ 'ORDER BY' => 'rev_timestamp ASC' ]
4600 );
4601 if ( !$time ) {
4602 return false; // no edits
4603 }
4604 return wfTimestamp( TS_MW, $time );
4605 }
4606
4607 /**
4608 * Get the permissions associated with a given list of groups
4609 *
4610 * @param array $groups Array of Strings List of internal group names
4611 * @return array Array of Strings List of permission key names for given groups combined
4612 */
4613 public static function getGroupPermissions( $groups ) {
4614 global $wgGroupPermissions, $wgRevokePermissions;
4615 $rights = [];
4616 // grant every granted permission first
4617 foreach ( $groups as $group ) {
4618 if ( isset( $wgGroupPermissions[$group] ) ) {
4619 $rights = array_merge( $rights,
4620 // array_filter removes empty items
4621 array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4622 }
4623 }
4624 // now revoke the revoked permissions
4625 foreach ( $groups as $group ) {
4626 if ( isset( $wgRevokePermissions[$group] ) ) {
4627 $rights = array_diff( $rights,
4628 array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4629 }
4630 }
4631 return array_unique( $rights );
4632 }
4633
4634 /**
4635 * Get all the groups who have a given permission
4636 *
4637 * @param string $role Role to check
4638 * @return array Array of Strings List of internal group names with the given permission
4639 */
4640 public static function getGroupsWithPermission( $role ) {
4641 global $wgGroupPermissions;
4642 $allowedGroups = [];
4643 foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4644 if ( self::groupHasPermission( $group, $role ) ) {
4645 $allowedGroups[] = $group;
4646 }
4647 }
4648 return $allowedGroups;
4649 }
4650
4651 /**
4652 * Check, if the given group has the given permission
4653 *
4654 * If you're wanting to check whether all users have a permission, use
4655 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4656 * from anyone.
4657 *
4658 * @since 1.21
4659 * @param string $group Group to check
4660 * @param string $role Role to check
4661 * @return bool
4662 */
4663 public static function groupHasPermission( $group, $role ) {
4664 global $wgGroupPermissions, $wgRevokePermissions;
4665 return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4666 && !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4667 }
4668
4669 /**
4670 * Check if all users may be assumed to have the given permission
4671 *
4672 * We generally assume so if the right is granted to '*' and isn't revoked
4673 * on any group. It doesn't attempt to take grants or other extension
4674 * limitations on rights into account in the general case, though, as that
4675 * would require it to always return false and defeat the purpose.
4676 * Specifically, session-based rights restrictions (such as OAuth or bot
4677 * passwords) are applied based on the current session.
4678 *
4679 * @since 1.22
4680 * @param string $right Right to check
4681 * @return bool
4682 */
4683 public static function isEveryoneAllowed( $right ) {
4684 global $wgGroupPermissions, $wgRevokePermissions;
4685 static $cache = [];
4686
4687 // Use the cached results, except in unit tests which rely on
4688 // being able change the permission mid-request
4689 if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4690 return $cache[$right];
4691 }
4692
4693 if ( !isset( $wgGroupPermissions['*'][$right] ) || !$wgGroupPermissions['*'][$right] ) {
4694 $cache[$right] = false;
4695 return false;
4696 }
4697
4698 // If it's revoked anywhere, then everyone doesn't have it
4699 foreach ( $wgRevokePermissions as $rights ) {
4700 if ( isset( $rights[$right] ) && $rights[$right] ) {
4701 $cache[$right] = false;
4702 return false;
4703 }
4704 }
4705
4706 // Remove any rights that aren't allowed to the global-session user,
4707 // unless there are no sessions for this endpoint.
4708 if ( !defined( 'MW_NO_SESSION' ) ) {
4709 $allowedRights = SessionManager::getGlobalSession()->getAllowedUserRights();
4710 if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4711 $cache[$right] = false;
4712 return false;
4713 }
4714 }
4715
4716 // Allow extensions to say false
4717 if ( !Hooks::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4718 $cache[$right] = false;
4719 return false;
4720 }
4721
4722 $cache[$right] = true;
4723 return true;
4724 }
4725
4726 /**
4727 * Get the localized descriptive name for a group, if it exists
4728 *
4729 * @param string $group Internal group name
4730 * @return string Localized descriptive group name
4731 */
4732 public static function getGroupName( $group ) {
4733 $msg = wfMessage( "group-$group" );
4734 return $msg->isBlank() ? $group : $msg->text();
4735 }
4736
4737 /**
4738 * Get the localized descriptive name for a member of a group, if it exists
4739 *
4740 * @param string $group Internal group name
4741 * @param string $username Username for gender (since 1.19)
4742 * @return string Localized name for group member
4743 */
4744 public static function getGroupMember( $group, $username = '#' ) {
4745 $msg = wfMessage( "group-$group-member", $username );
4746 return $msg->isBlank() ? $group : $msg->text();
4747 }
4748
4749 /**
4750 * Return the set of defined explicit groups.
4751 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4752 * are not included, as they are defined automatically, not in the database.
4753 * @return array Array of internal group names
4754 */
4755 public static function getAllGroups() {
4756 global $wgGroupPermissions, $wgRevokePermissions;
4757 return array_diff(
4758 array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4759 self::getImplicitGroups()
4760 );
4761 }
4762
4763 /**
4764 * Get a list of all available permissions.
4765 * @return string[] Array of permission names
4766 */
4767 public static function getAllRights() {
4768 if ( self::$mAllRights === false ) {
4769 global $wgAvailableRights;
4770 if ( count( $wgAvailableRights ) ) {
4771 self::$mAllRights = array_unique( array_merge( self::$mCoreRights, $wgAvailableRights ) );
4772 } else {
4773 self::$mAllRights = self::$mCoreRights;
4774 }
4775 Hooks::run( 'UserGetAllRights', [ &self::$mAllRights ] );
4776 }
4777 return self::$mAllRights;
4778 }
4779
4780 /**
4781 * Get a list of implicit groups
4782 * @return array Array of Strings Array of internal group names
4783 */
4784 public static function getImplicitGroups() {
4785 global $wgImplicitGroups;
4786
4787 $groups = $wgImplicitGroups;
4788 # Deprecated, use $wgImplicitGroups instead
4789 Hooks::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
4790
4791 return $groups;
4792 }
4793
4794 /**
4795 * Get the title of a page describing a particular group
4796 *
4797 * @param string $group Internal group name
4798 * @return Title|bool Title of the page if it exists, false otherwise
4799 */
4800 public static function getGroupPage( $group ) {
4801 $msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4802 if ( $msg->exists() ) {
4803 $title = Title::newFromText( $msg->text() );
4804 if ( is_object( $title ) ) {
4805 return $title;
4806 }
4807 }
4808 return false;
4809 }
4810
4811 /**
4812 * Create a link to the group in HTML, if available;
4813 * else return the group name.
4814 *
4815 * @param string $group Internal name of the group
4816 * @param string $text The text of the link
4817 * @return string HTML link to the group
4818 */
4819 public static function makeGroupLinkHTML( $group, $text = '' ) {
4820 if ( $text == '' ) {
4821 $text = self::getGroupName( $group );
4822 }
4823 $title = self::getGroupPage( $group );
4824 if ( $title ) {
4825 return Linker::link( $title, htmlspecialchars( $text ) );
4826 } else {
4827 return htmlspecialchars( $text );
4828 }
4829 }
4830
4831 /**
4832 * Create a link to the group in Wikitext, if available;
4833 * else return the group name.
4834 *
4835 * @param string $group Internal name of the group
4836 * @param string $text The text of the link
4837 * @return string Wikilink to the group
4838 */
4839 public static function makeGroupLinkWiki( $group, $text = '' ) {
4840 if ( $text == '' ) {
4841 $text = self::getGroupName( $group );
4842 }
4843 $title = self::getGroupPage( $group );
4844 if ( $title ) {
4845 $page = $title->getFullText();
4846 return "[[$page|$text]]";
4847 } else {
4848 return $text;
4849 }
4850 }
4851
4852 /**
4853 * Returns an array of the groups that a particular group can add/remove.
4854 *
4855 * @param string $group The group to check for whether it can add/remove
4856 * @return array Array( 'add' => array( addablegroups ),
4857 * 'remove' => array( removablegroups ),
4858 * 'add-self' => array( addablegroups to self),
4859 * 'remove-self' => array( removable groups from self) )
4860 */
4861 public static function changeableByGroup( $group ) {
4862 global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4863
4864 $groups = [
4865 'add' => [],
4866 'remove' => [],
4867 'add-self' => [],
4868 'remove-self' => []
4869 ];
4870
4871 if ( empty( $wgAddGroups[$group] ) ) {
4872 // Don't add anything to $groups
4873 } elseif ( $wgAddGroups[$group] === true ) {
4874 // You get everything
4875 $groups['add'] = self::getAllGroups();
4876 } elseif ( is_array( $wgAddGroups[$group] ) ) {
4877 $groups['add'] = $wgAddGroups[$group];
4878 }
4879
4880 // Same thing for remove
4881 if ( empty( $wgRemoveGroups[$group] ) ) {
4882 // Do nothing
4883 } elseif ( $wgRemoveGroups[$group] === true ) {
4884 $groups['remove'] = self::getAllGroups();
4885 } elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4886 $groups['remove'] = $wgRemoveGroups[$group];
4887 }
4888
4889 // Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4890 if ( empty( $wgGroupsAddToSelf['user'] ) || $wgGroupsAddToSelf['user'] !== true ) {
4891 foreach ( $wgGroupsAddToSelf as $key => $value ) {
4892 if ( is_int( $key ) ) {
4893 $wgGroupsAddToSelf['user'][] = $value;
4894 }
4895 }
4896 }
4897
4898 if ( empty( $wgGroupsRemoveFromSelf['user'] ) || $wgGroupsRemoveFromSelf['user'] !== true ) {
4899 foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4900 if ( is_int( $key ) ) {
4901 $wgGroupsRemoveFromSelf['user'][] = $value;
4902 }
4903 }
4904 }
4905
4906 // Now figure out what groups the user can add to him/herself
4907 if ( empty( $wgGroupsAddToSelf[$group] ) ) {
4908 // Do nothing
4909 } elseif ( $wgGroupsAddToSelf[$group] === true ) {
4910 // No idea WHY this would be used, but it's there
4911 $groups['add-self'] = User::getAllGroups();
4912 } elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4913 $groups['add-self'] = $wgGroupsAddToSelf[$group];
4914 }
4915
4916 if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
4917 // Do nothing
4918 } elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4919 $groups['remove-self'] = User::getAllGroups();
4920 } elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4921 $groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4922 }
4923
4924 return $groups;
4925 }
4926
4927 /**
4928 * Returns an array of groups that this user can add and remove
4929 * @return array Array( 'add' => array( addablegroups ),
4930 * 'remove' => array( removablegroups ),
4931 * 'add-self' => array( addablegroups to self),
4932 * 'remove-self' => array( removable groups from self) )
4933 */
4934 public function changeableGroups() {
4935 if ( $this->isAllowed( 'userrights' ) ) {
4936 // This group gives the right to modify everything (reverse-
4937 // compatibility with old "userrights lets you change
4938 // everything")
4939 // Using array_merge to make the groups reindexed
4940 $all = array_merge( User::getAllGroups() );
4941 return [
4942 'add' => $all,
4943 'remove' => $all,
4944 'add-self' => [],
4945 'remove-self' => []
4946 ];
4947 }
4948
4949 // Okay, it's not so simple, we will have to go through the arrays
4950 $groups = [
4951 'add' => [],
4952 'remove' => [],
4953 'add-self' => [],
4954 'remove-self' => []
4955 ];
4956 $addergroups = $this->getEffectiveGroups();
4957
4958 foreach ( $addergroups as $addergroup ) {
4959 $groups = array_merge_recursive(
4960 $groups, $this->changeableByGroup( $addergroup )
4961 );
4962 $groups['add'] = array_unique( $groups['add'] );
4963 $groups['remove'] = array_unique( $groups['remove'] );
4964 $groups['add-self'] = array_unique( $groups['add-self'] );
4965 $groups['remove-self'] = array_unique( $groups['remove-self'] );
4966 }
4967 return $groups;
4968 }
4969
4970 /**
4971 * Deferred version of incEditCountImmediate()
4972 */
4973 public function incEditCount() {
4974 wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle(
4975 function () {
4976 $this->incEditCountImmediate();
4977 },
4978 __METHOD__
4979 );
4980 }
4981
4982 /**
4983 * Increment the user's edit-count field.
4984 * Will have no effect for anonymous users.
4985 * @since 1.26
4986 */
4987 public function incEditCountImmediate() {
4988 if ( $this->isAnon() ) {
4989 return;
4990 }
4991
4992 $dbw = wfGetDB( DB_MASTER );
4993 // No rows will be "affected" if user_editcount is NULL
4994 $dbw->update(
4995 'user',
4996 [ 'user_editcount=user_editcount+1' ],
4997 [ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
4998 __METHOD__
4999 );
5000 // Lazy initialization check...
5001 if ( $dbw->affectedRows() == 0 ) {
5002 // Now here's a goddamn hack...
5003 $dbr = wfGetDB( DB_REPLICA );
5004 if ( $dbr !== $dbw ) {
5005 // If we actually have a replica DB server, the count is
5006 // at least one behind because the current transaction
5007 // has not been committed and replicated.
5008 $this->mEditCount = $this->initEditCount( 1 );
5009 } else {
5010 // But if DB_REPLICA is selecting the master, then the
5011 // count we just read includes the revision that was
5012 // just added in the working transaction.
5013 $this->mEditCount = $this->initEditCount();
5014 }
5015 } else {
5016 if ( $this->mEditCount === null ) {
5017 $this->getEditCount();
5018 $dbr = wfGetDB( DB_REPLICA );
5019 $this->mEditCount += ( $dbr !== $dbw ) ? 1 : 0;
5020 } else {
5021 $this->mEditCount++;
5022 }
5023 }
5024 // Edit count in user cache too
5025 $this->invalidateCache();
5026 }
5027
5028 /**
5029 * Initialize user_editcount from data out of the revision table
5030 *
5031 * @param int $add Edits to add to the count from the revision table
5032 * @return int Number of edits
5033 */
5034 protected function initEditCount( $add = 0 ) {
5035 // Pull from a replica DB to be less cruel to servers
5036 // Accuracy isn't the point anyway here
5037 $dbr = wfGetDB( DB_REPLICA );
5038 $count = (int)$dbr->selectField(
5039 'revision',
5040 'COUNT(rev_user)',
5041 [ 'rev_user' => $this->getId() ],
5042 __METHOD__
5043 );
5044 $count = $count + $add;
5045
5046 $dbw = wfGetDB( DB_MASTER );
5047 $dbw->update(
5048 'user',
5049 [ 'user_editcount' => $count ],
5050 [ 'user_id' => $this->getId() ],
5051 __METHOD__
5052 );
5053
5054 return $count;
5055 }
5056
5057 /**
5058 * Get the description of a given right
5059 *
5060 * @since 1.29
5061 * @param string $right Right to query
5062 * @return string Localized description of the right
5063 */
5064 public static function getRightDescription( $right ) {
5065 $key = "right-$right";
5066 $msg = wfMessage( $key );
5067 return $msg->isDisabled() ? $right : $msg->text();
5068 }
5069
5070 /**
5071 * Get the name of a given grant
5072 *
5073 * @since 1.29
5074 * @param string $grant Grant to query
5075 * @return string Localized name of the grant
5076 */
5077 public static function getGrantName( $grant ) {
5078 $key = "grant-$grant";
5079 $msg = wfMessage( $key );
5080 return $msg->isDisabled() ? $grant : $msg->text();
5081 }
5082
5083 /**
5084 * Make a new-style password hash
5085 *
5086 * @param string $password Plain-text password
5087 * @param bool|string $salt Optional salt, may be random or the user ID.
5088 * If unspecified or false, will generate one automatically
5089 * @return string Password hash
5090 * @deprecated since 1.24, use Password class
5091 */
5092 public static function crypt( $password, $salt = false ) {
5093 wfDeprecated( __METHOD__, '1.24' );
5094 $passwordFactory = new PasswordFactory();
5095 $passwordFactory->init( RequestContext::getMain()->getConfig() );
5096 $hash = $passwordFactory->newFromPlaintext( $password );
5097 return $hash->toString();
5098 }
5099
5100 /**
5101 * Compare a password hash with a plain-text password. Requires the user
5102 * ID if there's a chance that the hash is an old-style hash.
5103 *
5104 * @param string $hash Password hash
5105 * @param string $password Plain-text password to compare
5106 * @param string|bool $userId User ID for old-style password salt
5107 *
5108 * @return bool
5109 * @deprecated since 1.24, use Password class
5110 */
5111 public static function comparePasswords( $hash, $password, $userId = false ) {
5112 wfDeprecated( __METHOD__, '1.24' );
5113
5114 // Check for *really* old password hashes that don't even have a type
5115 // The old hash format was just an md5 hex hash, with no type information
5116 if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
5117 global $wgPasswordSalt;
5118 if ( $wgPasswordSalt ) {
5119 $password = ":B:{$userId}:{$hash}";
5120 } else {
5121 $password = ":A:{$hash}";
5122 }
5123 }
5124
5125 $passwordFactory = new PasswordFactory();
5126 $passwordFactory->init( RequestContext::getMain()->getConfig() );
5127 $hash = $passwordFactory->newFromCiphertext( $hash );
5128 return $hash->equals( $password );
5129 }
5130
5131 /**
5132 * Add a newuser log entry for this user.
5133 * Before 1.19 the return value was always true.
5134 *
5135 * @deprecated since 1.27, AuthManager handles logging
5136 * @param string|bool $action Account creation type.
5137 * - String, one of the following values:
5138 * - 'create' for an anonymous user creating an account for himself.
5139 * This will force the action's performer to be the created user itself,
5140 * no matter the value of $wgUser
5141 * - 'create2' for a logged in user creating an account for someone else
5142 * - 'byemail' when the created user will receive its password by e-mail
5143 * - 'autocreate' when the user is automatically created (such as by CentralAuth).
5144 * - Boolean means whether the account was created by e-mail (deprecated):
5145 * - true will be converted to 'byemail'
5146 * - false will be converted to 'create' if this object is the same as
5147 * $wgUser and to 'create2' otherwise
5148 * @param string $reason User supplied reason
5149 * @return bool true
5150 */
5151 public function addNewUserLogEntry( $action = false, $reason = '' ) {
5152 return true; // disabled
5153 }
5154
5155 /**
5156 * Add an autocreate newuser log entry for this user
5157 * Used by things like CentralAuth and perhaps other authplugins.
5158 * Consider calling addNewUserLogEntry() directly instead.
5159 *
5160 * @deprecated since 1.27, AuthManager handles logging
5161 * @return bool
5162 */
5163 public function addNewUserLogEntryAutoCreate() {
5164 $this->addNewUserLogEntry( 'autocreate' );
5165
5166 return true;
5167 }
5168
5169 /**
5170 * Load the user options either from cache, the database or an array
5171 *
5172 * @param array $data Rows for the current user out of the user_properties table
5173 */
5174 protected function loadOptions( $data = null ) {
5175 global $wgContLang;
5176
5177 $this->load();
5178
5179 if ( $this->mOptionsLoaded ) {
5180 return;
5181 }
5182
5183 $this->mOptions = self::getDefaultOptions();
5184
5185 if ( !$this->getId() ) {
5186 // For unlogged-in users, load language/variant options from request.
5187 // There's no need to do it for logged-in users: they can set preferences,
5188 // and handling of page content is done by $pageLang->getPreferredVariant() and such,
5189 // so don't override user's choice (especially when the user chooses site default).
5190 $variant = $wgContLang->getDefaultVariant();
5191 $this->mOptions['variant'] = $variant;
5192 $this->mOptions['language'] = $variant;
5193 $this->mOptionsLoaded = true;
5194 return;
5195 }
5196
5197 // Maybe load from the object
5198 if ( !is_null( $this->mOptionOverrides ) ) {
5199 wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5200 foreach ( $this->mOptionOverrides as $key => $value ) {
5201 $this->mOptions[$key] = $value;
5202 }
5203 } else {
5204 if ( !is_array( $data ) ) {
5205 wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5206 // Load from database
5207 $dbr = ( $this->queryFlagsUsed & self::READ_LATEST )
5208 ? wfGetDB( DB_MASTER )
5209 : wfGetDB( DB_REPLICA );
5210
5211 $res = $dbr->select(
5212 'user_properties',
5213 [ 'up_property', 'up_value' ],
5214 [ 'up_user' => $this->getId() ],
5215 __METHOD__
5216 );
5217
5218 $this->mOptionOverrides = [];
5219 $data = [];
5220 foreach ( $res as $row ) {
5221 $data[$row->up_property] = $row->up_value;
5222 }
5223 }
5224 foreach ( $data as $property => $value ) {
5225 $this->mOptionOverrides[$property] = $value;
5226 $this->mOptions[$property] = $value;
5227 }
5228 }
5229
5230 $this->mOptionsLoaded = true;
5231
5232 Hooks::run( 'UserLoadOptions', [ $this, &$this->mOptions ] );
5233 }
5234
5235 /**
5236 * Saves the non-default options for this user, as previously set e.g. via
5237 * setOption(), in the database's "user_properties" (preferences) table.
5238 * Usually used via saveSettings().
5239 */
5240 protected function saveOptions() {
5241 $this->loadOptions();
5242
5243 // Not using getOptions(), to keep hidden preferences in database
5244 $saveOptions = $this->mOptions;
5245
5246 // Allow hooks to abort, for instance to save to a global profile.
5247 // Reset options to default state before saving.
5248 if ( !Hooks::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5249 return;
5250 }
5251
5252 $userId = $this->getId();
5253
5254 $insert_rows = []; // all the new preference rows
5255 foreach ( $saveOptions as $key => $value ) {
5256 // Don't bother storing default values
5257 $defaultOption = self::getDefaultOption( $key );
5258 if ( ( $defaultOption === null && $value !== false && $value !== null )
5259 || $value != $defaultOption
5260 ) {
5261 $insert_rows[] = [
5262 'up_user' => $userId,
5263 'up_property' => $key,
5264 'up_value' => $value,
5265 ];
5266 }
5267 }
5268
5269 $dbw = wfGetDB( DB_MASTER );
5270
5271 $res = $dbw->select( 'user_properties',
5272 [ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__ );
5273
5274 // Find prior rows that need to be removed or updated. These rows will
5275 // all be deleted (the latter so that INSERT IGNORE applies the new values).
5276 $keysDelete = [];
5277 foreach ( $res as $row ) {
5278 if ( !isset( $saveOptions[$row->up_property] )
5279 || strcmp( $saveOptions[$row->up_property], $row->up_value ) != 0
5280 ) {
5281 $keysDelete[] = $row->up_property;
5282 }
5283 }
5284
5285 if ( count( $keysDelete ) ) {
5286 // Do the DELETE by PRIMARY KEY for prior rows.
5287 // In the past a very large portion of calls to this function are for setting
5288 // 'rememberpassword' for new accounts (a preference that has since been removed).
5289 // Doing a blanket per-user DELETE for new accounts with no rows in the table
5290 // caused gap locks on [max user ID,+infinity) which caused high contention since
5291 // updates would pile up on each other as they are for higher (newer) user IDs.
5292 // It might not be necessary these days, but it shouldn't hurt either.
5293 $dbw->delete( 'user_properties',
5294 [ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__ );
5295 }
5296 // Insert the new preference rows
5297 $dbw->insert( 'user_properties', $insert_rows, __METHOD__, [ 'IGNORE' ] );
5298 }
5299
5300 /**
5301 * Lazily instantiate and return a factory object for making passwords
5302 *
5303 * @deprecated since 1.27, create a PasswordFactory directly instead
5304 * @return PasswordFactory
5305 */
5306 public static function getPasswordFactory() {
5307 wfDeprecated( __METHOD__, '1.27' );
5308 $ret = new PasswordFactory();
5309 $ret->init( RequestContext::getMain()->getConfig() );
5310 return $ret;
5311 }
5312
5313 /**
5314 * Provide an array of HTML5 attributes to put on an input element
5315 * intended for the user to enter a new password. This may include
5316 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5317 *
5318 * Do *not* use this when asking the user to enter his current password!
5319 * Regardless of configuration, users may have invalid passwords for whatever
5320 * reason (e.g., they were set before requirements were tightened up).
5321 * Only use it when asking for a new password, like on account creation or
5322 * ResetPass.
5323 *
5324 * Obviously, you still need to do server-side checking.
5325 *
5326 * NOTE: A combination of bugs in various browsers means that this function
5327 * actually just returns array() unconditionally at the moment. May as
5328 * well keep it around for when the browser bugs get fixed, though.
5329 *
5330 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5331 *
5332 * @deprecated since 1.27
5333 * @return array Array of HTML attributes suitable for feeding to
5334 * Html::element(), directly or indirectly. (Don't feed to Xml::*()!
5335 * That will get confused by the boolean attribute syntax used.)
5336 */
5337 public static function passwordChangeInputAttribs() {
5338 global $wgMinimalPasswordLength;
5339
5340 if ( $wgMinimalPasswordLength == 0 ) {
5341 return [];
5342 }
5343
5344 # Note that the pattern requirement will always be satisfied if the
5345 # input is empty, so we need required in all cases.
5346
5347 # @todo FIXME: Bug 23769: This needs to not claim the password is required
5348 # if e-mail confirmation is being used. Since HTML5 input validation
5349 # is b0rked anyway in some browsers, just return nothing. When it's
5350 # re-enabled, fix this code to not output required for e-mail
5351 # registration.
5352 # $ret = array( 'required' );
5353 $ret = [];
5354
5355 # We can't actually do this right now, because Opera 9.6 will print out
5356 # the entered password visibly in its error message! When other
5357 # browsers add support for this attribute, or Opera fixes its support,
5358 # we can add support with a version check to avoid doing this on Opera
5359 # versions where it will be a problem. Reported to Opera as
5360 # DSK-262266, but they don't have a public bug tracker for us to follow.
5361 /*
5362 if ( $wgMinimalPasswordLength > 1 ) {
5363 $ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5364 $ret['title'] = wfMessage( 'passwordtooshort' )
5365 ->numParams( $wgMinimalPasswordLength )->text();
5366 }
5367 */
5368
5369 return $ret;
5370 }
5371
5372 /**
5373 * Return the list of user fields that should be selected to create
5374 * a new user object.
5375 * @return array
5376 */
5377 public static function selectFields() {
5378 return [
5379 'user_id',
5380 'user_name',
5381 'user_real_name',
5382 'user_email',
5383 'user_touched',
5384 'user_token',
5385 'user_email_authenticated',
5386 'user_email_token',
5387 'user_email_token_expires',
5388 'user_registration',
5389 'user_editcount',
5390 ];
5391 }
5392
5393 /**
5394 * Factory function for fatal permission-denied errors
5395 *
5396 * @since 1.22
5397 * @param string $permission User right required
5398 * @return Status
5399 */
5400 static function newFatalPermissionDeniedStatus( $permission ) {
5401 global $wgLang;
5402
5403 $groups = array_map(
5404 [ 'User', 'makeGroupLinkWiki' ],
5405 User::getGroupsWithPermission( $permission )
5406 );
5407
5408 if ( $groups ) {
5409 return Status::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5410 } else {
5411 return Status::newFatal( 'badaccess-group0' );
5412 }
5413 }
5414
5415 /**
5416 * Get a new instance of this user that was loaded from the master via a locking read
5417 *
5418 * Use this instead of the main context User when updating that user. This avoids races
5419 * where that user was loaded from a replica DB or even the master but without proper locks.
5420 *
5421 * @return User|null Returns null if the user was not found in the DB
5422 * @since 1.27
5423 */
5424 public function getInstanceForUpdate() {
5425 if ( !$this->getId() ) {
5426 return null; // anon
5427 }
5428
5429 $user = self::newFromId( $this->getId() );
5430 if ( !$user->loadFromId( self::READ_EXCLUSIVE ) ) {
5431 return null;
5432 }
5433
5434 return $user;
5435 }
5436
5437 /**
5438 * Checks if two user objects point to the same user.
5439 *
5440 * @since 1.25
5441 * @param User $user
5442 * @return bool
5443 */
5444 public function equals( User $user ) {
5445 return $this->getName() === $user->getName();
5446 }
5447 }