Completed
Branch master (8d5465)
by
unknown
31:25
created

User::clearAllNotifications()   C

Complexity

Conditions 8
Paths 5

Size

Total Lines 65
Code Lines 43

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 8
eloc 43
nc 5
nop 0
dl 0
loc 65
rs 6.7651
c 0
b 0
f 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
/**
3
 * Implements the User class for the %MediaWiki software.
4
 *
5
 * This program is free software; you can redistribute it and/or modify
6
 * it under the terms of the GNU General Public License as published by
7
 * the Free Software Foundation; either version 2 of the License, or
8
 * (at your option) any later version.
9
 *
10
 * This program is distributed in the hope that it will be useful,
11
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
 * GNU General Public License for more details.
14
 *
15
 * You should have received a copy of the GNU General Public License along
16
 * with this program; if not, write to the Free Software Foundation, Inc.,
17
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18
 * http://www.gnu.org/copyleft/gpl.html
19
 *
20
 * @file
21
 */
22
23
use MediaWiki\MediaWikiServices;
24
use MediaWiki\Session\SessionManager;
25
use MediaWiki\Session\Token;
26
use MediaWiki\Auth\AuthManager;
27
use MediaWiki\Auth\AuthenticationResponse;
28
use MediaWiki\Auth\AuthenticationRequest;
29
30
/**
31
 * String Some punctuation to prevent editing from broken text-mangling proxies.
32
 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
33
 * @ingroup Constants
34
 */
35
define( 'EDIT_TOKEN_SUFFIX', Token::SUFFIX );
36
37
/**
38
 * The User object encapsulates all of the user-specific settings (user_id,
39
 * name, rights, email address, options, last login time). Client
40
 * classes use the getXXX() functions to access these fields. These functions
41
 * do all the work of determining whether the user is logged in,
42
 * whether the requested option can be satisfied from cookies or
43
 * whether a database query is needed. Most of the settings needed
44
 * for rendering normal pages are set in the cookie to minimize use
45
 * of the database.
46
 */
47
class User implements IDBAccessObject {
48
	/**
49
	 * @const int Number of characters in user_token field.
50
	 */
51
	const TOKEN_LENGTH = 32;
52
53
	/**
54
	 * @const string An invalid value for user_token
55
	 */
56
	const INVALID_TOKEN = '*** INVALID ***';
57
58
	/**
59
	 * Global constant made accessible as class constants so that autoloader
60
	 * magic can be used.
61
	 * @deprecated since 1.27, use \MediaWiki\Session\Token::SUFFIX
62
	 */
63
	const EDIT_TOKEN_SUFFIX = EDIT_TOKEN_SUFFIX;
0 ignored issues
show
Deprecated Code introduced by
The constant EDIT_TOKEN_SUFFIX has been deprecated with message: since 1.27, use \MediaWiki\Session\Token::SUFFIX

This class constant has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the constant will be removed from the class and what other constant to use instead.

Loading history...
64
65
	/**
66
	 * @const int Serialized record version.
67
	 */
68
	const VERSION = 10;
69
70
	/**
71
	 * Exclude user options that are set to their default value.
72
	 * @since 1.25
73
	 */
74
	const GETOPTIONS_EXCLUDE_DEFAULTS = 1;
75
76
	/**
77
	 * @since 1.27
78
	 */
79
	const CHECK_USER_RIGHTS = true;
80
81
	/**
82
	 * @since 1.27
83
	 */
84
	const IGNORE_USER_RIGHTS = false;
85
86
	/**
87
	 * Array of Strings List of member variables which are saved to the
88
	 * shared cache (memcached). Any operation which changes the
89
	 * corresponding database fields must call a cache-clearing function.
90
	 * @showinitializer
91
	 */
92
	protected static $mCacheVars = [
93
		// user table
94
		'mId',
95
		'mName',
96
		'mRealName',
97
		'mEmail',
98
		'mTouched',
99
		'mToken',
100
		'mEmailAuthenticated',
101
		'mEmailToken',
102
		'mEmailTokenExpires',
103
		'mRegistration',
104
		'mEditCount',
105
		// user_groups table
106
		'mGroups',
107
		// user_properties table
108
		'mOptionOverrides',
109
	];
110
111
	/**
112
	 * Array of Strings Core rights.
113
	 * Each of these should have a corresponding message of the form
114
	 * "right-$right".
115
	 * @showinitializer
116
	 */
117
	protected static $mCoreRights = [
118
		'apihighlimits',
119
		'applychangetags',
120
		'autoconfirmed',
121
		'autocreateaccount',
122
		'autopatrol',
123
		'bigdelete',
124
		'block',
125
		'blockemail',
126
		'bot',
127
		'browsearchive',
128
		'changetags',
129
		'createaccount',
130
		'createpage',
131
		'createtalk',
132
		'delete',
133
		'deletechangetags',
134
		'deletedhistory',
135
		'deletedtext',
136
		'deletelogentry',
137
		'deleterevision',
138
		'edit',
139
		'editcontentmodel',
140
		'editinterface',
141
		'editprotected',
142
		'editmyoptions',
143
		'editmyprivateinfo',
144
		'editmyusercss',
145
		'editmyuserjs',
146
		'editmywatchlist',
147
		'editsemiprotected',
148
		'editusercssjs', # deprecated
149
		'editusercss',
150
		'edituserjs',
151
		'hideuser',
152
		'import',
153
		'importupload',
154
		'ipblock-exempt',
155
		'managechangetags',
156
		'markbotedits',
157
		'mergehistory',
158
		'minoredit',
159
		'move',
160
		'movefile',
161
		'move-categorypages',
162
		'move-rootuserpages',
163
		'move-subpages',
164
		'nominornewtalk',
165
		'noratelimit',
166
		'override-export-depth',
167
		'pagelang',
168
		'passwordreset',
169
		'patrol',
170
		'patrolmarks',
171
		'protect',
172
		'purge',
173
		'read',
174
		'reupload',
175
		'reupload-own',
176
		'reupload-shared',
177
		'rollback',
178
		'sendemail',
179
		'siteadmin',
180
		'suppressionlog',
181
		'suppressredirect',
182
		'suppressrevision',
183
		'unblockself',
184
		'undelete',
185
		'unwatchedpages',
186
		'upload',
187
		'upload_by_url',
188
		'userrights',
189
		'userrights-interwiki',
190
		'viewmyprivateinfo',
191
		'viewmywatchlist',
192
		'viewsuppressed',
193
		'writeapi',
194
	];
195
196
	/**
197
	 * String Cached results of getAllRights()
198
	 */
199
	protected static $mAllRights = false;
200
201
	/** Cache variables */
202
	// @{
203
	/** @var int */
204
	public $mId;
205
	/** @var string */
206
	public $mName;
207
	/** @var string */
208
	public $mRealName;
209
210
	/** @var string */
211
	public $mEmail;
212
	/** @var string TS_MW timestamp from the DB */
213
	public $mTouched;
214
	/** @var string TS_MW timestamp from cache */
215
	protected $mQuickTouched;
216
	/** @var string */
217
	protected $mToken;
218
	/** @var string */
219
	public $mEmailAuthenticated;
220
	/** @var string */
221
	protected $mEmailToken;
222
	/** @var string */
223
	protected $mEmailTokenExpires;
224
	/** @var string */
225
	protected $mRegistration;
226
	/** @var int */
227
	protected $mEditCount;
228
	/** @var array */
229
	public $mGroups;
230
	/** @var array */
231
	protected $mOptionOverrides;
232
	// @}
233
234
	/**
235
	 * Bool Whether the cache variables have been loaded.
236
	 */
237
	// @{
238
	public $mOptionsLoaded;
239
240
	/**
241
	 * Array with already loaded items or true if all items have been loaded.
242
	 */
243
	protected $mLoadedItems = [];
244
	// @}
245
246
	/**
247
	 * String Initialization data source if mLoadedItems!==true. May be one of:
248
	 *  - 'defaults'   anonymous user initialised from class defaults
249
	 *  - 'name'       initialise from mName
250
	 *  - 'id'         initialise from mId
251
	 *  - 'session'    log in from session if possible
252
	 *
253
	 * Use the User::newFrom*() family of functions to set this.
254
	 */
255
	public $mFrom;
256
257
	/**
258
	 * Lazy-initialized variables, invalidated with clearInstanceCache
259
	 */
260
	protected $mNewtalk;
261
	/** @var string */
262
	protected $mDatePreference;
263
	/** @var string */
264
	public $mBlockedby;
265
	/** @var string */
266
	protected $mHash;
267
	/** @var array */
268
	public $mRights;
269
	/** @var string */
270
	protected $mBlockreason;
271
	/** @var array */
272
	protected $mEffectiveGroups;
273
	/** @var array */
274
	protected $mImplicitGroups;
275
	/** @var array */
276
	protected $mFormerGroups;
277
	/** @var Block */
278
	protected $mGlobalBlock;
279
	/** @var bool */
280
	protected $mLocked;
281
	/** @var bool */
282
	public $mHideName;
283
	/** @var array */
284
	public $mOptions;
285
286
	/**
287
	 * @var WebRequest
288
	 */
289
	private $mRequest;
290
291
	/** @var Block */
292
	public $mBlock;
293
294
	/** @var bool */
295
	protected $mAllowUsertalk;
296
297
	/** @var Block */
298
	private $mBlockedFromCreateAccount = false;
299
300
	/** @var integer User::READ_* constant bitfield used to load data */
301
	protected $queryFlagsUsed = self::READ_NORMAL;
302
303
	public static $idCacheByName = [];
304
305
	/**
306
	 * Lightweight constructor for an anonymous user.
307
	 * Use the User::newFrom* factory functions for other kinds of users.
308
	 *
309
	 * @see newFromName()
310
	 * @see newFromId()
311
	 * @see newFromConfirmationCode()
312
	 * @see newFromSession()
313
	 * @see newFromRow()
314
	 */
315
	public function __construct() {
316
		$this->clearInstanceCache( 'defaults' );
317
	}
318
319
	/**
320
	 * @return string
321
	 */
322
	public function __toString() {
323
		return $this->getName();
324
	}
325
326
	/**
327
	 * Test if it's safe to load this User object.
328
	 *
329
	 * You should typically check this before using $wgUser or
330
	 * RequestContext::getUser in a method that might be called before the
331
	 * system has been fully initialized. If the object is unsafe, you should
332
	 * use an anonymous user:
333
	 * \code
334
	 * $user = $wgUser->isSafeToLoad() ? $wgUser : new User;
335
	 * \endcode
336
	 *
337
	 * @since 1.27
338
	 * @return bool
339
	 */
340
	public function isSafeToLoad() {
341
		global $wgFullyInitialised;
342
343
		// The user is safe to load if:
344
		// * MW_NO_SESSION is undefined AND $wgFullyInitialised is true (safe to use session data)
345
		// * mLoadedItems === true (already loaded)
346
		// * mFrom !== 'session' (sessions not involved at all)
347
348
		return ( !defined( 'MW_NO_SESSION' ) && $wgFullyInitialised ) ||
349
			$this->mLoadedItems === true || $this->mFrom !== 'session';
350
	}
351
352
	/**
353
	 * Load the user table data for this object from the source given by mFrom.
354
	 *
355
	 * @param integer $flags User::READ_* constant bitfield
356
	 */
357
	public function load( $flags = self::READ_NORMAL ) {
358
		global $wgFullyInitialised;
359
360
		if ( $this->mLoadedItems === true ) {
361
			return;
362
		}
363
364
		// Set it now to avoid infinite recursion in accessors
365
		$oldLoadedItems = $this->mLoadedItems;
366
		$this->mLoadedItems = true;
0 ignored issues
show
Documentation Bug introduced by
It seems like true of type boolean is incompatible with the declared type array of property $mLoadedItems.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
367
		$this->queryFlagsUsed = $flags;
368
369
		// If this is called too early, things are likely to break.
370
		if ( !$wgFullyInitialised && $this->mFrom === 'session' ) {
371
			\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
372
				->warning( 'User::loadFromSession called before the end of Setup.php', [
373
					'exception' => new Exception( 'User::loadFromSession called before the end of Setup.php' ),
374
				] );
375
			$this->loadDefaults();
376
			$this->mLoadedItems = $oldLoadedItems;
377
			return;
378
		}
379
380
		switch ( $this->mFrom ) {
381
			case 'defaults':
382
				$this->loadDefaults();
383
				break;
384
			case 'name':
385
				// Make sure this thread sees its own changes
386
				if ( wfGetLB()->hasOrMadeRecentMasterChanges() ) {
0 ignored issues
show
Deprecated Code introduced by
The function wfGetLB() has been deprecated with message: since 1.27, use MediaWikiServices::getDBLoadBalancer() or MediaWikiServices::getDBLoadBalancerFactory() instead.

This function has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the function will be removed from the class and what other function to use instead.

Loading history...
387
					$flags |= self::READ_LATEST;
388
					$this->queryFlagsUsed = $flags;
389
				}
390
391
				$this->mId = self::idFromName( $this->mName, $flags );
392
				if ( !$this->mId ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->mId of type integer|null is loosely compared to false; this is ambiguous if the integer can be zero. You might want to explicitly use === null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
393
					// Nonexistent user placeholder object
394
					$this->loadDefaults( $this->mName );
395
				} else {
396
					$this->loadFromId( $flags );
397
				}
398
				break;
399
			case 'id':
400
				$this->loadFromId( $flags );
401
				break;
402
			case 'session':
403
				if ( !$this->loadFromSession() ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $this->loadFromSession() of type null|boolean is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
404
					// Loading from session failed. Load defaults.
405
					$this->loadDefaults();
406
				}
407
				Hooks::run( 'UserLoadAfterLoadFromSession', [ $this ] );
408
				break;
409
			default:
410
				throw new UnexpectedValueException(
411
					"Unrecognised value for User->mFrom: \"{$this->mFrom}\"" );
412
		}
413
	}
414
415
	/**
416
	 * Load user table data, given mId has already been set.
417
	 * @param integer $flags User::READ_* constant bitfield
418
	 * @return bool False if the ID does not exist, true otherwise
419
	 */
420
	public function loadFromId( $flags = self::READ_NORMAL ) {
421
		if ( $this->mId == 0 ) {
422
			// Anonymous users are not in the database (don't need cache)
423
			$this->loadDefaults();
424
			return false;
425
		}
426
427
		// Try cache (unless this needs data from the master DB).
428
		// NOTE: if this thread called saveSettings(), the cache was cleared.
429
		$latest = DBAccessObjectUtils::hasFlags( $flags, self::READ_LATEST );
430
		if ( $latest ) {
431
			if ( !$this->loadFromDatabase( $flags ) ) {
432
				// Can't load from ID
433
				return false;
434
			}
435
		} else {
436
			$this->loadFromCache();
437
		}
438
439
		$this->mLoadedItems = true;
0 ignored issues
show
Documentation Bug introduced by
It seems like true of type boolean is incompatible with the declared type array of property $mLoadedItems.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
440
		$this->queryFlagsUsed = $flags;
441
442
		return true;
443
	}
444
445
	/**
446
	 * @since 1.27
447
	 * @param string $wikiId
448
	 * @param integer $userId
449
	 */
450
	public static function purge( $wikiId, $userId ) {
451
		$cache = ObjectCache::getMainWANInstance();
452
		$key = $cache->makeGlobalKey( 'user', 'id', $wikiId, $userId );
453
		$cache->delete( $key );
454
	}
455
456
	/**
457
	 * @since 1.27
458
	 * @param WANObjectCache $cache
459
	 * @return string
460
	 */
461
	protected function getCacheKey( WANObjectCache $cache ) {
462
		return $cache->makeGlobalKey( 'user', 'id', wfWikiID(), $this->mId );
463
	}
464
465
	/**
466
	 * Load user data from shared cache, given mId has already been set.
467
	 *
468
	 * @return bool True
469
	 * @since 1.25
470
	 */
471
	protected function loadFromCache() {
472
		$cache = ObjectCache::getMainWANInstance();
473
		$data = $cache->getWithSetCallback(
474
			$this->getCacheKey( $cache ),
475
			$cache::TTL_HOUR,
476
			function ( $oldValue, &$ttl, array &$setOpts ) use ( $cache ) {
477
				$setOpts += Database::getCacheSetOptions( wfGetDB( DB_REPLICA ) );
478
				wfDebug( "User: cache miss for user {$this->mId}\n" );
479
480
				$this->loadFromDatabase( self::READ_NORMAL );
481
				$this->loadGroups();
482
				$this->loadOptions();
483
484
				$data = [];
485
				foreach ( self::$mCacheVars as $name ) {
486
					$data[$name] = $this->$name;
487
				}
488
489
				$ttl = $cache->adaptiveTTL( wfTimestamp( TS_UNIX, $this->mTouched ), $ttl );
490
491
				return $data;
492
493
			},
494
			[ 'pcTTL' => $cache::TTL_PROC_LONG, 'version' => self::VERSION ]
495
		);
496
497
		// Restore from cache
498
		foreach ( self::$mCacheVars as $name ) {
499
			$this->$name = $data[$name];
500
		}
501
502
		return true;
503
	}
504
505
	/** @name newFrom*() static factory methods */
506
	// @{
507
508
	/**
509
	 * Static factory method for creation from username.
510
	 *
511
	 * This is slightly less efficient than newFromId(), so use newFromId() if
512
	 * you have both an ID and a name handy.
513
	 *
514
	 * @param string $name Username, validated by Title::newFromText()
515
	 * @param string|bool $validate Validate username. Takes the same parameters as
516
	 *  User::getCanonicalName(), except that true is accepted as an alias
517
	 *  for 'valid', for BC.
518
	 *
519
	 * @return User|bool User object, or false if the username is invalid
520
	 *  (e.g. if it contains illegal characters or is an IP address). If the
521
	 *  username is not present in the database, the result will be a user object
522
	 *  with a name, zero user ID and default settings.
523
	 */
524
	public static function newFromName( $name, $validate = 'valid' ) {
525
		if ( $validate === true ) {
526
			$validate = 'valid';
527
		}
528
		$name = self::getCanonicalName( $name, $validate );
529
		if ( $name === false ) {
530
			return false;
531
		} else {
532
			// Create unloaded user object
533
			$u = new User;
534
			$u->mName = $name;
0 ignored issues
show
Documentation Bug introduced by
It seems like $name can also be of type boolean. However, the property $mName is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
535
			$u->mFrom = 'name';
536
			$u->setItemLoaded( 'name' );
537
			return $u;
538
		}
539
	}
540
541
	/**
542
	 * Static factory method for creation from a given user ID.
543
	 *
544
	 * @param int $id Valid user ID
545
	 * @return User The corresponding User object
546
	 */
547
	public static function newFromId( $id ) {
548
		$u = new User;
549
		$u->mId = $id;
550
		$u->mFrom = 'id';
551
		$u->setItemLoaded( 'id' );
552
		return $u;
553
	}
554
555
	/**
556
	 * Factory method to fetch whichever user has a given email confirmation code.
557
	 * This code is generated when an account is created or its e-mail address
558
	 * has changed.
559
	 *
560
	 * If the code is invalid or has expired, returns NULL.
561
	 *
562
	 * @param string $code Confirmation code
563
	 * @param int $flags User::READ_* bitfield
564
	 * @return User|null
565
	 */
566
	public static function newFromConfirmationCode( $code, $flags = 0 ) {
567
		$db = ( $flags & self::READ_LATEST ) == self::READ_LATEST
568
			? wfGetDB( DB_MASTER )
569
			: wfGetDB( DB_REPLICA );
570
571
		$id = $db->selectField(
572
			'user',
573
			'user_id',
574
			[
575
				'user_email_token' => md5( $code ),
576
				'user_email_token_expires > ' . $db->addQuotes( $db->timestamp() ),
0 ignored issues
show
Security Bug introduced by
It seems like $db->timestamp() targeting DatabaseBase::timestamp() can also be of type false; however, DatabaseBase::addQuotes() does only seem to accept string|object<Blob>, did you maybe forget to handle an error condition?
Loading history...
577
			]
578
		);
579
580
		return $id ? User::newFromId( $id ) : null;
581
	}
582
583
	/**
584
	 * Create a new user object using data from session. If the login
585
	 * credentials are invalid, the result is an anonymous user.
586
	 *
587
	 * @param WebRequest|null $request Object to use; $wgRequest will be used if omitted.
588
	 * @return User
589
	 */
590
	public static function newFromSession( WebRequest $request = null ) {
591
		$user = new User;
592
		$user->mFrom = 'session';
593
		$user->mRequest = $request;
594
		return $user;
595
	}
596
597
	/**
598
	 * Create a new user object from a user row.
599
	 * The row should have the following fields from the user table in it:
600
	 * - either user_name or user_id to load further data if needed (or both)
601
	 * - user_real_name
602
	 * - all other fields (email, etc.)
603
	 * It is useless to provide the remaining fields if either user_id,
604
	 * user_name and user_real_name are not provided because the whole row
605
	 * will be loaded once more from the database when accessing them.
606
	 *
607
	 * @param stdClass $row A row from the user table
608
	 * @param array $data Further data to load into the object (see User::loadFromRow for valid keys)
609
	 * @return User
610
	 */
611
	public static function newFromRow( $row, $data = null ) {
612
		$user = new User;
613
		$user->loadFromRow( $row, $data );
614
		return $user;
615
	}
616
617
	/**
618
	 * Static factory method for creation of a "system" user from username.
619
	 *
620
	 * A "system" user is an account that's used to attribute logged actions
621
	 * taken by MediaWiki itself, as opposed to a bot or human user. Examples
622
	 * might include the 'Maintenance script' or 'Conversion script' accounts
623
	 * used by various scripts in the maintenance/ directory or accounts such
624
	 * as 'MediaWiki message delivery' used by the MassMessage extension.
625
	 *
626
	 * This can optionally create the user if it doesn't exist, and "steal" the
627
	 * account if it does exist.
628
	 *
629
	 * "Stealing" an existing user is intended to make it impossible for normal
630
	 * authentication processes to use the account, effectively disabling the
631
	 * account for normal use:
632
	 * - Email is invalidated, to prevent account recovery by emailing a
633
	 *   temporary password and to disassociate the account from the existing
634
	 *   human.
635
	 * - The token is set to a magic invalid value, to kill existing sessions
636
	 *   and to prevent $this->setToken() calls from resetting the token to a
637
	 *   valid value.
638
	 * - SessionManager is instructed to prevent new sessions for the user, to
639
	 *   do things like deauthorizing OAuth consumers.
640
	 * - AuthManager is instructed to revoke access, to invalidate or remove
641
	 *   passwords and other credentials.
642
	 *
643
	 * @param string $name Username
644
	 * @param array $options Options are:
645
	 *  - validate: As for User::getCanonicalName(), default 'valid'
646
	 *  - create: Whether to create the user if it doesn't already exist, default true
647
	 *  - steal: Whether to "disable" the account for normal use if it already
648
	 *    exists, default false
649
	 * @return User|null
650
	 * @since 1.27
651
	 */
652
	public static function newSystemUser( $name, $options = [] ) {
653
		$options += [
654
			'validate' => 'valid',
655
			'create' => true,
656
			'steal' => false,
657
		];
658
659
		$name = self::getCanonicalName( $name, $options['validate'] );
660
		if ( $name === false ) {
661
			return null;
662
		}
663
664
		$fields = self::selectFields();
665
666
		$dbw = wfGetDB( DB_MASTER );
667
		$row = $dbw->selectRow(
668
			'user',
669
			$fields,
670
			[ 'user_name' => $name ],
671
			__METHOD__
672
		);
673
		if ( !$row ) {
674
			// No user. Create it?
675
			return $options['create'] ? self::createNew( $name ) : null;
0 ignored issues
show
Bug introduced by
It seems like $name defined by self::getCanonicalName($..., $options['validate']) on line 659 can also be of type boolean; however, User::createNew() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
676
		}
677
		$user = self::newFromRow( $row );
0 ignored issues
show
Bug introduced by
It seems like $row defined by $dbw->selectRow('user', ... => $name), __METHOD__) on line 667 can also be of type boolean; however, User::newFromRow() does only seem to accept object<stdClass>, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
678
679
		// A user is considered to exist as a non-system user if it can
680
		// authenticate, or has an email set, or has a non-invalid token.
681
		if ( $user->mEmail || $user->mToken !== self::INVALID_TOKEN ||
682
			AuthManager::singleton()->userCanAuthenticate( $name )
0 ignored issues
show
Bug introduced by
It seems like $name defined by self::getCanonicalName($..., $options['validate']) on line 659 can also be of type boolean; however, MediaWiki\Auth\AuthManager::userCanAuthenticate() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
683
		) {
684
			// User exists. Steal it?
685
			if ( !$options['steal'] ) {
686
				return null;
687
			}
688
689
			AuthManager::singleton()->revokeAccessForUser( $name );
0 ignored issues
show
Bug introduced by
It seems like $name defined by self::getCanonicalName($..., $options['validate']) on line 659 can also be of type boolean; however, MediaWiki\Auth\AuthManager::revokeAccessForUser() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
690
691
			$user->invalidateEmail();
692
			$user->mToken = self::INVALID_TOKEN;
693
			$user->saveSettings();
694
			SessionManager::singleton()->preventSessionsForUser( $user->getName() );
695
		}
696
697
		return $user;
698
	}
699
700
	// @}
701
702
	/**
703
	 * Get the username corresponding to a given user ID
704
	 * @param int $id User ID
705
	 * @return string|bool The corresponding username
706
	 */
707
	public static function whoIs( $id ) {
708
		return UserCache::singleton()->getProp( $id, 'name' );
709
	}
710
711
	/**
712
	 * Get the real name of a user given their user ID
713
	 *
714
	 * @param int $id User ID
715
	 * @return string|bool The corresponding user's real name
716
	 */
717
	public static function whoIsReal( $id ) {
718
		return UserCache::singleton()->getProp( $id, 'real_name' );
719
	}
720
721
	/**
722
	 * Get database id given a user name
723
	 * @param string $name Username
724
	 * @param integer $flags User::READ_* constant bitfield
725
	 * @return int|null The corresponding user's ID, or null if user is nonexistent
726
	 */
727
	public static function idFromName( $name, $flags = self::READ_NORMAL ) {
728
		$nt = Title::makeTitleSafe( NS_USER, $name );
729
		if ( is_null( $nt ) ) {
730
			// Illegal name
731
			return null;
732
		}
733
734
		if ( !( $flags & self::READ_LATEST ) && isset( self::$idCacheByName[$name] ) ) {
735
			return self::$idCacheByName[$name];
736
		}
737
738
		list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
739
		$db = wfGetDB( $index );
740
741
		$s = $db->selectRow(
742
			'user',
743
			[ 'user_id' ],
744
			[ 'user_name' => $nt->getText() ],
745
			__METHOD__,
746
			$options
747
		);
748
749
		if ( $s === false ) {
750
			$result = null;
751
		} else {
752
			$result = $s->user_id;
753
		}
754
755
		self::$idCacheByName[$name] = $result;
756
757
		if ( count( self::$idCacheByName ) > 1000 ) {
758
			self::$idCacheByName = [];
759
		}
760
761
		return $result;
762
	}
763
764
	/**
765
	 * Reset the cache used in idFromName(). For use in tests.
766
	 */
767
	public static function resetIdByNameCache() {
768
		self::$idCacheByName = [];
769
	}
770
771
	/**
772
	 * Does the string match an anonymous IP address?
773
	 *
774
	 * This function exists for username validation, in order to reject
775
	 * usernames which are similar in form to IP addresses. Strings such
776
	 * as 300.300.300.300 will return true because it looks like an IP
777
	 * address, despite not being strictly valid.
778
	 *
779
	 * We match "\d{1,3}\.\d{1,3}\.\d{1,3}\.xxx" as an anonymous IP
780
	 * address because the usemod software would "cloak" anonymous IP
781
	 * addresses like this, if we allowed accounts like this to be created
782
	 * new users could get the old edits of these anonymous users.
783
	 *
784
	 * @param string $name Name to match
785
	 * @return bool
786
	 */
787
	public static function isIP( $name ) {
788
		return preg_match( '/^\d{1,3}\.\d{1,3}\.\d{1,3}\.(?:xxx|\d{1,3})$/', $name )
789
			|| IP::isIPv6( $name );
790
	}
791
792
	/**
793
	 * Is the input a valid username?
794
	 *
795
	 * Checks if the input is a valid username, we don't want an empty string,
796
	 * an IP address, anything that contains slashes (would mess up subpages),
797
	 * is longer than the maximum allowed username size or doesn't begin with
798
	 * a capital letter.
799
	 *
800
	 * @param string $name Name to match
801
	 * @return bool
802
	 */
803
	public static function isValidUserName( $name ) {
804
		global $wgContLang, $wgMaxNameChars;
805
806
		if ( $name == ''
807
			|| User::isIP( $name )
808
			|| strpos( $name, '/' ) !== false
809
			|| strlen( $name ) > $wgMaxNameChars
810
			|| $name != $wgContLang->ucfirst( $name )
811
		) {
812
			return false;
813
		}
814
815
		// Ensure that the name can't be misresolved as a different title,
816
		// such as with extra namespace keys at the start.
817
		$parsed = Title::newFromText( $name );
818
		if ( is_null( $parsed )
819
			|| $parsed->getNamespace()
820
			|| strcmp( $name, $parsed->getPrefixedText() ) ) {
821
			return false;
822
		}
823
824
		// Check an additional blacklist of troublemaker characters.
825
		// Should these be merged into the title char list?
826
		$unicodeBlacklist = '/[' .
827
			'\x{0080}-\x{009f}' . # iso-8859-1 control chars
828
			'\x{00a0}' .          # non-breaking space
829
			'\x{2000}-\x{200f}' . # various whitespace
830
			'\x{2028}-\x{202f}' . # breaks and control chars
831
			'\x{3000}' .          # ideographic space
832
			'\x{e000}-\x{f8ff}' . # private use
833
			']/u';
834
		if ( preg_match( $unicodeBlacklist, $name ) ) {
835
			return false;
836
		}
837
838
		return true;
839
	}
840
841
	/**
842
	 * Usernames which fail to pass this function will be blocked
843
	 * from user login and new account registrations, but may be used
844
	 * internally by batch processes.
845
	 *
846
	 * If an account already exists in this form, login will be blocked
847
	 * by a failure to pass this function.
848
	 *
849
	 * @param string $name Name to match
850
	 * @return bool
851
	 */
852
	public static function isUsableName( $name ) {
853
		global $wgReservedUsernames;
854
		// Must be a valid username, obviously ;)
855
		if ( !self::isValidUserName( $name ) ) {
856
			return false;
857
		}
858
859
		static $reservedUsernames = false;
860
		if ( !$reservedUsernames ) {
861
			$reservedUsernames = $wgReservedUsernames;
862
			Hooks::run( 'UserGetReservedNames', [ &$reservedUsernames ] );
863
		}
864
865
		// Certain names may be reserved for batch processes.
866
		foreach ( $reservedUsernames as $reserved ) {
867
			if ( substr( $reserved, 0, 4 ) == 'msg:' ) {
868
				$reserved = wfMessage( substr( $reserved, 4 ) )->inContentLanguage()->text();
869
			}
870
			if ( $reserved == $name ) {
871
				return false;
872
			}
873
		}
874
		return true;
875
	}
876
877
	/**
878
	 * Return the users who are members of the given group(s). In case of multiple groups,
879
	 * users who are members of at least one of them are returned.
880
	 *
881
	 * @param string|array $groups A single group name or an array of group names
882
	 * @param int $limit Max number of users to return. The actual limit will never exceed 5000
883
	 *   records; larger values are ignored.
884
	 * @param int $after ID the user to start after
885
	 * @return UserArrayFromResult
886
	 */
887
	public static function findUsersByGroup( $groups, $limit = 5000, $after = null ) {
888
		if ( $groups === [] ) {
889
			return UserArrayFromResult::newFromIDs( [] );
890
		}
891
892
		$groups = array_unique( (array)$groups );
893
		$limit = min( 5000, $limit );
894
895
		$conds = [ 'ug_group' => $groups ];
896
		if ( $after !== null ) {
897
			$conds[] = 'ug_user > ' . (int)$after;
898
		}
899
900
		$dbr = wfGetDB( DB_REPLICA );
901
		$ids = $dbr->selectFieldValues(
902
			'user_groups',
903
			'ug_user',
904
			$conds,
905
			__METHOD__,
906
			[
907
				'DISTINCT' => true,
908
				'ORDER BY' => 'ug_user',
909
				'LIMIT' => $limit,
910
			]
911
		) ?: [];
912
		return UserArray::newFromIDs( $ids );
913
	}
914
915
	/**
916
	 * Usernames which fail to pass this function will be blocked
917
	 * from new account registrations, but may be used internally
918
	 * either by batch processes or by user accounts which have
919
	 * already been created.
920
	 *
921
	 * Additional blacklisting may be added here rather than in
922
	 * isValidUserName() to avoid disrupting existing accounts.
923
	 *
924
	 * @param string $name String to match
925
	 * @return bool
926
	 */
927
	public static function isCreatableName( $name ) {
928
		global $wgInvalidUsernameCharacters;
929
930
		// Ensure that the username isn't longer than 235 bytes, so that
931
		// (at least for the builtin skins) user javascript and css files
932
		// will work. (bug 23080)
933
		if ( strlen( $name ) > 235 ) {
934
			wfDebugLog( 'username', __METHOD__ .
935
				": '$name' invalid due to length" );
936
			return false;
937
		}
938
939
		// Preg yells if you try to give it an empty string
940
		if ( $wgInvalidUsernameCharacters !== '' ) {
941
			if ( preg_match( '/[' . preg_quote( $wgInvalidUsernameCharacters, '/' ) . ']/', $name ) ) {
942
				wfDebugLog( 'username', __METHOD__ .
943
					": '$name' invalid due to wgInvalidUsernameCharacters" );
944
				return false;
945
			}
946
		}
947
948
		return self::isUsableName( $name );
949
	}
950
951
	/**
952
	 * Is the input a valid password for this user?
953
	 *
954
	 * @param string $password Desired password
955
	 * @return bool
956
	 */
957
	public function isValidPassword( $password ) {
958
		// simple boolean wrapper for getPasswordValidity
959
		return $this->getPasswordValidity( $password ) === true;
960
	}
961
962
	/**
963
	 * Given unvalidated password input, return error message on failure.
964
	 *
965
	 * @param string $password Desired password
966
	 * @return bool|string|array True on success, string or array of error message on failure
967
	 */
968
	public function getPasswordValidity( $password ) {
969
		$result = $this->checkPasswordValidity( $password );
970
		if ( $result->isGood() ) {
971
			return true;
972
		} else {
973
			$messages = [];
974
			foreach ( $result->getErrorsByType( 'error' ) as $error ) {
975
				$messages[] = $error['message'];
976
			}
977
			foreach ( $result->getErrorsByType( 'warning' ) as $warning ) {
978
				$messages[] = $warning['message'];
979
			}
980
			if ( count( $messages ) === 1 ) {
981
				return $messages[0];
982
			}
983
			return $messages;
984
		}
985
	}
986
987
	/**
988
	 * Check if this is a valid password for this user
989
	 *
990
	 * Create a Status object based on the password's validity.
991
	 * The Status should be set to fatal if the user should not
992
	 * be allowed to log in, and should have any errors that
993
	 * would block changing the password.
994
	 *
995
	 * If the return value of this is not OK, the password
996
	 * should not be checked. If the return value is not Good,
997
	 * the password can be checked, but the user should not be
998
	 * able to set their password to this.
999
	 *
1000
	 * @param string $password Desired password
1001
	 * @param string $purpose one of 'login', 'create', 'reset'
1002
	 * @return Status
1003
	 * @since 1.23
1004
	 */
1005
	public function checkPasswordValidity( $password, $purpose = 'login' ) {
1006
		global $wgPasswordPolicy;
1007
1008
		$upp = new UserPasswordPolicy(
1009
			$wgPasswordPolicy['policies'],
1010
			$wgPasswordPolicy['checks']
1011
		);
1012
1013
		$status = Status::newGood();
1014
		$result = false; // init $result to false for the internal checks
1015
1016
		if ( !Hooks::run( 'isValidPassword', [ $password, &$result, $this ] ) ) {
1017
			$status->error( $result );
1018
			return $status;
1019
		}
1020
1021
		if ( $result === false ) {
1022
			$status->merge( $upp->checkUserPassword( $this, $password, $purpose ) );
1023
			return $status;
1024
		} elseif ( $result === true ) {
1025
			return $status;
1026
		} else {
1027
			$status->error( $result );
1028
			return $status; // the isValidPassword hook set a string $result and returned true
1029
		}
1030
	}
1031
1032
	/**
1033
	 * Given unvalidated user input, return a canonical username, or false if
1034
	 * the username is invalid.
1035
	 * @param string $name User input
1036
	 * @param string|bool $validate Type of validation to use:
1037
	 *   - false        No validation
1038
	 *   - 'valid'      Valid for batch processes
1039
	 *   - 'usable'     Valid for batch processes and login
1040
	 *   - 'creatable'  Valid for batch processes, login and account creation
1041
	 *
1042
	 * @throws InvalidArgumentException
1043
	 * @return bool|string
1044
	 */
1045
	public static function getCanonicalName( $name, $validate = 'valid' ) {
1046
		// Force usernames to capital
1047
		global $wgContLang;
1048
		$name = $wgContLang->ucfirst( $name );
1049
1050
		# Reject names containing '#'; these will be cleaned up
1051
		# with title normalisation, but then it's too late to
1052
		# check elsewhere
1053
		if ( strpos( $name, '#' ) !== false ) {
1054
			return false;
1055
		}
1056
1057
		// Clean up name according to title rules,
1058
		// but only when validation is requested (bug 12654)
1059
		$t = ( $validate !== false ) ?
1060
			Title::newFromText( $name, NS_USER ) : Title::makeTitle( NS_USER, $name );
1061
		// Check for invalid titles
1062
		if ( is_null( $t ) || $t->getNamespace() !== NS_USER || $t->isExternal() ) {
1063
			return false;
1064
		}
1065
1066
		// Reject various classes of invalid names
1067
		$name = AuthManager::callLegacyAuthPlugin(
1068
			'getCanonicalName', [ $t->getText() ], $t->getText()
1069
		);
1070
1071
		switch ( $validate ) {
1072
			case false:
1073
				break;
1074
			case 'valid':
1075
				if ( !User::isValidUserName( $name ) ) {
1076
					$name = false;
1077
				}
1078
				break;
1079
			case 'usable':
1080
				if ( !User::isUsableName( $name ) ) {
1081
					$name = false;
1082
				}
1083
				break;
1084
			case 'creatable':
1085
				if ( !User::isCreatableName( $name ) ) {
1086
					$name = false;
1087
				}
1088
				break;
1089
			default:
1090
				throw new InvalidArgumentException(
1091
					'Invalid parameter value for $validate in ' . __METHOD__ );
1092
		}
1093
		return $name;
1094
	}
1095
1096
	/**
1097
	 * Count the number of edits of a user
1098
	 *
1099
	 * @param int $uid User ID to check
1100
	 * @return int The user's edit count
1101
	 *
1102
	 * @deprecated since 1.21 in favour of User::getEditCount
1103
	 */
1104
	public static function edits( $uid ) {
1105
		wfDeprecated( __METHOD__, '1.21' );
1106
		$user = self::newFromId( $uid );
1107
		return $user->getEditCount();
1108
	}
1109
1110
	/**
1111
	 * Return a random password.
1112
	 *
1113
	 * @deprecated since 1.27, use PasswordFactory::generateRandomPasswordString()
1114
	 * @return string New random password
1115
	 */
1116
	public static function randomPassword() {
1117
		global $wgMinimalPasswordLength;
1118
		return PasswordFactory::generateRandomPasswordString( $wgMinimalPasswordLength );
1119
	}
1120
1121
	/**
1122
	 * Set cached properties to default.
1123
	 *
1124
	 * @note This no longer clears uncached lazy-initialised properties;
1125
	 *       the constructor does that instead.
1126
	 *
1127
	 * @param string|bool $name
1128
	 */
1129
	public function loadDefaults( $name = false ) {
1130
		$this->mId = 0;
1131
		$this->mName = $name;
0 ignored issues
show
Documentation Bug introduced by
It seems like $name can also be of type boolean. However, the property $mName is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1132
		$this->mRealName = '';
1133
		$this->mEmail = '';
1134
		$this->mOptionOverrides = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mOptionOverrides.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1135
		$this->mOptionsLoaded = false;
1136
1137
		$loggedOut = $this->mRequest && !defined( 'MW_NO_SESSION' )
1138
			? $this->mRequest->getSession()->getLoggedOutTimestamp() : 0;
1139
		if ( $loggedOut !== 0 ) {
1140
			$this->mTouched = wfTimestamp( TS_MW, $loggedOut );
0 ignored issues
show
Documentation Bug introduced by
It seems like wfTimestamp(TS_MW, $loggedOut) can also be of type false. However, the property $mTouched is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1141
		} else {
1142
			$this->mTouched = '1'; # Allow any pages to be cached
1143
		}
1144
1145
		$this->mToken = null; // Don't run cryptographic functions till we need a token
1146
		$this->mEmailAuthenticated = null;
1147
		$this->mEmailToken = '';
1148
		$this->mEmailTokenExpires = null;
1149
		$this->mRegistration = wfTimestamp( TS_MW );
0 ignored issues
show
Documentation Bug introduced by
It seems like wfTimestamp(TS_MW) can also be of type false. However, the property $mRegistration is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1150
		$this->mGroups = [];
1151
1152
		Hooks::run( 'UserLoadDefaults', [ $this, $name ] );
1153
	}
1154
1155
	/**
1156
	 * Return whether an item has been loaded.
1157
	 *
1158
	 * @param string $item Item to check. Current possibilities:
1159
	 *   - id
1160
	 *   - name
1161
	 *   - realname
1162
	 * @param string $all 'all' to check if the whole object has been loaded
1163
	 *   or any other string to check if only the item is available (e.g.
1164
	 *   for optimisation)
1165
	 * @return bool
1166
	 */
1167
	public function isItemLoaded( $item, $all = 'all' ) {
1168
		return ( $this->mLoadedItems === true && $all === 'all' ) ||
1169
			( isset( $this->mLoadedItems[$item] ) && $this->mLoadedItems[$item] === true );
1170
	}
1171
1172
	/**
1173
	 * Set that an item has been loaded
1174
	 *
1175
	 * @param string $item
1176
	 */
1177
	protected function setItemLoaded( $item ) {
1178
		if ( is_array( $this->mLoadedItems ) ) {
1179
			$this->mLoadedItems[$item] = true;
1180
		}
1181
	}
1182
1183
	/**
1184
	 * Load user data from the session.
1185
	 *
1186
	 * @return bool True if the user is logged in, false otherwise.
1187
	 */
1188
	private function loadFromSession() {
1189
		// Deprecated hook
1190
		$result = null;
1191
		Hooks::run( 'UserLoadFromSession', [ $this, &$result ], '1.27' );
1192
		if ( $result !== null ) {
1193
			return $result;
1194
		}
1195
1196
		// MediaWiki\Session\Session already did the necessary authentication of the user
1197
		// returned here, so just use it if applicable.
1198
		$session = $this->getRequest()->getSession();
1199
		$user = $session->getUser();
1200
		if ( $user->isLoggedIn() ) {
1201
			$this->loadFromUserObject( $user );
1202
			// Other code expects these to be set in the session, so set them.
1203
			$session->set( 'wsUserID', $this->getId() );
1204
			$session->set( 'wsUserName', $this->getName() );
1205
			$session->set( 'wsToken', $this->getToken() );
1206
			return true;
1207
		}
1208
1209
		return false;
1210
	}
1211
1212
	/**
1213
	 * Load user and user_group data from the database.
1214
	 * $this->mId must be set, this is how the user is identified.
1215
	 *
1216
	 * @param integer $flags User::READ_* constant bitfield
1217
	 * @return bool True if the user exists, false if the user is anonymous
1218
	 */
1219
	public function loadFromDatabase( $flags = self::READ_LATEST ) {
1220
		// Paranoia
1221
		$this->mId = intval( $this->mId );
1222
1223
		if ( !$this->mId ) {
1224
			// Anonymous users are not in the database
1225
			$this->loadDefaults();
1226
			return false;
1227
		}
1228
1229
		list( $index, $options ) = DBAccessObjectUtils::getDBOptions( $flags );
1230
		$db = wfGetDB( $index );
1231
1232
		$s = $db->selectRow(
1233
			'user',
1234
			self::selectFields(),
1235
			[ 'user_id' => $this->mId ],
1236
			__METHOD__,
1237
			$options
1238
		);
1239
1240
		$this->queryFlagsUsed = $flags;
1241
		Hooks::run( 'UserLoadFromDatabase', [ $this, &$s ] );
1242
1243
		if ( $s !== false ) {
1244
			// Initialise user table data
1245
			$this->loadFromRow( $s );
0 ignored issues
show
Bug introduced by
It seems like $s defined by $db->selectRow('user', s..., __METHOD__, $options) on line 1232 can also be of type boolean; however, User::loadFromRow() does only seem to accept object<stdClass>, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
1246
			$this->mGroups = null; // deferred
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mGroups.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1247
			$this->getEditCount(); // revalidation for nulls
1248
			return true;
1249
		} else {
1250
			// Invalid user_id
1251
			$this->mId = 0;
1252
			$this->loadDefaults();
1253
			return false;
1254
		}
1255
	}
1256
1257
	/**
1258
	 * Initialize this object from a row from the user table.
1259
	 *
1260
	 * @param stdClass $row Row from the user table to load.
1261
	 * @param array $data Further user data to load into the object
1262
	 *
1263
	 *	user_groups		Array with groups out of the user_groups table
1264
	 *	user_properties		Array with properties out of the user_properties table
1265
	 */
1266
	protected function loadFromRow( $row, $data = null ) {
1267
		$all = true;
1268
1269
		$this->mGroups = null; // deferred
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mGroups.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1270
1271 View Code Duplication
		if ( isset( $row->user_name ) ) {
1272
			$this->mName = $row->user_name;
1273
			$this->mFrom = 'name';
1274
			$this->setItemLoaded( 'name' );
1275
		} else {
1276
			$all = false;
1277
		}
1278
1279
		if ( isset( $row->user_real_name ) ) {
1280
			$this->mRealName = $row->user_real_name;
1281
			$this->setItemLoaded( 'realname' );
1282
		} else {
1283
			$all = false;
1284
		}
1285
1286 View Code Duplication
		if ( isset( $row->user_id ) ) {
1287
			$this->mId = intval( $row->user_id );
1288
			$this->mFrom = 'id';
1289
			$this->setItemLoaded( 'id' );
1290
		} else {
1291
			$all = false;
1292
		}
1293
1294
		if ( isset( $row->user_id ) && isset( $row->user_name ) ) {
1295
			self::$idCacheByName[$row->user_name] = $row->user_id;
1296
		}
1297
1298
		if ( isset( $row->user_editcount ) ) {
1299
			$this->mEditCount = $row->user_editcount;
1300
		} else {
1301
			$all = false;
1302
		}
1303
1304
		if ( isset( $row->user_touched ) ) {
1305
			$this->mTouched = wfTimestamp( TS_MW, $row->user_touched );
0 ignored issues
show
Documentation Bug introduced by
It seems like wfTimestamp(TS_MW, $row->user_touched) can also be of type false. However, the property $mTouched is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1306
		} else {
1307
			$all = false;
1308
		}
1309
1310
		if ( isset( $row->user_token ) ) {
1311
			// The definition for the column is binary(32), so trim the NULs
1312
			// that appends. The previous definition was char(32), so trim
1313
			// spaces too.
1314
			$this->mToken = rtrim( $row->user_token, " \0" );
1315
			if ( $this->mToken === '' ) {
1316
				$this->mToken = null;
1317
			}
1318
		} else {
1319
			$all = false;
1320
		}
1321
1322
		if ( isset( $row->user_email ) ) {
1323
			$this->mEmail = $row->user_email;
1324
			$this->mEmailAuthenticated = wfTimestampOrNull( TS_MW, $row->user_email_authenticated );
0 ignored issues
show
Documentation Bug introduced by
It seems like wfTimestampOrNull(TS_MW,...er_email_authenticated) can also be of type false. However, the property $mEmailAuthenticated is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1325
			$this->mEmailToken = $row->user_email_token;
1326
			$this->mEmailTokenExpires = wfTimestampOrNull( TS_MW, $row->user_email_token_expires );
0 ignored issues
show
Documentation Bug introduced by
It seems like wfTimestampOrNull(TS_MW,...er_email_token_expires) can also be of type false. However, the property $mEmailTokenExpires is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1327
			$this->mRegistration = wfTimestampOrNull( TS_MW, $row->user_registration );
0 ignored issues
show
Documentation Bug introduced by
It seems like wfTimestampOrNull(TS_MW, $row->user_registration) can also be of type false. However, the property $mRegistration is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1328
		} else {
1329
			$all = false;
1330
		}
1331
1332
		if ( $all ) {
1333
			$this->mLoadedItems = true;
0 ignored issues
show
Documentation Bug introduced by
It seems like true of type boolean is incompatible with the declared type array of property $mLoadedItems.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1334
		}
1335
1336
		if ( is_array( $data ) ) {
1337
			if ( isset( $data['user_groups'] ) && is_array( $data['user_groups'] ) ) {
1338
				$this->mGroups = $data['user_groups'];
1339
			}
1340
			if ( isset( $data['user_properties'] ) && is_array( $data['user_properties'] ) ) {
1341
				$this->loadOptions( $data['user_properties'] );
1342
			}
1343
		}
1344
	}
1345
1346
	/**
1347
	 * Load the data for this user object from another user object.
1348
	 *
1349
	 * @param User $user
1350
	 */
1351
	protected function loadFromUserObject( $user ) {
1352
		$user->load();
1353
		foreach ( self::$mCacheVars as $var ) {
1354
			$this->$var = $user->$var;
1355
		}
1356
	}
1357
1358
	/**
1359
	 * Load the groups from the database if they aren't already loaded.
1360
	 */
1361 View Code Duplication
	private function loadGroups() {
1362
		if ( is_null( $this->mGroups ) ) {
1363
			$db = ( $this->queryFlagsUsed & self::READ_LATEST )
1364
				? wfGetDB( DB_MASTER )
1365
				: wfGetDB( DB_REPLICA );
1366
			$res = $db->select( 'user_groups',
1367
				[ 'ug_group' ],
1368
				[ 'ug_user' => $this->mId ],
1369
				__METHOD__ );
1370
			$this->mGroups = [];
1371
			foreach ( $res as $row ) {
0 ignored issues
show
Bug introduced by
The expression $res of type boolean|object<ResultWrapper> is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
1372
				$this->mGroups[] = $row->ug_group;
1373
			}
1374
		}
1375
	}
1376
1377
	/**
1378
	 * Add the user to the group if he/she meets given criteria.
1379
	 *
1380
	 * Contrary to autopromotion by \ref $wgAutopromote, the group will be
1381
	 *   possible to remove manually via Special:UserRights. In such case it
1382
	 *   will not be re-added automatically. The user will also not lose the
1383
	 *   group if they no longer meet the criteria.
1384
	 *
1385
	 * @param string $event Key in $wgAutopromoteOnce (each one has groups/criteria)
1386
	 *
1387
	 * @return array Array of groups the user has been promoted to.
1388
	 *
1389
	 * @see $wgAutopromoteOnce
1390
	 */
1391
	public function addAutopromoteOnceGroups( $event ) {
1392
		global $wgAutopromoteOnceLogInRC;
1393
1394
		if ( wfReadOnly() || !$this->getId() ) {
1395
			return [];
1396
		}
1397
1398
		$toPromote = Autopromote::getAutopromoteOnceGroups( $this, $event );
1399
		if ( !count( $toPromote ) ) {
1400
			return [];
1401
		}
1402
1403
		if ( !$this->checkAndSetTouched() ) {
1404
			return []; // raced out (bug T48834)
1405
		}
1406
1407
		$oldGroups = $this->getGroups(); // previous groups
1408
		foreach ( $toPromote as $group ) {
1409
			$this->addGroup( $group );
1410
		}
1411
		// update groups in external authentication database
1412
		Hooks::run( 'UserGroupsChanged', [ $this, $toPromote, [], false, false ] );
1413
		AuthManager::callLegacyAuthPlugin( 'updateExternalDBGroups', [ $this, $toPromote ] );
1414
1415
		$newGroups = array_merge( $oldGroups, $toPromote ); // all groups
1416
1417
		$logEntry = new ManualLogEntry( 'rights', 'autopromote' );
1418
		$logEntry->setPerformer( $this );
1419
		$logEntry->setTarget( $this->getUserPage() );
1420
		$logEntry->setParameters( [
1421
			'4::oldgroups' => $oldGroups,
1422
			'5::newgroups' => $newGroups,
1423
		] );
1424
		$logid = $logEntry->insert();
1425
		if ( $wgAutopromoteOnceLogInRC ) {
1426
			$logEntry->publish( $logid );
1427
		}
1428
1429
		return $toPromote;
1430
	}
1431
1432
	/**
1433
	 * Builds update conditions. Additional conditions may be added to $conditions to
1434
	 * protected against race conditions using a compare-and-set (CAS) mechanism
1435
	 * based on comparing $this->mTouched with the user_touched field.
1436
	 *
1437
	 * @param DatabaseBase $db
1438
	 * @param array $conditions WHERE conditions for use with DatabaseBase::update
1439
	 * @return array WHERE conditions for use with DatabaseBase::update
1440
	 */
1441
	protected function makeUpdateConditions( DatabaseBase $db, array $conditions ) {
1442
		if ( $this->mTouched ) {
1443
			// CAS check: only update if the row wasn't changed sicne it was loaded.
1444
			$conditions['user_touched'] = $db->timestamp( $this->mTouched );
1445
		}
1446
1447
		return $conditions;
1448
	}
1449
1450
	/**
1451
	 * Bump user_touched if it didn't change since this object was loaded
1452
	 *
1453
	 * On success, the mTouched field is updated.
1454
	 * The user serialization cache is always cleared.
1455
	 *
1456
	 * @return bool Whether user_touched was actually updated
1457
	 * @since 1.26
1458
	 */
1459
	protected function checkAndSetTouched() {
1460
		$this->load();
1461
1462
		if ( !$this->mId ) {
1463
			return false; // anon
1464
		}
1465
1466
		// Get a new user_touched that is higher than the old one
1467
		$newTouched = $this->newTouchedTimestamp();
1468
1469
		$dbw = wfGetDB( DB_MASTER );
1470
		$dbw->update( 'user',
1471
			[ 'user_touched' => $dbw->timestamp( $newTouched ) ],
1472
			$this->makeUpdateConditions( $dbw, [
1473
				'user_id' => $this->mId,
1474
			] ),
1475
			__METHOD__
1476
		);
1477
		$success = ( $dbw->affectedRows() > 0 );
1478
1479
		if ( $success ) {
1480
			$this->mTouched = $newTouched;
0 ignored issues
show
Documentation Bug introduced by
It seems like $newTouched can also be of type false. However, the property $mTouched is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
1481
			$this->clearSharedCache();
1482
		} else {
1483
			// Clears on failure too since that is desired if the cache is stale
1484
			$this->clearSharedCache( 'refresh' );
1485
		}
1486
1487
		return $success;
1488
	}
1489
1490
	/**
1491
	 * Clear various cached data stored in this object. The cache of the user table
1492
	 * data (i.e. self::$mCacheVars) is not cleared unless $reloadFrom is given.
1493
	 *
1494
	 * @param bool|string $reloadFrom Reload user and user_groups table data from a
1495
	 *   given source. May be "name", "id", "defaults", "session", or false for no reload.
1496
	 */
1497
	public function clearInstanceCache( $reloadFrom = false ) {
1498
		$this->mNewtalk = -1;
1499
		$this->mDatePreference = null;
1500
		$this->mBlockedby = -1; # Unset
0 ignored issues
show
Documentation Bug introduced by
The property $mBlockedby was declared of type string, but -1 is of type integer. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
1501
		$this->mHash = false;
0 ignored issues
show
Documentation Bug introduced by
The property $mHash was declared of type string, but false is of type false. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
1502
		$this->mRights = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mRights.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1503
		$this->mEffectiveGroups = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mEffectiveGroups.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1504
		$this->mImplicitGroups = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mImplicitGroups.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1505
		$this->mGroups = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mGroups.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1506
		$this->mOptions = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mOptions.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
1507
		$this->mOptionsLoaded = false;
1508
		$this->mEditCount = null;
1509
1510
		if ( $reloadFrom ) {
1511
			$this->mLoadedItems = [];
1512
			$this->mFrom = $reloadFrom;
1513
		}
1514
	}
1515
1516
	/**
1517
	 * Combine the language default options with any site-specific options
1518
	 * and add the default language variants.
1519
	 *
1520
	 * @return array Array of String options
1521
	 */
1522
	public static function getDefaultOptions() {
1523
		global $wgNamespacesToBeSearchedDefault, $wgDefaultUserOptions, $wgContLang, $wgDefaultSkin;
1524
1525
		static $defOpt = null;
1526
		static $defOptLang = null;
1527
1528
		if ( $defOpt !== null && $defOptLang === $wgContLang->getCode() ) {
1529
			// $wgContLang does not change (and should not change) mid-request,
1530
			// but the unit tests change it anyway, and expect this method to
1531
			// return values relevant to the current $wgContLang.
1532
			return $defOpt;
1533
		}
1534
1535
		$defOpt = $wgDefaultUserOptions;
1536
		// Default language setting
1537
		$defOptLang = $wgContLang->getCode();
1538
		$defOpt['language'] = $defOptLang;
1539
		foreach ( LanguageConverter::$languagesWithVariants as $langCode ) {
1540
			$defOpt[$langCode == $wgContLang->getCode() ? 'variant' : "variant-$langCode"] = $langCode;
1541
		}
1542
1543
		// NOTE: don't use SearchEngineConfig::getSearchableNamespaces here,
1544
		// since extensions may change the set of searchable namespaces depending
1545
		// on user groups/permissions.
1546
		foreach ( $wgNamespacesToBeSearchedDefault as $nsnum => $val ) {
1547
			$defOpt['searchNs' . $nsnum] = (boolean)$val;
1548
		}
1549
		$defOpt['skin'] = Skin::normalizeKey( $wgDefaultSkin );
1550
1551
		Hooks::run( 'UserGetDefaultOptions', [ &$defOpt ] );
1552
1553
		return $defOpt;
1554
	}
1555
1556
	/**
1557
	 * Get a given default option value.
1558
	 *
1559
	 * @param string $opt Name of option to retrieve
1560
	 * @return string Default option value
1561
	 */
1562
	public static function getDefaultOption( $opt ) {
1563
		$defOpts = self::getDefaultOptions();
1564
		if ( isset( $defOpts[$opt] ) ) {
1565
			return $defOpts[$opt];
1566
		} else {
1567
			return null;
1568
		}
1569
	}
1570
1571
	/**
1572
	 * Get blocking information
1573
	 * @param bool $bFromSlave Whether to check the replica DB first.
1574
	 *   To improve performance, non-critical checks are done against replica DBs.
1575
	 *   Check when actually saving should be done against master.
1576
	 */
1577
	private function getBlockedStatus( $bFromSlave = true ) {
1578
		global $wgProxyWhitelist, $wgUser, $wgApplyIpBlocksToXff;
1579
1580
		if ( -1 != $this->mBlockedby ) {
1581
			return;
1582
		}
1583
1584
		wfDebug( __METHOD__ . ": checking...\n" );
1585
1586
		// Initialize data...
1587
		// Otherwise something ends up stomping on $this->mBlockedby when
1588
		// things get lazy-loaded later, causing false positive block hits
1589
		// due to -1 !== 0. Probably session-related... Nothing should be
1590
		// overwriting mBlockedby, surely?
1591
		$this->load();
1592
1593
		# We only need to worry about passing the IP address to the Block generator if the
1594
		# user is not immune to autoblocks/hardblocks, and they are the current user so we
1595
		# know which IP address they're actually coming from
1596
		$ip = null;
1597
		if ( !$this->isAllowed( 'ipblock-exempt' ) ) {
1598
			// $wgUser->getName() only works after the end of Setup.php. Until
1599
			// then, assume it's a logged-out user.
1600
			$globalUserName = $wgUser->isSafeToLoad()
1601
				? $wgUser->getName()
1602
				: IP::sanitizeIP( $wgUser->getRequest()->getIP() );
1603
			if ( $this->getName() === $globalUserName ) {
1604
				$ip = $this->getRequest()->getIP();
1605
			}
1606
		}
1607
1608
		// User/IP blocking
1609
		$block = Block::newFromTarget( $this, $ip, !$bFromSlave );
1610
1611
		// Proxy blocking
1612
		if ( !$block instanceof Block && $ip !== null && !in_array( $ip, $wgProxyWhitelist ) ) {
1613
			// Local list
1614
			if ( self::isLocallyBlockedProxy( $ip ) ) {
1615
				$block = new Block;
1616
				$block->setBlocker( wfMessage( 'proxyblocker' )->text() );
1617
				$block->mReason = wfMessage( 'proxyblockreason' )->text();
1618
				$block->setTarget( $ip );
1619
			} elseif ( $this->isAnon() && $this->isDnsBlacklisted( $ip ) ) {
1620
				$block = new Block;
1621
				$block->setBlocker( wfMessage( 'sorbs' )->text() );
1622
				$block->mReason = wfMessage( 'sorbsreason' )->text();
1623
				$block->setTarget( $ip );
1624
			}
1625
		}
1626
1627
		// (bug 23343) Apply IP blocks to the contents of XFF headers, if enabled
1628
		if ( !$block instanceof Block
1629
			&& $wgApplyIpBlocksToXff
1630
			&& $ip !== null
1631
			&& !in_array( $ip, $wgProxyWhitelist )
1632
		) {
1633
			$xff = $this->getRequest()->getHeader( 'X-Forwarded-For' );
1634
			$xff = array_map( 'trim', explode( ',', $xff ) );
1635
			$xff = array_diff( $xff, [ $ip ] );
1636
			$xffblocks = Block::getBlocksForIPList( $xff, $this->isAnon(), !$bFromSlave );
1637
			$block = Block::chooseBlock( $xffblocks, $xff );
1638
			if ( $block instanceof Block ) {
1639
				# Mangle the reason to alert the user that the block
1640
				# originated from matching the X-Forwarded-For header.
1641
				$block->mReason = wfMessage( 'xffblockreason', $block->mReason )->text();
1642
			}
1643
		}
1644
1645
		if ( $block instanceof Block ) {
1646
			wfDebug( __METHOD__ . ": Found block.\n" );
1647
			$this->mBlock = $block;
1648
			$this->mBlockedby = $block->getByName();
1649
			$this->mBlockreason = $block->mReason;
1650
			$this->mHideName = $block->mHideName;
1651
			$this->mAllowUsertalk = !$block->prevents( 'editownusertalk' );
1652
		} else {
1653
			$this->mBlockedby = '';
1654
			$this->mHideName = 0;
0 ignored issues
show
Documentation Bug introduced by
The property $mHideName was declared of type boolean, but 0 is of type integer. Maybe add a type cast?

This check looks for assignments to scalar types that may be of the wrong type.

To ensure the code behaves as expected, it may be a good idea to add an explicit type cast.

$answer = 42;

$correct = false;

$correct = (bool) $answer;
Loading history...
1655
			$this->mAllowUsertalk = false;
1656
		}
1657
1658
		// Extensions
1659
		Hooks::run( 'GetBlockedStatus', [ &$this ] );
1660
1661
	}
1662
1663
	/**
1664
	 * Whether the given IP is in a DNS blacklist.
1665
	 *
1666
	 * @param string $ip IP to check
1667
	 * @param bool $checkWhitelist Whether to check the whitelist first
1668
	 * @return bool True if blacklisted.
1669
	 */
1670
	public function isDnsBlacklisted( $ip, $checkWhitelist = false ) {
1671
		global $wgEnableDnsBlacklist, $wgDnsBlacklistUrls, $wgProxyWhitelist;
1672
1673
		if ( !$wgEnableDnsBlacklist ) {
1674
			return false;
1675
		}
1676
1677
		if ( $checkWhitelist && in_array( $ip, $wgProxyWhitelist ) ) {
1678
			return false;
1679
		}
1680
1681
		return $this->inDnsBlacklist( $ip, $wgDnsBlacklistUrls );
1682
	}
1683
1684
	/**
1685
	 * Whether the given IP is in a given DNS blacklist.
1686
	 *
1687
	 * @param string $ip IP to check
1688
	 * @param string|array $bases Array of Strings: URL of the DNS blacklist
1689
	 * @return bool True if blacklisted.
1690
	 */
1691
	public function inDnsBlacklist( $ip, $bases ) {
1692
1693
		$found = false;
1694
		// @todo FIXME: IPv6 ???  (http://bugs.php.net/bug.php?id=33170)
1695
		if ( IP::isIPv4( $ip ) ) {
1696
			// Reverse IP, bug 21255
1697
			$ipReversed = implode( '.', array_reverse( explode( '.', $ip ) ) );
1698
1699
			foreach ( (array)$bases as $base ) {
1700
				// Make hostname
1701
				// If we have an access key, use that too (ProjectHoneypot, etc.)
1702
				$basename = $base;
1703
				if ( is_array( $base ) ) {
1704
					if ( count( $base ) >= 2 ) {
1705
						// Access key is 1, base URL is 0
1706
						$host = "{$base[1]}.$ipReversed.{$base[0]}";
1707
					} else {
1708
						$host = "$ipReversed.{$base[0]}";
1709
					}
1710
					$basename = $base[0];
1711
				} else {
1712
					$host = "$ipReversed.$base";
1713
				}
1714
1715
				// Send query
1716
				$ipList = gethostbynamel( $host );
1717
1718
				if ( $ipList ) {
1719
					wfDebugLog( 'dnsblacklist', "Hostname $host is {$ipList[0]}, it's a proxy says $basename!" );
1720
					$found = true;
1721
					break;
1722
				} else {
1723
					wfDebugLog( 'dnsblacklist', "Requested $host, not found in $basename." );
1724
				}
1725
			}
1726
		}
1727
1728
		return $found;
1729
	}
1730
1731
	/**
1732
	 * Check if an IP address is in the local proxy list
1733
	 *
1734
	 * @param string $ip
1735
	 *
1736
	 * @return bool
1737
	 */
1738
	public static function isLocallyBlockedProxy( $ip ) {
1739
		global $wgProxyList;
1740
1741
		if ( !$wgProxyList ) {
1742
			return false;
1743
		}
1744
1745
		if ( !is_array( $wgProxyList ) ) {
1746
			// Load from the specified file
1747
			$wgProxyList = array_map( 'trim', file( $wgProxyList ) );
1748
		}
1749
1750
		if ( !is_array( $wgProxyList ) ) {
1751
			$ret = false;
1752
		} elseif ( array_search( $ip, $wgProxyList ) !== false ) {
1753
			$ret = true;
1754
		} elseif ( array_key_exists( $ip, $wgProxyList ) ) {
1755
			// Old-style flipped proxy list
1756
			$ret = true;
1757
		} else {
1758
			$ret = false;
1759
		}
1760
		return $ret;
1761
	}
1762
1763
	/**
1764
	 * Is this user subject to rate limiting?
1765
	 *
1766
	 * @return bool True if rate limited
1767
	 */
1768
	public function isPingLimitable() {
1769
		global $wgRateLimitsExcludedIPs;
1770
		if ( in_array( $this->getRequest()->getIP(), $wgRateLimitsExcludedIPs ) ) {
1771
			// No other good way currently to disable rate limits
1772
			// for specific IPs. :P
1773
			// But this is a crappy hack and should die.
1774
			return false;
1775
		}
1776
		return !$this->isAllowed( 'noratelimit' );
1777
	}
1778
1779
	/**
1780
	 * Primitive rate limits: enforce maximum actions per time period
1781
	 * to put a brake on flooding.
1782
	 *
1783
	 * The method generates both a generic profiling point and a per action one
1784
	 * (suffix being "-$action".
1785
	 *
1786
	 * @note When using a shared cache like memcached, IP-address
1787
	 * last-hit counters will be shared across wikis.
1788
	 *
1789
	 * @param string $action Action to enforce; 'edit' if unspecified
1790
	 * @param int $incrBy Positive amount to increment counter by [defaults to 1]
1791
	 * @return bool True if a rate limiter was tripped
1792
	 */
1793
	public function pingLimiter( $action = 'edit', $incrBy = 1 ) {
1794
		// Call the 'PingLimiter' hook
1795
		$result = false;
1796
		if ( !Hooks::run( 'PingLimiter', [ &$this, $action, &$result, $incrBy ] ) ) {
1797
			return $result;
1798
		}
1799
1800
		global $wgRateLimits;
1801
		if ( !isset( $wgRateLimits[$action] ) ) {
1802
			return false;
1803
		}
1804
1805
		// Some groups shouldn't trigger the ping limiter, ever
1806
		if ( !$this->isPingLimitable() ) {
1807
			return false;
1808
		}
1809
1810
		$limits = $wgRateLimits[$action];
1811
		$keys = [];
1812
		$id = $this->getId();
1813
		$userLimit = false;
1814
		$isNewbie = $this->isNewbie();
1815
1816
		if ( $id == 0 ) {
1817
			// limits for anons
1818 View Code Duplication
			if ( isset( $limits['anon'] ) ) {
1819
				$keys[wfMemcKey( 'limiter', $action, 'anon' )] = $limits['anon'];
1820
			}
1821
		} else {
1822
			// limits for logged-in users
1823
			if ( isset( $limits['user'] ) ) {
1824
				$userLimit = $limits['user'];
1825
			}
1826
			// limits for newbie logged-in users
1827 View Code Duplication
			if ( $isNewbie && isset( $limits['newbie'] ) ) {
1828
				$keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $limits['newbie'];
1829
			}
1830
		}
1831
1832
		// limits for anons and for newbie logged-in users
1833
		if ( $isNewbie ) {
1834
			// ip-based limits
1835
			if ( isset( $limits['ip'] ) ) {
1836
				$ip = $this->getRequest()->getIP();
1837
				$keys["mediawiki:limiter:$action:ip:$ip"] = $limits['ip'];
1838
			}
1839
			// subnet-based limits
1840
			if ( isset( $limits['subnet'] ) ) {
1841
				$ip = $this->getRequest()->getIP();
1842
				$subnet = IP::getSubnet( $ip );
1843
				if ( $subnet !== false ) {
1844
					$keys["mediawiki:limiter:$action:subnet:$subnet"] = $limits['subnet'];
1845
				}
1846
			}
1847
		}
1848
1849
		// Check for group-specific permissions
1850
		// If more than one group applies, use the group with the highest limit ratio (max/period)
1851
		foreach ( $this->getGroups() as $group ) {
1852
			if ( isset( $limits[$group] ) ) {
1853
				if ( $userLimit === false
1854
					|| $limits[$group][0] / $limits[$group][1] > $userLimit[0] / $userLimit[1]
1855
				) {
1856
					$userLimit = $limits[$group];
1857
				}
1858
			}
1859
		}
1860
1861
		// Set the user limit key
1862
		if ( $userLimit !== false ) {
1863
			list( $max, $period ) = $userLimit;
1864
			wfDebug( __METHOD__ . ": effective user limit: $max in {$period}s\n" );
1865
			$keys[wfMemcKey( 'limiter', $action, 'user', $id )] = $userLimit;
1866
		}
1867
1868
		// ip-based limits for all ping-limitable users
1869
		if ( isset( $limits['ip-all'] ) ) {
1870
			$ip = $this->getRequest()->getIP();
1871
			// ignore if user limit is more permissive
1872 View Code Duplication
			if ( $isNewbie || $userLimit === false
1873
				|| $limits['ip-all'][0] / $limits['ip-all'][1] > $userLimit[0] / $userLimit[1] ) {
1874
				$keys["mediawiki:limiter:$action:ip-all:$ip"] = $limits['ip-all'];
1875
			}
1876
		}
1877
1878
		// subnet-based limits for all ping-limitable users
1879
		if ( isset( $limits['subnet-all'] ) ) {
1880
			$ip = $this->getRequest()->getIP();
1881
			$subnet = IP::getSubnet( $ip );
1882 View Code Duplication
			if ( $subnet !== false ) {
1883
				// ignore if user limit is more permissive
1884
				if ( $isNewbie || $userLimit === false
1885
					|| $limits['ip-all'][0] / $limits['ip-all'][1]
1886
					> $userLimit[0] / $userLimit[1] ) {
1887
					$keys["mediawiki:limiter:$action:subnet-all:$subnet"] = $limits['subnet-all'];
1888
				}
1889
			}
1890
		}
1891
1892
		$cache = ObjectCache::getLocalClusterInstance();
1893
1894
		$triggered = false;
1895
		foreach ( $keys as $key => $limit ) {
1896
			list( $max, $period ) = $limit;
1897
			$summary = "(limit $max in {$period}s)";
1898
			$count = $cache->get( $key );
1899
			// Already pinged?
1900
			if ( $count ) {
1901
				if ( $count >= $max ) {
1902
					wfDebugLog( 'ratelimit', "User '{$this->getName()}' " .
1903
						"(IP {$this->getRequest()->getIP()}) tripped $key at $count $summary" );
1904
					$triggered = true;
1905
				} else {
1906
					wfDebug( __METHOD__ . ": ok. $key at $count $summary\n" );
1907
				}
1908
			} else {
1909
				wfDebug( __METHOD__ . ": adding record for $key $summary\n" );
1910
				if ( $incrBy > 0 ) {
1911
					$cache->add( $key, 0, intval( $period ) ); // first ping
1912
				}
1913
			}
1914
			if ( $incrBy > 0 ) {
1915
				$cache->incr( $key, $incrBy );
1916
			}
1917
		}
1918
1919
		return $triggered;
1920
	}
1921
1922
	/**
1923
	 * Check if user is blocked
1924
	 *
1925
	 * @param bool $bFromSlave Whether to check the replica DB instead of
1926
	 *   the master. Hacked from false due to horrible probs on site.
1927
	 * @return bool True if blocked, false otherwise
1928
	 */
1929
	public function isBlocked( $bFromSlave = true ) {
1930
		return $this->getBlock( $bFromSlave ) instanceof Block && $this->getBlock()->prevents( 'edit' );
1931
	}
1932
1933
	/**
1934
	 * Get the block affecting the user, or null if the user is not blocked
1935
	 *
1936
	 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1937
	 * @return Block|null
1938
	 */
1939
	public function getBlock( $bFromSlave = true ) {
1940
		$this->getBlockedStatus( $bFromSlave );
1941
		return $this->mBlock instanceof Block ? $this->mBlock : null;
1942
	}
1943
1944
	/**
1945
	 * Check if user is blocked from editing a particular article
1946
	 *
1947
	 * @param Title $title Title to check
1948
	 * @param bool $bFromSlave Whether to check the replica DB instead of the master
1949
	 * @return bool
1950
	 */
1951
	public function isBlockedFrom( $title, $bFromSlave = false ) {
1952
		global $wgBlockAllowsUTEdit;
1953
1954
		$blocked = $this->isBlocked( $bFromSlave );
1955
		$allowUsertalk = ( $wgBlockAllowsUTEdit ? $this->mAllowUsertalk : false );
1956
		// If a user's name is suppressed, they cannot make edits anywhere
1957
		if ( !$this->mHideName && $allowUsertalk && $title->getText() === $this->getName()
1958
			&& $title->getNamespace() == NS_USER_TALK ) {
1959
			$blocked = false;
1960
			wfDebug( __METHOD__ . ": self-talk page, ignoring any blocks\n" );
1961
		}
1962
1963
		Hooks::run( 'UserIsBlockedFrom', [ $this, $title, &$blocked, &$allowUsertalk ] );
1964
1965
		return $blocked;
1966
	}
1967
1968
	/**
1969
	 * If user is blocked, return the name of the user who placed the block
1970
	 * @return string Name of blocker
1971
	 */
1972
	public function blockedBy() {
1973
		$this->getBlockedStatus();
1974
		return $this->mBlockedby;
1975
	}
1976
1977
	/**
1978
	 * If user is blocked, return the specified reason for the block
1979
	 * @return string Blocking reason
1980
	 */
1981
	public function blockedFor() {
1982
		$this->getBlockedStatus();
1983
		return $this->mBlockreason;
1984
	}
1985
1986
	/**
1987
	 * If user is blocked, return the ID for the block
1988
	 * @return int Block ID
1989
	 */
1990
	public function getBlockId() {
1991
		$this->getBlockedStatus();
1992
		return ( $this->mBlock ? $this->mBlock->getId() : false );
1993
	}
1994
1995
	/**
1996
	 * Check if user is blocked on all wikis.
1997
	 * Do not use for actual edit permission checks!
1998
	 * This is intended for quick UI checks.
1999
	 *
2000
	 * @param string $ip IP address, uses current client if none given
2001
	 * @return bool True if blocked, false otherwise
2002
	 */
2003
	public function isBlockedGlobally( $ip = '' ) {
2004
		return $this->getGlobalBlock( $ip ) instanceof Block;
2005
	}
2006
2007
	/**
2008
	 * Check if user is blocked on all wikis.
2009
	 * Do not use for actual edit permission checks!
2010
	 * This is intended for quick UI checks.
2011
	 *
2012
	 * @param string $ip IP address, uses current client if none given
2013
	 * @return Block|null Block object if blocked, null otherwise
2014
	 * @throws FatalError
2015
	 * @throws MWException
2016
	 */
2017
	public function getGlobalBlock( $ip = '' ) {
2018
		if ( $this->mGlobalBlock !== null ) {
2019
			return $this->mGlobalBlock ?: null;
2020
		}
2021
		// User is already an IP?
2022
		if ( IP::isIPAddress( $this->getName() ) ) {
2023
			$ip = $this->getName();
2024
		} elseif ( !$ip ) {
2025
			$ip = $this->getRequest()->getIP();
2026
		}
2027
		$blocked = false;
2028
		$block = null;
2029
		Hooks::run( 'UserIsBlockedGlobally', [ &$this, $ip, &$blocked, &$block ] );
2030
2031
		if ( $blocked && $block === null ) {
2032
			// back-compat: UserIsBlockedGlobally didn't have $block param first
2033
			$block = new Block;
2034
			$block->setTarget( $ip );
2035
		}
2036
2037
		$this->mGlobalBlock = $blocked ? $block : false;
0 ignored issues
show
Documentation Bug introduced by
It seems like $blocked ? $block : false can also be of type false. However, the property $mGlobalBlock is declared as type object<Block>. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
2038
		return $this->mGlobalBlock ?: null;
2039
	}
2040
2041
	/**
2042
	 * Check if user account is locked
2043
	 *
2044
	 * @return bool True if locked, false otherwise
2045
	 */
2046 View Code Duplication
	public function isLocked() {
2047
		if ( $this->mLocked !== null ) {
2048
			return $this->mLocked;
2049
		}
2050
		$authUser = AuthManager::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2051
		$this->mLocked = $authUser && $authUser->isLocked();
2052
		Hooks::run( 'UserIsLocked', [ $this, &$this->mLocked ] );
2053
		return $this->mLocked;
2054
	}
2055
2056
	/**
2057
	 * Check if user account is hidden
2058
	 *
2059
	 * @return bool True if hidden, false otherwise
2060
	 */
2061 View Code Duplication
	public function isHidden() {
2062
		if ( $this->mHideName !== null ) {
2063
			return $this->mHideName;
2064
		}
2065
		$this->getBlockedStatus();
2066
		if ( !$this->mHideName ) {
2067
			$authUser = AuthManager::callLegacyAuthPlugin( 'getUserInstance', [ &$this ], null );
2068
			$this->mHideName = $authUser && $authUser->isHidden();
2069
			Hooks::run( 'UserIsHidden', [ $this, &$this->mHideName ] );
2070
		}
2071
		return $this->mHideName;
2072
	}
2073
2074
	/**
2075
	 * Get the user's ID.
2076
	 * @return int The user's ID; 0 if the user is anonymous or nonexistent
2077
	 */
2078
	public function getId() {
2079
		if ( $this->mId === null && $this->mName !== null && User::isIP( $this->mName ) ) {
2080
			// Special case, we know the user is anonymous
2081
			return 0;
2082
		} elseif ( !$this->isItemLoaded( 'id' ) ) {
2083
			// Don't load if this was initialized from an ID
2084
			$this->load();
2085
		}
2086
2087
		return (int)$this->mId;
2088
	}
2089
2090
	/**
2091
	 * Set the user and reload all fields according to a given ID
2092
	 * @param int $v User ID to reload
2093
	 */
2094
	public function setId( $v ) {
2095
		$this->mId = $v;
2096
		$this->clearInstanceCache( 'id' );
2097
	}
2098
2099
	/**
2100
	 * Get the user name, or the IP of an anonymous user
2101
	 * @return string User's name or IP address
2102
	 */
2103
	public function getName() {
2104
		if ( $this->isItemLoaded( 'name', 'only' ) ) {
2105
			// Special case optimisation
2106
			return $this->mName;
2107
		} else {
2108
			$this->load();
2109
			if ( $this->mName === false ) {
2110
				// Clean up IPs
2111
				$this->mName = IP::sanitizeIP( $this->getRequest()->getIP() );
2112
			}
2113
			return $this->mName;
2114
		}
2115
	}
2116
2117
	/**
2118
	 * Set the user name.
2119
	 *
2120
	 * This does not reload fields from the database according to the given
2121
	 * name. Rather, it is used to create a temporary "nonexistent user" for
2122
	 * later addition to the database. It can also be used to set the IP
2123
	 * address for an anonymous user to something other than the current
2124
	 * remote IP.
2125
	 *
2126
	 * @note User::newFromName() has roughly the same function, when the named user
2127
	 * does not exist.
2128
	 * @param string $str New user name to set
2129
	 */
2130
	public function setName( $str ) {
2131
		$this->load();
2132
		$this->mName = $str;
2133
	}
2134
2135
	/**
2136
	 * Get the user's name escaped by underscores.
2137
	 * @return string Username escaped by underscores.
2138
	 */
2139
	public function getTitleKey() {
2140
		return str_replace( ' ', '_', $this->getName() );
2141
	}
2142
2143
	/**
2144
	 * Check if the user has new messages.
2145
	 * @return bool True if the user has new messages
2146
	 */
2147
	public function getNewtalk() {
2148
		$this->load();
2149
2150
		// Load the newtalk status if it is unloaded (mNewtalk=-1)
2151
		if ( $this->mNewtalk === -1 ) {
2152
			$this->mNewtalk = false; # reset talk page status
2153
2154
			// Check memcached separately for anons, who have no
2155
			// entire User object stored in there.
2156
			if ( !$this->mId ) {
2157
				global $wgDisableAnonTalk;
2158
				if ( $wgDisableAnonTalk ) {
2159
					// Anon newtalk disabled by configuration.
2160
					$this->mNewtalk = false;
2161
				} else {
2162
					$this->mNewtalk = $this->checkNewtalk( 'user_ip', $this->getName() );
2163
				}
2164
			} else {
2165
				$this->mNewtalk = $this->checkNewtalk( 'user_id', $this->mId );
2166
			}
2167
		}
2168
2169
		return (bool)$this->mNewtalk;
2170
	}
2171
2172
	/**
2173
	 * Return the data needed to construct links for new talk page message
2174
	 * alerts. If there are new messages, this will return an associative array
2175
	 * with the following data:
2176
	 *     wiki: The database name of the wiki
2177
	 *     link: Root-relative link to the user's talk page
2178
	 *     rev: The last talk page revision that the user has seen or null. This
2179
	 *         is useful for building diff links.
2180
	 * If there are no new messages, it returns an empty array.
2181
	 * @note This function was designed to accomodate multiple talk pages, but
2182
	 * currently only returns a single link and revision.
2183
	 * @return array
2184
	 */
2185
	public function getNewMessageLinks() {
2186
		$talks = [];
2187
		if ( !Hooks::run( 'UserRetrieveNewTalks', [ &$this, &$talks ] ) ) {
2188
			return $talks;
2189
		} elseif ( !$this->getNewtalk() ) {
2190
			return [];
2191
		}
2192
		$utp = $this->getTalkPage();
2193
		$dbr = wfGetDB( DB_REPLICA );
2194
		// Get the "last viewed rev" timestamp from the oldest message notification
2195
		$timestamp = $dbr->selectField( 'user_newtalk',
2196
			'MIN(user_last_timestamp)',
2197
			$this->isAnon() ? [ 'user_ip' => $this->getName() ] : [ 'user_id' => $this->getId() ],
2198
			__METHOD__ );
2199
		$rev = $timestamp ? Revision::loadFromTimestamp( $dbr, $utp, $timestamp ) : null;
2200
		return [ [ 'wiki' => wfWikiID(), 'link' => $utp->getLocalURL(), 'rev' => $rev ] ];
2201
	}
2202
2203
	/**
2204
	 * Get the revision ID for the last talk page revision viewed by the talk
2205
	 * page owner.
2206
	 * @return int|null Revision ID or null
2207
	 */
2208
	public function getNewMessageRevisionId() {
2209
		$newMessageRevisionId = null;
2210
		$newMessageLinks = $this->getNewMessageLinks();
2211
		if ( $newMessageLinks ) {
2212
			// Note: getNewMessageLinks() never returns more than a single link
2213
			// and it is always for the same wiki, but we double-check here in
2214
			// case that changes some time in the future.
2215
			if ( count( $newMessageLinks ) === 1
2216
				&& $newMessageLinks[0]['wiki'] === wfWikiID()
2217
				&& $newMessageLinks[0]['rev']
2218
			) {
2219
				/** @var Revision $newMessageRevision */
2220
				$newMessageRevision = $newMessageLinks[0]['rev'];
2221
				$newMessageRevisionId = $newMessageRevision->getId();
2222
			}
2223
		}
2224
		return $newMessageRevisionId;
2225
	}
2226
2227
	/**
2228
	 * Internal uncached check for new messages
2229
	 *
2230
	 * @see getNewtalk()
2231
	 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2232
	 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2233
	 * @return bool True if the user has new messages
2234
	 */
2235
	protected function checkNewtalk( $field, $id ) {
2236
		$dbr = wfGetDB( DB_REPLICA );
2237
2238
		$ok = $dbr->selectField( 'user_newtalk', $field, [ $field => $id ], __METHOD__ );
2239
2240
		return $ok !== false;
2241
	}
2242
2243
	/**
2244
	 * Add or update the new messages flag
2245
	 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2246
	 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2247
	 * @param Revision|null $curRev New, as yet unseen revision of the user talk page. Ignored if null.
2248
	 * @return bool True if successful, false otherwise
2249
	 */
2250
	protected function updateNewtalk( $field, $id, $curRev = null ) {
2251
		// Get timestamp of the talk page revision prior to the current one
2252
		$prevRev = $curRev ? $curRev->getPrevious() : false;
2253
		$ts = $prevRev ? $prevRev->getTimestamp() : null;
2254
		// Mark the user as having new messages since this revision
2255
		$dbw = wfGetDB( DB_MASTER );
2256
		$dbw->insert( 'user_newtalk',
2257
			[ $field => $id, 'user_last_timestamp' => $dbw->timestampOrNull( $ts ) ],
2258
			__METHOD__,
2259
			'IGNORE' );
2260 View Code Duplication
		if ( $dbw->affectedRows() ) {
2261
			wfDebug( __METHOD__ . ": set on ($field, $id)\n" );
2262
			return true;
2263
		} else {
2264
			wfDebug( __METHOD__ . " already set ($field, $id)\n" );
2265
			return false;
2266
		}
2267
	}
2268
2269
	/**
2270
	 * Clear the new messages flag for the given user
2271
	 * @param string $field 'user_ip' for anonymous users, 'user_id' otherwise
2272
	 * @param string|int $id User's IP address for anonymous users, User ID otherwise
2273
	 * @return bool True if successful, false otherwise
2274
	 */
2275
	protected function deleteNewtalk( $field, $id ) {
2276
		$dbw = wfGetDB( DB_MASTER );
2277
		$dbw->delete( 'user_newtalk',
2278
			[ $field => $id ],
2279
			__METHOD__ );
2280 View Code Duplication
		if ( $dbw->affectedRows() ) {
2281
			wfDebug( __METHOD__ . ": killed on ($field, $id)\n" );
2282
			return true;
2283
		} else {
2284
			wfDebug( __METHOD__ . ": already gone ($field, $id)\n" );
2285
			return false;
2286
		}
2287
	}
2288
2289
	/**
2290
	 * Update the 'You have new messages!' status.
2291
	 * @param bool $val Whether the user has new messages
2292
	 * @param Revision $curRev New, as yet unseen revision of the user talk
2293
	 *   page. Ignored if null or !$val.
2294
	 */
2295
	public function setNewtalk( $val, $curRev = null ) {
2296
		if ( wfReadOnly() ) {
2297
			return;
2298
		}
2299
2300
		$this->load();
2301
		$this->mNewtalk = $val;
2302
2303
		if ( $this->isAnon() ) {
2304
			$field = 'user_ip';
2305
			$id = $this->getName();
2306
		} else {
2307
			$field = 'user_id';
2308
			$id = $this->getId();
2309
		}
2310
2311
		if ( $val ) {
2312
			$changed = $this->updateNewtalk( $field, $id, $curRev );
2313
		} else {
2314
			$changed = $this->deleteNewtalk( $field, $id );
2315
		}
2316
2317
		if ( $changed ) {
2318
			$this->invalidateCache();
2319
		}
2320
	}
2321
2322
	/**
2323
	 * Generate a current or new-future timestamp to be stored in the
2324
	 * user_touched field when we update things.
2325
	 * @return string Timestamp in TS_MW format
2326
	 */
2327
	private function newTouchedTimestamp() {
2328
		global $wgClockSkewFudge;
2329
2330
		$time = wfTimestamp( TS_MW, time() + $wgClockSkewFudge );
2331
		if ( $this->mTouched && $time <= $this->mTouched ) {
2332
			$time = wfTimestamp( TS_MW, wfTimestamp( TS_UNIX, $this->mTouched ) + 1 );
2333
		}
2334
2335
		return $time;
2336
	}
2337
2338
	/**
2339
	 * Clear user data from memcached
2340
	 *
2341
	 * Use after applying updates to the database; caller's
2342
	 * responsibility to update user_touched if appropriate.
2343
	 *
2344
	 * Called implicitly from invalidateCache() and saveSettings().
2345
	 *
2346
	 * @param string $mode Use 'refresh' to clear now; otherwise before DB commit
2347
	 */
2348
	public function clearSharedCache( $mode = 'changed' ) {
2349
		if ( !$this->getId() ) {
2350
			return;
2351
		}
2352
2353
		$cache = ObjectCache::getMainWANInstance();
2354
		$key = $this->getCacheKey( $cache );
2355
		if ( $mode === 'refresh' ) {
2356
			$cache->delete( $key, 1 );
2357
		} else {
2358
			wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle(
2359
				function() use ( $cache, $key ) {
2360
					$cache->delete( $key );
2361
				}
2362
			);
2363
		}
2364
	}
2365
2366
	/**
2367
	 * Immediately touch the user data cache for this account
2368
	 *
2369
	 * Calls touch() and removes account data from memcached
2370
	 */
2371
	public function invalidateCache() {
2372
		$this->touch();
2373
		$this->clearSharedCache();
2374
	}
2375
2376
	/**
2377
	 * Update the "touched" timestamp for the user
2378
	 *
2379
	 * This is useful on various login/logout events when making sure that
2380
	 * a browser or proxy that has multiple tenants does not suffer cache
2381
	 * pollution where the new user sees the old users content. The value
2382
	 * of getTouched() is checked when determining 304 vs 200 responses.
2383
	 * Unlike invalidateCache(), this preserves the User object cache and
2384
	 * avoids database writes.
2385
	 *
2386
	 * @since 1.25
2387
	 */
2388
	public function touch() {
2389
		$id = $this->getId();
2390
		if ( $id ) {
2391
			$key = wfMemcKey( 'user-quicktouched', 'id', $id );
2392
			ObjectCache::getMainWANInstance()->touchCheckKey( $key );
2393
			$this->mQuickTouched = null;
2394
		}
2395
	}
2396
2397
	/**
2398
	 * Validate the cache for this account.
2399
	 * @param string $timestamp A timestamp in TS_MW format
2400
	 * @return bool
2401
	 */
2402
	public function validateCache( $timestamp ) {
2403
		return ( $timestamp >= $this->getTouched() );
2404
	}
2405
2406
	/**
2407
	 * Get the user touched timestamp
2408
	 *
2409
	 * Use this value only to validate caches via inequalities
2410
	 * such as in the case of HTTP If-Modified-Since response logic
2411
	 *
2412
	 * @return string TS_MW Timestamp
2413
	 */
2414
	public function getTouched() {
2415
		$this->load();
2416
2417
		if ( $this->mId ) {
2418
			if ( $this->mQuickTouched === null ) {
2419
				$key = wfMemcKey( 'user-quicktouched', 'id', $this->mId );
2420
				$cache = ObjectCache::getMainWANInstance();
2421
2422
				$this->mQuickTouched = wfTimestamp( TS_MW, $cache->getCheckKeyTime( $key ) );
0 ignored issues
show
Documentation Bug introduced by
It seems like wfTimestamp(TS_MW, $cache->getCheckKeyTime($key)) can also be of type false. However, the property $mQuickTouched is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
2423
			}
2424
2425
			return max( $this->mTouched, $this->mQuickTouched );
2426
		}
2427
2428
		return $this->mTouched;
2429
	}
2430
2431
	/**
2432
	 * Get the user_touched timestamp field (time of last DB updates)
2433
	 * @return string TS_MW Timestamp
2434
	 * @since 1.26
2435
	 */
2436
	public function getDBTouched() {
2437
		$this->load();
2438
2439
		return $this->mTouched;
2440
	}
2441
2442
	/**
2443
	 * @deprecated Removed in 1.27.
2444
	 * @return Password
2445
	 * @since 1.24
2446
	 */
2447
	public function getPassword() {
2448
		throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2449
	}
2450
2451
	/**
2452
	 * @deprecated Removed in 1.27.
2453
	 * @return Password
2454
	 * @since 1.24
2455
	 */
2456
	public function getTemporaryPassword() {
2457
		throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2458
	}
2459
2460
	/**
2461
	 * Set the password and reset the random token.
2462
	 * Calls through to authentication plugin if necessary;
2463
	 * will have no effect if the auth plugin refuses to
2464
	 * pass the change through or if the legal password
2465
	 * checks fail.
2466
	 *
2467
	 * As a special case, setting the password to null
2468
	 * wipes it, so the account cannot be logged in until
2469
	 * a new password is set, for instance via e-mail.
2470
	 *
2471
	 * @deprecated since 1.27, use AuthManager instead
2472
	 * @param string $str New password to set
2473
	 * @throws PasswordError On failure
2474
	 * @return bool
2475
	 */
2476
	public function setPassword( $str ) {
2477
		return $this->setPasswordInternal( $str );
2478
	}
2479
2480
	/**
2481
	 * Set the password and reset the random token unconditionally.
2482
	 *
2483
	 * @deprecated since 1.27, use AuthManager instead
2484
	 * @param string|null $str New password to set or null to set an invalid
2485
	 *  password hash meaning that the user will not be able to log in
2486
	 *  through the web interface.
2487
	 */
2488
	public function setInternalPassword( $str ) {
2489
		$this->setPasswordInternal( $str );
2490
	}
2491
2492
	/**
2493
	 * Actually set the password and such
2494
	 * @since 1.27 cannot set a password for a user not in the database
2495
	 * @param string|null $str New password to set or null to set an invalid
2496
	 *  password hash meaning that the user will not be able to log in
2497
	 *  through the web interface.
2498
	 * @return bool Success
2499
	 */
2500
	private function setPasswordInternal( $str ) {
2501
		$manager = AuthManager::singleton();
2502
2503
		// If the user doesn't exist yet, fail
2504
		if ( !$manager->userExists( $this->getName() ) ) {
2505
			throw new LogicException( 'Cannot set a password for a user that is not in the database.' );
2506
		}
2507
2508
		$status = $this->changeAuthenticationData( [
2509
			'username' => $this->getName(),
2510
			'password' => $str,
2511
			'retype' => $str,
2512
		] );
2513
		if ( !$status->isGood() ) {
2514
			\MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
2515
				->info( __METHOD__ . ': Password change rejected: '
2516
					. $status->getWikiText( null, null, 'en' ) );
2517
			return false;
2518
		}
2519
2520
		$this->setOption( 'watchlisttoken', false );
2521
		SessionManager::singleton()->invalidateSessionsForUser( $this );
2522
2523
		return true;
2524
	}
2525
2526
	/**
2527
	 * Changes credentials of the user.
2528
	 *
2529
	 * This is a convenience wrapper around AuthManager::changeAuthenticationData.
2530
	 * Note that this can return a status that isOK() but not isGood() on certain types of failures,
2531
	 * e.g. when no provider handled the change.
2532
	 *
2533
	 * @param array $data A set of authentication data in fieldname => value format. This is the
2534
	 *   same data you would pass the changeauthenticationdata API - 'username', 'password' etc.
2535
	 * @return Status
2536
	 * @since 1.27
2537
	 */
2538
	public function changeAuthenticationData( array $data ) {
2539
		$manager = AuthManager::singleton();
2540
		$reqs = $manager->getAuthenticationRequests( AuthManager::ACTION_CHANGE, $this );
2541
		$reqs = AuthenticationRequest::loadRequestsFromSubmission( $reqs, $data );
2542
2543
		$status = Status::newGood( 'ignored' );
2544
		foreach ( $reqs as $req ) {
2545
			$status->merge( $manager->allowsAuthenticationDataChange( $req ), true );
2546
		}
2547
		if ( $status->getValue() === 'ignored' ) {
2548
			$status->warning( 'authenticationdatachange-ignored' );
2549
		}
2550
2551
		if ( $status->isGood() ) {
2552
			foreach ( $reqs as $req ) {
2553
				$manager->changeAuthenticationData( $req );
2554
			}
2555
		}
2556
		return $status;
2557
	}
2558
2559
	/**
2560
	 * Get the user's current token.
2561
	 * @param bool $forceCreation Force the generation of a new token if the
2562
	 *   user doesn't have one (default=true for backwards compatibility).
2563
	 * @return string|null Token
2564
	 */
2565
	public function getToken( $forceCreation = true ) {
2566
		global $wgAuthenticationTokenVersion;
2567
2568
		$this->load();
2569
		if ( !$this->mToken && $forceCreation ) {
2570
			$this->setToken();
2571
		}
2572
2573
		if ( !$this->mToken ) {
2574
			// The user doesn't have a token, return null to indicate that.
2575
			return null;
2576
		} elseif ( $this->mToken === self::INVALID_TOKEN ) {
2577
			// We return a random value here so existing token checks are very
2578
			// likely to fail.
2579
			return MWCryptRand::generateHex( self::TOKEN_LENGTH );
2580
		} elseif ( $wgAuthenticationTokenVersion === null ) {
2581
			// $wgAuthenticationTokenVersion not in use, so return the raw secret
2582
			return $this->mToken;
2583
		} else {
2584
			// $wgAuthenticationTokenVersion in use, so hmac it.
2585
			$ret = MWCryptHash::hmac( $wgAuthenticationTokenVersion, $this->mToken, false );
2586
2587
			// The raw hash can be overly long. Shorten it up.
2588
			$len = max( 32, self::TOKEN_LENGTH );
2589
			if ( strlen( $ret ) < $len ) {
2590
				// Should never happen, even md5 is 128 bits
2591
				throw new \UnexpectedValueException( 'Hmac returned less than 128 bits' );
2592
			}
2593
			return substr( $ret, -$len );
2594
		}
2595
	}
2596
2597
	/**
2598
	 * Set the random token (used for persistent authentication)
2599
	 * Called from loadDefaults() among other places.
2600
	 *
2601
	 * @param string|bool $token If specified, set the token to this value
2602
	 */
2603
	public function setToken( $token = false ) {
2604
		$this->load();
2605
		if ( $this->mToken === self::INVALID_TOKEN ) {
2606
			\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
2607
				->debug( __METHOD__ . ": Ignoring attempt to set token for system user \"$this\"" );
2608
		} elseif ( !$token ) {
2609
			$this->mToken = MWCryptRand::generateHex( self::TOKEN_LENGTH );
2610
		} else {
2611
			$this->mToken = $token;
0 ignored issues
show
Documentation Bug introduced by
It seems like $token can also be of type boolean. However, the property $mToken is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
2612
		}
2613
	}
2614
2615
	/**
2616
	 * Set the password for a password reminder or new account email
2617
	 *
2618
	 * @deprecated Removed in 1.27. Use PasswordReset instead.
2619
	 * @param string $str New password to set or null to set an invalid
2620
	 *  password hash meaning that the user will not be able to use it
2621
	 * @param bool $throttle If true, reset the throttle timestamp to the present
2622
	 */
2623
	public function setNewpassword( $str, $throttle = true ) {
2624
		throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2625
	}
2626
2627
	/**
2628
	 * Has password reminder email been sent within the last
2629
	 * $wgPasswordReminderResendTime hours?
2630
	 * @deprecated Removed in 1.27. See above.
2631
	 * @return bool
2632
	 */
2633
	public function isPasswordReminderThrottled() {
2634
		throw new BadMethodCallException( __METHOD__ . ' has been removed in 1.27' );
2635
	}
2636
2637
	/**
2638
	 * Get the user's e-mail address
2639
	 * @return string User's email address
2640
	 */
2641
	public function getEmail() {
2642
		$this->load();
2643
		Hooks::run( 'UserGetEmail', [ $this, &$this->mEmail ] );
2644
		return $this->mEmail;
2645
	}
2646
2647
	/**
2648
	 * Get the timestamp of the user's e-mail authentication
2649
	 * @return string TS_MW timestamp
2650
	 */
2651
	public function getEmailAuthenticationTimestamp() {
2652
		$this->load();
2653
		Hooks::run( 'UserGetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
2654
		return $this->mEmailAuthenticated;
2655
	}
2656
2657
	/**
2658
	 * Set the user's e-mail address
2659
	 * @param string $str New e-mail address
2660
	 */
2661
	public function setEmail( $str ) {
2662
		$this->load();
2663
		if ( $str == $this->mEmail ) {
2664
			return;
2665
		}
2666
		$this->invalidateEmail();
2667
		$this->mEmail = $str;
2668
		Hooks::run( 'UserSetEmail', [ $this, &$this->mEmail ] );
2669
	}
2670
2671
	/**
2672
	 * Set the user's e-mail address and a confirmation mail if needed.
2673
	 *
2674
	 * @since 1.20
2675
	 * @param string $str New e-mail address
2676
	 * @return Status
2677
	 */
2678
	public function setEmailWithConfirmation( $str ) {
2679
		global $wgEnableEmail, $wgEmailAuthentication;
2680
2681
		if ( !$wgEnableEmail ) {
2682
			return Status::newFatal( 'emaildisabled' );
2683
		}
2684
2685
		$oldaddr = $this->getEmail();
2686
		if ( $str === $oldaddr ) {
2687
			return Status::newGood( true );
2688
		}
2689
2690
		$type = $oldaddr != '' ? 'changed' : 'set';
2691
		$notificationResult = null;
2692
2693
		if ( $wgEmailAuthentication ) {
2694
			// Send the user an email notifying the user of the change in registered
2695
			// email address on their previous email address
2696
			if ( $type == 'changed' ) {
2697
				$change = $str != '' ? 'changed' : 'removed';
2698
				$notificationResult = $this->sendMail(
2699
					wfMessage( 'notificationemail_subject_' . $change )->text(),
2700
					wfMessage( 'notificationemail_body_' . $change,
2701
						$this->getRequest()->getIP(),
2702
						$this->getName(),
2703
						$str )->text()
2704
				);
2705
			}
2706
		}
2707
2708
		$this->setEmail( $str );
2709
2710
		if ( $str !== '' && $wgEmailAuthentication ) {
2711
			// Send a confirmation request to the new address if needed
2712
			$result = $this->sendConfirmationMail( $type );
2713
2714
			if ( $notificationResult !== null ) {
2715
				$result->merge( $notificationResult );
2716
			}
2717
2718
			if ( $result->isGood() ) {
2719
				// Say to the caller that a confirmation and notification mail has been sent
2720
				$result->value = 'eauth';
2721
			}
2722
		} else {
2723
			$result = Status::newGood( true );
2724
		}
2725
2726
		return $result;
2727
	}
2728
2729
	/**
2730
	 * Get the user's real name
2731
	 * @return string User's real name
2732
	 */
2733
	public function getRealName() {
2734
		if ( !$this->isItemLoaded( 'realname' ) ) {
2735
			$this->load();
2736
		}
2737
2738
		return $this->mRealName;
2739
	}
2740
2741
	/**
2742
	 * Set the user's real name
2743
	 * @param string $str New real name
2744
	 */
2745
	public function setRealName( $str ) {
2746
		$this->load();
2747
		$this->mRealName = $str;
2748
	}
2749
2750
	/**
2751
	 * Get the user's current setting for a given option.
2752
	 *
2753
	 * @param string $oname The option to check
2754
	 * @param string $defaultOverride A default value returned if the option does not exist
2755
	 * @param bool $ignoreHidden Whether to ignore the effects of $wgHiddenPrefs
2756
	 * @return string User's current value for the option
2757
	 * @see getBoolOption()
2758
	 * @see getIntOption()
2759
	 */
2760
	public function getOption( $oname, $defaultOverride = null, $ignoreHidden = false ) {
2761
		global $wgHiddenPrefs;
2762
		$this->loadOptions();
2763
2764
		# We want 'disabled' preferences to always behave as the default value for
2765
		# users, even if they have set the option explicitly in their settings (ie they
2766
		# set it, and then it was disabled removing their ability to change it).  But
2767
		# we don't want to erase the preferences in the database in case the preference
2768
		# is re-enabled again.  So don't touch $mOptions, just override the returned value
2769
		if ( !$ignoreHidden && in_array( $oname, $wgHiddenPrefs ) ) {
2770
			return self::getDefaultOption( $oname );
2771
		}
2772
2773
		if ( array_key_exists( $oname, $this->mOptions ) ) {
2774
			return $this->mOptions[$oname];
2775
		} else {
2776
			return $defaultOverride;
2777
		}
2778
	}
2779
2780
	/**
2781
	 * Get all user's options
2782
	 *
2783
	 * @param int $flags Bitwise combination of:
2784
	 *   User::GETOPTIONS_EXCLUDE_DEFAULTS  Exclude user options that are set
2785
	 *                                      to the default value. (Since 1.25)
2786
	 * @return array
2787
	 */
2788
	public function getOptions( $flags = 0 ) {
2789
		global $wgHiddenPrefs;
2790
		$this->loadOptions();
2791
		$options = $this->mOptions;
2792
2793
		# We want 'disabled' preferences to always behave as the default value for
2794
		# users, even if they have set the option explicitly in their settings (ie they
2795
		# set it, and then it was disabled removing their ability to change it).  But
2796
		# we don't want to erase the preferences in the database in case the preference
2797
		# is re-enabled again.  So don't touch $mOptions, just override the returned value
2798
		foreach ( $wgHiddenPrefs as $pref ) {
2799
			$default = self::getDefaultOption( $pref );
2800
			if ( $default !== null ) {
2801
				$options[$pref] = $default;
2802
			}
2803
		}
2804
2805
		if ( $flags & self::GETOPTIONS_EXCLUDE_DEFAULTS ) {
2806
			$options = array_diff_assoc( $options, self::getDefaultOptions() );
2807
		}
2808
2809
		return $options;
2810
	}
2811
2812
	/**
2813
	 * Get the user's current setting for a given option, as a boolean value.
2814
	 *
2815
	 * @param string $oname The option to check
2816
	 * @return bool User's current value for the option
2817
	 * @see getOption()
2818
	 */
2819
	public function getBoolOption( $oname ) {
2820
		return (bool)$this->getOption( $oname );
2821
	}
2822
2823
	/**
2824
	 * Get the user's current setting for a given option, as an integer value.
2825
	 *
2826
	 * @param string $oname The option to check
2827
	 * @param int $defaultOverride A default value returned if the option does not exist
2828
	 * @return int User's current value for the option
2829
	 * @see getOption()
2830
	 */
2831
	public function getIntOption( $oname, $defaultOverride = 0 ) {
2832
		$val = $this->getOption( $oname );
2833
		if ( $val == '' ) {
2834
			$val = $defaultOverride;
2835
		}
2836
		return intval( $val );
2837
	}
2838
2839
	/**
2840
	 * Set the given option for a user.
2841
	 *
2842
	 * You need to call saveSettings() to actually write to the database.
2843
	 *
2844
	 * @param string $oname The option to set
2845
	 * @param mixed $val New value to set
2846
	 */
2847
	public function setOption( $oname, $val ) {
2848
		$this->loadOptions();
2849
2850
		// Explicitly NULL values should refer to defaults
2851
		if ( is_null( $val ) ) {
2852
			$val = self::getDefaultOption( $oname );
2853
		}
2854
2855
		$this->mOptions[$oname] = $val;
2856
	}
2857
2858
	/**
2859
	 * Get a token stored in the preferences (like the watchlist one),
2860
	 * resetting it if it's empty (and saving changes).
2861
	 *
2862
	 * @param string $oname The option name to retrieve the token from
2863
	 * @return string|bool User's current value for the option, or false if this option is disabled.
2864
	 * @see resetTokenFromOption()
2865
	 * @see getOption()
2866
	 * @deprecated since 1.26 Applications should use the OAuth extension
2867
	 */
2868
	public function getTokenFromOption( $oname ) {
2869
		global $wgHiddenPrefs;
2870
2871
		$id = $this->getId();
2872
		if ( !$id || in_array( $oname, $wgHiddenPrefs ) ) {
2873
			return false;
2874
		}
2875
2876
		$token = $this->getOption( $oname );
2877
		if ( !$token ) {
2878
			// Default to a value based on the user token to avoid space
2879
			// wasted on storing tokens for all users. When this option
2880
			// is set manually by the user, only then is it stored.
2881
			$token = hash_hmac( 'sha1', "$oname:$id", $this->getToken() );
2882
		}
2883
2884
		return $token;
2885
	}
2886
2887
	/**
2888
	 * Reset a token stored in the preferences (like the watchlist one).
2889
	 * *Does not* save user's preferences (similarly to setOption()).
2890
	 *
2891
	 * @param string $oname The option name to reset the token in
2892
	 * @return string|bool New token value, or false if this option is disabled.
2893
	 * @see getTokenFromOption()
2894
	 * @see setOption()
2895
	 */
2896
	public function resetTokenFromOption( $oname ) {
2897
		global $wgHiddenPrefs;
2898
		if ( in_array( $oname, $wgHiddenPrefs ) ) {
2899
			return false;
2900
		}
2901
2902
		$token = MWCryptRand::generateHex( 40 );
2903
		$this->setOption( $oname, $token );
2904
		return $token;
2905
	}
2906
2907
	/**
2908
	 * Return a list of the types of user options currently returned by
2909
	 * User::getOptionKinds().
2910
	 *
2911
	 * Currently, the option kinds are:
2912
	 * - 'registered' - preferences which are registered in core MediaWiki or
2913
	 *                  by extensions using the UserGetDefaultOptions hook.
2914
	 * - 'registered-multiselect' - as above, using the 'multiselect' type.
2915
	 * - 'registered-checkmatrix' - as above, using the 'checkmatrix' type.
2916
	 * - 'userjs' - preferences with names starting with 'userjs-', intended to
2917
	 *              be used by user scripts.
2918
	 * - 'special' - "preferences" that are not accessible via User::getOptions
2919
	 *               or User::setOptions.
2920
	 * - 'unused' - preferences about which MediaWiki doesn't know anything.
2921
	 *              These are usually legacy options, removed in newer versions.
2922
	 *
2923
	 * The API (and possibly others) use this function to determine the possible
2924
	 * option types for validation purposes, so make sure to update this when a
2925
	 * new option kind is added.
2926
	 *
2927
	 * @see User::getOptionKinds
2928
	 * @return array Option kinds
2929
	 */
2930
	public static function listOptionKinds() {
2931
		return [
2932
			'registered',
2933
			'registered-multiselect',
2934
			'registered-checkmatrix',
2935
			'userjs',
2936
			'special',
2937
			'unused'
2938
		];
2939
	}
2940
2941
	/**
2942
	 * Return an associative array mapping preferences keys to the kind of a preference they're
2943
	 * used for. Different kinds are handled differently when setting or reading preferences.
2944
	 *
2945
	 * See User::listOptionKinds for the list of valid option types that can be provided.
2946
	 *
2947
	 * @see User::listOptionKinds
2948
	 * @param IContextSource $context
2949
	 * @param array $options Assoc. array with options keys to check as keys.
2950
	 *   Defaults to $this->mOptions.
2951
	 * @return array The key => kind mapping data
2952
	 */
2953
	public function getOptionKinds( IContextSource $context, $options = null ) {
2954
		$this->loadOptions();
2955
		if ( $options === null ) {
2956
			$options = $this->mOptions;
2957
		}
2958
2959
		$prefs = Preferences::getPreferences( $this, $context );
2960
		$mapping = [];
2961
2962
		// Pull out the "special" options, so they don't get converted as
2963
		// multiselect or checkmatrix.
2964
		$specialOptions = array_fill_keys( Preferences::getSaveBlacklist(), true );
2965
		foreach ( $specialOptions as $name => $value ) {
2966
			unset( $prefs[$name] );
2967
		}
2968
2969
		// Multiselect and checkmatrix options are stored in the database with
2970
		// one key per option, each having a boolean value. Extract those keys.
2971
		$multiselectOptions = [];
2972
		foreach ( $prefs as $name => $info ) {
0 ignored issues
show
Bug introduced by
The expression $prefs of type array|null is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
2973 View Code Duplication
			if ( ( isset( $info['type'] ) && $info['type'] == 'multiselect' ) ||
2974
					( isset( $info['class'] ) && $info['class'] == 'HTMLMultiSelectField' ) ) {
2975
				$opts = HTMLFormField::flattenOptions( $info['options'] );
2976
				$prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2977
2978
				foreach ( $opts as $value ) {
2979
					$multiselectOptions["$prefix$value"] = true;
2980
				}
2981
2982
				unset( $prefs[$name] );
2983
			}
2984
		}
2985
		$checkmatrixOptions = [];
2986
		foreach ( $prefs as $name => $info ) {
0 ignored issues
show
Bug introduced by
The expression $prefs of type array|null is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
2987
			if ( ( isset( $info['type'] ) && $info['type'] == 'checkmatrix' ) ||
2988
					( isset( $info['class'] ) && $info['class'] == 'HTMLCheckMatrix' ) ) {
2989
				$columns = HTMLFormField::flattenOptions( $info['columns'] );
2990
				$rows = HTMLFormField::flattenOptions( $info['rows'] );
2991
				$prefix = isset( $info['prefix'] ) ? $info['prefix'] : $name;
2992
2993
				foreach ( $columns as $column ) {
2994
					foreach ( $rows as $row ) {
2995
						$checkmatrixOptions["$prefix$column-$row"] = true;
2996
					}
2997
				}
2998
2999
				unset( $prefs[$name] );
3000
			}
3001
		}
3002
3003
		// $value is ignored
3004
		foreach ( $options as $key => $value ) {
3005
			if ( isset( $prefs[$key] ) ) {
3006
				$mapping[$key] = 'registered';
3007
			} elseif ( isset( $multiselectOptions[$key] ) ) {
3008
				$mapping[$key] = 'registered-multiselect';
3009
			} elseif ( isset( $checkmatrixOptions[$key] ) ) {
3010
				$mapping[$key] = 'registered-checkmatrix';
3011
			} elseif ( isset( $specialOptions[$key] ) ) {
3012
				$mapping[$key] = 'special';
3013
			} elseif ( substr( $key, 0, 7 ) === 'userjs-' ) {
3014
				$mapping[$key] = 'userjs';
3015
			} else {
3016
				$mapping[$key] = 'unused';
3017
			}
3018
		}
3019
3020
		return $mapping;
3021
	}
3022
3023
	/**
3024
	 * Reset certain (or all) options to the site defaults
3025
	 *
3026
	 * The optional parameter determines which kinds of preferences will be reset.
3027
	 * Supported values are everything that can be reported by getOptionKinds()
3028
	 * and 'all', which forces a reset of *all* preferences and overrides everything else.
3029
	 *
3030
	 * @param array|string $resetKinds Which kinds of preferences to reset. Defaults to
3031
	 *  array( 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' )
3032
	 *  for backwards-compatibility.
3033
	 * @param IContextSource|null $context Context source used when $resetKinds
3034
	 *  does not contain 'all', passed to getOptionKinds().
3035
	 *  Defaults to RequestContext::getMain() when null.
3036
	 */
3037
	public function resetOptions(
3038
		$resetKinds = [ 'registered', 'registered-multiselect', 'registered-checkmatrix', 'unused' ],
3039
		IContextSource $context = null
3040
	) {
3041
		$this->load();
3042
		$defaultOptions = self::getDefaultOptions();
3043
3044
		if ( !is_array( $resetKinds ) ) {
3045
			$resetKinds = [ $resetKinds ];
3046
		}
3047
3048
		if ( in_array( 'all', $resetKinds ) ) {
3049
			$newOptions = $defaultOptions;
3050
		} else {
3051
			if ( $context === null ) {
3052
				$context = RequestContext::getMain();
3053
			}
3054
3055
			$optionKinds = $this->getOptionKinds( $context );
3056
			$resetKinds = array_intersect( $resetKinds, self::listOptionKinds() );
3057
			$newOptions = [];
3058
3059
			// Use default values for the options that should be deleted, and
3060
			// copy old values for the ones that shouldn't.
3061
			foreach ( $this->mOptions as $key => $value ) {
3062
				if ( in_array( $optionKinds[$key], $resetKinds ) ) {
3063
					if ( array_key_exists( $key, $defaultOptions ) ) {
3064
						$newOptions[$key] = $defaultOptions[$key];
3065
					}
3066
				} else {
3067
					$newOptions[$key] = $value;
3068
				}
3069
			}
3070
		}
3071
3072
		Hooks::run( 'UserResetAllOptions', [ $this, &$newOptions, $this->mOptions, $resetKinds ] );
3073
3074
		$this->mOptions = $newOptions;
0 ignored issues
show
Documentation Bug introduced by
It seems like $newOptions can be null. However, the property $mOptions is declared as array. Maybe change the type of the property to array|null or add a type check?

Our type inference engine has found an assignment of a scalar value (like a string, an integer or null) to a property which is an array.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.

To type hint that a parameter can be either an array or null, you can set a type hint of array and a default value of null. The PHP interpreter will then accept both an array or null for that parameter.

function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

    return array_intersect($haystack, $needle) == $haystack;
}

The function can be called with either null or an array for the parameter $needle but will only accept an array as $haystack.

Loading history...
3075
		$this->mOptionsLoaded = true;
3076
	}
3077
3078
	/**
3079
	 * Get the user's preferred date format.
3080
	 * @return string User's preferred date format
3081
	 */
3082
	public function getDatePreference() {
3083
		// Important migration for old data rows
3084
		if ( is_null( $this->mDatePreference ) ) {
3085
			global $wgLang;
3086
			$value = $this->getOption( 'date' );
3087
			$map = $wgLang->getDatePreferenceMigrationMap();
3088
			if ( isset( $map[$value] ) ) {
3089
				$value = $map[$value];
3090
			}
3091
			$this->mDatePreference = $value;
3092
		}
3093
		return $this->mDatePreference;
3094
	}
3095
3096
	/**
3097
	 * Determine based on the wiki configuration and the user's options,
3098
	 * whether this user must be over HTTPS no matter what.
3099
	 *
3100
	 * @return bool
3101
	 */
3102
	public function requiresHTTPS() {
3103
		global $wgSecureLogin;
3104
		if ( !$wgSecureLogin ) {
3105
			return false;
3106
		} else {
3107
			$https = $this->getBoolOption( 'prefershttps' );
3108
			Hooks::run( 'UserRequiresHTTPS', [ $this, &$https ] );
3109
			if ( $https ) {
3110
				$https = wfCanIPUseHTTPS( $this->getRequest()->getIP() );
3111
			}
3112
			return $https;
3113
		}
3114
	}
3115
3116
	/**
3117
	 * Get the user preferred stub threshold
3118
	 *
3119
	 * @return int
3120
	 */
3121
	public function getStubThreshold() {
3122
		global $wgMaxArticleSize; # Maximum article size, in Kb
3123
		$threshold = $this->getIntOption( 'stubthreshold' );
3124
		if ( $threshold > $wgMaxArticleSize * 1024 ) {
3125
			// If they have set an impossible value, disable the preference
3126
			// so we can use the parser cache again.
3127
			$threshold = 0;
3128
		}
3129
		return $threshold;
3130
	}
3131
3132
	/**
3133
	 * Get the permissions this user has.
3134
	 * @return array Array of String permission names
3135
	 */
3136
	public function getRights() {
3137
		if ( is_null( $this->mRights ) ) {
3138
			$this->mRights = self::getGroupPermissions( $this->getEffectiveGroups() );
3139
			Hooks::run( 'UserGetRights', [ $this, &$this->mRights ] );
3140
3141
			// Deny any rights denied by the user's session, unless this
3142
			// endpoint has no sessions.
3143
			if ( !defined( 'MW_NO_SESSION' ) ) {
3144
				$allowedRights = $this->getRequest()->getSession()->getAllowedUserRights();
3145
				if ( $allowedRights !== null ) {
3146
					$this->mRights = array_intersect( $this->mRights, $allowedRights );
3147
				}
3148
			}
3149
3150
			// Force reindexation of rights when a hook has unset one of them
3151
			$this->mRights = array_values( array_unique( $this->mRights ) );
3152
3153
			// If block disables login, we should also remove any
3154
			// extra rights blocked users might have, in case the
3155
			// blocked user has a pre-existing session (T129738).
3156
			// This is checked here for cases where people only call
3157
			// $user->isAllowed(). It is also checked in Title::checkUserBlock()
3158
			// to give a better error message in the common case.
3159
			$config = RequestContext::getMain()->getConfig();
3160
			if (
3161
				$this->isLoggedIn() &&
3162
				$config->get( 'BlockDisablesLogin' ) &&
3163
				$this->isBlocked()
3164
			) {
3165
				$anon = new User;
3166
				$this->mRights = array_intersect( $this->mRights, $anon->getRights() );
3167
			}
3168
		}
3169
		return $this->mRights;
3170
	}
3171
3172
	/**
3173
	 * Get the list of explicit group memberships this user has.
3174
	 * The implicit * and user groups are not included.
3175
	 * @return array Array of String internal group names
3176
	 */
3177
	public function getGroups() {
3178
		$this->load();
3179
		$this->loadGroups();
3180
		return $this->mGroups;
3181
	}
3182
3183
	/**
3184
	 * Get the list of implicit group memberships this user has.
3185
	 * This includes all explicit groups, plus 'user' if logged in,
3186
	 * '*' for all accounts, and autopromoted groups
3187
	 * @param bool $recache Whether to avoid the cache
3188
	 * @return array Array of String internal group names
3189
	 */
3190
	public function getEffectiveGroups( $recache = false ) {
3191
		if ( $recache || is_null( $this->mEffectiveGroups ) ) {
3192
			$this->mEffectiveGroups = array_unique( array_merge(
3193
				$this->getGroups(), // explicit groups
3194
				$this->getAutomaticGroups( $recache ) // implicit groups
3195
			) );
3196
			// Hook for additional groups
3197
			Hooks::run( 'UserEffectiveGroups', [ &$this, &$this->mEffectiveGroups ] );
3198
			// Force reindexation of groups when a hook has unset one of them
3199
			$this->mEffectiveGroups = array_values( array_unique( $this->mEffectiveGroups ) );
3200
		}
3201
		return $this->mEffectiveGroups;
3202
	}
3203
3204
	/**
3205
	 * Get the list of implicit group memberships this user has.
3206
	 * This includes 'user' if logged in, '*' for all accounts,
3207
	 * and autopromoted groups
3208
	 * @param bool $recache Whether to avoid the cache
3209
	 * @return array Array of String internal group names
3210
	 */
3211
	public function getAutomaticGroups( $recache = false ) {
3212
		if ( $recache || is_null( $this->mImplicitGroups ) ) {
3213
			$this->mImplicitGroups = [ '*' ];
3214
			if ( $this->getId() ) {
3215
				$this->mImplicitGroups[] = 'user';
3216
3217
				$this->mImplicitGroups = array_unique( array_merge(
3218
					$this->mImplicitGroups,
3219
					Autopromote::getAutopromoteGroups( $this )
3220
				) );
3221
			}
3222
			if ( $recache ) {
3223
				// Assure data consistency with rights/groups,
3224
				// as getEffectiveGroups() depends on this function
3225
				$this->mEffectiveGroups = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mEffectiveGroups.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
3226
			}
3227
		}
3228
		return $this->mImplicitGroups;
3229
	}
3230
3231
	/**
3232
	 * Returns the groups the user has belonged to.
3233
	 *
3234
	 * The user may still belong to the returned groups. Compare with getGroups().
3235
	 *
3236
	 * The function will not return groups the user had belonged to before MW 1.17
3237
	 *
3238
	 * @return array Names of the groups the user has belonged to.
3239
	 */
3240 View Code Duplication
	public function getFormerGroups() {
3241
		$this->load();
3242
3243
		if ( is_null( $this->mFormerGroups ) ) {
3244
			$db = ( $this->queryFlagsUsed & self::READ_LATEST )
3245
				? wfGetDB( DB_MASTER )
3246
				: wfGetDB( DB_REPLICA );
3247
			$res = $db->select( 'user_former_groups',
3248
				[ 'ufg_group' ],
3249
				[ 'ufg_user' => $this->mId ],
3250
				__METHOD__ );
3251
			$this->mFormerGroups = [];
3252
			foreach ( $res as $row ) {
0 ignored issues
show
Bug introduced by
The expression $res of type boolean|object<ResultWrapper> is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
3253
				$this->mFormerGroups[] = $row->ufg_group;
3254
			}
3255
		}
3256
3257
		return $this->mFormerGroups;
3258
	}
3259
3260
	/**
3261
	 * Get the user's edit count.
3262
	 * @return int|null Null for anonymous users
3263
	 */
3264
	public function getEditCount() {
3265
		if ( !$this->getId() ) {
3266
			return null;
3267
		}
3268
3269
		if ( $this->mEditCount === null ) {
3270
			/* Populate the count, if it has not been populated yet */
3271
			$dbr = wfGetDB( DB_REPLICA );
3272
			// check if the user_editcount field has been initialized
3273
			$count = $dbr->selectField(
3274
				'user', 'user_editcount',
3275
				[ 'user_id' => $this->mId ],
3276
				__METHOD__
3277
			);
3278
3279
			if ( $count === null ) {
3280
				// it has not been initialized. do so.
3281
				$count = $this->initEditCount();
3282
			}
3283
			$this->mEditCount = $count;
3284
		}
3285
		return (int)$this->mEditCount;
3286
	}
3287
3288
	/**
3289
	 * Add the user to the given group.
3290
	 * This takes immediate effect.
3291
	 * @param string $group Name of the group to add
3292
	 * @return bool
3293
	 */
3294
	public function addGroup( $group ) {
3295
		$this->load();
3296
3297
		if ( !Hooks::run( 'UserAddGroup', [ $this, &$group ] ) ) {
3298
			return false;
3299
		}
3300
3301
		$dbw = wfGetDB( DB_MASTER );
3302
		if ( $this->getId() ) {
3303
			$dbw->insert( 'user_groups',
3304
				[
3305
					'ug_user' => $this->getId(),
3306
					'ug_group' => $group,
3307
				],
3308
				__METHOD__,
3309
				[ 'IGNORE' ] );
3310
		}
3311
3312
		$this->loadGroups();
3313
		$this->mGroups[] = $group;
3314
		// In case loadGroups was not called before, we now have the right twice.
3315
		// Get rid of the duplicate.
3316
		$this->mGroups = array_unique( $this->mGroups );
3317
3318
		// Refresh the groups caches, and clear the rights cache so it will be
3319
		// refreshed on the next call to $this->getRights().
3320
		$this->getEffectiveGroups( true );
3321
		$this->mRights = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mRights.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
3322
3323
		$this->invalidateCache();
3324
3325
		return true;
3326
	}
3327
3328
	/**
3329
	 * Remove the user from the given group.
3330
	 * This takes immediate effect.
3331
	 * @param string $group Name of the group to remove
3332
	 * @return bool
3333
	 */
3334
	public function removeGroup( $group ) {
3335
		$this->load();
3336
		if ( !Hooks::run( 'UserRemoveGroup', [ $this, &$group ] ) ) {
3337
			return false;
3338
		}
3339
3340
		$dbw = wfGetDB( DB_MASTER );
3341
		$dbw->delete( 'user_groups',
3342
			[
3343
				'ug_user' => $this->getId(),
3344
				'ug_group' => $group,
3345
			], __METHOD__
3346
		);
3347
		// Remember that the user was in this group
3348
		$dbw->insert( 'user_former_groups',
3349
			[
3350
				'ufg_user' => $this->getId(),
3351
				'ufg_group' => $group,
3352
			],
3353
			__METHOD__,
3354
			[ 'IGNORE' ]
3355
		);
3356
3357
		$this->loadGroups();
3358
		$this->mGroups = array_diff( $this->mGroups, [ $group ] );
3359
3360
		// Refresh the groups caches, and clear the rights cache so it will be
3361
		// refreshed on the next call to $this->getRights().
3362
		$this->getEffectiveGroups( true );
3363
		$this->mRights = null;
0 ignored issues
show
Documentation Bug introduced by
It seems like null of type null is incompatible with the declared type array of property $mRights.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
3364
3365
		$this->invalidateCache();
3366
3367
		return true;
3368
	}
3369
3370
	/**
3371
	 * Get whether the user is logged in
3372
	 * @return bool
3373
	 */
3374
	public function isLoggedIn() {
3375
		return $this->getId() != 0;
3376
	}
3377
3378
	/**
3379
	 * Get whether the user is anonymous
3380
	 * @return bool
3381
	 */
3382
	public function isAnon() {
3383
		return !$this->isLoggedIn();
3384
	}
3385
3386
	/**
3387
	 * @return bool Whether this user is flagged as being a bot role account
3388
	 * @since 1.28
3389
	 */
3390
	public function isBot() {
3391
		if ( in_array( 'bot', $this->getGroups() ) && $this->isAllowed( 'bot' ) ) {
3392
			return true;
3393
		}
3394
3395
		$isBot = false;
3396
		Hooks::run( "UserIsBot", [ $this, &$isBot ] );
3397
3398
		return $isBot;
3399
	}
3400
3401
	/**
3402
	 * Check if user is allowed to access a feature / make an action
3403
	 *
3404
	 * @param string ... Permissions to test
3405
	 * @return bool True if user is allowed to perform *any* of the given actions
3406
	 */
3407 View Code Duplication
	public function isAllowedAny() {
3408
		$permissions = func_get_args();
3409
		foreach ( $permissions as $permission ) {
3410
			if ( $this->isAllowed( $permission ) ) {
3411
				return true;
3412
			}
3413
		}
3414
		return false;
3415
	}
3416
3417
	/**
3418
	 *
3419
	 * @param string ... Permissions to test
3420
	 * @return bool True if the user is allowed to perform *all* of the given actions
3421
	 */
3422 View Code Duplication
	public function isAllowedAll() {
3423
		$permissions = func_get_args();
3424
		foreach ( $permissions as $permission ) {
3425
			if ( !$this->isAllowed( $permission ) ) {
3426
				return false;
3427
			}
3428
		}
3429
		return true;
3430
	}
3431
3432
	/**
3433
	 * Internal mechanics of testing a permission
3434
	 * @param string $action
3435
	 * @return bool
3436
	 */
3437
	public function isAllowed( $action = '' ) {
3438
		if ( $action === '' ) {
3439
			return true; // In the spirit of DWIM
3440
		}
3441
		// Use strict parameter to avoid matching numeric 0 accidentally inserted
3442
		// by misconfiguration: 0 == 'foo'
3443
		return in_array( $action, $this->getRights(), true );
3444
	}
3445
3446
	/**
3447
	 * Check whether to enable recent changes patrol features for this user
3448
	 * @return bool True or false
3449
	 */
3450
	public function useRCPatrol() {
3451
		global $wgUseRCPatrol;
3452
		return $wgUseRCPatrol && $this->isAllowedAny( 'patrol', 'patrolmarks' );
3453
	}
3454
3455
	/**
3456
	 * Check whether to enable new pages patrol features for this user
3457
	 * @return bool True or false
3458
	 */
3459
	public function useNPPatrol() {
3460
		global $wgUseRCPatrol, $wgUseNPPatrol;
3461
		return (
3462
			( $wgUseRCPatrol || $wgUseNPPatrol )
3463
				&& ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3464
		);
3465
	}
3466
3467
	/**
3468
	 * Check whether to enable new files patrol features for this user
3469
	 * @return bool True or false
3470
	 */
3471
	public function useFilePatrol() {
3472
		global $wgUseRCPatrol, $wgUseFilePatrol;
3473
		return (
3474
			( $wgUseRCPatrol || $wgUseFilePatrol )
3475
				&& ( $this->isAllowedAny( 'patrol', 'patrolmarks' ) )
3476
		);
3477
	}
3478
3479
	/**
3480
	 * Get the WebRequest object to use with this object
3481
	 *
3482
	 * @return WebRequest
3483
	 */
3484
	public function getRequest() {
3485
		if ( $this->mRequest ) {
3486
			return $this->mRequest;
3487
		} else {
3488
			global $wgRequest;
3489
			return $wgRequest;
3490
		}
3491
	}
3492
3493
	/**
3494
	 * Check the watched status of an article.
3495
	 * @since 1.22 $checkRights parameter added
3496
	 * @param Title $title Title of the article to look at
3497
	 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3498
	 *     Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3499
	 * @return bool
3500
	 */
3501
	public function isWatched( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
3502
		if ( $title->isWatchable() && ( !$checkRights || $this->isAllowed( 'viewmywatchlist' ) ) ) {
3503
			return MediaWikiServices::getInstance()->getWatchedItemStore()->isWatched( $this, $title );
3504
		}
3505
		return false;
3506
	}
3507
3508
	/**
3509
	 * Watch an article.
3510
	 * @since 1.22 $checkRights parameter added
3511
	 * @param Title $title Title of the article to look at
3512
	 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3513
	 *     Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3514
	 */
3515
	public function addWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
3516
		if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
3517
			MediaWikiServices::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
3518
				$this,
3519
				[ $title->getSubjectPage(), $title->getTalkPage() ]
3520
			);
3521
		}
3522
		$this->invalidateCache();
3523
	}
3524
3525
	/**
3526
	 * Stop watching an article.
3527
	 * @since 1.22 $checkRights parameter added
3528
	 * @param Title $title Title of the article to look at
3529
	 * @param bool $checkRights Whether to check 'viewmywatchlist'/'editmywatchlist' rights.
3530
	 *     Pass User::CHECK_USER_RIGHTS or User::IGNORE_USER_RIGHTS.
3531
	 */
3532
	public function removeWatch( $title, $checkRights = self::CHECK_USER_RIGHTS ) {
3533
		if ( !$checkRights || $this->isAllowed( 'editmywatchlist' ) ) {
3534
			$store = MediaWikiServices::getInstance()->getWatchedItemStore();
3535
			$store->removeWatch( $this, $title->getSubjectPage() );
3536
			$store->removeWatch( $this, $title->getTalkPage() );
3537
		}
3538
		$this->invalidateCache();
3539
	}
3540
3541
	/**
3542
	 * Clear the user's notification timestamp for the given title.
3543
	 * If e-notif e-mails are on, they will receive notification mails on
3544
	 * the next change of the page if it's watched etc.
3545
	 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3546
	 * @param Title $title Title of the article to look at
3547
	 * @param int $oldid The revision id being viewed. If not given or 0, latest revision is assumed.
3548
	 */
3549
	public function clearNotification( &$title, $oldid = 0 ) {
3550
		global $wgUseEnotif, $wgShowUpdatedMarker;
3551
3552
		// Do nothing if the database is locked to writes
3553
		if ( wfReadOnly() ) {
3554
			return;
3555
		}
3556
3557
		// Do nothing if not allowed to edit the watchlist
3558
		if ( !$this->isAllowed( 'editmywatchlist' ) ) {
3559
			return;
3560
		}
3561
3562
		// If we're working on user's talk page, we should update the talk page message indicator
3563
		if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3564
			if ( !Hooks::run( 'UserClearNewTalkNotification', [ &$this, $oldid ] ) ) {
3565
				return;
3566
			}
3567
3568
			// Try to update the DB post-send and only if needed...
3569
			DeferredUpdates::addCallableUpdate( function() use ( $title, $oldid ) {
3570
				if ( !$this->getNewtalk() ) {
3571
					return; // no notifications to clear
3572
				}
3573
3574
				// Delete the last notifications (they stack up)
3575
				$this->setNewtalk( false );
3576
3577
				// If there is a new, unseen, revision, use its timestamp
3578
				$nextid = $oldid
3579
					? $title->getNextRevisionID( $oldid, Title::GAID_FOR_UPDATE )
3580
					: null;
3581
				if ( $nextid ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression $nextid of type integer|null is loosely compared to true; this is ambiguous if the integer can be zero. You might want to explicitly use !== null instead.

In PHP, under loose comparison (like ==, or !=, or switch conditions), values of different types might be equal.

For integer values, zero is a special case, in particular the following results might be unexpected:

0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
Loading history...
3582
					$this->setNewtalk( true, Revision::newFromId( $nextid ) );
3583
				}
3584
			} );
3585
		}
3586
3587
		if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3588
			return;
3589
		}
3590
3591
		if ( $this->isAnon() ) {
3592
			// Nothing else to do...
3593
			return;
3594
		}
3595
3596
		// Only update the timestamp if the page is being watched.
3597
		// The query to find out if it is watched is cached both in memcached and per-invocation,
3598
		// and when it does have to be executed, it can be on a replica DB
3599
		// If this is the user's newtalk page, we always update the timestamp
3600
		$force = '';
3601
		if ( $title->getNamespace() == NS_USER_TALK && $title->getText() == $this->getName() ) {
3602
			$force = 'force';
3603
		}
3604
3605
		MediaWikiServices::getInstance()->getWatchedItemStore()
3606
			->resetNotificationTimestamp( $this, $title, $force, $oldid );
3607
	}
3608
3609
	/**
3610
	 * Resets all of the given user's page-change notification timestamps.
3611
	 * If e-notif e-mails are on, they will receive notification mails on
3612
	 * the next change of any watched page.
3613
	 * @note If the user doesn't have 'editmywatchlist', this will do nothing.
3614
	 */
3615
	public function clearAllNotifications() {
3616
		global $wgUseEnotif, $wgShowUpdatedMarker;
3617
		// Do nothing if not allowed to edit the watchlist
3618
		if ( wfReadOnly() || !$this->isAllowed( 'editmywatchlist' ) ) {
3619
			return;
3620
		}
3621
3622
		if ( !$wgUseEnotif && !$wgShowUpdatedMarker ) {
3623
			$this->setNewtalk( false );
3624
			return;
3625
		}
3626
3627
		$id = $this->getId();
3628
		if ( !$id ) {
3629
			return;
3630
		}
3631
3632
		$dbw = wfGetDB( DB_MASTER );
3633
		$asOfTimes = array_unique( $dbw->selectFieldValues(
3634
			'watchlist',
3635
			'wl_notificationtimestamp',
3636
			[ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3637
			__METHOD__,
3638
			[ 'ORDER BY' => 'wl_notificationtimestamp DESC', 'LIMIT' => 500 ]
3639
		) );
3640
		if ( !$asOfTimes ) {
3641
			return;
3642
		}
3643
		// Immediately update the most recent touched rows, which hopefully covers what
3644
		// the user sees on the watchlist page before pressing "mark all pages visited"....
3645
		$dbw->update(
3646
			'watchlist',
3647
			[ 'wl_notificationtimestamp' => null ],
3648
			[ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimes ],
3649
			__METHOD__
3650
		);
3651
		// ...and finish the older ones in a post-send update with lag checks...
3652
		DeferredUpdates::addUpdate( new AutoCommitUpdate(
3653
			$dbw,
3654
			__METHOD__,
3655
			function () use ( $dbw, $id ) {
3656
				global $wgUpdateRowsPerQuery;
3657
3658
				$lbFactory = MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
3659
				$ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
3660
				$asOfTimes = array_unique( $dbw->selectFieldValues(
3661
					'watchlist',
3662
					'wl_notificationtimestamp',
3663
					[ 'wl_user' => $id, 'wl_notificationtimestamp IS NOT NULL' ],
3664
					__METHOD__
3665
				) );
3666
				foreach ( array_chunk( $asOfTimes, $wgUpdateRowsPerQuery ) as $asOfTimeBatch ) {
3667
					$dbw->update(
3668
						'watchlist',
3669
						[ 'wl_notificationtimestamp' => null ],
3670
						[ 'wl_user' => $id, 'wl_notificationtimestamp' => $asOfTimeBatch ],
3671
						__METHOD__
3672
					);
3673
					$lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
3674
				}
3675
			}
3676
		) );
3677
		// We also need to clear here the "you have new message" notification for the own
3678
		// user_talk page; it's cleared one page view later in WikiPage::doViewUpdates().
3679
	}
3680
3681
	/**
3682
	 * Set a cookie on the user's client. Wrapper for
3683
	 * WebResponse::setCookie
3684
	 * @deprecated since 1.27
3685
	 * @param string $name Name of the cookie to set
3686
	 * @param string $value Value to set
3687
	 * @param int $exp Expiration time, as a UNIX time value;
3688
	 *                   if 0 or not specified, use the default $wgCookieExpiration
3689
	 * @param bool $secure
3690
	 *  true: Force setting the secure attribute when setting the cookie
3691
	 *  false: Force NOT setting the secure attribute when setting the cookie
3692
	 *  null (default): Use the default ($wgCookieSecure) to set the secure attribute
3693
	 * @param array $params Array of options sent passed to WebResponse::setcookie()
3694
	 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3695
	 *        is passed.
3696
	 */
3697
	protected function setCookie(
3698
		$name, $value, $exp = 0, $secure = null, $params = [], $request = null
3699
	) {
3700
		wfDeprecated( __METHOD__, '1.27' );
3701
		if ( $request === null ) {
3702
			$request = $this->getRequest();
3703
		}
3704
		$params['secure'] = $secure;
3705
		$request->response()->setCookie( $name, $value, $exp, $params );
3706
	}
3707
3708
	/**
3709
	 * Clear a cookie on the user's client
3710
	 * @deprecated since 1.27
3711
	 * @param string $name Name of the cookie to clear
3712
	 * @param bool $secure
3713
	 *  true: Force setting the secure attribute when setting the cookie
3714
	 *  false: Force NOT setting the secure attribute when setting the cookie
3715
	 *  null (default): Use the default ($wgCookieSecure) to set the secure attribute
3716
	 * @param array $params Array of options sent passed to WebResponse::setcookie()
3717
	 */
3718
	protected function clearCookie( $name, $secure = null, $params = [] ) {
3719
		wfDeprecated( __METHOD__, '1.27' );
3720
		$this->setCookie( $name, '', time() - 86400, $secure, $params );
3721
	}
3722
3723
	/**
3724
	 * Set an extended login cookie on the user's client. The expiry of the cookie
3725
	 * is controlled by the $wgExtendedLoginCookieExpiration configuration
3726
	 * variable.
3727
	 *
3728
	 * @see User::setCookie
3729
	 *
3730
	 * @deprecated since 1.27
3731
	 * @param string $name Name of the cookie to set
3732
	 * @param string $value Value to set
3733
	 * @param bool $secure
3734
	 *  true: Force setting the secure attribute when setting the cookie
3735
	 *  false: Force NOT setting the secure attribute when setting the cookie
3736
	 *  null (default): Use the default ($wgCookieSecure) to set the secure attribute
3737
	 */
3738
	protected function setExtendedLoginCookie( $name, $value, $secure ) {
3739
		global $wgExtendedLoginCookieExpiration, $wgCookieExpiration;
3740
3741
		wfDeprecated( __METHOD__, '1.27' );
3742
3743
		$exp = time();
3744
		$exp += $wgExtendedLoginCookieExpiration !== null
3745
			? $wgExtendedLoginCookieExpiration
3746
			: $wgCookieExpiration;
3747
3748
		$this->setCookie( $name, $value, $exp, $secure );
3749
	}
3750
3751
	/**
3752
	 * Persist this user's session (e.g. set cookies)
3753
	 *
3754
	 * @param WebRequest|null $request WebRequest object to use; $wgRequest will be used if null
3755
	 *        is passed.
3756
	 * @param bool $secure Whether to force secure/insecure cookies or use default
3757
	 * @param bool $rememberMe Whether to add a Token cookie for elongated sessions
3758
	 */
3759
	public function setCookies( $request = null, $secure = null, $rememberMe = false ) {
3760
		$this->load();
3761
		if ( 0 == $this->mId ) {
3762
			return;
3763
		}
3764
3765
		$session = $this->getRequest()->getSession();
3766
		if ( $request && $session->getRequest() !== $request ) {
3767
			$session = $session->sessionWithRequest( $request );
3768
		}
3769
		$delay = $session->delaySave();
3770
3771
		if ( !$session->getUser()->equals( $this ) ) {
3772
			if ( !$session->canSetUser() ) {
3773
				\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
3774
					->warning( __METHOD__ .
3775
						": Cannot save user \"$this\" to a user \"{$session->getUser()}\"'s immutable session"
3776
					);
3777
				return;
3778
			}
3779
			$session->setUser( $this );
3780
		}
3781
3782
		$session->setRememberUser( $rememberMe );
3783
		if ( $secure !== null ) {
3784
			$session->setForceHTTPS( $secure );
3785
		}
3786
3787
		$session->persist();
3788
3789
		ScopedCallback::consume( $delay );
3790
	}
3791
3792
	/**
3793
	 * Log this user out.
3794
	 */
3795
	public function logout() {
3796
		if ( Hooks::run( 'UserLogout', [ &$this ] ) ) {
3797
			$this->doLogout();
3798
		}
3799
	}
3800
3801
	/**
3802
	 * Clear the user's session, and reset the instance cache.
3803
	 * @see logout()
3804
	 */
3805
	public function doLogout() {
3806
		$session = $this->getRequest()->getSession();
3807
		if ( !$session->canSetUser() ) {
3808
			\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
3809
				->warning( __METHOD__ . ": Cannot log out of an immutable session" );
3810
			$error = 'immutable';
3811
		} elseif ( !$session->getUser()->equals( $this ) ) {
3812
			\MediaWiki\Logger\LoggerFactory::getInstance( 'session' )
3813
				->warning( __METHOD__ .
3814
					": Cannot log user \"$this\" out of a user \"{$session->getUser()}\"'s session"
3815
				);
3816
			// But we still may as well make this user object anon
3817
			$this->clearInstanceCache( 'defaults' );
3818
			$error = 'wronguser';
3819
		} else {
3820
			$this->clearInstanceCache( 'defaults' );
3821
			$delay = $session->delaySave();
3822
			$session->unpersist(); // Clear cookies (T127436)
3823
			$session->setLoggedOutTimestamp( time() );
3824
			$session->setUser( new User );
3825
			$session->set( 'wsUserID', 0 ); // Other code expects this
3826
			$session->resetAllTokens();
3827
			ScopedCallback::consume( $delay );
3828
			$error = false;
3829
		}
3830
		\MediaWiki\Logger\LoggerFactory::getInstance( 'authevents' )->info( 'Logout', [
3831
			'event' => 'logout',
3832
			'successful' => $error === false,
3833
			'status' => $error ?: 'success',
3834
		] );
3835
	}
3836
3837
	/**
3838
	 * Save this user's settings into the database.
3839
	 * @todo Only rarely do all these fields need to be set!
3840
	 */
3841
	public function saveSettings() {
3842
		if ( wfReadOnly() ) {
3843
			// @TODO: caller should deal with this instead!
3844
			// This should really just be an exception.
3845
			MWExceptionHandler::logException( new DBExpectedError(
3846
				null,
3847
				"Could not update user with ID '{$this->mId}'; DB is read-only."
3848
			) );
3849
			return;
3850
		}
3851
3852
		$this->load();
3853
		if ( 0 == $this->mId ) {
3854
			return; // anon
3855
		}
3856
3857
		// Get a new user_touched that is higher than the old one.
3858
		// This will be used for a CAS check as a last-resort safety
3859
		// check against race conditions and replica DB lag.
3860
		$newTouched = $this->newTouchedTimestamp();
3861
3862
		$dbw = wfGetDB( DB_MASTER );
3863
		$dbw->update( 'user',
3864
			[ /* SET */
3865
				'user_name' => $this->mName,
3866
				'user_real_name' => $this->mRealName,
3867
				'user_email' => $this->mEmail,
3868
				'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
3869
				'user_touched' => $dbw->timestamp( $newTouched ),
3870
				'user_token' => strval( $this->mToken ),
3871
				'user_email_token' => $this->mEmailToken,
3872
				'user_email_token_expires' => $dbw->timestampOrNull( $this->mEmailTokenExpires ),
3873
			], $this->makeUpdateConditions( $dbw, [ /* WHERE */
3874
				'user_id' => $this->mId,
3875
			] ), __METHOD__
3876
		);
3877
3878
		if ( !$dbw->affectedRows() ) {
3879
			// Maybe the problem was a missed cache update; clear it to be safe
3880
			$this->clearSharedCache( 'refresh' );
3881
			// User was changed in the meantime or loaded with stale data
3882
			$from = ( $this->queryFlagsUsed & self::READ_LATEST ) ? 'master' : 'replica';
3883
			throw new MWException(
3884
				"CAS update failed on user_touched for user ID '{$this->mId}' (read from $from);" .
3885
				" the version of the user to be saved is older than the current version."
3886
			);
3887
		}
3888
3889
		$this->mTouched = $newTouched;
0 ignored issues
show
Documentation Bug introduced by
It seems like $newTouched can also be of type false. However, the property $mTouched is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
3890
		$this->saveOptions();
3891
3892
		Hooks::run( 'UserSaveSettings', [ $this ] );
3893
		$this->clearSharedCache();
3894
		$this->getUserPage()->invalidateCache();
3895
	}
3896
3897
	/**
3898
	 * If only this user's username is known, and it exists, return the user ID.
3899
	 *
3900
	 * @param int $flags Bitfield of User:READ_* constants; useful for existence checks
3901
	 * @return int
3902
	 */
3903
	public function idForName( $flags = 0 ) {
3904
		$s = trim( $this->getName() );
3905
		if ( $s === '' ) {
3906
			return 0;
3907
		}
3908
3909
		$db = ( ( $flags & self::READ_LATEST ) == self::READ_LATEST )
3910
			? wfGetDB( DB_MASTER )
3911
			: wfGetDB( DB_REPLICA );
3912
3913
		$options = ( ( $flags & self::READ_LOCKING ) == self::READ_LOCKING )
3914
			? [ 'LOCK IN SHARE MODE' ]
3915
			: [];
3916
3917
		$id = $db->selectField( 'user',
3918
			'user_id', [ 'user_name' => $s ], __METHOD__, $options );
3919
3920
		return (int)$id;
3921
	}
3922
3923
	/**
3924
	 * Add a user to the database, return the user object
3925
	 *
3926
	 * @param string $name Username to add
3927
	 * @param array $params Array of Strings Non-default parameters to save to
3928
	 *   the database as user_* fields:
3929
	 *   - email: The user's email address.
3930
	 *   - email_authenticated: The email authentication timestamp.
3931
	 *   - real_name: The user's real name.
3932
	 *   - options: An associative array of non-default options.
3933
	 *   - token: Random authentication token. Do not set.
3934
	 *   - registration: Registration timestamp. Do not set.
3935
	 *
3936
	 * @return User|null User object, or null if the username already exists.
3937
	 */
3938
	public static function createNew( $name, $params = [] ) {
3939
		foreach ( [ 'password', 'newpassword', 'newpass_time', 'password_expires' ] as $field ) {
3940
			if ( isset( $params[$field] ) ) {
3941
				wfDeprecated( __METHOD__ . " with param '$field'", '1.27' );
3942
				unset( $params[$field] );
3943
			}
3944
		}
3945
3946
		$user = new User;
3947
		$user->load();
3948
		$user->setToken(); // init token
3949
		if ( isset( $params['options'] ) ) {
3950
			$user->mOptions = $params['options'] + (array)$user->mOptions;
3951
			unset( $params['options'] );
3952
		}
3953
		$dbw = wfGetDB( DB_MASTER );
3954
		$seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
3955
3956
		$noPass = PasswordFactory::newInvalidPassword()->toString();
3957
3958
		$fields = [
3959
			'user_id' => $seqVal,
3960
			'user_name' => $name,
3961
			'user_password' => $noPass,
3962
			'user_newpassword' => $noPass,
3963
			'user_email' => $user->mEmail,
3964
			'user_email_authenticated' => $dbw->timestampOrNull( $user->mEmailAuthenticated ),
3965
			'user_real_name' => $user->mRealName,
3966
			'user_token' => strval( $user->mToken ),
3967
			'user_registration' => $dbw->timestamp( $user->mRegistration ),
3968
			'user_editcount' => 0,
3969
			'user_touched' => $dbw->timestamp( $user->newTouchedTimestamp() ),
3970
		];
3971
		foreach ( $params as $name => $value ) {
3972
			$fields["user_$name"] = $value;
3973
		}
3974
		$dbw->insert( 'user', $fields, __METHOD__, [ 'IGNORE' ] );
3975
		if ( $dbw->affectedRows() ) {
3976
			$newUser = User::newFromId( $dbw->insertId() );
3977
		} else {
3978
			$newUser = null;
3979
		}
3980
		return $newUser;
3981
	}
3982
3983
	/**
3984
	 * Add this existing user object to the database. If the user already
3985
	 * exists, a fatal status object is returned, and the user object is
3986
	 * initialised with the data from the database.
3987
	 *
3988
	 * Previously, this function generated a DB error due to a key conflict
3989
	 * if the user already existed. Many extension callers use this function
3990
	 * in code along the lines of:
3991
	 *
3992
	 *   $user = User::newFromName( $name );
3993
	 *   if ( !$user->isLoggedIn() ) {
3994
	 *       $user->addToDatabase();
3995
	 *   }
3996
	 *   // do something with $user...
3997
	 *
3998
	 * However, this was vulnerable to a race condition (bug 16020). By
3999
	 * initialising the user object if the user exists, we aim to support this
4000
	 * calling sequence as far as possible.
4001
	 *
4002
	 * Note that if the user exists, this function will acquire a write lock,
4003
	 * so it is still advisable to make the call conditional on isLoggedIn(),
4004
	 * and to commit the transaction after calling.
4005
	 *
4006
	 * @throws MWException
4007
	 * @return Status
4008
	 */
4009
	public function addToDatabase() {
4010
		$this->load();
4011
		if ( !$this->mToken ) {
4012
			$this->setToken(); // init token
4013
		}
4014
4015
		$this->mTouched = $this->newTouchedTimestamp();
0 ignored issues
show
Documentation Bug introduced by
It seems like $this->newTouchedTimestamp() can also be of type false. However, the property $mTouched is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
4016
4017
		$noPass = PasswordFactory::newInvalidPassword()->toString();
4018
4019
		$dbw = wfGetDB( DB_MASTER );
4020
		$seqVal = $dbw->nextSequenceValue( 'user_user_id_seq' );
4021
		$dbw->insert( 'user',
4022
			[
4023
				'user_id' => $seqVal,
4024
				'user_name' => $this->mName,
4025
				'user_password' => $noPass,
4026
				'user_newpassword' => $noPass,
4027
				'user_email' => $this->mEmail,
4028
				'user_email_authenticated' => $dbw->timestampOrNull( $this->mEmailAuthenticated ),
4029
				'user_real_name' => $this->mRealName,
4030
				'user_token' => strval( $this->mToken ),
4031
				'user_registration' => $dbw->timestamp( $this->mRegistration ),
4032
				'user_editcount' => 0,
4033
				'user_touched' => $dbw->timestamp( $this->mTouched ),
4034
			], __METHOD__,
4035
			[ 'IGNORE' ]
4036
		);
4037
		if ( !$dbw->affectedRows() ) {
4038
			// Use locking reads to bypass any REPEATABLE-READ snapshot.
4039
			$this->mId = $dbw->selectField(
4040
				'user',
4041
				'user_id',
4042
				[ 'user_name' => $this->mName ],
4043
				__METHOD__,
4044
				[ 'LOCK IN SHARE MODE' ]
4045
			);
4046
			$loaded = false;
4047
			if ( $this->mId ) {
4048
				if ( $this->loadFromDatabase( self::READ_LOCKING ) ) {
4049
					$loaded = true;
4050
				}
4051
			}
4052
			if ( !$loaded ) {
4053
				throw new MWException( __METHOD__ . ": hit a key conflict attempting " .
4054
					"to insert user '{$this->mName}' row, but it was not present in select!" );
4055
			}
4056
			return Status::newFatal( 'userexists' );
4057
		}
4058
		$this->mId = $dbw->insertId();
4059
		self::$idCacheByName[$this->mName] = $this->mId;
4060
4061
		// Clear instance cache other than user table data, which is already accurate
4062
		$this->clearInstanceCache();
4063
4064
		$this->saveOptions();
4065
		return Status::newGood();
4066
	}
4067
4068
	/**
4069
	 * If this user is logged-in and blocked,
4070
	 * block any IP address they've successfully logged in from.
4071
	 * @return bool A block was spread
4072
	 */
4073
	public function spreadAnyEditBlock() {
4074
		if ( $this->isLoggedIn() && $this->isBlocked() ) {
4075
			return $this->spreadBlock();
4076
		}
4077
4078
		return false;
4079
	}
4080
4081
	/**
4082
	 * If this (non-anonymous) user is blocked,
4083
	 * block the IP address they've successfully logged in from.
4084
	 * @return bool A block was spread
4085
	 */
4086
	protected function spreadBlock() {
4087
		wfDebug( __METHOD__ . "()\n" );
4088
		$this->load();
4089
		if ( $this->mId == 0 ) {
4090
			return false;
4091
		}
4092
4093
		$userblock = Block::newFromTarget( $this->getName() );
4094
		if ( !$userblock ) {
4095
			return false;
4096
		}
4097
4098
		return (bool)$userblock->doAutoblock( $this->getRequest()->getIP() );
4099
	}
4100
4101
	/**
4102
	 * Get whether the user is explicitly blocked from account creation.
4103
	 * @return bool|Block
4104
	 */
4105
	public function isBlockedFromCreateAccount() {
4106
		$this->getBlockedStatus();
4107
		if ( $this->mBlock && $this->mBlock->prevents( 'createaccount' ) ) {
4108
			return $this->mBlock;
4109
		}
4110
4111
		# bug 13611: if the IP address the user is trying to create an account from is
4112
		# blocked with createaccount disabled, prevent new account creation there even
4113
		# when the user is logged in
4114
		if ( $this->mBlockedFromCreateAccount === false && !$this->isAllowed( 'ipblock-exempt' ) ) {
4115
			$this->mBlockedFromCreateAccount = Block::newFromTarget( null, $this->getRequest()->getIP() );
4116
		}
4117
		return $this->mBlockedFromCreateAccount instanceof Block
4118
			&& $this->mBlockedFromCreateAccount->prevents( 'createaccount' )
4119
			? $this->mBlockedFromCreateAccount
4120
			: false;
4121
	}
4122
4123
	/**
4124
	 * Get whether the user is blocked from using Special:Emailuser.
4125
	 * @return bool
4126
	 */
4127
	public function isBlockedFromEmailuser() {
4128
		$this->getBlockedStatus();
4129
		return $this->mBlock && $this->mBlock->prevents( 'sendemail' );
4130
	}
4131
4132
	/**
4133
	 * Get whether the user is allowed to create an account.
4134
	 * @return bool
4135
	 */
4136
	public function isAllowedToCreateAccount() {
4137
		return $this->isAllowed( 'createaccount' ) && !$this->isBlockedFromCreateAccount();
4138
	}
4139
4140
	/**
4141
	 * Get this user's personal page title.
4142
	 *
4143
	 * @return Title User's personal page title
4144
	 */
4145
	public function getUserPage() {
4146
		return Title::makeTitle( NS_USER, $this->getName() );
4147
	}
4148
4149
	/**
4150
	 * Get this user's talk page title.
4151
	 *
4152
	 * @return Title User's talk page title
4153
	 */
4154
	public function getTalkPage() {
4155
		$title = $this->getUserPage();
4156
		return $title->getTalkPage();
4157
	}
4158
4159
	/**
4160
	 * Determine whether the user is a newbie. Newbies are either
4161
	 * anonymous IPs, or the most recently created accounts.
4162
	 * @return bool
4163
	 */
4164
	public function isNewbie() {
4165
		return !$this->isAllowed( 'autoconfirmed' );
4166
	}
4167
4168
	/**
4169
	 * Check to see if the given clear-text password is one of the accepted passwords
4170
	 * @deprecated since 1.27, use AuthManager instead
4171
	 * @param string $password User password
4172
	 * @return bool True if the given password is correct, otherwise False
4173
	 */
4174
	public function checkPassword( $password ) {
4175
		$manager = AuthManager::singleton();
4176
		$reqs = AuthenticationRequest::loadRequestsFromSubmission(
4177
			$manager->getAuthenticationRequests( AuthManager::ACTION_LOGIN ),
4178
			[
4179
				'username' => $this->getName(),
4180
				'password' => $password,
4181
			]
4182
		);
4183
		$res = AuthManager::singleton()->beginAuthentication( $reqs, 'null:' );
4184
		switch ( $res->status ) {
4185
			case AuthenticationResponse::PASS:
4186
				return true;
4187
			case AuthenticationResponse::FAIL:
4188
				// Hope it's not a PreAuthenticationProvider that failed...
4189
				\MediaWiki\Logger\LoggerFactory::getInstance( 'authentication' )
4190
					->info( __METHOD__ . ': Authentication failed: ' . $res->message->plain() );
4191
				return false;
4192
			default:
4193
				throw new BadMethodCallException(
4194
					'AuthManager returned a response unsupported by ' . __METHOD__
4195
				);
4196
		}
4197
	}
4198
4199
	/**
4200
	 * Check if the given clear-text password matches the temporary password
4201
	 * sent by e-mail for password reset operations.
4202
	 *
4203
	 * @deprecated since 1.27, use AuthManager instead
4204
	 * @param string $plaintext
4205
	 * @return bool True if matches, false otherwise
4206
	 */
4207
	public function checkTemporaryPassword( $plaintext ) {
4208
		// Can't check the temporary password individually.
4209
		return $this->checkPassword( $plaintext );
4210
	}
4211
4212
	/**
4213
	 * Initialize (if necessary) and return a session token value
4214
	 * which can be used in edit forms to show that the user's
4215
	 * login credentials aren't being hijacked with a foreign form
4216
	 * submission.
4217
	 *
4218
	 * @since 1.27
4219
	 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4220
	 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4221
	 * @return MediaWiki\Session\Token The new edit token
4222
	 */
4223
	public function getEditTokenObject( $salt = '', $request = null ) {
4224
		if ( $this->isAnon() ) {
4225
			return new LoggedOutEditToken();
4226
		}
4227
4228
		if ( !$request ) {
4229
			$request = $this->getRequest();
4230
		}
4231
		return $request->getSession()->getToken( $salt );
0 ignored issues
show
Bug introduced by
It seems like $salt defined by parameter $salt on line 4223 can also be of type array; however, MediaWiki\Session\Session::getToken() does only seem to accept string|array<integer,string>, maybe add an additional type check?

This check looks at variables that have been passed in as parameters and are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
4232
	}
4233
4234
	/**
4235
	 * Initialize (if necessary) and return a session token value
4236
	 * which can be used in edit forms to show that the user's
4237
	 * login credentials aren't being hijacked with a foreign form
4238
	 * submission.
4239
	 *
4240
	 * The $salt for 'edit' and 'csrf' tokens is the default (empty string).
4241
	 *
4242
	 * @since 1.19
4243
	 * @param string|array $salt Array of Strings Optional function-specific data for hashing
4244
	 * @param WebRequest|null $request WebRequest object to use or null to use $wgRequest
4245
	 * @return string The new edit token
4246
	 */
4247
	public function getEditToken( $salt = '', $request = null ) {
4248
		return $this->getEditTokenObject( $salt, $request )->toString();
4249
	}
4250
4251
	/**
4252
	 * Get the embedded timestamp from a token.
4253
	 * @deprecated since 1.27, use \MediaWiki\Session\Token::getTimestamp instead.
4254
	 * @param string $val Input token
4255
	 * @return int|null
4256
	 */
4257
	public static function getEditTokenTimestamp( $val ) {
4258
		wfDeprecated( __METHOD__, '1.27' );
4259
		return MediaWiki\Session\Token::getTimestamp( $val );
4260
	}
4261
4262
	/**
4263
	 * Check given value against the token value stored in the session.
4264
	 * A match should confirm that the form was submitted from the
4265
	 * user's own login session, not a form submission from a third-party
4266
	 * site.
4267
	 *
4268
	 * @param string $val Input value to compare
4269
	 * @param string $salt Optional function-specific data for hashing
4270
	 * @param WebRequest|null $request Object to use or null to use $wgRequest
4271
	 * @param int $maxage Fail tokens older than this, in seconds
4272
	 * @return bool Whether the token matches
4273
	 */
4274
	public function matchEditToken( $val, $salt = '', $request = null, $maxage = null ) {
4275
		return $this->getEditTokenObject( $salt, $request )->match( $val, $maxage );
4276
	}
4277
4278
	/**
4279
	 * Check given value against the token value stored in the session,
4280
	 * ignoring the suffix.
4281
	 *
4282
	 * @param string $val Input value to compare
4283
	 * @param string $salt Optional function-specific data for hashing
4284
	 * @param WebRequest|null $request Object to use or null to use $wgRequest
4285
	 * @param int $maxage Fail tokens older than this, in seconds
4286
	 * @return bool Whether the token matches
4287
	 */
4288
	public function matchEditTokenNoSuffix( $val, $salt = '', $request = null, $maxage = null ) {
4289
		$val = substr( $val, 0, strspn( $val, '0123456789abcdef' ) ) . Token::SUFFIX;
4290
		return $this->matchEditToken( $val, $salt, $request, $maxage );
4291
	}
4292
4293
	/**
4294
	 * Generate a new e-mail confirmation token and send a confirmation/invalidation
4295
	 * mail to the user's given address.
4296
	 *
4297
	 * @param string $type Message to send, either "created", "changed" or "set"
4298
	 * @return Status
4299
	 */
4300
	public function sendConfirmationMail( $type = 'created' ) {
4301
		global $wgLang;
4302
		$expiration = null; // gets passed-by-ref and defined in next line.
4303
		$token = $this->confirmationToken( $expiration );
4304
		$url = $this->confirmationTokenUrl( $token );
4305
		$invalidateURL = $this->invalidationTokenUrl( $token );
4306
		$this->saveSettings();
4307
4308
		if ( $type == 'created' || $type === false ) {
4309
			$message = 'confirmemail_body';
4310
		} elseif ( $type === true ) {
4311
			$message = 'confirmemail_body_changed';
4312
		} else {
4313
			// Messages: confirmemail_body_changed, confirmemail_body_set
4314
			$message = 'confirmemail_body_' . $type;
4315
		}
4316
4317
		return $this->sendMail( wfMessage( 'confirmemail_subject' )->text(),
4318
			wfMessage( $message,
4319
				$this->getRequest()->getIP(),
4320
				$this->getName(),
4321
				$url,
4322
				$wgLang->userTimeAndDate( $expiration, $this ),
4323
				$invalidateURL,
4324
				$wgLang->userDate( $expiration, $this ),
4325
				$wgLang->userTime( $expiration, $this ) )->text() );
4326
	}
4327
4328
	/**
4329
	 * Send an e-mail to this user's account. Does not check for
4330
	 * confirmed status or validity.
4331
	 *
4332
	 * @param string $subject Message subject
4333
	 * @param string $body Message body
4334
	 * @param User|null $from Optional sending user; if unspecified, default
4335
	 *   $wgPasswordSender will be used.
4336
	 * @param string $replyto Reply-To address
4337
	 * @return Status
4338
	 */
4339
	public function sendMail( $subject, $body, $from = null, $replyto = null ) {
4340
		global $wgPasswordSender;
4341
4342
		if ( $from instanceof User ) {
4343
			$sender = MailAddress::newFromUser( $from );
4344
		} else {
4345
			$sender = new MailAddress( $wgPasswordSender,
4346
				wfMessage( 'emailsender' )->inContentLanguage()->text() );
4347
		}
4348
		$to = MailAddress::newFromUser( $this );
4349
4350
		return UserMailer::send( $to, $sender, $subject, $body, [
4351
			'replyTo' => $replyto,
4352
		] );
4353
	}
4354
4355
	/**
4356
	 * Generate, store, and return a new e-mail confirmation code.
4357
	 * A hash (unsalted, since it's used as a key) is stored.
4358
	 *
4359
	 * @note Call saveSettings() after calling this function to commit
4360
	 * this change to the database.
4361
	 *
4362
	 * @param string &$expiration Accepts the expiration time
4363
	 * @return string New token
4364
	 */
4365
	protected function confirmationToken( &$expiration ) {
4366
		global $wgUserEmailConfirmationTokenExpiry;
4367
		$now = time();
4368
		$expires = $now + $wgUserEmailConfirmationTokenExpiry;
4369
		$expiration = wfTimestamp( TS_MW, $expires );
4370
		$this->load();
4371
		$token = MWCryptRand::generateHex( 32 );
4372
		$hash = md5( $token );
4373
		$this->mEmailToken = $hash;
4374
		$this->mEmailTokenExpires = $expiration;
0 ignored issues
show
Documentation Bug introduced by
It seems like $expiration can also be of type false. However, the property $mEmailTokenExpires is declared as type string. Maybe add an additional type check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a mixed type is assigned to a property that is type hinted more strictly.

For example, imagine you have a variable $accountId that can either hold an Id object or false (if there is no account id yet). Your code now assigns that value to the id property of an instance of the Account class. This class holds a proper account, so the id value must no longer be false.

Either this assignment is in error or a type check should be added for that assignment.

class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
Loading history...
4375
		return $token;
4376
	}
4377
4378
	/**
4379
	 * Return a URL the user can use to confirm their email address.
4380
	 * @param string $token Accepts the email confirmation token
4381
	 * @return string New token URL
4382
	 */
4383
	protected function confirmationTokenUrl( $token ) {
4384
		return $this->getTokenUrl( 'ConfirmEmail', $token );
4385
	}
4386
4387
	/**
4388
	 * Return a URL the user can use to invalidate their email address.
4389
	 * @param string $token Accepts the email confirmation token
4390
	 * @return string New token URL
4391
	 */
4392
	protected function invalidationTokenUrl( $token ) {
4393
		return $this->getTokenUrl( 'InvalidateEmail', $token );
4394
	}
4395
4396
	/**
4397
	 * Internal function to format the e-mail validation/invalidation URLs.
4398
	 * This uses a quickie hack to use the
4399
	 * hardcoded English names of the Special: pages, for ASCII safety.
4400
	 *
4401
	 * @note Since these URLs get dropped directly into emails, using the
4402
	 * short English names avoids insanely long URL-encoded links, which
4403
	 * also sometimes can get corrupted in some browsers/mailers
4404
	 * (bug 6957 with Gmail and Internet Explorer).
4405
	 *
4406
	 * @param string $page Special page
4407
	 * @param string $token Token
4408
	 * @return string Formatted URL
4409
	 */
4410
	protected function getTokenUrl( $page, $token ) {
4411
		// Hack to bypass localization of 'Special:'
4412
		$title = Title::makeTitle( NS_MAIN, "Special:$page/$token" );
4413
		return $title->getCanonicalURL();
4414
	}
4415
4416
	/**
4417
	 * Mark the e-mail address confirmed.
4418
	 *
4419
	 * @note Call saveSettings() after calling this function to commit the change.
4420
	 *
4421
	 * @return bool
4422
	 */
4423
	public function confirmEmail() {
4424
		// Check if it's already confirmed, so we don't touch the database
4425
		// and fire the ConfirmEmailComplete hook on redundant confirmations.
4426
		if ( !$this->isEmailConfirmed() ) {
4427
			$this->setEmailAuthenticationTimestamp( wfTimestampNow() );
0 ignored issues
show
Security Bug introduced by
It seems like wfTimestampNow() can also be of type false; however, User::setEmailAuthenticationTimestamp() does only seem to accept string, did you maybe forget to handle an error condition?
Loading history...
4428
			Hooks::run( 'ConfirmEmailComplete', [ $this ] );
4429
		}
4430
		return true;
4431
	}
4432
4433
	/**
4434
	 * Invalidate the user's e-mail confirmation, and unauthenticate the e-mail
4435
	 * address if it was already confirmed.
4436
	 *
4437
	 * @note Call saveSettings() after calling this function to commit the change.
4438
	 * @return bool Returns true
4439
	 */
4440
	public function invalidateEmail() {
4441
		$this->load();
4442
		$this->mEmailToken = null;
4443
		$this->mEmailTokenExpires = null;
4444
		$this->setEmailAuthenticationTimestamp( null );
4445
		$this->mEmail = '';
4446
		Hooks::run( 'InvalidateEmailComplete', [ $this ] );
4447
		return true;
4448
	}
4449
4450
	/**
4451
	 * Set the e-mail authentication timestamp.
4452
	 * @param string $timestamp TS_MW timestamp
4453
	 */
4454
	public function setEmailAuthenticationTimestamp( $timestamp ) {
4455
		$this->load();
4456
		$this->mEmailAuthenticated = $timestamp;
4457
		Hooks::run( 'UserSetEmailAuthenticationTimestamp', [ $this, &$this->mEmailAuthenticated ] );
4458
	}
4459
4460
	/**
4461
	 * Is this user allowed to send e-mails within limits of current
4462
	 * site configuration?
4463
	 * @return bool
4464
	 */
4465
	public function canSendEmail() {
4466
		global $wgEnableEmail, $wgEnableUserEmail;
4467
		if ( !$wgEnableEmail || !$wgEnableUserEmail || !$this->isAllowed( 'sendemail' ) ) {
4468
			return false;
4469
		}
4470
		$canSend = $this->isEmailConfirmed();
4471
		Hooks::run( 'UserCanSendEmail', [ &$this, &$canSend ] );
4472
		return $canSend;
4473
	}
4474
4475
	/**
4476
	 * Is this user allowed to receive e-mails within limits of current
4477
	 * site configuration?
4478
	 * @return bool
4479
	 */
4480
	public function canReceiveEmail() {
4481
		return $this->isEmailConfirmed() && !$this->getOption( 'disablemail' );
4482
	}
4483
4484
	/**
4485
	 * Is this user's e-mail address valid-looking and confirmed within
4486
	 * limits of the current site configuration?
4487
	 *
4488
	 * @note If $wgEmailAuthentication is on, this may require the user to have
4489
	 * confirmed their address by returning a code or using a password
4490
	 * sent to the address from the wiki.
4491
	 *
4492
	 * @return bool
4493
	 */
4494
	public function isEmailConfirmed() {
4495
		global $wgEmailAuthentication;
4496
		$this->load();
4497
		$confirmed = true;
4498
		if ( Hooks::run( 'EmailConfirmed', [ &$this, &$confirmed ] ) ) {
4499
			if ( $this->isAnon() ) {
4500
				return false;
4501
			}
4502
			if ( !Sanitizer::validateEmail( $this->mEmail ) ) {
0 ignored issues
show
Bug Best Practice introduced by
The expression \Sanitizer::validateEmail($this->mEmail) of type null|boolean is loosely compared to false; this is ambiguous if the boolean can be false. You might want to explicitly use !== null instead.

If an expression can have both false, and null as possible values. It is generally a good practice to always use strict comparison to clearly distinguish between those two values.

$a = canBeFalseAndNull();

// Instead of
if ( ! $a) { }

// Better use one of the explicit versions:
if ($a !== null) { }
if ($a !== false) { }
if ($a !== null && $a !== false) { }
Loading history...
4503
				return false;
4504
			}
4505
			if ( $wgEmailAuthentication && !$this->getEmailAuthenticationTimestamp() ) {
4506
				return false;
4507
			}
4508
			return true;
4509
		} else {
4510
			return $confirmed;
4511
		}
4512
	}
4513
4514
	/**
4515
	 * Check whether there is an outstanding request for e-mail confirmation.
4516
	 * @return bool
4517
	 */
4518
	public function isEmailConfirmationPending() {
4519
		global $wgEmailAuthentication;
4520
		return $wgEmailAuthentication &&
4521
			!$this->isEmailConfirmed() &&
4522
			$this->mEmailToken &&
4523
			$this->mEmailTokenExpires > wfTimestamp();
4524
	}
4525
4526
	/**
4527
	 * Get the timestamp of account creation.
4528
	 *
4529
	 * @return string|bool|null Timestamp of account creation, false for
4530
	 *  non-existent/anonymous user accounts, or null if existing account
4531
	 *  but information is not in database.
4532
	 */
4533
	public function getRegistration() {
4534
		if ( $this->isAnon() ) {
4535
			return false;
4536
		}
4537
		$this->load();
4538
		return $this->mRegistration;
4539
	}
4540
4541
	/**
4542
	 * Get the timestamp of the first edit
4543
	 *
4544
	 * @return string|bool Timestamp of first edit, or false for
4545
	 *  non-existent/anonymous user accounts.
4546
	 */
4547
	public function getFirstEditTimestamp() {
4548
		if ( $this->getId() == 0 ) {
4549
			return false; // anons
4550
		}
4551
		$dbr = wfGetDB( DB_REPLICA );
4552
		$time = $dbr->selectField( 'revision', 'rev_timestamp',
4553
			[ 'rev_user' => $this->getId() ],
4554
			__METHOD__,
4555
			[ 'ORDER BY' => 'rev_timestamp ASC' ]
4556
		);
4557
		if ( !$time ) {
4558
			return false; // no edits
4559
		}
4560
		return wfTimestamp( TS_MW, $time );
4561
	}
4562
4563
	/**
4564
	 * Get the permissions associated with a given list of groups
4565
	 *
4566
	 * @param array $groups Array of Strings List of internal group names
4567
	 * @return array Array of Strings List of permission key names for given groups combined
4568
	 */
4569
	public static function getGroupPermissions( $groups ) {
4570
		global $wgGroupPermissions, $wgRevokePermissions;
4571
		$rights = [];
4572
		// grant every granted permission first
4573
		foreach ( $groups as $group ) {
4574
			if ( isset( $wgGroupPermissions[$group] ) ) {
4575
				$rights = array_merge( $rights,
4576
					// array_filter removes empty items
4577
					array_keys( array_filter( $wgGroupPermissions[$group] ) ) );
4578
			}
4579
		}
4580
		// now revoke the revoked permissions
4581
		foreach ( $groups as $group ) {
4582
			if ( isset( $wgRevokePermissions[$group] ) ) {
4583
				$rights = array_diff( $rights,
4584
					array_keys( array_filter( $wgRevokePermissions[$group] ) ) );
4585
			}
4586
		}
4587
		return array_unique( $rights );
4588
	}
4589
4590
	/**
4591
	 * Get all the groups who have a given permission
4592
	 *
4593
	 * @param string $role Role to check
4594
	 * @return array Array of Strings List of internal group names with the given permission
4595
	 */
4596
	public static function getGroupsWithPermission( $role ) {
4597
		global $wgGroupPermissions;
4598
		$allowedGroups = [];
4599
		foreach ( array_keys( $wgGroupPermissions ) as $group ) {
4600
			if ( self::groupHasPermission( $group, $role ) ) {
4601
				$allowedGroups[] = $group;
4602
			}
4603
		}
4604
		return $allowedGroups;
4605
	}
4606
4607
	/**
4608
	 * Check, if the given group has the given permission
4609
	 *
4610
	 * If you're wanting to check whether all users have a permission, use
4611
	 * User::isEveryoneAllowed() instead. That properly checks if it's revoked
4612
	 * from anyone.
4613
	 *
4614
	 * @since 1.21
4615
	 * @param string $group Group to check
4616
	 * @param string $role Role to check
4617
	 * @return bool
4618
	 */
4619
	public static function groupHasPermission( $group, $role ) {
4620
		global $wgGroupPermissions, $wgRevokePermissions;
4621
		return isset( $wgGroupPermissions[$group][$role] ) && $wgGroupPermissions[$group][$role]
4622
			&& !( isset( $wgRevokePermissions[$group][$role] ) && $wgRevokePermissions[$group][$role] );
4623
	}
4624
4625
	/**
4626
	 * Check if all users may be assumed to have the given permission
4627
	 *
4628
	 * We generally assume so if the right is granted to '*' and isn't revoked
4629
	 * on any group. It doesn't attempt to take grants or other extension
4630
	 * limitations on rights into account in the general case, though, as that
4631
	 * would require it to always return false and defeat the purpose.
4632
	 * Specifically, session-based rights restrictions (such as OAuth or bot
4633
	 * passwords) are applied based on the current session.
4634
	 *
4635
	 * @since 1.22
4636
	 * @param string $right Right to check
4637
	 * @return bool
4638
	 */
4639
	public static function isEveryoneAllowed( $right ) {
4640
		global $wgGroupPermissions, $wgRevokePermissions;
4641
		static $cache = [];
4642
4643
		// Use the cached results, except in unit tests which rely on
4644
		// being able change the permission mid-request
4645
		if ( isset( $cache[$right] ) && !defined( 'MW_PHPUNIT_TEST' ) ) {
4646
			return $cache[$right];
4647
		}
4648
4649
		if ( !isset( $wgGroupPermissions['*'][$right] ) || !$wgGroupPermissions['*'][$right] ) {
4650
			$cache[$right] = false;
4651
			return false;
4652
		}
4653
4654
		// If it's revoked anywhere, then everyone doesn't have it
4655
		foreach ( $wgRevokePermissions as $rights ) {
4656
			if ( isset( $rights[$right] ) && $rights[$right] ) {
4657
				$cache[$right] = false;
4658
				return false;
4659
			}
4660
		}
4661
4662
		// Remove any rights that aren't allowed to the global-session user,
4663
		// unless there are no sessions for this endpoint.
4664
		if ( !defined( 'MW_NO_SESSION' ) ) {
4665
			$allowedRights = SessionManager::getGlobalSession()->getAllowedUserRights();
4666
			if ( $allowedRights !== null && !in_array( $right, $allowedRights, true ) ) {
4667
				$cache[$right] = false;
4668
				return false;
4669
			}
4670
		}
4671
4672
		// Allow extensions to say false
4673
		if ( !Hooks::run( 'UserIsEveryoneAllowed', [ $right ] ) ) {
4674
			$cache[$right] = false;
4675
			return false;
4676
		}
4677
4678
		$cache[$right] = true;
4679
		return true;
4680
	}
4681
4682
	/**
4683
	 * Get the localized descriptive name for a group, if it exists
4684
	 *
4685
	 * @param string $group Internal group name
4686
	 * @return string Localized descriptive group name
4687
	 */
4688
	public static function getGroupName( $group ) {
4689
		$msg = wfMessage( "group-$group" );
4690
		return $msg->isBlank() ? $group : $msg->text();
4691
	}
4692
4693
	/**
4694
	 * Get the localized descriptive name for a member of a group, if it exists
4695
	 *
4696
	 * @param string $group Internal group name
4697
	 * @param string $username Username for gender (since 1.19)
4698
	 * @return string Localized name for group member
4699
	 */
4700
	public static function getGroupMember( $group, $username = '#' ) {
4701
		$msg = wfMessage( "group-$group-member", $username );
4702
		return $msg->isBlank() ? $group : $msg->text();
4703
	}
4704
4705
	/**
4706
	 * Return the set of defined explicit groups.
4707
	 * The implicit groups (by default *, 'user' and 'autoconfirmed')
4708
	 * are not included, as they are defined automatically, not in the database.
4709
	 * @return array Array of internal group names
4710
	 */
4711
	public static function getAllGroups() {
4712
		global $wgGroupPermissions, $wgRevokePermissions;
4713
		return array_diff(
4714
			array_merge( array_keys( $wgGroupPermissions ), array_keys( $wgRevokePermissions ) ),
4715
			self::getImplicitGroups()
4716
		);
4717
	}
4718
4719
	/**
4720
	 * Get a list of all available permissions.
4721
	 * @return string[] Array of permission names
4722
	 */
4723
	public static function getAllRights() {
4724
		if ( self::$mAllRights === false ) {
4725
			global $wgAvailableRights;
4726
			if ( count( $wgAvailableRights ) ) {
4727
				self::$mAllRights = array_unique( array_merge( self::$mCoreRights, $wgAvailableRights ) );
0 ignored issues
show
Documentation Bug introduced by
It seems like array_unique(array_merge...s, $wgAvailableRights)) of type array is incompatible with the declared type boolean of property $mAllRights.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
4728
			} else {
4729
				self::$mAllRights = self::$mCoreRights;
0 ignored issues
show
Documentation Bug introduced by
It seems like self::$mCoreRights of type array is incompatible with the declared type boolean of property $mAllRights.

Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property..

Loading history...
4730
			}
4731
			Hooks::run( 'UserGetAllRights', [ &self::$mAllRights ] );
4732
		}
4733
		return self::$mAllRights;
4734
	}
4735
4736
	/**
4737
	 * Get a list of implicit groups
4738
	 * @return array Array of Strings Array of internal group names
4739
	 */
4740
	public static function getImplicitGroups() {
4741
		global $wgImplicitGroups;
4742
4743
		$groups = $wgImplicitGroups;
4744
		# Deprecated, use $wgImplicitGroups instead
4745
		Hooks::run( 'UserGetImplicitGroups', [ &$groups ], '1.25' );
4746
4747
		return $groups;
4748
	}
4749
4750
	/**
4751
	 * Get the title of a page describing a particular group
4752
	 *
4753
	 * @param string $group Internal group name
4754
	 * @return Title|bool Title of the page if it exists, false otherwise
4755
	 */
4756
	public static function getGroupPage( $group ) {
4757
		$msg = wfMessage( 'grouppage-' . $group )->inContentLanguage();
4758
		if ( $msg->exists() ) {
4759
			$title = Title::newFromText( $msg->text() );
4760
			if ( is_object( $title ) ) {
4761
				return $title;
4762
			}
4763
		}
4764
		return false;
4765
	}
4766
4767
	/**
4768
	 * Create a link to the group in HTML, if available;
4769
	 * else return the group name.
4770
	 *
4771
	 * @param string $group Internal name of the group
4772
	 * @param string $text The text of the link
4773
	 * @return string HTML link to the group
4774
	 */
4775
	public static function makeGroupLinkHTML( $group, $text = '' ) {
4776
		if ( $text == '' ) {
4777
			$text = self::getGroupName( $group );
4778
		}
4779
		$title = self::getGroupPage( $group );
4780
		if ( $title ) {
4781
			return Linker::link( $title, htmlspecialchars( $text ) );
4782
		} else {
4783
			return htmlspecialchars( $text );
4784
		}
4785
	}
4786
4787
	/**
4788
	 * Create a link to the group in Wikitext, if available;
4789
	 * else return the group name.
4790
	 *
4791
	 * @param string $group Internal name of the group
4792
	 * @param string $text The text of the link
4793
	 * @return string Wikilink to the group
4794
	 */
4795
	public static function makeGroupLinkWiki( $group, $text = '' ) {
4796
		if ( $text == '' ) {
4797
			$text = self::getGroupName( $group );
4798
		}
4799
		$title = self::getGroupPage( $group );
4800
		if ( $title ) {
4801
			$page = $title->getFullText();
4802
			return "[[$page|$text]]";
4803
		} else {
4804
			return $text;
4805
		}
4806
	}
4807
4808
	/**
4809
	 * Returns an array of the groups that a particular group can add/remove.
4810
	 *
4811
	 * @param string $group The group to check for whether it can add/remove
4812
	 * @return array Array( 'add' => array( addablegroups ),
4813
	 *     'remove' => array( removablegroups ),
4814
	 *     'add-self' => array( addablegroups to self),
4815
	 *     'remove-self' => array( removable groups from self) )
4816
	 */
4817
	public static function changeableByGroup( $group ) {
4818
		global $wgAddGroups, $wgRemoveGroups, $wgGroupsAddToSelf, $wgGroupsRemoveFromSelf;
4819
4820
		$groups = [
4821
			'add' => [],
4822
			'remove' => [],
4823
			'add-self' => [],
4824
			'remove-self' => []
4825
		];
4826
4827 View Code Duplication
		if ( empty( $wgAddGroups[$group] ) ) {
0 ignored issues
show
Unused Code introduced by
This if statement is empty and can be removed.

This check looks for the bodies of if statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These if bodies can be removed. If you have an empty if but statements in the else branch, consider inverting the condition.

if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

could be turned into

if (rand(1, 6) <= 3) {
    print "Check succeeded";
}

This is much more concise to read.

Loading history...
4828
			// Don't add anything to $groups
4829
		} elseif ( $wgAddGroups[$group] === true ) {
4830
			// You get everything
4831
			$groups['add'] = self::getAllGroups();
4832
		} elseif ( is_array( $wgAddGroups[$group] ) ) {
4833
			$groups['add'] = $wgAddGroups[$group];
4834
		}
4835
4836
		// Same thing for remove
4837 View Code Duplication
		if ( empty( $wgRemoveGroups[$group] ) ) {
0 ignored issues
show
Unused Code introduced by
This if statement is empty and can be removed.

This check looks for the bodies of if statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These if bodies can be removed. If you have an empty if but statements in the else branch, consider inverting the condition.

if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

could be turned into

if (rand(1, 6) <= 3) {
    print "Check succeeded";
}

This is much more concise to read.

Loading history...
4838
			// Do nothing
4839
		} elseif ( $wgRemoveGroups[$group] === true ) {
4840
			$groups['remove'] = self::getAllGroups();
4841
		} elseif ( is_array( $wgRemoveGroups[$group] ) ) {
4842
			$groups['remove'] = $wgRemoveGroups[$group];
4843
		}
4844
4845
		// Re-map numeric keys of AddToSelf/RemoveFromSelf to the 'user' key for backwards compatibility
4846 View Code Duplication
		if ( empty( $wgGroupsAddToSelf['user'] ) || $wgGroupsAddToSelf['user'] !== true ) {
4847
			foreach ( $wgGroupsAddToSelf as $key => $value ) {
4848
				if ( is_int( $key ) ) {
4849
					$wgGroupsAddToSelf['user'][] = $value;
4850
				}
4851
			}
4852
		}
4853
4854 View Code Duplication
		if ( empty( $wgGroupsRemoveFromSelf['user'] ) || $wgGroupsRemoveFromSelf['user'] !== true ) {
4855
			foreach ( $wgGroupsRemoveFromSelf as $key => $value ) {
4856
				if ( is_int( $key ) ) {
4857
					$wgGroupsRemoveFromSelf['user'][] = $value;
4858
				}
4859
			}
4860
		}
4861
4862
		// Now figure out what groups the user can add to him/herself
4863 View Code Duplication
		if ( empty( $wgGroupsAddToSelf[$group] ) ) {
0 ignored issues
show
Unused Code introduced by
This if statement is empty and can be removed.

This check looks for the bodies of if statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These if bodies can be removed. If you have an empty if but statements in the else branch, consider inverting the condition.

if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

could be turned into

if (rand(1, 6) <= 3) {
    print "Check succeeded";
}

This is much more concise to read.

Loading history...
4864
			// Do nothing
4865
		} elseif ( $wgGroupsAddToSelf[$group] === true ) {
4866
			// No idea WHY this would be used, but it's there
4867
			$groups['add-self'] = User::getAllGroups();
4868
		} elseif ( is_array( $wgGroupsAddToSelf[$group] ) ) {
4869
			$groups['add-self'] = $wgGroupsAddToSelf[$group];
4870
		}
4871
4872 View Code Duplication
		if ( empty( $wgGroupsRemoveFromSelf[$group] ) ) {
0 ignored issues
show
Unused Code introduced by
This if statement is empty and can be removed.

This check looks for the bodies of if statements that have no statements or where all statements have been commented out. This may be the result of changes for debugging or the code may simply be obsolete.

These if bodies can be removed. If you have an empty if but statements in the else branch, consider inverting the condition.

if (rand(1, 6) > 3) {
//print "Check failed";
} else {
    print "Check succeeded";
}

could be turned into

if (rand(1, 6) <= 3) {
    print "Check succeeded";
}

This is much more concise to read.

Loading history...
4873
			// Do nothing
4874
		} elseif ( $wgGroupsRemoveFromSelf[$group] === true ) {
4875
			$groups['remove-self'] = User::getAllGroups();
4876
		} elseif ( is_array( $wgGroupsRemoveFromSelf[$group] ) ) {
4877
			$groups['remove-self'] = $wgGroupsRemoveFromSelf[$group];
4878
		}
4879
4880
		return $groups;
4881
	}
4882
4883
	/**
4884
	 * Returns an array of groups that this user can add and remove
4885
	 * @return array Array( 'add' => array( addablegroups ),
4886
	 *  'remove' => array( removablegroups ),
4887
	 *  'add-self' => array( addablegroups to self),
4888
	 *  'remove-self' => array( removable groups from self) )
4889
	 */
4890
	public function changeableGroups() {
4891
		if ( $this->isAllowed( 'userrights' ) ) {
4892
			// This group gives the right to modify everything (reverse-
4893
			// compatibility with old "userrights lets you change
4894
			// everything")
4895
			// Using array_merge to make the groups reindexed
4896
			$all = array_merge( User::getAllGroups() );
4897
			return [
4898
				'add' => $all,
4899
				'remove' => $all,
4900
				'add-self' => [],
4901
				'remove-self' => []
4902
			];
4903
		}
4904
4905
		// Okay, it's not so simple, we will have to go through the arrays
4906
		$groups = [
4907
			'add' => [],
4908
			'remove' => [],
4909
			'add-self' => [],
4910
			'remove-self' => []
4911
		];
4912
		$addergroups = $this->getEffectiveGroups();
4913
4914
		foreach ( $addergroups as $addergroup ) {
4915
			$groups = array_merge_recursive(
4916
				$groups, $this->changeableByGroup( $addergroup )
4917
			);
4918
			$groups['add'] = array_unique( $groups['add'] );
4919
			$groups['remove'] = array_unique( $groups['remove'] );
4920
			$groups['add-self'] = array_unique( $groups['add-self'] );
4921
			$groups['remove-self'] = array_unique( $groups['remove-self'] );
4922
		}
4923
		return $groups;
4924
	}
4925
4926
	/**
4927
	 * Deferred version of incEditCountImmediate()
4928
	 */
4929
	public function incEditCount() {
4930
		wfGetDB( DB_MASTER )->onTransactionPreCommitOrIdle( function() {
4931
			$this->incEditCountImmediate();
4932
		} );
4933
	}
4934
4935
	/**
4936
	 * Increment the user's edit-count field.
4937
	 * Will have no effect for anonymous users.
4938
	 * @since 1.26
4939
	 */
4940
	public function incEditCountImmediate() {
4941
		if ( $this->isAnon() ) {
4942
			return;
4943
		}
4944
4945
		$dbw = wfGetDB( DB_MASTER );
4946
		// No rows will be "affected" if user_editcount is NULL
4947
		$dbw->update(
4948
			'user',
4949
			[ 'user_editcount=user_editcount+1' ],
4950
			[ 'user_id' => $this->getId(), 'user_editcount IS NOT NULL' ],
4951
			__METHOD__
4952
		);
4953
		// Lazy initialization check...
4954
		if ( $dbw->affectedRows() == 0 ) {
4955
			// Now here's a goddamn hack...
4956
			$dbr = wfGetDB( DB_REPLICA );
4957
			if ( $dbr !== $dbw ) {
4958
				// If we actually have a replica DB server, the count is
4959
				// at least one behind because the current transaction
4960
				// has not been committed and replicated.
4961
				$this->mEditCount = $this->initEditCount( 1 );
4962
			} else {
4963
				// But if DB_REPLICA is selecting the master, then the
4964
				// count we just read includes the revision that was
4965
				// just added in the working transaction.
4966
				$this->mEditCount = $this->initEditCount();
4967
			}
4968
		} else {
4969
			if ( $this->mEditCount === null ) {
4970
				$this->getEditCount();
4971
				$dbr = wfGetDB( DB_REPLICA );
4972
				$this->mEditCount += ( $dbr !== $dbw ) ? 1 : 0;
4973
			} else {
4974
				$this->mEditCount++;
4975
			}
4976
		}
4977
		// Edit count in user cache too
4978
		$this->invalidateCache();
4979
	}
4980
4981
	/**
4982
	 * Initialize user_editcount from data out of the revision table
4983
	 *
4984
	 * @param int $add Edits to add to the count from the revision table
4985
	 * @return int Number of edits
4986
	 */
4987
	protected function initEditCount( $add = 0 ) {
4988
		// Pull from a replica DB to be less cruel to servers
4989
		// Accuracy isn't the point anyway here
4990
		$dbr = wfGetDB( DB_REPLICA );
4991
		$count = (int)$dbr->selectField(
4992
			'revision',
4993
			'COUNT(rev_user)',
4994
			[ 'rev_user' => $this->getId() ],
4995
			__METHOD__
4996
		);
4997
		$count = $count + $add;
4998
4999
		$dbw = wfGetDB( DB_MASTER );
5000
		$dbw->update(
5001
			'user',
5002
			[ 'user_editcount' => $count ],
5003
			[ 'user_id' => $this->getId() ],
5004
			__METHOD__
5005
		);
5006
5007
		return $count;
5008
	}
5009
5010
	/**
5011
	 * Get the description of a given right
5012
	 *
5013
	 * @param string $right Right to query
5014
	 * @return string Localized description of the right
5015
	 */
5016
	public static function getRightDescription( $right ) {
5017
		$key = "right-$right";
5018
		$msg = wfMessage( $key );
5019
		return $msg->isBlank() ? $right : $msg->text();
5020
	}
5021
5022
	/**
5023
	 * Make a new-style password hash
5024
	 *
5025
	 * @param string $password Plain-text password
5026
	 * @param bool|string $salt Optional salt, may be random or the user ID.
5027
	 *  If unspecified or false, will generate one automatically
5028
	 * @return string Password hash
5029
	 * @deprecated since 1.24, use Password class
5030
	 */
5031
	public static function crypt( $password, $salt = false ) {
5032
		wfDeprecated( __METHOD__, '1.24' );
5033
		$passwordFactory = new PasswordFactory();
5034
		$passwordFactory->init( RequestContext::getMain()->getConfig() );
5035
		$hash = $passwordFactory->newFromPlaintext( $password );
5036
		return $hash->toString();
5037
	}
5038
5039
	/**
5040
	 * Compare a password hash with a plain-text password. Requires the user
5041
	 * ID if there's a chance that the hash is an old-style hash.
5042
	 *
5043
	 * @param string $hash Password hash
5044
	 * @param string $password Plain-text password to compare
5045
	 * @param string|bool $userId User ID for old-style password salt
5046
	 *
5047
	 * @return bool
5048
	 * @deprecated since 1.24, use Password class
5049
	 */
5050
	public static function comparePasswords( $hash, $password, $userId = false ) {
5051
		wfDeprecated( __METHOD__, '1.24' );
5052
5053
		// Check for *really* old password hashes that don't even have a type
5054
		// The old hash format was just an md5 hex hash, with no type information
5055
		if ( preg_match( '/^[0-9a-f]{32}$/', $hash ) ) {
5056
			global $wgPasswordSalt;
5057
			if ( $wgPasswordSalt ) {
5058
				$password = ":B:{$userId}:{$hash}";
5059
			} else {
5060
				$password = ":A:{$hash}";
5061
			}
5062
		}
5063
5064
		$passwordFactory = new PasswordFactory();
5065
		$passwordFactory->init( RequestContext::getMain()->getConfig() );
5066
		$hash = $passwordFactory->newFromCiphertext( $hash );
5067
		return $hash->equals( $password );
5068
	}
5069
5070
	/**
5071
	 * Add a newuser log entry for this user.
5072
	 * Before 1.19 the return value was always true.
5073
	 *
5074
	 * @deprecated since 1.27, AuthManager handles logging
5075
	 * @param string|bool $action Account creation type.
5076
	 *   - String, one of the following values:
5077
	 *     - 'create' for an anonymous user creating an account for himself.
5078
	 *       This will force the action's performer to be the created user itself,
5079
	 *       no matter the value of $wgUser
5080
	 *     - 'create2' for a logged in user creating an account for someone else
5081
	 *     - 'byemail' when the created user will receive its password by e-mail
5082
	 *     - 'autocreate' when the user is automatically created (such as by CentralAuth).
5083
	 *   - Boolean means whether the account was created by e-mail (deprecated):
5084
	 *     - true will be converted to 'byemail'
5085
	 *     - false will be converted to 'create' if this object is the same as
5086
	 *       $wgUser and to 'create2' otherwise
5087
	 * @param string $reason User supplied reason
5088
	 * @return bool true
5089
	 */
5090
	public function addNewUserLogEntry( $action = false, $reason = '' ) {
5091
		return true; // disabled
5092
	}
5093
5094
	/**
5095
	 * Add an autocreate newuser log entry for this user
5096
	 * Used by things like CentralAuth and perhaps other authplugins.
5097
	 * Consider calling addNewUserLogEntry() directly instead.
5098
	 *
5099
	 * @deprecated since 1.27, AuthManager handles logging
5100
	 * @return bool
5101
	 */
5102
	public function addNewUserLogEntryAutoCreate() {
5103
		$this->addNewUserLogEntry( 'autocreate' );
0 ignored issues
show
Unused Code introduced by
The call to the method User::addNewUserLogEntry() seems un-needed as the method has no side-effects.

PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left.

Let’s take a look at an example:

class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

If we look at the getEmail() method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless:

$user = new User();
$user->getEmail(); // This line could safely be removed as it has no effect.

On the hand, if we look at the setEmail(), this method _has_ side-effects. In the following case, we could not remove the method call:

$user = new User();
$user->setEmail('email@domain'); // This line has a side-effect (it changes an
                                 // instance variable).
Loading history...
5104
5105
		return true;
5106
	}
5107
5108
	/**
5109
	 * Load the user options either from cache, the database or an array
5110
	 *
5111
	 * @param array $data Rows for the current user out of the user_properties table
5112
	 */
5113
	protected function loadOptions( $data = null ) {
5114
		global $wgContLang;
5115
5116
		$this->load();
5117
5118
		if ( $this->mOptionsLoaded ) {
5119
			return;
5120
		}
5121
5122
		$this->mOptions = self::getDefaultOptions();
0 ignored issues
show
Documentation Bug introduced by
It seems like self::getDefaultOptions() can be null. However, the property $mOptions is declared as array. Maybe change the type of the property to array|null or add a type check?

Our type inference engine has found an assignment of a scalar value (like a string, an integer or null) to a property which is an array.

Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.

To type hint that a parameter can be either an array or null, you can set a type hint of array and a default value of null. The PHP interpreter will then accept both an array or null for that parameter.

function aContainsB(array $needle = null, array  $haystack) {
    if (!$needle) {
        return false;
    }

    return array_intersect($haystack, $needle) == $haystack;
}

The function can be called with either null or an array for the parameter $needle but will only accept an array as $haystack.

Loading history...
5123
5124
		if ( !$this->getId() ) {
5125
			// For unlogged-in users, load language/variant options from request.
5126
			// There's no need to do it for logged-in users: they can set preferences,
5127
			// and handling of page content is done by $pageLang->getPreferredVariant() and such,
5128
			// so don't override user's choice (especially when the user chooses site default).
5129
			$variant = $wgContLang->getDefaultVariant();
5130
			$this->mOptions['variant'] = $variant;
5131
			$this->mOptions['language'] = $variant;
5132
			$this->mOptionsLoaded = true;
5133
			return;
5134
		}
5135
5136
		// Maybe load from the object
5137
		if ( !is_null( $this->mOptionOverrides ) ) {
5138
			wfDebug( "User: loading options for user " . $this->getId() . " from override cache.\n" );
5139
			foreach ( $this->mOptionOverrides as $key => $value ) {
5140
				$this->mOptions[$key] = $value;
5141
			}
5142
		} else {
5143
			if ( !is_array( $data ) ) {
5144
				wfDebug( "User: loading options for user " . $this->getId() . " from database.\n" );
5145
				// Load from database
5146
				$dbr = ( $this->queryFlagsUsed & self::READ_LATEST )
5147
					? wfGetDB( DB_MASTER )
5148
					: wfGetDB( DB_REPLICA );
5149
5150
				$res = $dbr->select(
5151
					'user_properties',
5152
					[ 'up_property', 'up_value' ],
5153
					[ 'up_user' => $this->getId() ],
5154
					__METHOD__
5155
				);
5156
5157
				$this->mOptionOverrides = [];
5158
				$data = [];
5159
				foreach ( $res as $row ) {
0 ignored issues
show
Bug introduced by
The expression $res of type boolean|object<ResultWrapper> is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
5160
					$data[$row->up_property] = $row->up_value;
5161
				}
5162
			}
5163
			foreach ( $data as $property => $value ) {
5164
				$this->mOptionOverrides[$property] = $value;
5165
				$this->mOptions[$property] = $value;
5166
			}
5167
		}
5168
5169
		$this->mOptionsLoaded = true;
5170
5171
		Hooks::run( 'UserLoadOptions', [ $this, &$this->mOptions ] );
5172
	}
5173
5174
	/**
5175
	 * Saves the non-default options for this user, as previously set e.g. via
5176
	 * setOption(), in the database's "user_properties" (preferences) table.
5177
	 * Usually used via saveSettings().
5178
	 */
5179
	protected function saveOptions() {
5180
		$this->loadOptions();
5181
5182
		// Not using getOptions(), to keep hidden preferences in database
5183
		$saveOptions = $this->mOptions;
5184
5185
		// Allow hooks to abort, for instance to save to a global profile.
5186
		// Reset options to default state before saving.
5187
		if ( !Hooks::run( 'UserSaveOptions', [ $this, &$saveOptions ] ) ) {
5188
			return;
5189
		}
5190
5191
		$userId = $this->getId();
5192
5193
		$insert_rows = []; // all the new preference rows
5194
		foreach ( $saveOptions as $key => $value ) {
5195
			// Don't bother storing default values
5196
			$defaultOption = self::getDefaultOption( $key );
5197
			if ( ( $defaultOption === null && $value !== false && $value !== null )
5198
				|| $value != $defaultOption
5199
			) {
5200
				$insert_rows[] = [
5201
					'up_user' => $userId,
5202
					'up_property' => $key,
5203
					'up_value' => $value,
5204
				];
5205
			}
5206
		}
5207
5208
		$dbw = wfGetDB( DB_MASTER );
5209
5210
		$res = $dbw->select( 'user_properties',
5211
			[ 'up_property', 'up_value' ], [ 'up_user' => $userId ], __METHOD__ );
5212
5213
		// Find prior rows that need to be removed or updated. These rows will
5214
		// all be deleted (the latter so that INSERT IGNORE applies the new values).
5215
		$keysDelete = [];
5216
		foreach ( $res as $row ) {
0 ignored issues
show
Bug introduced by
The expression $res of type boolean|object<ResultWrapper> is not guaranteed to be traversable. How about adding an additional type check?

There are different options of fixing this problem.

  1. If you want to be on the safe side, you can add an additional type-check:

    $collection = json_decode($data, true);
    if ( ! is_array($collection)) {
        throw new \RuntimeException('$collection must be an array.');
    }
    
    foreach ($collection as $item) { /** ... */ }
    
  2. If you are sure that the expression is traversable, you might want to add a doc comment cast to improve IDE auto-completion and static analysis:

    /** @var array $collection */
    $collection = json_decode($data, true);
    
    foreach ($collection as $item) { /** .. */ }
    
  3. Mark the issue as a false-positive: Just hover the remove button, in the top-right corner of this issue for more options.

Loading history...
5217
			if ( !isset( $saveOptions[$row->up_property] )
5218
				|| strcmp( $saveOptions[$row->up_property], $row->up_value ) != 0
5219
			) {
5220
				$keysDelete[] = $row->up_property;
5221
			}
5222
		}
5223
5224
		if ( count( $keysDelete ) ) {
5225
			// Do the DELETE by PRIMARY KEY for prior rows.
5226
			// In the past a very large portion of calls to this function are for setting
5227
			// 'rememberpassword' for new accounts (a preference that has since been removed).
5228
			// Doing a blanket per-user DELETE for new accounts with no rows in the table
5229
			// caused gap locks on [max user ID,+infinity) which caused high contention since
5230
			// updates would pile up on each other as they are for higher (newer) user IDs.
5231
			// It might not be necessary these days, but it shouldn't hurt either.
5232
			$dbw->delete( 'user_properties',
5233
				[ 'up_user' => $userId, 'up_property' => $keysDelete ], __METHOD__ );
5234
		}
5235
		// Insert the new preference rows
5236
		$dbw->insert( 'user_properties', $insert_rows, __METHOD__, [ 'IGNORE' ] );
5237
	}
5238
5239
	/**
5240
	 * Lazily instantiate and return a factory object for making passwords
5241
	 *
5242
	 * @deprecated since 1.27, create a PasswordFactory directly instead
5243
	 * @return PasswordFactory
5244
	 */
5245
	public static function getPasswordFactory() {
5246
		wfDeprecated( __METHOD__, '1.27' );
5247
		$ret = new PasswordFactory();
5248
		$ret->init( RequestContext::getMain()->getConfig() );
5249
		return $ret;
5250
	}
5251
5252
	/**
5253
	 * Provide an array of HTML5 attributes to put on an input element
5254
	 * intended for the user to enter a new password.  This may include
5255
	 * required, title, and/or pattern, depending on $wgMinimalPasswordLength.
5256
	 *
5257
	 * Do *not* use this when asking the user to enter his current password!
5258
	 * Regardless of configuration, users may have invalid passwords for whatever
5259
	 * reason (e.g., they were set before requirements were tightened up).
5260
	 * Only use it when asking for a new password, like on account creation or
5261
	 * ResetPass.
5262
	 *
5263
	 * Obviously, you still need to do server-side checking.
5264
	 *
5265
	 * NOTE: A combination of bugs in various browsers means that this function
5266
	 * actually just returns array() unconditionally at the moment.  May as
5267
	 * well keep it around for when the browser bugs get fixed, though.
5268
	 *
5269
	 * @todo FIXME: This does not belong here; put it in Html or Linker or somewhere
5270
	 *
5271
	 * @deprecated since 1.27
5272
	 * @return array Array of HTML attributes suitable for feeding to
5273
	 *   Html::element(), directly or indirectly.  (Don't feed to Xml::*()!
5274
	 *   That will get confused by the boolean attribute syntax used.)
5275
	 */
5276
	public static function passwordChangeInputAttribs() {
5277
		global $wgMinimalPasswordLength;
5278
5279
		if ( $wgMinimalPasswordLength == 0 ) {
5280
			return [];
5281
		}
5282
5283
		# Note that the pattern requirement will always be satisfied if the
5284
		# input is empty, so we need required in all cases.
5285
5286
		# @todo FIXME: Bug 23769: This needs to not claim the password is required
5287
		# if e-mail confirmation is being used.  Since HTML5 input validation
5288
		# is b0rked anyway in some browsers, just return nothing.  When it's
5289
		# re-enabled, fix this code to not output required for e-mail
5290
		# registration.
5291
		# $ret = array( 'required' );
5292
		$ret = [];
5293
5294
		# We can't actually do this right now, because Opera 9.6 will print out
5295
		# the entered password visibly in its error message!  When other
5296
		# browsers add support for this attribute, or Opera fixes its support,
5297
		# we can add support with a version check to avoid doing this on Opera
5298
		# versions where it will be a problem.  Reported to Opera as
5299
		# DSK-262266, but they don't have a public bug tracker for us to follow.
5300
		/*
5301
		if ( $wgMinimalPasswordLength > 1 ) {
5302
			$ret['pattern'] = '.{' . intval( $wgMinimalPasswordLength ) . ',}';
5303
			$ret['title'] = wfMessage( 'passwordtooshort' )
5304
				->numParams( $wgMinimalPasswordLength )->text();
5305
		}
5306
		*/
5307
5308
		return $ret;
5309
	}
5310
5311
	/**
5312
	 * Return the list of user fields that should be selected to create
5313
	 * a new user object.
5314
	 * @return array
5315
	 */
5316
	public static function selectFields() {
5317
		return [
5318
			'user_id',
5319
			'user_name',
5320
			'user_real_name',
5321
			'user_email',
5322
			'user_touched',
5323
			'user_token',
5324
			'user_email_authenticated',
5325
			'user_email_token',
5326
			'user_email_token_expires',
5327
			'user_registration',
5328
			'user_editcount',
5329
		];
5330
	}
5331
5332
	/**
5333
	 * Factory function for fatal permission-denied errors
5334
	 *
5335
	 * @since 1.22
5336
	 * @param string $permission User right required
5337
	 * @return Status
5338
	 */
5339
	static function newFatalPermissionDeniedStatus( $permission ) {
5340
		global $wgLang;
5341
5342
		$groups = array_map(
5343
			[ 'User', 'makeGroupLinkWiki' ],
5344
			User::getGroupsWithPermission( $permission )
5345
		);
5346
5347
		if ( $groups ) {
5348
			return Status::newFatal( 'badaccess-groups', $wgLang->commaList( $groups ), count( $groups ) );
5349
		} else {
5350
			return Status::newFatal( 'badaccess-group0' );
5351
		}
5352
	}
5353
5354
	/**
5355
	 * Get a new instance of this user that was loaded from the master via a locking read
5356
	 *
5357
	 * Use this instead of the main context User when updating that user. This avoids races
5358
	 * where that user was loaded from a replica DB or even the master but without proper locks.
5359
	 *
5360
	 * @return User|null Returns null if the user was not found in the DB
5361
	 * @since 1.27
5362
	 */
5363
	public function getInstanceForUpdate() {
5364
		if ( !$this->getId() ) {
5365
			return null; // anon
5366
		}
5367
5368
		$user = self::newFromId( $this->getId() );
5369
		if ( !$user->loadFromId( self::READ_EXCLUSIVE ) ) {
5370
			return null;
5371
		}
5372
5373
		return $user;
5374
	}
5375
5376
	/**
5377
	 * Checks if two user objects point to the same user.
5378
	 *
5379
	 * @since 1.25
5380
	 * @param User $user
5381
	 * @return bool
5382
	 */
5383
	public function equals( User $user ) {
5384
		return $this->getName() === $user->getName();
5385
	}
5386
}
5387