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